swagger: '2.0' schemes: - https consumes: - application/json produces: - application/json host: api-homologacao.getnet.com.br info: title: Marketplace Capture API - Transactional | Digital Platform Reference version: 1.0.5 description: | # API ## Introduction The purpose of this document is to describe the interface of Getnet's Digital Platform integration APIs with E-commerce. tags: - name: Authentication x-displayName: Authentication description: The APIs listed in this documentation use OAuth2 authentication, which means that in all requests it is necessary to enter an access token that will be obtained through authentication with its Client ID and Client Secret. - name: Tokenization x-displayName: Tokenization description: In order to carry out transactions safely, the card number must be previously tokenized in all the requisitions before being trafficked along with the other data, such as name of the bearer, expiration date and CVV. - name: Vault x-displayName: Vault description: |- This product gives customers the ability to keep the card information of their purchasers to be used in future purchases. All of this is guaranteed by the best security practices according to the PCI certification guidelines. With this solution it is possible to store card data (card number, bearer’s name and due date) for recurring payments, for example: signatures that can be offered to your customers, thus ensuring that installment payments of this signature are made without the need for the gift card, but with the guarantees required by the Card Issuers and Brands. In this product the following methods are available: * Stores consumer card data in the vault (new card). * List of saved cards. * Recovering data from a saved card. * Removal of a saved card. __It is important to note that Getnet's Vault solution is a product available on the Digital Platform, that is, it can only be used by hiring a package that has this product.__ - name: Payment x-displayName: Payment description: | To perform payment-related transactions, use the endpoints described below through authentication. - name: Payment Combined x-displayName: Payment Combined description: | To perform payment combined -related transactions, use the endpoints described below through authentication. - name: Cancellation x-displayName: Cancellation description: | To enable a request for cancellation of payments with credit cards, use the endpoints below through authentication. paths: /auth/oauth/v2/token: post: summary: Generating the access token description: |- Endpoint responsible for generating the access token used in other requests, for this we use [HTTP Basic Authentication]( https://www.w3.org/Protocols/HTTP/1.0/draft-ietf-http-spec.html#BasicAA) tags: - Authentication consumes: - application/x-www-form-urlencoded produces: - application/json parameters: - in: header name: Content-type required: true type: string enum: - application/x-www-form-urlencoded default: application/x-www-form-urlencoded description: | Default content type application/x-www-form-urlencoded. - in: header name: Authorization required: true type: string description: 'Authorization: Basic *AuthString*
In which *AuthString* is the concatenation of your Client ID, followed by ":"(colon) plus your Client Secret, converted to base64.
For example: For Client ID equal to client-01 and Client Secret equal to secret-key-02, we will have the text client-01:secret-key-02 after the concatenation, converting to base64 we will have the result 2xpZW50LTAxOnNlY3JldC1rZXktMDI=.
In this case the Authorization in the header of the request will be:
Authorization: Basic 2xpZW50LTAxOnNlY3JldC1rZXktMDI=' - in: formData required: true type: string name: scope description: Use the fixed value "oob" default: oob - in: formData required: true type: string name: grant_type description: Use The fixed value "client_credentials" default: client_credentials responses: '200': description: Returns the access token. schema: type: object properties: access_token: type: string description: API access token to be submitted with all requests example: ca22a2ge-1914-4b0c-a0fb-d3ce0fde7346 format: uuidv4 minLength: 36 maxLength: 36 token_type: type: string description: Token type, must be submitted in the header with the token (https://tools.ietf.org/html/rfc6750) example: Bearer expires_in: type: number description: Token expiration period in seconds example: 3600 scope: type: string description: Token scope example: oob '400': description: Invalid request. schema: $ref: '#/definitions/error_authentication' '401': description: Unauthorized. schema: $ref: '#/definitions/error_authentication' x-code-samples: - lang: cURL source: | curl -X POST \ https://api-homologacao.getnet.com.br/auth/oauth/v2/token \ -H 'authorization: Basic 2xpZW50LTAxOnNlY3JldC1rZXktMDI=' \ -H 'content-type: application/x-www-form-urlencoded' \ -d 'scope=oob&grant_type=client_credentials' /v1/tokens/card: post: summary: Card Token Generation description: To perform transactions securely, card data except CVV must be *tokenized*, this process is done by the endpoint described below through authentication. tags: - Tokenization consumes: - application/json produces: - application/json parameters: - in: header name: Content-type required: true type: string enum: - application/json; charset=utf-8 default: application/json; charset=utf-8 description: | Content type. - in: header name: Authorization required: true type: string description: | Authorization: Bearer *AuthString*
In which *AuthString* is an access token obtained at the authentication endpoint. - in: header name: seller_id required: false type: string description: 'Authorization: E-commerce identification code. Required when the client is treated as a Platform.' format: uuidv4 minLength: 36 maxLength: 36 - in: body name: token_card description: Card and Buyer Data schema: type: object required: - card_number properties: card_number: type: string description: Card number minLength: 13 maxLength: 19 example: '5155901222280001' customer_id: type: string description: Buyer ID. Information defined by the application that consumes the api of the Digital Platform. example: customer_21081826 maxLength: 100 responses: '201': description: Returns the token of the card. schema: type: object properties: number_token: type: string description: The Card Token that will be used in the transactions. If the HTTP response contains the "Content-Encoding:gzip" ( RFC 2616 topic 14.11 Content-Encoding ) header, the response must go through an unzipping process, depending on the technology used for integration, it will require the use of a third party library. example: dfe05208b105578c070f806c80abd3af09e246827d29b866cf4ce16c205849977c9496cbf0d0234f42339937f327747075f68763537b90b31389e01231d4d13c minLength: 128 maxLength: 128 '400': description: Invalid request. schema: $ref: '#/definitions/error' '401': description: Invalid authentication. schema: $ref: '#/definitions/error' '404': description: Not found. schema: $ref: '#/definitions/error' '500': description: Internal server or service error. schema: $ref: '#/definitions/error' x-code-samples: - lang: cURL source: | curl -X POST \ https://api-homologacao.getnet.com.br/v1/tokens/card \ -H 'authorization: Bearer ca22a2ge-1914-4b0c-a0fb-d3ce0fde7346' \ -H 'content-type: application/json; charset=utf-8' \ -d '{ "card_number": "5155901222280001" }' /v1/cards/verification: post: summary: Card verification description: This transaction verifies if the credit card informed by the cardholder is valid. A valid credit card is one that is not canceled, blocked or restricted. Card verification is only available for MasterCard and Visa. tags: - Payment consumes: - application/json produces: - application/json parameters: - in: header name: Content-type required: true type: string enum: - application/json; charset=utf-8 default: application/json; charset=utf-8 description: | Content type. - in: header name: Authorization required: true type: string description: 'Authorization: Bearer *AuthString*
In which *AuthString* is an access token obtained at the authentication endpoint.' - in: header name: seller_id required: false type: string description: | Authorization: E-commerce identification code. Required when the client is treated as a Platform. format: uuidv4 minLength: 36 maxLength: 36 - in: body name: verification_card_body required: true description: Request containing the card data for verification. schema: $ref: '#/definitions/verification_card_body' responses: '200': description: Card verification performed successfully. schema: type: object properties: status: type: string description: Card verification status, where VERIFIED indicates that the card has been successfully validated. enum: - VERIFIED - NOT VERIFIED - DENIED - ERROR example: VERIFIED minLength: 5 maxLength: 20 verification_id: type: string format: uuidv4 description: Verification request identification on the digital platform. example: ae267804-503c-4163-b1b1-f5da5120b74e minLength: 36 maxLength: 36 authorization_code: type: string description: Authorization number generated by the card verification system. example: '6964722471672911' minLength: 1 maxLength: 18 '400': description: Invalid request. schema: $ref: '#/definitions/error' '401': description: Invalid authentication. schema: $ref: '#/definitions/error' '500': description: Internal server or service error. schema: $ref: '#/definitions/error' x-code-samples: - lang: cURL source: | curl -X POST \ https://api-homologacao.getnet.com.br/v1/cards/verification \ -H 'authorization: Bearer 4d98da5d-767b-4db6-b581-b664e829bd41' \ -H 'content-type: application/json; charset=utf-8' \ -d ' { "number_token": "3fdb3ac9a6def80bf64cd241b9035e77ed8757032d356718864d03465a1130e20d8a897005e144dd6c1a5b4e63fcc99d3755f9e18a7cd852ad82778c65008988", "brand":"mastercard", "cardholder_name": "JOAO DA SILVA", "expiration_month" : "10", "expiration_year" : "18", "security_code" : "123" }' /v1/cards: post: summary: Stores consumer card data in safe description: Creates a feature within the Getnet digital platform from consumer card data for use in future payments. tags: - Vault consumes: - application/json produces: - application/json parameters: - in: header name: Content-type required: true type: string enum: - application/json; charset=utf-8 default: application/json; charset=utf-8 description: | Content type. - in: header name: Authorization required: true type: string description: | Authorization: Bearer *AuthString*
In which *AuthString* is an access token obtained at the authentication endpoint. - in: header name: seller_id required: false type: string description: | Authorization: E-commerce identification code. format: uuidv4 minLength: 36 maxLength: 36 - in: body name: vault_card_body required: true description: Request containing the card data to be saved in the safe. schema: $ref: '#/definitions/vault_card' responses: '201': description: Identifier of the card successfully created. Card saved in safe. schema: type: object properties: card_id: type: string description: Card identifier saved in vault can be used to retrieve a valid number_token for future purchases as well as can be used to remove saved cards. example: e8ad2ae4-9e3e-4532-998f-1a5a11e56e58 format: uuidv4 minLength: 36 maxLength: 36 number_token: type: string description: The Card Token that will be used in the transactions. example: dfe05208b105578c070f806c80abd3af09e246827d29b866cf4ce16c205849977c9496cbf0d0234f42339937f327747075f68763537b90b31389e01231d4d13c minLength: 128 maxLength: 128 '400': description: Invalid request. schema: $ref: '#/definitions/error' '401': description: Invalid authentication. schema: $ref: '#/definitions/error' '403': description: Product safe not enabled. schema: $ref: '#/definitions/error' '404': description: Not found. schema: $ref: '#/definitions/error' '500': description: Internal server or service error. schema: $ref: '#/definitions/error' x-code-samples: - lang: cURL source: | curl -X POST \ https://api-homologacao.getnet.com.br/v1/cards \ -H 'authorization: Bearer ca22a2ge-1914-4b0c-a0fb-d3ce0fde7346' \ -H 'content-type: application/json; charset=utf-8' \ -d '{ "number_token": "dfe05208b105578c070f806c80abd3af09e246827d29b866cf4ce16c205849977c9496cbf0d0234f42339937f327747075f68763537b90b31389e01231d4d13c", "cardholder_name": "JOAO DA SILVA", "expiration_month": "12", "expiration_year": "20", "customer_id": "customer_21081826", "cardholder_identification": "12345678912" }' get: summary: List of cards saved in the safe description: Returns a list of saved cards based on buyer ID data - customer_id. tags: - Vault produces: - application/json parameters: - required: true description: | Authorization: Bearer *AuthString *
In which *AuthString* is an access token obtained at the authentication endpoint. type: string name: Authorization in: header - in: header name: seller_id required: false type: string description: | Authorization: E-commerce identification code. Required when the client is treated as a Platform. format: uuidv4 minLength: 36 maxLength: 36 - required: true description: Buyer ID. Information defined by the application that consumes the api of the Digital Platform. type: string name: customer_id maxLength: 100 in: query - required: false description: Status filter of returned cards. If no filter is entered, the active and renewed cards are returned. enum: - all - active - renewed type: string name: status maxLength: 25 in: query responses: '200': description: List of saved cards. schema: type: object properties: cards: type: array items: $ref: '#/definitions/vault_card_response' '400': description: Invalid request. schema: $ref: '#/definitions/error' '401': description: Invalid authentication. schema: $ref: '#/definitions/error' '403': description: Product safe not enabled. schema: $ref: '#/definitions/error' '404': description: Not found. schema: $ref: '#/definitions/error' '500': description: Internal server or service error. schema: $ref: '#/definitions/error' x-code-samples: - lang: cURL source: | curl -X GET \ https://api-homologacao.getnet.com.br/v1/cards?customer_id=customer_21081826 \ -H 'authorization: Bearer 72402c54-6bd3-4895-a6b4-adfded0c11dc' /v1/cards/{card_id}: get: summary: Retrieve a saved card in the safe description: Gets the data from the card saved in the safe, from the card_id generated at the time of card storage. tags: - Vault produces: - application/json parameters: - required: true description: | Authorization: Bearer *AuthString*
In which *AuthString* is an access token obtained at the authentication endpoint. type: string name: Authorization in: header - in: header name: seller_id required: false type: string description: | Authorization: E-commerce identification code. Required when the client is treated as a Platform. format: uuidv4 minLength: 36 maxLength: 36 - required: true description: Unique identifier of the card in Getnet digital platform. type: string name: card_id maxLength: 36 in: path responses: '200': description: Card data. schema: $ref: '#/definitions/vault_card_response' '400': description: Invalid request. schema: $ref: '#/definitions/error' '401': description: Invalid authentication. schema: $ref: '#/definitions/error' '403': description: Product safe not enabled. schema: $ref: '#/definitions/error' '404': description: Not found. schema: $ref: '#/definitions/error' '500': description: Internal server or service error. schema: $ref: '#/definitions/error' x-code-samples: - lang: cURL source: | curl -X GET \ https://api-homologacao.getnet.com.br/v1/cards/14a2ce5d-ebc3-49dc-a516-cb5239b02285 \ -H 'authorization: Bearer 72402c54-6bd3-4895-a6b4-adfded0c11dc' delete: summary: Removes a saved card in the safe description: Removes a saved card from Getnet's digital platform, from card_id. tags: - Vault produces: - application/json parameters: - required: true description: | Authorization: Bearer *AuthString*
In which *AuthString* is an access token obtained at the authentication endpoint. type: string name: Authorization in: header - in: header name: seller_id required: false type: string description: | Authorization: E-commerce identification code. Required when the client is treated as a Platform. format: uuidv4 minLength: 36 maxLength: 36 - required: true description: Unique identifier of the card in Getnet digital platform. type: string name: card_id maxLength: 36 in: path responses: '204': description: Card removed successfully. '400': description: Invalid request. schema: $ref: '#/definitions/error' '401': description: Invalid authentication. schema: $ref: '#/definitions/error' '403': description: Product safe not enabled. schema: $ref: '#/definitions/error' '404': description: Resource not found. schema: $ref: '#/definitions/error' '500': description: Internal server or service error. schema: $ref: '#/definitions/error' x-code-samples: - lang: cURL source: | curl -X DELETE \ https://api-homologacao.getnet.com.br/v1/cards/14a2ce5d-ebc3-49dc-a516-cb5239b02285 \ -H 'authorization: Bearer 72402c54-6bd3-4895-a6b4-adfded0c11dc' /v1/payments/credit: post: summary: Payment by credit card description: At this endpoint data for payment by credit card will be received. tags: - Payment consumes: - application/json produces: - application/json parameters: - in: header name: Content-type required: true type: string enum: - application/json; charset=utf-8 default: application/json; charset=utf-8 description: | Content type. - in: header name: Authorization required: true type: string description: | Authorization: Bearer *AuthString*
In which *AuthString* is an access token obtained at the authentication endpoint. - in: body name: credit_body required: true description: Request containing data for credit card payment and fraud analysis. schema: $ref: '#/definitions/payment_credit' responses: '200': description: Payment successful. Transaction approved. schema: $ref: '#/definitions/payment_credit_response' '202': description: Request for credit payment with late confirmation or pre-authorization received, accepted and stored awaiting confirmation. schema: $ref: '#/definitions/payment_credit_pre_response' '400': description: Invalid request. schema: $ref: '#/definitions/error_table' '401': description: Invalid authentication. schema: $ref: '#/definitions/error' '402': description: Request is valid but payment denied. Can be denied for various reasons / business rules. schema: $ref: '#/definitions/error_table' '404': description: Not found. schema: $ref: '#/definitions/error_table' '500': description: Internal server or service error. schema: $ref: '#/definitions/error_table' x-code-samples: - lang: cURL source: | curl -X POST \ https://api-homologacao.getnet.com.br/v1/payments/credit \ -H 'authorization: Bearer 72402c54-6bd3-4895-a6b4-adfded0c11dc' \ -d '{ "seller_id": "6eb2412c-165a-41cd-b1d9-76c575d70a28", "amount": 100, "currency": "BRL", "order": { "order_id": "6d2e4380-d8a3-4ccb-9138-c289182818a3", "sales_tax": 0, "product_type": "service" }, "customer": { "customer_id": "customer_21081826", "first_name": "João", "name": "João Silva", "email": "customer@email.com.br", "document_type": "CPF", "document_number": "12345678912", "phone_number": "5551999887766", "billing_address": { "street": "Av. Brasil", "number": "1000", "complement": "Sala 1", "district": "São Geraldo", "city": "Porto Alegre", "state": "RS", "country": "Brasil", "postal_code": "90230060" } }, "device": { "ip_address": "127.0.0.1", "device_id": "hash-device-id" }, "shippings": [{ "first_name": "João", "name": "João da Silva", "email": "customer@email.com.br", "phone_number": "5551999887766", "shipping_amount": 3000, "address": { "street": "Av. Brasil", "complement": "Sala 1", "number": "1000", "district": "São Geraldo", "city": "Porto Alegre", "state": "RS", "country": "Brasil", "postal_code": "90230060" } }], "marketplace_subseller_payments": [{ "subseller_sales_amount": 10202, "subseller_id": "10", "order_items": [{ "amount": 5101, "tax_percent": 0.10, "description": "produto x", "currency": "BRL", "id": "X0001" }, { "amount": 5101, "tax_percent": 0.10, "description": "produto y", "currency": "BRL", "id": "Y0002" }] }], "credit": { "delayed": false, "save_card_data": false, "transaction_type": "FULL", "number_installments": 1, "soft_descriptor": "LOJA*TESTE*COMPRA-123", "dynamic_mcc": 1799, "card": { "number_token": "dfe05208b105578c070f806c80abd3af09e246827d29b866cf4ce16c205849977c9496cbf0d0234f42339937f327747075f68763537b90b31389e01231d4d13c", "bin": "123412", "security_code": "123", "expiration_month": "12", "expiration_year": "20", "cardholder_name": "JOAO DA SILVA" } } }' /v1/payments/credit/{payment_id}/confirm: post: summary: Late payment or pre authorization confirmation with credit card. description: |- Late Payment Confirmation:
When a credit transaction is made with the option delayed = true, late confirmation, it can be later confirmed by up to 7 Days.

Pre-Authorization Confirmation:
When a credit transaction is made with the pre_authorization = true, pre-authorization, it has a period of 30 days to be confirmed.
In a transaction with the Pre-Authorization functionality, where the transaction and the value are confirmed after the service has been completed, you can change the Subseller before the transaction is committed, so that a subseller other than the one you initiated the transaction can receive the amount and proceed with the confirmation, without the transaction need to be canceled, ideal for application templates of mobility, delivery and services. tags: - Payment consumes: - application/json produces: - application/json parameters: - in: header name: Content-type required: true type: string enum: - application/json; charset=utf-8 default: application/json; charset=utf-8 description: | Content type. - in: header name: Authorization required: true type: string description: | Authorization: Bearer *AuthString*
In which *AuthString* is an access token obtained at the authentication endpoint. - in: path name: payment_id description: Payment identifier previously received and accepted. type: string minLength: 36 maxLength: 36 format: uuidv4 required: true - in: body name: body description: Request containing the data for a late or pre-authorized credit confirmation request. schema: $ref: '#/definitions/credit_confirm' required: false responses: '200': description: Payment confirmed successfully. schema: $ref: '#/definitions/credit_delayed_confirm' '400': description: Invalid request. schema: $ref: '#/definitions/error' '401': description: Invalid authentication. schema: $ref: '#/definitions/error' '402': description: Request is valid but payment denied. Can be denied for various reasons / business rules. schema: $ref: '#/definitions/error' '404': description: Not found. schema: $ref: '#/definitions/error' '500': description: Internal server or service error. schema: $ref: '#/definitions/error' x-code-samples: - lang: cURL source: | curl -X POST \ https://api-homologacao.getnet.com.br/v1/payments/credit/06f256c8-1bbf-42bf-93b4-ce2041bfb87e/confirm \ -H 'authorization: Bearer 72402c54-6bd3-4895-a6b4-adfded0c11dc' \ -H 'cache-control: no-cache' \ -H 'content-type: application/json; charset=utf-8' \ /v1/payments/credit/{payment_id}/adjustment: post: summary: Adjust value of a pre-authorization transaction description: Performs an adjustment (Increase/Decrease) in the amount previously reserved in the Holder’s balance for a Pre-Authorization Transaction. The value of the Pre-Authorization Adjustment Transaction can be greater or less than the original value. In the call of the adjustment process, the desired final value must always be sent in the amount field. For marketplace transactions, it must be informed which change was made in the customer's order. tags: - Payment consumes: - application/json produces: - application/json parameters: - in: header name: Content-type required: true type: string enum: - application/json default: application/json description: | Content type application/json. - in: header name: Authorization required: true type: string description: | Authorization: Bearer *AuthString*
In which *AuthString* is an access token obtained at the authentication endpoint. - in: path name: payment_id description: Payment identifier previously received and accepted. type: string minLength: 36 maxLength: 36 format: uuidv4 required: true - in: body name: body description: Request containing the data for a Pre-Authorization value adjustment request. schema: $ref: '#/definitions/credit_preauthorized_adjustment' required: true responses: '200': description: Adjustment made successfully. schema: $ref: '#/definitions/credit_preauthorized_adjustment_response' '400': description: Invalid request. schema: $ref: '#/definitions/error' '401': description: Invalid authentication. schema: $ref: '#/definitions/error' '402': description: Request is valid but the setting has been denied. Can be denied for various reasons / business rules. schema: $ref: '#/definitions/error' '404': description: Not found. schema: $ref: '#/definitions/error' '500': description: Internal server or service error. schema: $ref: '#/definitions/error' x-code-samples: - lang: cURL source: | curl -X POST \ https://api-homologacao.getnet.com.br/v1/payments/credit/06f256c8-1bbf-42bf-93b4-ce2041bfb87e/adjustment \ -H 'authorization: Bearer 72402c54-6bd3-4895-a6b4-adfded0c11dc' \ -H 'cache-control: no-cache' \ -H 'content-type: application/json' \ -d '{ "amount": 19990, "currency": "BRL", "dynamic_mcc": 6666, "soft_descriptor": "LOJA*TESTE*COMPRA-123", "marketplace_subseller_payments": [{ "subseller_sales_amount": 10202, "subseller_id": "10", "order_items": [{ "amount": 5101, "tax_percent": 0.10, "description": "produto x", "currency": "BRL", "id": "X0001" }, { "amount": 5101, "tax_percent": 0.10, "description": "produto y", "currency": "BRL", "id": "Y0002" }] }]}' /v1/payments/credit/{payment_id}/cancel: post: summary: Cancel payment on credit card description: Cancel full credit transaction or cancel/undo delayed capture or pre-authorization transaction. If the transaction is already committed, cancellation is allowed only on the same day (D0) that this transaction was performed. However if the transaction is authorized (delayed capture or pre-authorization) the undoing can be carried out within 7 days. tags: - Payment consumes: - application/json produces: - application/json parameters: - in: header name: Content-type required: true type: string enum: - application/json; charset=utf-8 default: application/json; charset=utf-8 description: | Content type. - in: header name: Authorization required: true type: string description: | Authorization: Bearer *AuthString*
In which *AuthString* is an access token obtained at the authentication endpoint. - in: path name: payment_id description: Payment identifier previously received and accepted. type: string minLength: 36 maxLength: 36 format: uuidv4 required: true responses: '200': description: Payment canceled successfully. schema: $ref: '#/definitions/credit_delayed_cancel' '400': description: Invalid request. schema: $ref: '#/definitions/error' '401': description: Invalid authentication. schema: $ref: '#/definitions/error' '402': description: Request is valid but payment denied. Can be denied for various reasons / business rules. schema: $ref: '#/definitions/error' '404': description: Not found. schema: $ref: '#/definitions/error' '500': description: Internal server or service error. schema: $ref: '#/definitions/error' x-code-samples: - lang: cURL source: | curl -X POST \ https://api-homologacao.getnet.com.br/v1/payments/credit/06f256c8-1bbf-42bf-93b4-ce2041bfb87e/cancel \ -H 'authorization: Bearer 72402c54-6bd3-4895-a6b4-adfded0c11dc' \ -H 'cache-control: no-cache' \ -H 'content-type: application/json; charset=utf-8' \ /v1/payments/cancel/request: post: summary: Request a cancellation description: Request the cancellation of transactions that were made more than 1 day ago (D + n). tags: - Cancellation consumes: - application/json produces: - application/json parameters: - required: true description: Content type. enum: - application/json; charset=utf-8 default: application/json; charset=utf-8 type: string name: Content-Type in: header - required: true description: | Authorization: Bearer *AuthString*
In which *AuthString* is an access token obtained at the authentication endpoint. type: string name: Authorization in: header - required: false description: E-commerce identification code. type: string name: seller_id format: uuidv4 minLength: 36 maxLength: 36 in: header - required: true in: body name: body description: Request containing the data for a cancellation request. schema: $ref: '#/definitions/cancel_request' responses: '202': description: Accepted cancellation request. schema: $ref: '#/definitions/cancel_request_response' '400': description: Invalid request. schema: $ref: '#/definitions/error' '401': description: Invalid authentication. schema: $ref: '#/definitions/error' '404': description: Not found. schema: $ref: '#/definitions/error' '409': description: Conflict. Duplicate client key (cancel_custom_key). schema: $ref: '#/definitions/error' '500': description: Internal server or service error. schema: $ref: '#/definitions/error' x-code-samples: - lang: cURL source: | curl -X POST \ https://api-homologacao.getnet.com.br/v1/payments/cancel/request \ -H 'authorization: Bearer 151f3061-d162-41c0-a3e7-474c49e60f57' \ -H 'cache-control: no-cache' \ -H 'content-type: application/json; charset=utf-8' \ -H 'seller_id: 6eb2412c-165a-41cd-b1d9-76c575d70a28' \ -d '{ "payment_id": "06f256c8-1bbf-42bf-93b4-ce2041bfb87e", "cancel_amount": 19990, "cancel_custom_key": "4ec33ee18f9e45bfb73c5c30667f9006" } get: summary: Returns a cancellation request by the client key description: Returns the cancellation request data by the key generated by the client. tags: - Cancellation produces: - application/json parameters: - required: true description: | Authorization: Bearer *AuthString*
In which *AuthString* is an access token obtained at the authentication endpoint. type: string name: Authorization in: header - required: false description: E-commerce identification code. type: string name: seller_id format: uuidv4 minLength: 36 maxLength: 36 in: header - required: true description: Customer generated key for the cancellation request. type: string name: cancel_custom_key maxLength: 32 in: query responses: '200': description: Returns the data for the cancellation request. schema: $ref: '#/definitions/cancel_query_response' '400': description: Invalid request. schema: $ref: '#/definitions/error' '401': description: Invalid authentication. schema: $ref: '#/definitions/error' '404': description: Not found. schema: $ref: '#/definitions/error' '500': description: Internal server or service error. schema: $ref: '#/definitions/error' x-code-samples: - lang: cURL source: | curl -X GET \ https://api-homologacao.getnet.com.br/v1/payments/cancel/request?cancel_custom_key=4ec33ee18f9e45bfb73c5c30667f9006 \ -H 'authorization: Bearer 72402c54-6bd3-4895-a6b4-adfded0c11dc' \ -H 'seller_id: 6eb2412c-165a-41cd-b1d9-76c575d70a28' /v1/payments/cancel/request/{cancel_request_id}: get: summary: Returns a request for cancellation by the identifier description: Returns the cancellation request data by the identifier. tags: - Cancellation produces: - application/json parameters: - required: true description: | Authorization: Bearer *AuthString*
In which *AuthString* is an access token obtained at the authentication endpoint. type: string name: Authorization in: header - required: false description: E-commerce identification code. type: string name: seller_id format: uuidv4 minLength: 36 maxLength: 36 in: header - required: true description: Identification of the cancellation request. type: string name: cancel_request_id minLength: 18 maxLength: 18 in: path responses: '200': description: Returns the data for the cancellation request. schema: $ref: '#/definitions/cancel_query_response' '400': description: Invalid request. schema: $ref: '#/definitions/error' '401': description: Invalid authentication. schema: $ref: '#/definitions/error' '404': description: Not found. schema: $ref: '#/definitions/error' '500': description: Internal server or service error. schema: $ref: '#/definitions/error' x-code-samples: - lang: cURL source: | curl -X GET \ https://api-homologacao.getnet.com.br/v1/payments/cancel/request/20171117084237501 \ -H 'authorization: Bearer 72402c54-6bd3-4895-a6b4-adfded0c11dc' \ -H 'seller_id: 6eb2412c-165a-41cd-b1d9-76c575d70a28' /v1/marketplace/payments/{payment_id}/release: post: summary: Release payment to SubSeller description: Releases payment to the SubSeller, for the order items. Payment is made per item, thus, for the value of each item from the order to be paid, all the items must be released. This way, the endpoint must be called individually for each item from the order. tags: - Payment consumes: - application/json produces: - application/json parameters: - in: header name: Content-type required: true type: string enum: - application/json; charset=utf-8 default: application/json; charset=utf-8 description: | Content type. - in: header name: Authorization required: true type: string description: | Authorization: Bearer *AuthString*
In which *AuthString* is an access token obtained at the authentication endpoint. - in: path name: payment_id description: Payment identifier previously received and accepted. type: string minLength: 36 maxLength: 36 format: uuidv4 required: true - in: body name: payment_release required: true description: Requisition containing the data release of the payment to the SubSeller concerning the products of the order. schema: $ref: '#/definitions/payment_release' responses: '200': description: Release successful. schema: $ref: '#/definitions/payment_release_response' '400': description: Invalid request. schema: $ref: '#/definitions/error' '401': description: Invalid authentication. schema: $ref: '#/definitions/error' '402': description: Request is valid but payment denied. Can be denied for various reasons / business rules. schema: $ref: '#/definitions/error' '404': description: Not found. schema: $ref: '#/definitions/error' '500': description: Internal server or service error. schema: $ref: '#/definitions/error' x-code-samples: - lang: cURL source: | curl -X POST \ https://api-homologacao.getnet.com.br/v1/marketplace/payments/5fa28781-3d54-432f-91c8-69ddb47d25d5/release \ -H 'authorization: Bearer 72402c54-6bd3-4895-a6b4-adfded0c11dc' \ -H 'cache-control: no-cache' \ -H 'content-type: application/json; charset=utf-8' \ -d '{ "release_payment_date": "2018-06-30T18:01:24Z", "subseller_id": "23", "order_item_release": { "id": "X0001", "amount": 5101 } }' patch: summary: Updates the release date of the payment to the SubSeller description: Updates the release date of the payment to the SubSeller regarding the products of the order tags: - Payment consumes: - application/json produces: - application/json parameters: - in: header name: Content-type required: true type: string enum: - application/json; charset=utf-8 default: application/json; charset=utf-8 description: | Content type. - in: header name: Authorization required: true type: string description: | Authorization: Bearer *AuthString*
In which *AuthString* is an access token obtained at the authentication endpoint. - in: path name: payment_id description: Payment identifier previously received and accepted. type: string minLength: 36 maxLength: 36 format: uuidv4 required: true - in: body name: payment_release required: true description: Requisition containing the data release of the payment to the SubSeller concerning the products of the order. schema: $ref: '#/definitions/payment_release_patch' responses: '200': description: Release successful. schema: $ref: '#/definitions/payment_release_response' '400': description: Invalid request. schema: $ref: '#/definitions/error' '401': description: Invalid authentication. schema: $ref: '#/definitions/error' '402': description: Request is valid but payment denied. Can be denied for various reasons / business rules. schema: $ref: '#/definitions/error' '404': description: Not found. schema: $ref: '#/definitions/error' '500': description: Internal server or service error. schema: $ref: '#/definitions/error' x-code-samples: - lang: cURL source: | curl -X POST \ https://api-homologacao.getnet.com.br/v1/marketplace/payments/5fa28781-3d54-432f-91c8-69ddb47d25d5/release \ -H 'authorization: Bearer 72402c54-6bd3-4895-a6b4-adfded0c11dc' \ -H 'cache-control: no-cache' \ -H 'content-type: application/json; charset=utf-8' \ -d '{ "release_payment_date": "2018-06-30T18:01:24Z", "previous_release_payment_date": "2019-03-14T17:14:24Z", "subseller_id": "23", "order_item_release": { "id": "X0001", "amount": 5101 } }' /v1/payments/boleto: post: summary: Registration for payment with bank slip description: |- This endpoint will receive the data of the new bank payment slip, which will be registered with Banco Santander.

#### Print the second copy of a bill In the registration of a payment bill the payment_id field is returned in the response of the registration request. Payment_id will be used for the duplicate bill download request in the Download pdf bill or Download html download requests.

__Note:__ The payment_id field can also be recovered in the bank payment slip notification. More information on notifications is available in Notifications 1.0. tags: - Payment consumes: - application/json produces: - application/json parameters: - in: header name: Content-type required: true type: string enum: - application/json; charset=utf-8 default: application/json; charset=utf-8 description: | Content type. - in: header name: Authorization required: true type: string description: | Authorization: Bearer *AuthString*
In which *AuthString* is an access token obtained at the authentication endpoint. - in: body name: boleto_body required: true description: Requisition containing the data for payment by bank slip. schema: $ref: '#/definitions/payment_boleto' responses: '201': description: Bank slip issued successfully. schema: $ref: '#/definitions/payment_boleto_response' '400': description: Invalid request. schema: $ref: '#/definitions/error' '401': description: Invalid authentication. schema: $ref: '#/definitions/error' '402': description: Request is valid but payment denied. Can be denied for various reasons / business rules. schema: $ref: '#/definitions/error_table' '404': description: Not found. schema: $ref: '#/definitions/error' '500': description: Internal server or service error. schema: $ref: '#/definitions/error' x-code-samples: - lang: cURL source: | curl -X POST \ https://api-homologacao.getnet.com.br/v1/payments/boleto \ -H 'authorization: Bearer 151f3061-d162-41c0-a3e7-474c49e60f57' \ -H 'cache-control: no-cache' \ -H 'content-type: application/json; charset=utf-8' \ -d '{ "seller_id": "6eb2412c-165a-41cd-b1d9-76c575d70a28", "amount": 100, "currency": "BRL", "order": { "order_id": "6d2e4380-d8a3-4ccb-9138-c289182818a3", "sales_tax": 0, "product_type": "service" }, "boleto": { "our_number": "000001946598", "document_number": "170500000019763", "instructions": "Pagar até o vencimento", "provider": "santander", "expiration_date": "10/05/2018" "guarantor_document_type": "CPF", "guarantor_document_number": "78009200021", "guarantor_name": "Nome do Avalista" }, "customer": { "first_name": "João", "name": "João da Silva", "document_type": "CPF", "document_number": "12345678912", "billing_address": { "street": "Av. Brasil", "number": "1000", "complement": "Sala 1", "district": "São Geraldo", "city": "Porto Alegre", "state": "RS", "country": "Brasil", "postal_code": "90230060" } }, "marketplace_subseller_payments": [{ "subseller_sales_amount": 10202, "subseller_id": "10", "order_items": [{ "amount": 5101, "tax_percent": 0.10, "description": "produto x", "currency": "BRL", "id": "X0001" }, { "amount": 5101, "tax_percent": 0.10, "description": "produto y", "currency": "BRL", "id": "Y0002" }] }], } /v1/payments/boleto/{payment_id}/pdf: get: summary: Download pdf of the bank slip description: At this endpoint, the user can download the bank slip PDF to the ID entered in the path. tags: - Payment produces: - application/json parameters: - in: path name: payment_id description: | Bank slip identifier Hash.
Exemplo: 67e1eba5a4bae6a5011fc30b type: string minLength: 24 maxLength: 24 required: true - in: query name: ack description: |

Parâmetro de segurança.

Exemplo: ack=eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiI2N2UxZWJhNWE0YmFlNmE1MDExZmMzMGIiLCJpYXQiOjE3NDI4NTkxNzMsImF1ZGllbmNlIjoiWW05c1pYUnZMV1J2ZDI1c2IyRmtMWE5sY25acFkyVT0iLCJleHAiOjE3NDg3MzYwMDB9.HXX3kOf95MiXUG9fJUE4d8QsDlr3acTGsCpfvd2RFX6HYPHiywnlFq-mXCKCYPkdY3mUJVwW7ct7WXStKkDZG2ZqfC7d9CnMQs5b5Tjw4sg2vbeZrMkbd69ih6pt6f0hpmecPA_Jbonl995suzW67zQNy-oJ-4ULDlNLuu4FdmRRX31uLho3Gtu3PoQhC3p876m5oFJ1MTxdZwcIqiGQIXWv96elhx-LpIfT4yzisSkZGgRe-EVdh-q31hRrAH3HqsS6_BdXX0XSoFBhEbCtkjOlST0Rknm_kMyk1QCvrh5vCh9EAJQ5DTeglcyE8NgDG5CLzRcJcM6B1KpKOH0oHw

Note: The ack field can also be retrieved in the bill notification. More information about notifications is available in Notificações 1.1

type: string maxLength: 600 required: true responses: '200': description: In case of success, the bank slip will be returned in PDF file. '400': description: Invalid request. schema: $ref: '#/definitions/error' '404': description: Not found. schema: $ref: '#/definitions/error' '500': description: Internal server or service error. schema: $ref: '#/definitions/error' x-code-samples: - lang: cURL source: | curl -X GET \ 'https://api-homologacao.getnet.com.br/v1/payments/boleto/599ca35059028b001023b323/pdf' /v1/payments/boleto/{payment_id}/html: get: summary: Download bank slip html description: At this endpoint, the user can download the bank slip html to the ID entered in the path. tags: - Payment produces: - application/json parameters: - in: path name: payment_id description: | Bank slip identifier Hash.
Exemplo: 67e1eba5a4bae6a5011fc30b type: string minLength: 24 maxLength: 24 required: true - in: query name: ack description: |

Parâmetro de segurança.

Note: The ack field can also be retrieved in the bill notification. More information about notifications is available in Notificações 1.1

type: string maxLength: 600 required: true responses: '200': description: In case of success, the bank slip will be returned in html file. '400': description: Invalid request. schema: $ref: '#/definitions/error' '404': description: Not found. schema: $ref: '#/definitions/error' '500': description: Internal server or service error. schema: $ref: '#/definitions/error' x-code-samples: - lang: cURL source: | curl -X GET \'https://api-homologacao.getnet.com.br/v1/payments/boleto/599ca35059028b001023b323/html' /v1/payments/combined: post: summary: Payment combined description: This endpoint will be receive data for combined payment tags: - Payment Combined consumes: - application/json produces: - application/json parameters: - in: header name: Content-type required: true type: string enum: - application/json; charset=utf-8 default: application/json; charset=utf-8 description: | Content type application/json. - in: header name: Authorization required: true type: string description: | Authorization: Bearer *AuthString*
Where *AuthString* it's access token obtained from the endpoint of authentication. - in: header required: false description: e-commerce identification code. type: string name: seller_id format: uuidv4 minLength: 36 maxLength: 36 - in: body name: body required: true description: Request containing data for combined payment schema: $ref: '#/definitions/payment_combined' responses: '201': description: Request for payment authorization(s) successfully received. schema: $ref: '#/definitions/payment_combined_response' '400': description: Request invalid. schema: $ref: '#/definitions/error' '401': description: Authentication invalid. schema: $ref: '#/definitions/error' '402': description: Request is valid, but payment(s) denied. Can be denied for various reasons/business rules. schema: $ref: '#/definitions/error' '404': description: Not found. schema: $ref: '#/definitions/error' '500': description: Internal server error or service. schema: $ref: '#/definitions/error' '504': description: Timeout. schema: $ref: '#/definitions/error' x-code-samples: - lang: cURL source: | curl -X POST \ https://api-homologacao.getnet.com.br/v1/payments/combined \ -H 'authorization: Bearer 72402c54-6bd3-4895-a6b4-adfded0c11dc' \ -d '{ "seller_id": "6eb2412c-165a-41cd-b1d9-76c575d70a28", "amount": 20000, "currency": "BRL", "order": { "order_id": "6d2e4380-d8a3-4ccb-9138-c289182818a3", "product_type": "service" }, "customer": { "customer_id": "customer_21081826", "first_name": "João", "name": "João Silva", "email": "customer@email.com.br", "document_type": "CPF", "document_number": "12345678912", "phone_number": "5551999887766", "billing_address": { "street": "Av. Brasil", "number": "1000", "complement": "Sala 1", "district": "São Geraldo", "city": "Porto Alegre", "state": "RS", "country": "Brasil", "postal_code": "90230060" } }, "device": { "ip_address": "127.0.0.1", "device_id": "hash-device-id" }, "shippings": [ { "first_name": "João", "name": "João da Silva", "email": "customer@email.com.br", "phone_number": "5551999887766", "shipping_amount": 1000, "address": { "street": "Av. Brasil", "complement": "Sala 1", "number": "1000", "district": "São Geraldo", "city": "Porto Alegre", "state": "RS", "country": "Brasil", "postal_code": "90230060" } } ], "payments": [ { "type": "CREDIT", "amount": 15000, "currency": "BRL", "save_card_data": false, "transaction_type": "FULL", "number_installments": 1, "soft_descriptor": "LOJA*TESTE*COMPRA-123", "payment_tag": "pay-1", "card": { "number_token": "3ac4934350d11409cb17433ce324e83e41d980afeeb0379c24e1895fec1bec0d72c0d1434241f9c73fff79367b373755dede2a98d09975ea9af93fdfd4581b78", "cardholder_name": "JOAO DA SILVA", "security_code": "123", "brand": "Mastercard", "expiration_month": "12", "expiration_year": "20" } }, { "type": "CREDIT", "amount": 5000, "currency": "BRL", "save_card_data": false, "transaction_type": "FULL", "number_installments": 1, "soft_descriptor": "LOJA*TESTE*COMPRA-123", "payment_tag": "pay-2", "card": { "number_token": "004ff49682bae4596b72ac14f5739f7e25231db823b75c1c2eadc9ecd494890164b79c8edb410471b3cae2a439ad192cc74b27ee7547b6089b2c3f8d66b8ab6a", "cardholder_name": "JOAO DA SILVA", "security_code": "123", "brand": "Visa", "expiration_month": "12", "expiration_year": "20" } } ] }' /v1/payments/combined/confirm: post: summary: Late Confirmation of Combined Payment description: When the payments that make up the combined payment transaction are made with option delayed = true, late confirmation, it must be later confirmed, this endpoint is responsible for this confirmation. **It is mandatory to send the same number of payments sent in the authorization request tags: - Payment Combined consumes: - application/json produces: - application/json parameters: - in: header name: Content-type required: true type: string enum: - application/json; charset=utf-8 default: application/json; charset=utf-8 description: | Content Type application/json. - in: header name: Authorization required: true type: string description: | Authorization: Bearer *AuthString*
Where *AuthString* é token of access obtained from the authentication endpoint. - in: header required: false description: identification code of the e-commerce. type: string name: seller_id format: uuidv4 minLength: 36 maxLength: 36 - in: body required: true name: body description: Request containing the data for a payment confirmation Combined. schema: $ref: '#/definitions/combined_confirm' responses: '200': description: Combined payment confirmed successfully. schema: $ref: '#/definitions/combined_confirm_response' '400': description: Invalid Request. schema: $ref: '#/definitions/error' '401': description: Invalid Authetication. schema: $ref: '#/definitions/error' '402': description: Request is valid but one or more payment(s) is denied. It might be denied for various reasons/business rules. schema: $ref: '#/definitions/error' '404': description: Not found. schema: $ref: '#/definitions/error' '500': description: Internal server error or service. schema: $ref: '#/definitions/error' '504': description: Timeout. schema: $ref: '#/definitions/error' x-code-samples: - lang: cURL source: | curl -X POST \ https://api-homologacao.getnet.com.br/v1/payments/combined/confirm \ -H 'content-type: application/json' \ -H 'authorization: Bearer 72402c54-6bd3-4895-a6b4-adfded0c11dc' \ -d '{ "payments": [ { "payment_tag": "pay-1", "payment_id": "06f256c8-1bbf-42bf-93b4-ce2041bfb87e" } ] }' /v1/payments/combined/cancel: post: summary: Cancel Combined Payment (only for credit transactions) description: Cancel a combined payment transaction. **Sending is mandatory of the same number of payments sent in the request for authorization/confirmation** * Reverses transactions confirmed on the same day (D0). * Undo authorized transactions within 7 days. tags: - Payment Combined consumes: - application/json produces: - application/json parameters: - in: header name: Content-type required: true type: string enum: - application/json; charset=utf-8 default: application/json; charset=utf-8 description: | Content Type application/json. - in: header name: Authorization required: true type: string description: | Authorization: Bearer *AuthString*
Where *AuthString* it's token of access obtained at the authentication endpoint. - in: header required: false description: Identification code do e-commerce. type: string name: seller_id format: uuidv4 minLength: 36 maxLength: 36 - in: body required: true name: body description: Request containing the data for a payment cancellation Combined. schema: $ref: '#/definitions/combined_cancel' responses: '200': description: Combined payment successfully canceled. schema: $ref: '#/definitions/combined_cancel_response' '400': description: Invalid Request. schema: $ref: '#/definitions/error' '401': description: Invalid Authentication. schema: $ref: '#/definitions/error' '402': description: Request is valid but cancellation denied. can be denied by various reasons / business rules. schema: $ref: '#/definitions/error' '404': description: Not found. schema: $ref: '#/definitions/error' '500': description: Internal server error or service. schema: $ref: '#/definitions/error' '504': description: Timeout. schema: $ref: '#/definitions/error' x-code-samples: - lang: cURL source: | curl -X POST \ https://api-homologacao.getnet.com.br/v1/payments/combined/cancel \ -H 'content-type: application/json' \ -H 'authorization: Bearer 72402c54-6bd3-4895-a6b4-adfded0c11dc' \ -d '{ "payments": [ { "payment_tag": "pay-1", "payment_id": "06f256c8-1bbf-42bf-93b4-ce2041bfb87e" } ] }' /v1/payments/combined/cancel/request: post: summary: Request a cancellation for combined payment (only for card transactions) description: Requests the cancellation of a combined, confirmed, made payment for more than 1 day (D+n). tags: - Payment Combined consumes: - application/json produces: - application/json parameters: - in: header description: Content type application/json. enum: - application/json; charset=utf-8 default: application/json; charset=utf-8 type: string name: Content-Type required: true - in: header description: | Authorization: Bearer *AuthString*
Onde *AuthString* it's token of access obtained from the authentication endpoint. type: string name: Authorization required: true - in: header required: false description: e-commerce identification code. type: string name: seller_id format: uuidv4 minLength: 36 maxLength: 36 - in: body required: true name: body description: Request containing the data for a cancellation request for agreed payment. schema: $ref: '#/definitions/combined_cancel_request' responses: '202': description: Cancellation request(s) accepted and in process schema: $ref: '#/definitions/combined_cancel_request_response' '207': description: |- Cancellation request returned multiple statuses for handling. **For returns with status *ERROR* ou *DENIED*** **Os *error_code* below are subject to retry.**:

PAYMENTS-021
PAYMENTS-031
PAYMENTS-064
PAYMENTS-500
GENERIC-504

*Nota*: you can also choose to perform a query by key *cancel_custom_key* to validate the transaction status. Endpoint */v1/payments/cancel/request?cancel_custom_key={cancel_custom_key}* **O *error_code* below indicates duplicate keys and means that the request has already been accepted**:

PAYMENTS-008

*Nota*: In this case, the return message *description_detail* informs the generated protocol. Ex: CUSTOMER KEY IS ALREADY IN USE. PROTOCOL:[20200806090931756]. ***error_code* different from those mentioned above must have their messages *decription_deteail* validated to identify the reason for denial of processing**. schema: $ref: '#/definitions/combined_cancel_request_response_207' '400': description: Invalid request. schema: $ref: '#/definitions/error' '401': description: Invalid authentication. schema: $ref: '#/definitions/error' '404': description: Not found. schema: $ref: '#/definitions/error' '500': description: Internal server error or service. schema: $ref: '#/definitions/error' '504': description: Timeout. schema: $ref: '#/definitions/error' x-code-samples: - lang: cURL source: | curl -X POST \ https://api-homologacao.getnet.com.br/v1/payments/combined/cancel \ -H 'content-type: application/json' \ -H 'authorization: Bearer 72402c54-6bd3-4895-a6b4-adfded0c11dc' \ -d '{ "payments": [ { "payment_tag": "pay-1", "payment_id": "06f256c8-1bbf-42bf-93b4-ce2041bfb87e" } ] }' /v1/marketplace/payments/combined/release: post: summary: Release payment to SubSeller for the products in the order description: Releases payment to SubSeller for the products in the order tags: - Payment Combined consumes: - application/json produces: - application/json parameters: - in: header name: Content-type required: true type: string enum: - application/json; charset=utf-8 default: application/json; charset=utf-8 description: | Content type application/json. - in: header name: Authorization required: true type: string description: | Authorization: Bearer *AuthString*
Onde *AuthString* it's token of access obtained from the authentication endpoint. - in: header required: false description: e-commerce identification code. type: string name: seller_id format: uuidv4 minLength: 36 maxLength: 36 - in: body name: combined_payment_release required: true description: Request containing payment release data to SubSeller referring to the products of the order. schema: $ref: '#/definitions/combined_payment_release' responses: '200': description: Release successful. schema: $ref: '#/definitions/combined_payment_release_response' '400': description: Invalid request. schema: $ref: '#/definitions/error' '401': description: Invalid authentication. schema: $ref: '#/definitions/error' '402': description: Request is valid but payment release was denied. He can be denied for various reasons/business rules. schema: $ref: '#/definitions/error' '404': description: Not found. schema: $ref: '#/definitions/error' '500': description: Internal server error or service. schema: $ref: '#/definitions/error' '504': description: Timeout. schema: $ref: '#/definitions/error' x-code-samples: - lang: cURL source: | curl -X POST \ https://api-homologacao.getnet.com.br/v1/marketplace/payments/combined/release \ -H 'authorization: Bearer 72402c54-6bd3-4895-a6b4-adfded0c11dc' \ -H 'content-type: application/json' \ -d '{ "release_payment_date": "2018-06-30T18:01:24Z", "subseller_id": "23", "payments": [{ "payment_id": "06f256c8-1bbf-42bf-93b4-ce2041bfb87e" }], "order_item_release": [{ "id": "X0001", "amount": 5101, "item_split_tag": "item_split_tag" }] }' patch: summary: Updates SubSeller payment release date for order products description: Updates SubSeller payment release date for order products tags: - Payment Combined consumes: - application/json produces: - application/json parameters: - in: header name: Content-type required: true type: string enum: - application/json; charset=utf-8 default: application/json; charset=utf-8 description: | Content type application/json. - in: header name: Authorization required: true type: string description: | Authorization: Bearer *AuthString*
Onde *AuthString* it's token of access obtained from the authentication endpoint. - in: header required: false description: e-commerce identification code. type: string name: seller_id format: uuidv4 minLength: 36 maxLength: 36 - in: body name: cobined_payment_release required: true description: Request containing payment release data to SubSeller referring to the products of the order. schema: $ref: '#/definitions/combined_payment_release_patch' responses: '200': description: Release successful. schema: $ref: '#/definitions/combined_payment_release_response' '400': description: Invalid request. schema: $ref: '#/definitions/error' '401': description: Invalid autentication. schema: $ref: '#/definitions/error' '402': description: Request is valid but payment release was denied. He can be denied for various reasons/business rules. schema: $ref: '#/definitions/error' '404': description: Not found. schema: $ref: '#/definitions/error' '500': description: Internal server error or service. schema: $ref: '#/definitions/error' '504': description: Timeout. schema: $ref: '#/definitions/error' x-code-samples: - lang: cURL source: | curl -X POST \ https://api-homologacao.getnet.com.br/v1/marketplace/payments/combined/release \ -H 'authorization: Bearer 72402c54-6bd3-4895-a6b4-adfded0c11dc' \ -H 'cache-control: no-cache' \ -H 'content-type: application/json' \ -d '{ "release_payment_date": "2018-06-30T18:01:24Z", "previous_release_payment_date": "2019-03-14T17:14:24Z", "subseller_id": "23", "payments": [{ "payment_id": "06f256c8-1bbf-42bf-93b4-ce2041bfb87e" }], "order_item_release": { "id": "X0001", "amount": 5101, "item_split_tag": "item_split_tag" } }' definitions: combined_payment_release: type: object required: - release_payment_date - subseller_id - order_items_release description: Conjunto de dados para liberação do pagamento ao vendedor (SubSeller) referente aos produtos do pedido. properties: release_payment_date: type: string description: Data de Liberação do Pagamento para o vendedor (SubSeller). example: '2017-04-19T16:30:30.00Z' format: YYYY-MM-DDTHH:MM:SSZ minLength: 24 maxLength: 24 subseller_id: type: string description: Identificador da loja no sistema. example: '10' payments: type: array items: $ref: '#/definitions/combined_release_payments' order_items_release: type: array description: Itens items: $ref: '#/definitions/combined_order_item_release' combined_order_item_release: type: object required: - id - amount description: Conjunto de dados contendo os itens do pedido. properties: id: description: Identificador do Item/Produto type: string example: X0001 amount: description: Valor do Item/Produto (em centavos) type: integer example: 10202 item_split_tag: description: Campo para indicar agrupamento de item splitado type: string example: item_split_tag combined_payment_release_response: type: object description: Resposta da liberação do pagamento ao vendedor (SubSeller) referente aos produtos do pedido. properties: success: type: boolean description: Indica se a transação foi executada com sucesso ou não. example: true combined_cancel_request: type: object description: Conjunto de dados para soliciatação de cancelamento de pagamento combinado. required: - payments properties: payments: type: array items: $ref: '#/definitions/combined_cancel_request_detail' marketplace_subseller_payments: type: array description: bloco informando quais produtos foram retirados do pedido, utilizar somente quando houver um cancelamento parcial do pedido, para cancelamentos totais não é necessário items: $ref: '#/definitions/marketplace_subseller_payments_combined' combined_cancel_request_detail: type: object description: Conjunto de dados para solicitação de cancelamento de pagamento combinado. required: - payment_id - cancel_amount properties: payment_id: type: string description: Código de identificação do pagamento da transação original. example: 06f256c8-1bbf-42bf-93b4-ce2041bfb87e minLength: 36 maxLength: 36 payment_type: type: string description: Tipo de pagamento example: CREDIT cancel_amount: description: Valor da solicitação de cancelamento. Pode ser igual ou menor ao valor da transação original. type: integer example: 10000 cancel_custom_key: description: Chave do cliente utilizada para identificar uma solicitação de cancelamento. (Chave deve ser única por transação). type: string example: 4ec33ee18f9e45bfb73c5c30667f9006 maxLength: 32 payment_tag: description: Tag para identificar partes de pagamento do item em mais de um cartão type: string example: pay-1 combined_cancel_request_response_207: type: object description: Conjunto de dados da resposta da solicitação de cancelamento para pagamento combinado. properties: seller_id: type: string description: Código de identificação do e-commerce. format: uuidv4 example: 6eb2412c-165a-41cd-b1d9-76c575d70a28 minLength: 36 maxLength: 36 combined_id: type: string description: Código de identificação do pagamento combinado. format: uuidv4 example: 693635a4-54b5-457b-9e07-e03579d189f1 minLength: 36 maxLength: 36 order_id: type: string description: Código de identificação da compra utilizado pelo e-commerce example: 6d2e4380-d8a3-4ccb-9138-c289182818a3 maxLength: 36 payments: type: array items: $ref: '#/definitions/combined_cancel_request_response_detail_207' combined_cancel_request_response_detail_207: type: object description: Conjunto de dados retornados em caso de sucesso ou insucesso de uma ou mais solicitação(ões) de cancelamento. properties: payment_tag: description: Tag para identificar partes de pagamento do item em mais de um cartão type: string example: pay-1 payment_id: type: string description: Código de identificação do pagamento da transação original. example: 06f256c8-1bbf-42bf-93b4-ce2041bfb87e minLength: 36 maxLength: 36 cancel_request_at: type: string description: Data da solicitação de cancelamento. **Retornado somente em caso de sucesso.** format: YYYY-MM-DDTHH:MM:SSZ example: '2019-08-24T16:30:30Z' cancel_request_id: description: Identificador do request de cancelamento. **Retornado somente em caso de sucesso.** type: string example: '20171117084237501' minLength: 18 maxLength: 18 cancel_custom_key: description: Chave do cliente utilizada para identificar uma solicitação de cancelamento. (Chave deve ser única por transação). Caso nenhuma chave seja informada o sistema irá gerar uma automaticamente. **Retornado somente em caso de sucesso.** type: string example: 4ec33ee18f9e45bfb73c5c30667f9006 maxLength: 32 status: description: Status da transação aceita ou negada. type: string enum: - ACCEPTED - DENIED - ERROR example: ACCEPTED message: description: Mensagem do erro. **Retornado somente em caso de falhas.** type: string example: '' name: description: Nome do modulo ou sistema em que o erro ocorreu. **Retornado somente em caso de falhas.** type: string example: '' error_code: description: Código do erro. **Retornado somente em caso de falhas.** type: string example: '' description: description: Descrição do erro. **Retornado somente em caso de falhas.** type: string example: '' description_detail: description: Descrição detalhada do erro. **Retornado somente em caso de falhas.** type: string example: '' combined_cancel_request_response: type: object description: Conjunto de dados da resposta da solicitação de cancelamento para pagamento combinado. properties: seller_id: type: string description: Código de identificação do e-commerce. format: uuidv4 example: 6eb2412c-165a-41cd-b1d9-76c575d70a28 minLength: 36 maxLength: 36 combined_id: type: string description: Código de identificação do pagamento combinado. format: uuidv4 example: 693635a4-54b5-457b-9e07-e03579d189f1 minLength: 36 maxLength: 36 status: type: string description: Status geral da solicitação de cancelamento do pagamento combinado. example: ACCEPTED enum: - ACCEPTED - DENIED - ERROR payments: type: array items: $ref: '#/definitions/combined_cancel_request_response_detail' combined_cancel_request_response_detail: type: object description: Conjunto de dados da solicitação de cancelamento. properties: payment_id: type: string description: Código de identificação do pagamento da transação original. example: 06f256c8-1bbf-42bf-93b4-ce2041bfb87e minLength: 36 maxLength: 36 payment_type: type: string description: Tipo de pagamento example: CREDIT cancel_request_at: type: string description: Data da solicitação de cancelamento. format: YYYY-MM-DDTHH:MM:SSZ example: '2019-08-24T16:30:30Z' cancel_request_id: description: Identificador do request de cancelamento. type: string example: '20171117084237501' minLength: 18 maxLength: 18 cancel_custom_key: description: Chave do cliente utilizada para identificar uma solicitação de cancelamento. (Chave deve ser única por transação). type: string example: 4ec33ee18f9e45bfb73c5c30667f9006 maxLength: 32 status: description: Status da transação aceita ou negada. type: string enum: - ACCEPTED - DENIED - ERROR example: ACCEPTED combined_release_payments: type: object description: Conjunto de dados referentes aos pagamentos a serem liberados - payment_id properties: payment_id: type: string description: Código de identificação do pagamento. format: uuidv4 example: 06f256c8-1bbf-42bf-93b4-ce2041bfb87e minLength: 36 maxLength: 36 combined_payment_release_patch: type: object required: - release_payment_date - subseller_id - order_items_release description: Conjunto de dados para liberação do pagamento ao vendedor (SubSeller) referente aos produtos do pedido. properties: release_payment_date: type: string description: Data de Liberação do Pagamento para o vendedor (SubSeller). example: '2017-04-19T16:30:30.00Z' format: YYYY-MM-DDTHH:MM:SSZ minLength: 24 maxLength: 24 previous_release_payment_date: type: string description: Data de liberação original do pagamento para o vendedor (Subseller). example: '2019-03-14T17:14:24Z' format: YYYY-MM-DDTHH:MM:SSZ subseller_id: type: string description: Identificador da loja no sistema. example: '10' payments: type: array items: $ref: '#/definitions/combined_release_payments' order_items_release: type: array description: Itens items: $ref: '#/definitions/combined_order_item_release' payment_credit: type: object description: Credit payment transaction dataset. required: - amount - credit - order - customer properties: seller_id: type: string description: E-commerce identification code. minLength: 36 maxLength: 36 format: uuidv4 example: 6eb2412c-165a-41cd-b1d9-76c575d70a28 amount: type: integer description: Value of the purchase in cents. example: 100 currency: type: string description: Currency identification (See code at "https://www.currency-iso.org/en/home/tables/table-a1.html"). example: BRL minLength: 3 maxLength: 3 order: $ref: '#/definitions/order' customer: $ref: '#/definitions/customer_credit' device: $ref: '#/definitions/device_credit' shippings: type: array items: $ref: '#/definitions/shipping_credit' marketplace_subseller_payments: type: array items: $ref: '#/definitions/marketplace_subseller_payments' credit: $ref: '#/definitions/credit' payment_boleto: type: object description: Bank payment slip transaction dataset. required: - seller_id - amount - order - boleto - customer - marketplace_subseller_payments properties: seller_id: type: string description: E-commerce identification code. minLength: 36 maxLength: 36 format: uuidv4 example: 6eb2412c-165a-41cd-b1d9-76c575d70a28 amount: type: integer description: Value of the purchase in cents. example: 100 currency: type: string description: Currency identification (See code at "https://www.currency-iso.org/en/home/tables/table-a1.html"). minLength: 3 maxLength: 3 example: BRL order: $ref: '#/definitions/order' boleto: $ref: '#/definitions/boleto' customer: $ref: '#/definitions/customer_boleto' marketplace_subseller_payments: type: array items: $ref: '#/definitions/marketplace_subseller_payments' order: type: object description: Set of data for purchase identification required: - order_id properties: order_id: type: string description: Order identification code used by the e-commerce. Must be unique per transaction. maxLength: 36 example: 6d2e4380-d8a3-4ccb-9138-c289182818a3 sales_tax: type: number description: Tax amount example: 0 product_type: type: string description: Identifies the type of product sold among the options enum: - cash_carry - digital_content - digital_goods - digital_physical - gift_card - physical_goods - renew_subs - shareware - service example: service address_credit: type: object description: Set of data relating to the buyer's address properties: street: type: string description: Street.
Required for the Anti-fraud field maxLength: 60 example: Av. Brasil number: type: string description: Street number.
Required for the Anti-fraud field maxLength: 10 example: '1000' complement: type: string description: Street complement.
Required for the Anti-fraud field maxLength: 60 example: Sala 1 district: type: string description: District. maxLength: 40 example: São Geraldo city: type: string description: City.
Required for the Anti-fraud field maxLength: 40 example: Porto Alegre state: type: string description: State.
Required for the Anti-fraud field maxLength: 20 example: RS country: type: string description: Country.
Required for the Anti-fraud field maxLength: 20 example: Brasil postal_code: type: string description: Postal Code, CEP in Brazil or ZIP in the United States - (without mask)
Required for the Anti-fraud field maxLength: 8 example: '90230060' address_boleto: type: object description: Dataset referring to the buyer’s address properties: street: type: string description: Address. maxLength: 20 example: Av. Brasil number: type: string description: Address number. maxLength: 6 example: '1000' complement: type: string description: Additional address information. maxLength: 12 example: Sala 1 district: type: string description: Neighborhood. maxLength: 30 example: São Geraldo city: type: string description: City. maxLength: 20 example: Porto Alegre state: type: string description: State. maxLength: 2 example: RS postal_code: type: string description: Postal Code, CEP in Brazil, ZIP in the United States. (no mask) minLength: 8 maxLength: 8 example: '90230060' customer_credit: type: object description: Set of data relating to the buyer. required: - customer_id - billing_address properties: customer_id: type: string description: Customer identification. example: customer_21081826 maxLength: 100 first_name: type: string description: Customer first name.
Required for the Anti-fraud field maxLength: 40 example: João last_name: type: string description: Customer last name.
Required for the Anti-fraud field maxLength: 80 example: da Silva name: type: string description: Customer full name. Mandatory for bank slip. maxLength: 100 example: João da Silva email: type: string description: Customer e-mail address.
Required for the Anti-fraud field format: email example: customer@email.com.br document_type: type: string description: Type of customer identification document. Mandatory for bank slip.
Required for the Anti-fraud field maxLength: 26 example: CPF document_number: type: string description: Customer document number with no special characters. (without mask)
Required for the Anti-fraud field minLength: 11 maxLength: 15 example: '12345678912' phone_number: type: string description: Customer phone number. (without mask)
Required for the Anti-fraud field maxLength: 15 example: '5551999887766' billing_address: $ref: '#/definitions/address_credit' customer_boleto: type: object description: Set of data relating to the buyer. required: - name - document_type - document_number - billing_address properties: first_name: type: string description: Buyer's first name. maxLength: 40 example: João name: type: string description: Buyer’s full name. Mandatory for the bill. maxLength: 40 example: João da Silva document_type: type: string description: Type of identification document of the buyer. Mandatory for the bill. enum: - CPF - CNPJ example: CPF document_number: type: string description: Buyer's document number without punctuation. (no mask) minLength: 11 maxLength: 15 example: '12345678912' billing_address: $ref: '#/definitions/address_boleto' device_credit: type: object description: Set of data relating to the device used by the buyer. properties: ip_address: type: string description: IP address (IPv4) of the buyer's device. This attribute must be captured by your application from the buyer's device (mobile; browser; etc.) and sent in the payload in order to enrich our preventive analysis.
Required for the Anti-fraud field format: IPv4 example: 127.0.0.1 device_id: type: string description: Identification Hash (Device Fingerprint) of the device. More information on Anti-Fraud.
Required for the Anti-fraud field example: hash-device-id shipping_credit: type: object description: Set of data relating to the delivery address. properties: first_name: type: string description: Customer first name. maxLength: 40 example: João name: type: string description: Customer full name. maxLength: 100 example: João da Silva email: type: string description: Customer e-mail address. format: email example: customer@email.com.br phone_number: type: string description: Customer phone number. (without mask)
Required for the Anti-fraud field maxLength: 15 example: '5551999887766' shipping_amount: type: number description: Shipping amount in cents. example: 3000 address: $ref: '#/definitions/address_credit' credit: type: object description: Set of data relating to the credit transaction. required: - delayed - save_card_data - transaction_type - number_installments - card properties: delayed: type: boolean description: Indicates if credit payment will be done with delayed confirmation. example: false pre_authorization: type: boolean description: Indicativo se a transação é uma pré autorização de crédito. example: false save_card_data: type: boolean description: Indicates if the card must be saved for use in future orders. example: false transaction_type: type: string description: | Type of transaction. Full payment in one installment, payment in installments with no interest, payment in installments with interest. enum: - FULL - INSTALL_NO_INTEREST - INSTALL_WITH_INTEREST example: FULL number_installments: type: number description: Number of installments for one credit transaction installment. example: 1 soft_descriptor: $ref: '#/definitions/soft_descriptor_global' dynamic_mcc: $ref: '#/definitions/dynamic_mcc' card: $ref: '#/definitions/card_credit' vault_card: type: object description: Card dataset. required: - number_token - expiration_month - expiration_year - customer_id properties: number_token: type: string description: Tokenized card number. Generated through endpoint/v1/tokens/card. example: dfe05208b105578c070f806c80abd3af09e246827d29b866cf4ce16c205849977c9496cbf0d0234f42339937f327747075f68763537b90b31389e01231d4d13c minLength: 128 maxLength: 128 brand: type: string description: Card Brand. Automatically populated by API if not informed. maxLength: 50 enum: - Mastercard - Visa - Amex - Elo - Hipercard example: Mastercard cardholder_name: type: string description: Name of the buyer printed on the card. maxLength: 26 example: JOAO DA SILVA expiration_month: type: string description: Card expiration month with two digits. minLength: 2 maxLength: 2 example: '12' expiration_year: type: string description: Card expiration year with two digits. minLength: 2 maxLength: 2 example: '20' customer_id: type: string description: | Buyer's Identifier: Information defined by the application that consumes the Digital Platform API. In this field, it is only allowed alphanumeric data. The following special characters must never be used: % $ , . / & ( ) + = < > - * example: customer_21081826 maxLength: 100 cardholder_identification: type: string description: Identification of the cardholder, such as CPF or RG. (without mask) example: '12345678912' verify_card: type: boolean description: Performs a transaction that checks if the card entered is not canceled, blocked or restricted. default: false example: false security_code: type: string description: Security code. CVV or CVC. minLength: 3 maxLength: 4 example: '123' vault_card_response: type: object description: Saved card data set. properties: card_id: type: string description: Card identifier saved in the vault. format: uuidv4 example: e8ad2ae4-9e3e-4532-998f-1a5a11e56e58 minLength: 36 maxLength: 36 last_four_digits: type: string description: Last four digits of the card. example: '1212' minLength: 4 maxLength: 4 expiration_month: type: string description: Two-digit card expiration month. example: '12' minLength: 2 maxLength: 2 expiration_year: type: string description: Two-digit card expiration year. example: '20' minLength: 2 maxLength: 2 brand: type: string description: Brand. (Also used in anti-fraud). example: Mastercard enum: - Mastercard - Visa - Amex - Elo - Hipercard maxLength: 50 cardholder_name: type: string description: Name of the Buyer print in the Card. example: JOAO DA SILVA maxLength: 26 customer_id: type: string description: Buyer's Identifier. It can be any information that identifies your consumer, such as identification, email or even an internal id of your system. example: customer_21081826 maxLength: 100 number_token: type: string description: Tokenized card number. Generated via endpoint /v1/tokens/card. example: dfe05208b105578c070f806c80abd3af09e246827d29b866cf4ce16c205849977c9496cbf0d0234f42339937f327747075f68763537b90b31389e01231d4d13c minLength: 128 maxLength: 128 used_at: type: string description: Date of last use. example: '2017-04-19T16:30:30Z' format: YYYY-MM-DDTHH:MM:SSZ minLength: 24 maxLength: 24 created_at: type: string description: Date of creation. example: '2017-04-19T16:30:30Z' format: YYYY-MM-DDTHH:MM:SSZ minLength: 24 maxLength: 24 updated_at: type: string description: Date of update. example: '2017-04-19T16:30:30Z' format: YYYY-MM-DDTHH:MM:SSZ minLength: 24 maxLength: 24 status: type: string description: Card status in the vault. enum: - active - blocked - canceled - renewed example: active maxLength: 20 verification_card_body: type: object description: Card to be checked dataset. required: - number_token - expiration_month - expiration_year properties: number_token: type: string description: Tokenized card number. Generated through endpoint/v1/tokens/card. example: dfe05208b105578c070f806c80abd3af09e246827d29b866cf4ce16c205849977c9496cbf0d0234f42339937f327747075f68763537b90b31389e01231d4d13c minLength: 128 maxLength: 128 brand: type: string description: Card Brand. Automatically populated by API if not informed. maxLength: 50 example: Mastercard enum: - Mastercard - Visa - Hipercard cardholder_name: type: string description: Name of the buyer printed on the card. maxLength: 26 example: JOAO DA SILVA expiration_month: type: string description: Card expiration month with two digits. minLength: 2 maxLength: 2 example: '12' expiration_year: type: string description: Card expiration year with two digits. minLength: 2 maxLength: 2 example: '20' security_code: type: string description: Security code. CVV or CVC. minLength: 3 maxLength: 4 example: '123' card_credit: type: object description: Dataset for the card. required: - number_token - expiration_month - expiration_year properties: number_token: type: string description: Tokenized card number. example: dfe05208b105578c070f806c80abd3af09e246827d29b866cf4ce16c205849977c9496cbf0d0234f42339937f327747075f68763537b90b31389e01231d4d13c minLength: 128 maxLength: 128 cardholder_name: type: string description: Cardholder name as it appears on the card.
Required for the Anti-fraud field maxLength: 26 example: JOAO DA SILVA security_code: type: string description: Security Code. CVV or CVC.
Required for the Anti-fraud field minLength: 3 maxLength: 4 example: '123' brand: type: string description: Card brand. Automatically populated by the API if not entered.
Required for the Anti-fraud field maxLength: 50 example: Mastercard enum: - Mastercard - Visa - Amex - Elo - Hipercard expiration_month: type: string description: Card expiration month with two digits. minLength: 2 maxLength: 2 example: '12' expiration_year: type: string description: Card expiration year with two digits. minLength: 2 maxLength: 2 example: '20' payment_credit_response: type: object description: Credit payment response dataset. properties: payment_id: type: string description: Payment identification code. format: uuidv4 example: 06f256c8-1bbf-42bf-93b4-ce2041bfb87e minLength: 36 maxLength: 36 seller_id: type: string description: E-commerce identification code. format: uuidv4 example: 6eb2412c-165a-41cd-b1d9-76c575d70a28 minLength: 36 maxLength: 36 amount: type: integer description: Order amount in cents. example: 100 currency: type: string description: Currency identification (Check code at "https://www.currency-iso.org/en/home/tables/table-a1.html"). example: BRL minLength: 3 maxLength: 3 order_id: type: string description: Order identification code used by the e-commerce. Must be unique per transaction. example: 6d2e4380-d8a3-4ccb-9138-c289182818a3 maxLength: 36 status: type: string description: Transaction status. For more information on the response status, see Notifications-1.0 example: APPROVED enum: - CANCELED - APPROVED - DENIED - AUTHORIZED - CONFIRMED maxLength: 20 received_at: type: string description: Date and time the order was received. format: YYYY-MM-DDTHH:mm:ss.SSSZ example: '2017-03-19T16:30:30.764Z' maxLength: 24 credit: $ref: '#/definitions/payment_credit_detail' payment_credit_pre_response: type: object description: Credit payment response dataset. properties: payment_id: type: string description: Payment identification code. format: uuidv4 example: 06f256c8-1bbf-42bf-93b4-ce2041bfb87e minLength: 36 maxLength: 36 seller_id: type: string description: E-commerce identification code. format: uuidv4 example: 6eb2412c-165a-41cd-b1d9-76c575d70a28 minLength: 36 maxLength: 36 amount: type: integer description: Amount of the purchase in cents. example: 100 currency: type: string description: Currency identification (See code at "https://www.currency-iso.org/en/home/tables/table-a1.html"). example: BRL minLength: 3 maxLength: 3 order_id: type: string description: Order identification code used by the e-commerce. Must be unique per transaction. example: 6d2e4380-d8a3-4ccb-9138-c289182818a3 maxLength: 36 status: type: string description: Transaction status. For more information on the response status, see Notifications-1.0 example: AUTHORIZED enum: - PENDING - CANCELED - APPROVED - DENIED - AUTHORIZED - CONFIRMED - EXPIRED - UNPROCESSED maxLength: 20 received_at: type: string description: Payment registration date and time. format: YYYY-MM-DDTHH:mm:ss.SSSZ example: '2017-03-19T16:30:30.764Z' maxLength: 24 credit: $ref: '#/definitions/payment_credit_detail' payment_credit_detail: type: object description: Dataset referring to the transaction. properties: delayed: type: boolean description: Indicates if the credit payment will be done with delayed confirmation. example: false authorization_code: type: string description: Credit authorization code. example: 99999 maxLength: 20 authorized_at: type: number description: Date/time of the credit authorization. format: YYYY-MM-DDTHH:MM:SSZ example: '2017-03-19T16:30:30Z' maxLength: 24 reason_code: type: string description: Return code. example: 0 minLength: 1 maxLength: 5 reason_message: type: string description: Return message. example: transaction approved maxLength: 250 acquirer: type: string description: Name of the acquirer. example: GETNET maxLength: 30 soft_descriptor: type: string description: Description for the card statement. example: Descrição para fatura maxLength: 22 brand: type: string description: Card network responsible for processing the transaction. example: Mastercard maxLength: 50 enum: - Mastercard - Visa - Amex - Elo - Hipercard terminal_nsu: type: string description: Authorization Code generated by the Issuer when the transaction is successfully executed. example: 99999 acquirer_transaction_id: type: string description: Acquirer transaction code. example: '10000024' maxLength: 20 transaction_id: type: string description: Transaction code. example: '1002217281190421' credit_delayed_confirm: type: object description: Dataset for the confirmation response of credit payments with delayed confirmation. properties: payment_id: type: string description: Payment identification code. minLength: 36 maxLength: 36 format: uuidv4 example: 331b0b07-6e37-4bd9-a37b-99156cb34104 seller_id: type: string description: E-commerce identification code. minLength: 36 maxLength: 36 format: uuidv4 example: 8f840ea0-b7d1-42f5-ad78-5a5521e3125f amount: type: integer description: Order amount in cents. example: 200000 currency: type: string description: Currency identification(Check code at "https://www.currency-iso.org/en/home/tables/table-a1.html"). minLength: 3 maxLength: 3 example: BRL order_id: type: string description: Order identification code used by the e-commerce. Must be unique per transaction. example: order-3 maxLength: 36 status: type: string description: Transaction status. For more information on the response status, see Notifications-1.0 example: CONFIRMED enum: - CONFIRMED - ERROR - DENIED maxLength: 20 credit_confirm: $ref: '#/definitions/payment_credit_confirm_details' payment_credit_confirm_details: type: object description: Additional dataset for confirmation services. properties: confirm_date: type: string description: Date/time the transaction was received. format: YYYY-MM-DDTHH:mm:ss.SSSZ example: '2018-07-18T20:00:53.764Z' maxLength: 24 message: type: string description: Receipt notice and finalization pending confirmation. maxLength: 250 example: Postponed 331b0b07-6e37-4bd9-a37b-99156cb34104 confirmed payment_combined: type: object description: Dataset refers to a payment transaction required: - amount - payments - order - customer - marketplace_subseller_payments properties: amount: type: integer description: Total purchase amount in cents. example: 10000 dynamic_mcc: $ref: '#/definitions/dynamic_mcc' order: $ref: '#/definitions/order' customer: $ref: '#/definitions/customer_credit' device: $ref: '#/definitions/device_credit' shippings: type: array items: $ref: '#/definitions/shipping_credit' marketplace_subseller_payments: type: array items: $ref: '#/definitions/marketplace_subseller_payments_combined' payments: type: array items: $ref: '#/definitions/combined' combined: type: object description: Combined payment dataset required: - payment_type - amount - delayed - save_card_data - transaction_type - number_installments - card properties: payment_type: type: string description: Type of payment enum: - CREDIT example: CREDIT amount: type: integer description: Type of payment example: 10000 currency: type: string description: Identificação da moeda (Consultar código em "https://www.currency-iso.org/en/home/tables/table-a1.html"). example: BRL minLength: 3 maxLength: 3 delayed: type: boolean description: Identifies if the credit will be made with late confirmation. example: true save_card_data: type: boolean description: Identifies whether the card should be saved for future purchases. example: false transaction_type: type: string description: | Transaction type. Cash payment, interest-free installments, installments with interest. enum: - FULL - INSTALL_NO_INTEREST - INSTALL_WITH_INTEREST example: FULL number_installments: type: number description: Number of installments for an installment credit transaction. example: 1 payment_tag: description: Tag to identify payment parts of the item on more than one card type: string example: pay-1 soft_descriptor: $ref: '#/definitions/soft_descriptor_global' card: $ref: '#/definitions/card_credit' payment_combined_response: type: object description: Combined Payment Response Dataset. properties: seller_id: type: string description: e-commerce identification code. format: uuidv4 example: 6eb2412c-165a-41cd-b1d9-76c575d70a28 minLength: 36 maxLength: 36 combined_id: type: string description: Combined payment identification code. format: uuidv4 example: 693635a4-54b5-457b-9e07-e03579d189f1 minLength: 36 maxLength: 36 order_id: type: string description: Código de identificação da compra utilizado pelo e-commerce. Deve ser único por transação. example: 6d2e4380-d8a3-4ccb-9138-c289182818a3 maxLength: 36 amount: type: integer description: Total purchase amount in cents example: 10000 status: type: string description: Status general of the agreed payment. example: AUTHORIZED enum: - AUTHORIZED - DENIED - ERROR payments: type: array items: $ref: '#/definitions/combined_response' combined_response: type: object description: Payment response dataset properties: payment_id: type: string description: payment identification code. format: uuidv4 example: 06f256c8-1bbf-42bf-93b4-ce2041bfb87e minLength: 36 maxLength: 36 payment_type: type: string description: Payment type example: CREDIT amount: type: integer description: Purchase amount in cents. example: 10000 currency: type: string description: Currency identification (See code in "https://www.currency-iso.org/en/home/tables/table-a1.html"). example: BRL minLength: 3 maxLength: 3 status: type: string description: Payment Transaction Status. example: AUTHORIZED maxLength: 20 received_at: type: string description: Payment record date and time. format: YYYY-MM-DDTHH:mm:ss.SSSZ example: '2019-08-23T16:30:30.764Z' maxLength: 24 credit: $ref: '#/definitions/payment_combined_detail' payment_combined_detail: type: object description: Transaction dataset. properties: delayed: type: boolean description: Identifies if the credit will be made with late confirmation. example: true authorization_code: type: string description: credit authorization code example: 99999 maxLength: 20 authorized_at: type: number description: Credit authorization date/time. format: YYYY-MM-DDTHH:MM:SSZ example: '2019-08-23T16:30:30.764Z' maxLength: 24 reason_code: type: string description: return code. example: 0 minLength: 1 maxLength: 5 reason_message: type: string description: return message. example: transaction approved maxLength: 250 acquirer: type: string description: acquirer's name. example: GETNET maxLength: 30 soft_descriptor: type: string description: Description for the card invoice. example: LOJA*TESTE*COMPRA-123 maxLength: 22 brand: type: string description: Flag responsible for transaction processing. example: Mastercard maxLength: 50 enum: - Mastercard - Visa - Amex - Elo - Hipercard terminal_nsu: type: string description: Authorization Code generated by the Issuer when the transaction is successfully performed. example: 99999 acquirer_transaction_id: type: string description: acquirer transaction code. example: '10000024' maxLength: 20 transaction_id: type: string description: transaction code. example: '1002217281190421' combined_confirm: type: object description: Dataset for confirmation of combined payment. required: - payments properties: payments: type: array items: $ref: '#/definitions/combined_confirm_detail' combined_confirm_detail: type: object description: Dataset regarding payments to be confirmed required: - payment_id properties: payment_id: type: string description: payment identification code. format: uuidv4 example: 06f256c8-1bbf-42bf-93b4-ce2041bfb87e minLength: 36 maxLength: 36 combined_confirm_response: type: object description: Combined Payment Confirmation Response Dataset. properties: seller_id: type: string description: E-commerce identification code. format: uuidv4 example: 6eb2412c-165a-41cd-b1d9-76c575d70a28 minLength: 36 maxLength: 36 combined_id: type: string description: Combined payment identification code. format: uuidv4 example: 693635a4-54b5-457b-9e07-e03579d189f1 minLength: 36 maxLength: 36 order_id: type: string description: Purchase identification code used by e-commerce. Must be single per transaction. example: 6d2e4380-d8a3-4ccb-9138-c289182818a3 maxLength: 36 amount: type: integer description: Total purchase amount in cents. example: 10000 status: type: string description: Overall status of agreed payment confirmation. example: CONFIRMED enum: - CONFIRMED - ERROR payments: type: array items: $ref: '#/definitions/combined_confirm_response_detail' combined_confirm_response_detail: type: object description: Payment confirmation response dataset properties: payment_id: type: string description: payment identification code. minLength: 36 maxLength: 36 format: uuidv4 example: 331b0b07-6e37-4bd9-a37b-99156cb34104 payment_type: type: string description: Type of payment example: CREDIT amount: type: integer description: Purchase amount in cents. example: 10000 currency: type: string description: Currency identification (See code in "https://www.currency-iso.org/en/home/tables/table-a1.html"). minLength: 3 maxLength: 3 example: BRL status: type: string description: Status do payment example: CONFIRMED enum: - CONFIRMED - ERROR maxLength: 20 credit_confirm: $ref: '#/definitions/payment_credit_confirm_details' combined_cancel: type: object description: Dataset for combined payment cancellation. required: - payments properties: payments: type: array items: $ref: '#/definitions/combined_cancel_detail' combined_cancel_detail: type: object description: Set of data regarding payments to be canceled required: - payment_id properties: payment_id: type: string description: payment identification code. format: uuidv4 example: 06f256c8-1bbf-42bf-93b4-ce2041bfb87e minLength: 36 maxLength: 36 combined_cancel_response: type: object description: Combined payment cancellation response dataset. properties: seller_id: type: string description: e-commerce identification code. format: uuidv4 example: 6eb2412c-165a-41cd-b1d9-76c575d70a28 minLength: 36 maxLength: 36 combined_id: type: string description: Combined payment identification code. format: uuidv4 example: 693635a4-54b5-457b-9e07-e03579d189f1 minLength: 36 maxLength: 36 order_id: type: string description: Purchase identification code used by e-commerce. Must be single per transaction. example: 6d2e4380-d8a3-4ccb-9138-c289182818a3 maxLength: 36 amount: type: integer description: Total purchase amount in cents. example: 10000 status: type: string description: Status general of the cancellation of the agreed payment. example: CANCELED enum: - CANCELED - ERROR payments: type: array items: $ref: '#/definitions/combined_cancel_response_detail' combined_cancel_response_detail: type: object description: Payment Cancel Response Dataset properties: payment_id: type: string description: payment identification code. minLength: 36 maxLength: 36 format: uuidv4 example: 331b0b07-6e37-4bd9-a37b-99156cb34104 payment_type: type: string description: Type of payment example: CREDIT amount: type: integer description: Purchase amount in cents. example: 10000 currency: type: string description: Currency identification (See code in "https://www.currency-iso.org/en/home/tables/table-a1.html"). minLength: 3 maxLength: 3 example: BRL status: type: string description: Status do payment example: CANCELED enum: - CANCELED - ERROR maxLength: 20 credit_confirm: $ref: '#/definitions/payment_credit_cancel_details' credit_delayed_cancel: type: object description: Dataset for the cancellation response of credit payment or credit payment with delayed confirmation transactions. properties: payment_id: type: string description: Payment identification code. minLength: 36 maxLength: 36 format: uuidv4 example: f3b54da1-0753-4dcf-ac92-48721d2ff553 seller_id: type: string description: E-commerce identification code. minLength: 36 maxLength: 36 format: uuidv4 example: 8f840ea0-b7d1-42f5-ad78-5a5521e3125f amount: type: integer description: Order amount in cents. example: 500000 currency: type: string description: Currency identification (Check code at "https://www.currency-iso.org/en/home/tables/table-a1.html"). minLength: 3 maxLength: 3 example: BRL order_id: type: string description: Order identification code used by the e-commerce. Must be unique per transaction. example: pre-auth-order-204 maxLength: 36 status: type: string description: Transaction status. For more information on the response status, see Notifications-1.0 example: CANCELED enum: - CANCELED - ERROR - DENIED maxLength: 20 credit_cancel: $ref: '#/definitions/payment_credit_cancel_details' payment_credit_cancel_details: type: object description: Additional set of cancellation service information. properties: canceled_at: type: string description: Date/time the transaction was received. format: YYYY-MM-DDTHH:mm:ss.SSSZ example: '2018-07-22T18:47:32.270Z' maxLength: 24 message: type: string description: Receipt notice and finalization pending confirmation. example: Credit transaction cancelled successfully maxLength: 250 boleto: type: object properties: our_number: type: string description: Named “our number” by banks. It is the bank slip’s unique identification for the collection system. Its rules vary according to the bank and the collection service. For example, for Santander there are two ways for numbering it. 1) If the client is the one who numbers, they should inform the CD (Check Digit); 2) If the number is left blank, the Bank is responsible for generating a sequential number, without a CD. minLength: 12 maxLength: 12 example: 1946598 document_number: type: string description: Your Number. Number controlled by the client, usually managed by the system generating the bank slip. minLength: 15 maxLength: 15 example: '170500000019763' expiration_date: type: string description: Bank slip due date. If not informed, the default number of days pre-registered for the due date will be considered. format: dd/mm/yyyy example: 16/11/2017 instructions: type: string description: Instructions to be printed on the bank payment slip (add line breaks ever 100 characters, maximum 10 lines). example: Não receber após o vencimento provider: type: string description: Provider bank. enum: - santander maxLength: 40 default: santander example: santander guarantor_document_type: type: string description: Guarantor document type. example: CPF guarantor_document_number: type: string description: Guarantor document number. example: '78009200021' guarantor_name: type: string description: Guarantor’s name example: Nome do Avalista payment_boleto_response: type: object description: Data set for the issuing response for a bank slip. properties: payment_id: type: string description: Payment identification code. example: 599ca35059028b001023b323 minLength: 24 maxLength: 24 seller_id: type: string description: E-commerce identification code. format: uuidv4 example: 6eb2412c-165a-41cd-b1d9-76c575d70a28 minLength: 36 maxLength: 36 amount: type: string description: Order amount in cents. example: '100' currency: type: string description: Currency identification (Check code at "https://www.currency-iso.org/en/home/tables/table-a1.html"). minLength: 3 maxLength: 3 example: BRL order_id: type: string description: Order identification code used by the e-commerce. Must be unique per transaction. example: 6d2e4380-d8a3-4ccb-9138-c289182818a3 maxLength: 36 status: type: string description: Transaction status. For more information on the response status, see Notifications-1.0 example: PENDING enum: - PENDING maxLength: 20 boleto: $ref: '#/definitions/payment_boleto_detail' payment_boleto_detail: type: object description: Body with bill data. properties: boleto_id: type: string description: Bank slip identification. format: uuidv4 example: e587cefe-8832-4fc0-acff-acc83dd66e9e minLength: 36 maxLength: 36 bank: type: string description: EC bank number. example: '0033' minLength: 3 maxLength: 4 status_code: type: string description: Payment status code. example: '1' minLength: 1 maxLength: 1 status_label: type: string description: Payment status in text form. example: EM ABERTO maxLength: 20 typeful_line: type: string description: Bank slip line to be typed. example: '03399.58910 93000.000013 94659.801016 8 71670000030015' minLength: 54 maxLength: 54 bar_code: type: string description: Bank slip barcode. example: '03397999200000002309235515900000026629840101' minLength: 44 maxLength: 44 issue_date: type: string description: Date the bank slip was generated. example: '17/05/2017' minLength: 10 maxLength: 10 expiration_date: type: string description: Bank slip due date. example: '22/05/2017' minLength: 10 maxLength: 10 our_number: type: string description: EC’s “Our Number”. example: '0000001946598' minLength: 12 maxLength: 13 document_number: type: string description: Customer controlled document number. (no mask) example: '170500000019763' minLength: 15 maxLength: 15 _links: type: array items: $ref: '#/definitions/boleto_links' boleto_links: type: object properties: href: type: string description: Bank payment slip link (html/pdf). example: /payments/boleto/593948e8589f66000ed575e0/pdf?ack=eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiI2N2UxZWJhNWE0YmFlNmE1MDExZmMzMGIiLCJpYXQiOjE3NDI4NTkxNzMsImF1ZGllbmNlIjoiWW05c1pYUnZMV1J2ZDI1c2IyRmtMWE5sY25acFkyVT0iLCJleHAiOjE3NDg3MzYwMDB9.HXX3kOf95MiXUG9fJUE4d8QsDlr3acTGsCpfvd2RFX6HYPHiywnlFq-mXCKCYPkdY3mUJVwW7ct7WXStKkDZG2ZqfC7d9CnMQs5b5Tjw4sg2vbeZrMkbd69ih6pt6f0hpmecPA_Jbonl995suzW67zQNy-oJ-4ULDlNLuu4FdmRRX31uLho3Gtu3PoQhC3p876m5oFJ1MTxdZwcIqiGQIXWv96elhx-LpIfT4yzisSkZGgRe-EVdh-q31hRrAH3HqsS6_BdXX0XSoFBhEbCtkjOlST0Rknm_kMyk1QCvrh5vCh9EAJQ5DTeglcyE8NgDG5CLzRcJcM6B1KpKOH0oHw rel: type: string description: bank payment slip link description. example: boleto_pdf enum: - boleto_pdf - boleto_html type: type: string description: type of requisition. example: GET cancel_request: type: object description: Dataset to request cancellation. required: - payment_id - cancel_amount - marketplace_subseller_payments properties: payment_id: type: string description: Payment ID code of the original transaction. example: 06f256c8-1bbf-42bf-93b4-ce2041bfb87e minLength: 36 maxLength: 36 cancel_amount: description: Value of the cancellation request. May be equal to or less than the value of the original transaction. type: integer example: 19990 cancel_custom_key: description: Customer key used to identify a cancellation request. (Key must be unique per transaction). type: string example: 4ec33ee18f9e45bfb73c5c30667f9006 maxLength: 32 marketplace_subseller_payments: type: array description: block indicating which products have been withdrawn from the order, use only when there is a partial cancellation of the order, for total cancellations is not necessary items: $ref: '#/definitions/marketplace_subseller_payments' cancel_request_response: type: object description: Cancel request dataset. properties: seller_id: description: E-commerce identification code. type: string format: uuidv4 minLength: 36 maxLength: 36 example: 6eb2412c-165a-41cd-b1d9-76c575d70a28 payment_id: type: string description: Payment identification code of the original transaction. example: 06f256c8-1bbf-42bf-93b4-ce2041bfb87e minLength: 36 maxLength: 36 cancel_request_at: type: string description: Cancel request data. format: YYYY-MM-DDTHH:MM:SSZ example: '2017-11-16T16:30:30Z' cancel_request_id: description: Cancellation request identifier. type: string example: '20171117084237501' minLength: 18 maxLength: 18 cancel_custom_key: description: Customer key used to identify a cancellation request. (Key must be unique per transaction). type: string example: 4ec33ee18f9e45bfb73c5c30667f9006 maxLength: 32 status: description: Transaction status. For more information on the response status, see Notifications-1.0 type: string enum: - ACCEPTED - DENIED example: ACCEPTED cancel_query_response: type: object description: Cancel request dataset. properties: seller_id: description: E-commerce identification code. type: string format: uuidv4 minLength: 36 maxLength: 36 example: 6eb2412c-165a-41cd-b1d9-76c575d70a28 payment_id: type: string description: Payment identification code of the original transaction. example: 06f256c8-1bbf-42bf-93b4-ce2041bfb87e minLength: 36 maxLength: 36 cancel_request_at: type: string description: Cancel request data. format: YYYY-MM-DDTHH:MM:SSZ example: '2017-11-16T16:30:30Z' cancel_request_id: description: Cancellation request identifier. type: string example: '20171117084237501' minLength: 18 maxLength: 18 cancel_custom_key: description: Customer key used to identify a cancellation request. (Key must be unique per transaction). type: string example: 4ec33ee18f9e45bfb73c5c30667f9006 maxLength: 32 terminal_nsu: type: string description: Authorization Code generated by the Issuer when the transaction is successfully executed. example: 13978 acquirer_transaction_id: type: string description: Code of the original transaction acquirer. example: '113880914' transaction_date: type: string description: Date of the original transaction. example: '17052017' format: DDMMAAAA minLength: 8 maxLength: 8 currency: description: Currency identification of the original transaction (See code at "https://www.currency-iso.org/en/home/tables/table-a1.html"). type: string minLength: 3 maxLength: 3 example: BRL transaction_type: description: Type of original transaction. V = à vista (FULL) e P = parcelado (INSTALLMENT). type: string enum: - V - P example: FULL number_installments: description: Number of installments of the original transaction. type: integer example: 1 amount: description: Amount of the original transaction. type: integer example: 19990 cancel_amount: description: Cancel request amount. type: integer example: 19990 status_processing_cancel_code: description: Cancel request status code. For more details see D+n Cancellation Return Code Table type: string example: '100' status_processing_cancel_message: description: Cancel request status message. type: string example: SOLICITACAO EM ANDAMENTO credit_confirm: type: object description: Dataset to confirm delayed and pre-authorized credit. properties: amount: description: Confirmation value. The value must be equal to the original value of the Transaction. If not informed, the original value will be accepted of the transaction. type: integer example: 19990 marketplace_subseller_payments: type: array description: List of Stores and their due amounts for payment.

__Note:__ For pre-authorization confirmation this field becomes __Required__ items: $ref: '#/definitions/marketplace_subseller_payments' marketplace_subseller_payments: type: object required: - subseller_sales_amount - subseller_id - order_items description: List of Stores and their due amounts for payment. properties: subseller_sales_amount: description: Part of the value of a SubSeller in relation to the Order (in Brazilian centavos) type: integer example: 10202 subseller_id: description: Subseller ID in the system. type: string example: 10 order_items: description: List of items that make up the subseller value in relation to the Order. type: array items: $ref: '#/definitions/marketplace_orders' marketplace_orders: type: object required: - amount - currency - id - description properties: amount: description: Item/Product Value (in Brazilian centavos). type: integer example: 10202 currency: description: Currency identification of the original transaction (See code at "https://www.currency-iso.org/en/home/tables/table-a1.html"). type: string example: BRL minLength: 3 maxLength: 3 id: description: Item/Product Identifier. type: string example: X0001 minLength: 1 maxLength: 20 description: description: Item/Product Description. type: string example: Produto x tax_percent: description: 'Tax to be charged on the item in percentage, if not submitted, the tax value in the register will apply.
__If the tax_percent is informed, do not send the tax_amount.__
__Note__: If the tax_percent and tax_amount are sent for the same item, the values will be added.' type: number format: double example: 0.1 tax_amount: description: 'Tax to be charged on the item in amount (in Brazilian centavos), if not submitted, the tax value in the register will apply.
__If the tax_amount is informed, do not send the tax_percent.__
__Note__: If the tax_percent and tax_amount are sent for the same item, the values will be added.' type: number example: 100 payment_plan: description: Subseller Payment Plan type: integer example: 1 marketplace_subseller_payments_combined: type: object required: - subseller_sales_amount - subseller_id - order_items description: Lista de Lojas e seus devidos valores para pagamento. properties: subseller_sales_amount: description: Parte do Valor da loja em relação ao Pedido (em centavos) type: integer example: 10000 subseller_id: description: Identificador da loja no sistema type: string example: 10 order_items: description: Lista de Itens que compõe o valor da loja em relação ao Pedido type: array items: $ref: '#/definitions/marketplace_orders_combined' marketplace_orders_combined: type: object required: - amount - currency - id - description properties: amount: description: Valor do Item/Produto (em centavos) type: integer example: 10000 currency: description: Identificação da moeda da transação original (Consultar código em "https://www.currency-iso.org/en/home/tables/table-a1.html"). type: string example: BRL minLength: 3 maxLength: 3 id: description: Identificador do Item/Produto type: string example: X0001 description: description: Descrição do Item/Produto type: string example: Produto x tax_percent: description: 'Taxa a ser cobrada no item em porcentagem se não enviar a taxa será definida a mesma do cadastro.
__Se tax_percent for informado não se deve enviar o tax_amount.__
__Obs__: Caso tax_percent e tax_amount forem enviado para um mesmo item os valores serão somados.' type: number format: double example: 0.1 tax_amount: description: 'Taxa a ser cobrada no item em valor (em centavos) se não enviar a taxa será definida a mesma do cadastro.
__Se tax_amount for informado não se deve enviar o tax_percent.__
__Obs__: Caso tax_percent e tax_amount forem enviado para um mesmo item os valores serão somados.' type: number example: 100 payment_tag: description: Tag pra identificar partes de pagamento do item em mais de um cartão type: string example: pay-1 item_split_tag: description: Tag pra identificar partes do item entre os itens da lista type: string example: item_split_tag payment_plan: description: Subseller Payment Plan type: integer example: 1 soft_descriptor_global: type: string maxLength: 22 description: 'Text shown in the buyer’s credit card statement. This field is optional, if nothing is inserted, it will be considered the registered trade name for the establishment. Only alphanumeric data and the following special characters are allowed in this field: % $ , . / & () + = <> - * Spaces will be replaced by the character ''*'' The transaction will not be denied if characters that are not allowed are sent. Any information that exceeds the maximum size will be disregarded.' example: LOJA*TESTE*COMPRA-123 dynamic_mcc: type: number maxLength: 4 minLength: 4 description: Field used to flag the transaction with another Merchant Category Code other than the one registered. If an invalid MCC is submitted, the default will be used. Send only numeric data. example: 1799 credit_preauthorized_adjustment: type: object required: - amount - currency description: Dataset to adjust Pre-authorized amount properties: amount: type: integer description: Pre-Authorization adjustment value. example: 19990 currency: type: string description: Identification of the currency of the original transaction (See code at "https://www.currency-iso.org/en/home/tables/table-a1.html"). minLength: 3 maxLength: 3 example: BRL soft_descriptor: $ref: '#/definitions/soft_descriptor_global' dynamic_mcc: $ref: '#/definitions/dynamic_mcc' marketplace_subseller_payments: type: array items: $ref: '#/definitions/marketplace_subseller_payments' credit_preauthorized_adjustment_response: type: object description: Pre-authorization value adjustment response dataset. properties: payment_id: type: string description: Payment identification code. format: uuidv4 example: 06f256c8-1bbf-42bf-93b4-ce2041bfb87e minLength: 36 maxLength: 36 seller_id: type: string description: E-commerce identification code. format: uuidv4 example: 6eb2412c-165a-41cd-b1d9-76c575d70a28 minLength: 36 maxLength: 36 amount: type: integer description: Adjusted amount in cents. example: 19990 currency: type: string description: Currency identification (See code at "https://www.currency-iso.org/en/home/tables/table-a1.html"). example: BRL minLength: 3 maxLength: 3 order_id: type: string description: Purchase identification used by the e-commerce example: 6d2e4380-d8a3-4ccb-9138-c289182818a3 maxLength: 36 status: type: string description: Transaction status. For more information on the response status, see Notifications 1.0. example: APPROVED enum: - APPROVED - DENIED maxLength: 20 authorization_code: type: string description: Credit Authorization Code example: 99999 maxLength: 20 authorized_at: type: number description: Date/time of the authorization of the credit. format: YYYY-MM-DDTHH:MM:SSZ example: '2017-03-19T16:30:30Z' maxLength: 24 reason_code: type: string description: Return code. example: 0 minLength: 1 maxLength: 5 reason_message: type: string description: Return message. example: transaction approved maxLength: 250 acquirer: type: string description: Acquirer's name. example: GETNET maxLength: 30 soft_descriptor: type: string description: Card statement description. example: Descrição para fatura maxLength: 22 terminal_nsu: type: string description: Authorization Code generated by the Issuer when the transaction is successfully executed. example: 99999 acquirer_transaction_id: type: string description: Acquirer's transaction code. example: '160453221' maxLength: 20 adjustment_acquirer_transaction_id: type: string description: Acquirer's adjust transaction code. example: '160453231' maxLength: 20 payment_release: type: object required: - release_payment_date - subseller_id - order_item_release description: Dataset to release payment to the SubSeller regarding the order products. properties: release_payment_date: type: string description: Payment Release Date for the SubSeller. example: '2017-04-19T16:30:30.00Z' format: YYYY-MM-DDTHH:MM:SSZ minLength: 24 maxLength: 24 subseller_id: type: string description: Store identifier in the system. example: '10' order_item_release: $ref: '#/definitions/order_item_release' payment_release_patch: type: object required: - release_payment_date - subseller_id - order_item_release description: Data set to release the payment to the SubSeller regarding the Order products. properties: release_payment_date: type: string description: Payment Release Date for the SubSeller. example: '2017-04-19T16:30:30.00Z' format: YYYY-MM-DDTHH:MM:SSZ minLength: 24 maxLength: 24 previous_release_payment_date: type: string description: Original release date of the payment for the Subseller. example: '2019-03-14T17:14:24Z' format: YYYY-MM-DDTHH:MM:SSZ subseller_id: type: string description: Store identifier in the system. example: '10' order_item_release: $ref: '#/definitions/order_item_release' order_item_release: type: object required: - id - amount description: Dataset containing the order items. properties: id: description: Item/Product Identifier. type: string example: X0001 amount: description: Item/Product Value (in Brazilian centavos). type: integer example: 10202 payment_release_response: type: object description: Release response for payment to the SubSeller regarding the order products. properties: success: type: boolean description: Indicates if transaction was successful or not. example: true error: type: object properties: message: type: string description: Detailed error message. maxLength: 250 name: type: string description: Name of the module or system where the error occurred. maxLength: 250 status_code: type: number description: HTTP Status code. details: type: array description: Error details. items: $ref: '#/definitions/empty' error_authentication: type: object properties: error: type: string description: Error message. error_description: type: string description: Error description. error_table: type: object properties: message: type: string description: Detailed error message. maxLength: 250 name: type: string description: Name of the module or system where the error occurred. maxLength: 250 status_code: type: number description: HTTP Status code. details: type: array description: For more details, check the Error Table. items: $ref: '#/definitions/empty' empty: type: object properties: {}

Marketplace API | Digital Platform