openapi: 3.0.1 info: title: API Reference | Digital platform description: | # Introduction This manual aims to help the developer who will consume the Digital Platform Payment API. ## Approval Environment URL base: https://api-homologacao.getnet.com.br version: '1.0.9' servers: - url: https://api-homologacao.getnet.com.br/ tags: - name: BIN Search description: 'This endpoint returns information from a BIN such as the name of the flag, flag code, issuing country, etc.. ' - name: Cryptography description: |- Use the /v1/keys service to get the public key to encrypt payment and card verification data.

Key format: Base64 encoded X509 SubjectKeyInfo PEM format

The encrypted_data attribute must be a valid JWE (check https://jwt.io for more information and verified libraries). We support RSA for encryption and symmetric (content) encryption algorithms A256CBC-HS512 and A128CBC-HS256.

This encryption model is used for payloads from API endpoints /v1/payments and /v1/verifycard

To hire the service or other questions, contact the Getnet team: produtos_digitais@getnet.com.br - name: Authentication description: The API's listed in this documentation use OAuth2 authentication, this means that in all requests it is necessary to inform an access token which will be obtained by authentication with your Client ID and Client Secret.' - name: PCI Tokenization description: | To carry out transactions securely, the card number must be pre-tokenized on all requests before being trafficked together with the other data, such as the bearer's name, expiration date and cvv. x-displayName: PCI Tokenization - name: Brand Tokenization x-displayName: Brand Tokenization description: | Card tokenization is a service that provides for the replacement of the PAN (main account number) with a token, provisioned directly with the card brands. The difference in card tokenization is linked to the token model generated, which is interoperable and can be transacted at acquirers that adhere to its processing, since the number of this token follows the same configuration as a PAN containing 16 digits, BIN and verification digit. In this way, the reading of the data remains with the same configuration and security. In addition, in every transaction with a card brand token, it is necessary to generate a cryptogram, which adds greater security to e-commerce transactions and verifies that the token sent is actually valid and can be transacted. __Available brands for Tokenization on Getnet:__ * VISA * MASTERCARD __Note:__ Tokens and cryptos need to be generated from the same token provider in order to be transacted. The token number must be filled in the field: number_token, at node “card”, available on card payment calls, along with their respective expiration date. In order to read the information generated in the token request process at the time of payment, it is necessary to fill in some additional information, available in the "tokenization" node in any card payment call (authorization), which are: * type: brand for which the token is intended: * UCAF (Mastercard); * TAVV (Visa). * cryptogram: Crypto value generated in "Card Crypto Generation" * eci: filled with 07 (Visa); 06 (Mastercard). In the case of Mastercard, if it is a recurring transaction, it is necessary to mark the ECI as 07, making the appropriate COF markings present in card payments (authorization). * requestor_id: If you use the Getnet tokenization service, it is not necessary to fill in this information. __NOTE:__ The Getnet tokenization service must be contracted before use and is subject to usage charges. - name: Card Verification description: '' - name: Vault description: | This product offers customers the possibility of saving their purchaser's card information for use in future purchases. All of this is guaranteed by the best security practices, as per PCI certification guidelines. With this solution, it is possible to store card data (card number, cardholder name and expiration date) for recurring payments, for example, subscriptions that can be offered to your customers, thus ensuring that installment payments of this subscription are carried out without the need for a gift card, but with the guarantees required by the Issuers and Card Brands. The following methods are available in this product: * Stores the consumer's card data in the safe (new card), * Listing of saved cards, * Data recovery from a saved card. * Removal of a saved card. __It is important to point out that the Getnet Vault solution is a product available on the Digital Platform, that is, it can only be used by contracting a package that has this product. - name: 3DS Authentication description: | To carry out transactions related to 3DS authentication, use the endpoints described below upon authentication OAuth2. x-displayName: 3DS Authentication - name: Payment - name: Pix description: '' - name: Recurrence description: | Getnet Recurrence allows you to manage charges easily and quickly. It is only necessary to register the client, the periodicity plan and a subscription to link the client to the plan. To have the recurrence service, you must purchase the Recurrence package or the Modular package with recurrence and vault. Below are the endpoints responsible for managing recurring charges - name: Clients x-displayName: Clients description: | For the recurrence to work it is necessary to register a client. The customer is the consumer of the product/service offered in the subscription. - name: Plans x-displayName: Plans description: | For the recurrence to work it is necessary to register a plan. The plan is what will define how recurring payments will be applied. The plan defines information on the value of the installment, the periodicity and the number of installments. The number of installments can be lifetime or finite, with an indefinite time for closing the installments being lifetime and a fixed time for closing the installments. The periodicity can be: * Annual, charges once a year; * Monthly, charges once a month; * Bimonthly, charges once every 2 months; * Quarterly, charges once every 3 months; * Half-yearly, charges once every 6 months; * Specific, specific billing cycle in days. - name: Subscriptions x-displayName: Subscriptions description: | For the recurrence to work, it is necessary to link the client and the plan through the subscription. Signature is what will be respected in all recurring charges based on what was described and parameterized in its creation. paths: /auth/oauth/v2/token: post: tags: - Authentication summary: Generate Access Token description: Endpoint responsible for generating the access token used in the other requests, for that we use HTTP Basic Authentication operationId: post-auth-oauth-v2-token parameters: - name: Content-type in: header description: Default content type application/x-www-form-urlencoded required: true schema: type: string - name: Authorization in: header description: |- Authorization: Basic AuthString Where 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 Y2xpZW50LTAxOnNlY3JldC1rZXktMDI=. In this case the Authorization in the request header will be: Authorization: Basic Y2xpZW50LTAxOnNlY3JldC1rZXktMDI= required: true schema: type: string requestBody: content: application/x-www-form-urlencoded: schema: required: - grant_type - scope properties: scope: type: string description: Use fixed value "oob" grant_type: type: string description: Use Fixed value "client_credentials" required: true responses: '200': description: Returns the access token content: application/json: schema: $ref: '#/components/schemas/AuthOauthV2TokenResponse' '400': description: Invalid request content: application/json: schema: $ref: '#/components/schemas/errorOAuth' '401': description: Not authorized content: application/json: schema: $ref: '#/components/schemas/errorOAuth' deprecated: false /v1/cards/verification: post: tags: - Card Verification summary: Card Verification description: The purpose of the credit card verification transaction is verify that the credit card used by the cardholder is a valid card. A valid credit card is understood to be a card that has not been cancelled, blocked or restricted. operationId: post-v1-verification parameters: - name: Content-type in: header description: Body content type required: true schema: type: string - name: Authorization in: header description: |- Authorization: Bearer AuthString where AuthString is access token obtained from authentication endpoint required: true schema: type: string - name: seller_id in: header description: 'Authorization: E-commerce identification code. Mandatory when the customer is treated as a Platform.' required: false schema: type: string requestBody: description: Card verification request. content: application/json: schema: $ref: '#/components/schemas/verify_request' required: false responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/verify_response' '400': description: Invalid request content: application/json: schema: $ref: '#/components/schemas/badRequestVerify' '401': description: Invalid authentication content: application/json: schema: $ref: '#/components/schemas/unauthorized' '500': description: Internal server or service error content: application/json: schema: $ref: '#/components/schemas/internalServerError' deprecated: false x-codegen-request-body-name: body /v2/payments: post: tags: - Payment summary: Authorization description: Make payment or authorize payment. operationId: payment_1 parameters: - name: Content-type in: header description: Content-type required: true schema: type: string default: application/json; charset=utf-8 enum: - application/json; charset=utf-8 - name: Authentication in: header description: 'Authorization: Bearer *AuthString*
Where *AuthString* is access token obtained from the authentication endpoint.' required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/definitions/PaymentDTO' required: true responses: '200': description: Transaction executed successfully. content: application/json: schema: $ref: '#/definitions/AutorizationResponseDTO' '400': description: Invalid Requisition content: application/json: schema: $ref: '#/definitions/DefaultErrorHttpResponse' example: message: Bad Request name: Module or service that returned the error status_code: 400 details: - status: DENIED error_code: Error code description: Bad Request description_detail: Detailed error description '401': description: Invalid Authentication content: application/json: schema: $ref: '#/definitions/DefaultErrorHttpResponse' example: message: Unauthorized name: Module or service that returned the error status_code: 401 details: - status: DENIED error_code: AUTHENTICATION-401 description: Unauthorized description_detail: Invalid client credentials '403': description: Product not Enable content: application/json: schema: $ref: '#/definitions/DefaultErrorHttpResponse' example: message: Forbidden name: Module or service that returned the error status_code: 403 details: - status: DENIED error_code: CONFIG-403 description: Forbidden description_detail: Product not enabled '404': description: Not Found content: application/json: schema: $ref: '#/definitions/DefaultErrorHttpResponse' example: message: Not Found name: Module or service that returned the error status_code: 404 details: - status: DENIED error_code: TOKENIZATION-404 description: Not Found description_detail: card_id Not Found '422': description: Unprocessable Entity content: application/json: schema: $ref: '#/definitions/DefaultErrorHttpResponse' example: message: Unprocessable Entity name: Module or service that returned the error status_code: 422 details: - status: DENIED error_code: Error code description: Unprocessable Entity description_detail: Detailed error description '429': description: Unprocessable Entity content: application/json: schema: $ref: '#/definitions/DefaultErrorHttpResponse' example: message: Bad Request name: Module or service that returned the error status_code: 429 details: - status: DENIED error_code: Error code description: Too Many Requests description_detail: Detailed error description '500': description: Internal server or service error content: application/json: schema: $ref: '#/definitions/DefaultErrorHttpResponse' example: message: Internal Server Error name: Module or service that returned the error status_code: 500 details: - status: ERROR error_code: GENERIC-500 description: Internal Server Error description_detail: The server encountered an unexpected error. '503': description: Internal server or service error content: application/json: schema: $ref: '#/definitions/DefaultErrorHttpResponse' example: message: Service Unavailable name: Module or service that returned the error status_code: 503 details: - status: ERROR error_code: GENERIC-503 description: Service Unavailable description_detail: The server encountered an unexpected error. '504': description: Gateway Timeout content: application/json: schema: $ref: '#/definitions/DefaultErrorHttpResponse' example: message: Gateway Timeout name: Module or service that returned the error status_code: 504 details: - status: ERROR error_code: GENERIC-504 description: Gateway Timeout description_detail: The server encountered an unexpected error. patch: tags: - Payment summary: Adjustment description: Adjust an authorization, available only for transactions with the payment method "CREDIT_PRE_AUTHORIZATION". operationId: adjustment_1 parameters: - name: Content-type in: header description: Content-type required: true schema: type: string default: application/json; charset=utf-8 enum: - application/json; charset=utf-8 - name: Authentication in: header description: 'Authorization: Bearer *AuthString*
Where *AuthString* is access token obtained from the authentication endpoint.' required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/definitions/PaymentAdjustmentDTO' required: true responses: '200': description: Transaction executed successfully. content: application/json: schema: $ref: '#/definitions/PreAutorizationResponseDTO' '400': description: Invalid Requisition content: application/json: schema: $ref: '#/definitions/DefaultErrorHttpResponse' example: message: Bad Request name: Module or service that returned the error status_code: 400 details: - status: DENIED error_code: Error code description: Bad Request description_detail: Detailed error description '401': description: Invalid Authentication content: application/json: schema: $ref: '#/definitions/DefaultErrorHttpResponse' example: message: Unauthorized name: Module or service that returned the error status_code: 401 details: - status: DENIED error_code: AUTHENTICATION-401 description: Unauthorized description_detail: Invalid client credentials '403': description: Product not Enable content: application/json: schema: $ref: '#/definitions/DefaultErrorHttpResponse' example: message: Forbidden name: Module or service that returned the error status_code: 403 details: - status: DENIED error_code: CONFIG-403 description: Forbidden description_detail: Product not enabled '404': description: Not Found content: application/json: schema: $ref: '#/definitions/DefaultErrorHttpResponse' example: message: Not Found name: Module or service that returned the error status_code: 404 details: - status: DENIED error_code: TOKENIZATION-404 description: Not Found description_detail: card_id Not Found '422': description: Unprocessable Entity content: application/json: schema: $ref: '#/definitions/DefaultErrorHttpResponse' example: message: Unprocessable Entity name: Module or service that returned the error status_code: 422 details: - status: DENIED error_code: Error code description: Unprocessable Entity description_detail: Detailed error description '429': description: Unprocessable Entity content: application/json: schema: $ref: '#/definitions/DefaultErrorHttpResponse' example: message: Bad Request name: Module or service that returned the error status_code: 429 details: - status: DENIED error_code: Error code description: Too Many Requests description_detail: Detailed error description '500': description: Internal server or service error content: application/json: schema: $ref: '#/definitions/DefaultErrorHttpResponse' example: message: Internal Server Error name: Module or service that returned the error status_code: 500 details: - status: ERROR error_code: GENERIC-500 description: Internal Server Error description_detail: The server encountered an unexpected error. '503': description: Internal server or service error content: application/json: schema: $ref: '#/definitions/DefaultErrorHttpResponse' example: message: Service Unavailable name: Module or service that returned the error status_code: 503 details: - status: ERROR error_code: GENERIC-503 description: Service Unavailable description_detail: The server encountered an unexpected error. '504': description: Gateway Timeout content: application/json: schema: $ref: '#/definitions/DefaultErrorHttpResponse' example: message: Gateway Timeout name: Module or service that returned the error status_code: 504 details: - status: ERROR error_code: GENERIC-504 description: Gateway Timeout description_detail: The server encountered an unexpected error. /v2/payments/capture: post: tags: - Payment summary: Capture description: Captures an authorized transaction. operationId: capture_3 parameters: - name: Content-type in: header description: Content-type required: true schema: type: string default: application/json; charset=utf-8 enum: - application/json; charset=utf-8 - name: Authentication in: header description: 'Authorization: Bearer *AuthString*
Where *AuthString* is access token obtained from the authentication endpoint.' required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/definitions/CapturetDTO' required: true responses: '200': description: Transaction executed successfully. content: application/json: schema: $ref: '#/definitions/CaptureResponseDTO' '400': description: Invalid Requisition content: application/json: schema: $ref: '#/definitions/DefaultErrorHttpResponse' example: message: Bad Request name: Module or service that returned the error status_code: 400 details: - status: DENIED error_code: Error code description: Bad Request description_detail: Detailed error description '401': description: Invalid Authentication content: application/json: schema: $ref: '#/definitions/DefaultErrorHttpResponse' example: message: Unauthorized name: Module or service that returned the error status_code: 401 details: - status: DENIED error_code: AUTHENTICATION-401 description: Unauthorized description_detail: Invalid client credentials '404': description: Not Found content: application/json: schema: $ref: '#/definitions/DefaultErrorHttpResponse' example: message: Not Found name: Module or service that returned the error status_code: 404 details: - status: DENIED error_code: TOKENIZATION-404 description: Not Found description_detail: card_id Not Found '422': description: Unprocessable Entity content: application/json: schema: $ref: '#/definitions/DefaultErrorHttpResponse' example: message: Unprocessable Entity name: Module or service that returned the error status_code: 422 details: - status: DENIED error_code: Error code description: Unprocessable Entity description_detail: Detailed error description '429': description: Unprocessable Entity content: application/json: schema: $ref: '#/definitions/DefaultErrorHttpResponse' example: message: Bad Request name: Module or service that returned the error status_code: 429 details: - status: DENIED error_code: Error code description: Too Many Requests description_detail: Detailed error description '500': description: Internal server or service error content: application/json: schema: $ref: '#/definitions/DefaultErrorHttpResponse' example: message: Internal Server Error name: Module or service that returned the error status_code: 500 details: - status: ERROR error_code: GENERIC-500 description: Internal Server Error description_detail: The server encountered an unexpected error. '503': description: Internal server or service error content: application/json: schema: $ref: '#/definitions/DefaultErrorHttpResponse' example: message: Service Unavailable name: Module or service that returned the error status_code: 503 details: - status: ERROR error_code: GENERIC-503 description: Service Unavailable description_detail: The server encountered an unexpected error. '504': description: Gateway Timeout content: application/json: schema: $ref: '#/definitions/DefaultErrorHttpResponse' example: message: Gateway Timeout name: Module or service that returned the error status_code: 504 details: - status: ERROR error_code: GENERIC-504 description: Gateway Timeout description_detail: The server encountered an unexpected error. /v2/payments/cancel: post: tags: - Payment summary: Cancellation description: Cancels a transaction made. If the cancellation request is made on the same day (D0) as the transaction (chargeback), only the reversal of the total amount is allowed. If the cancellation request is made from the next day (D+N) that the transaction (cancellation), the cancellation of the partial or total amount is allowed. In this case, it is only necessary to fill in the amount field with the value you want to cancel. If the field is not filled in, the transaction will be canceled in the full amount. operationId: cancel_5 parameters: - name: Content-type in: header description: Content-type required: true schema: type: string default: application/json; charset=utf-8 enum: - application/json; charset=utf-8 - name: Authentication in: header description: 'Authorization: Bearer *AuthString*
Where *AuthString* is access token obtained from the authentication endpoint.' required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/definitions/CancelDTO' required: true responses: '200': description: Transaction executed successfully. content: application/json: schema: $ref: '#/definitions/CancelResponseDTO' '400': description: Invalid Requisition content: application/json: schema: $ref: '#/definitions/DefaultErrorHttpResponse' example: message: Bad Request name: Module or service that returned the error status_code: 400 details: - status: DENIED error_code: Error code description: Bad Request description_detail: Detailed error description '401': description: Invalid Authentication content: application/json: schema: $ref: '#/definitions/DefaultErrorHttpResponse' example: message: Unauthorized name: Module or service that returned the error status_code: 401 details: - status: DENIED error_code: AUTHENTICATION-401 description: Unauthorized description_detail: Invalid client credentials '404': description: Not Found content: application/json: schema: $ref: '#/definitions/DefaultErrorHttpResponse' example: message: Not Found name: Module or service that returned the error status_code: 404 details: - status: DENIED error_code: TOKENIZATION-404 description: Not Found description_detail: card_id Not Found '422': description: Unprocessable Entity content: application/json: schema: $ref: '#/definitions/DefaultErrorHttpResponse' example: message: Unprocessable Entity name: Module or service that returned the error status_code: 422 details: - status: DENIED error_code: Error code description: Unprocessable Entity description_detail: Detailed error description '429': description: Unprocessable Entity content: application/json: schema: $ref: '#/definitions/DefaultErrorHttpResponse' example: message: Bad Request name: Module or service that returned the error status_code: 429 details: - status: DENIED error_code: Error code description: Too Many Requests description_detail: Detailed error description '500': description: Internal server or service error content: application/json: schema: $ref: '#/definitions/DefaultErrorHttpResponse' example: message: Internal Server Error name: Module or service that returned the error status_code: 500 details: - status: ERROR error_code: GENERIC-500 description: Internal Server Error description_detail: The server encountered an unexpected error. '503': description: Internal server or service error content: application/json: schema: $ref: '#/definitions/DefaultErrorHttpResponse' example: message: Service Unavailable name: Module or service that returned the error status_code: 503 details: - status: ERROR error_code: GENERIC-503 description: Service Unavailable description_detail: The server encountered an unexpected error. '504': description: Gateway Timeout content: application/json: schema: $ref: '#/definitions/DefaultErrorHttpResponse' example: message: Gateway Timeout name: Module or service that returned the error status_code: 504 details: - status: ERROR error_code: GENERIC-504 description: Gateway Timeout description_detail: The server encountered an unexpected error. /v2/payments/{paymentId}/release: post: tags: - Payment summary: Release description: Release of captured payment. operationId: release parameters: - name: Content-type in: header description: Content-type required: true schema: type: string default: application/json; charset=utf-8 enum: - application/json; charset=utf-8 - name: Authentication in: header description: 'Authorization: Bearer *AuthString*
Where *AuthString* is access token obtained from the authentication endpoint.' required: true schema: type: string - name: paymentId in: path required: true description: Payment identification code. schema: type: string requestBody: content: application/json: schema: $ref: '#/definitions/ReleaseDTO' required: true responses: '200': description: Transaction executed successfully. content: application/json: schema: $ref: '#/definitions/realeseResponse' '400': description: Invalid Requisition content: application/json: schema: $ref: '#/definitions/DefaultErrorHttpResponse' example: message: Bad Request name: Module or service that returned the error status_code: 400 details: - status: DENIED error_code: Error code description: Bad Request description_detail: Detailed error description '401': description: Invalid Authentication content: application/json: schema: $ref: '#/definitions/DefaultErrorHttpResponse' example: message: Unauthorized name: Module or service that returned the error status_code: 401 details: - status: DENIED error_code: AUTHENTICATION-401 description: Unauthorized description_detail: Invalid client credentials '402': description: Unprocessable Entity content: application/json: schema: $ref: '#/definitions/DefaultErrorHttpResponse' example: message: Unprocessable Entity name: Module or service that returned the error status_code: 422 details: - status: DENIED error_code: Error code description: Unprocessable Entity description_detail: Detailed error description '404': description: Not Found content: application/json: schema: $ref: '#/definitions/DefaultErrorHttpResponse' example: message: Not Found name: Module or service that returned the error status_code: 404 details: - status: DENIED error_code: TOKENIZATION-404 description: Not Found description_detail: card_id Not Found '500': description: Internal server or service error content: application/json: schema: $ref: '#/definitions/DefaultErrorHttpResponse' example: message: Internal Server Error name: Module or service that returned the error status_code: 500 details: - status: ERROR error_code: GENERIC-500 description: Internal Server Error description_detail: The server encountered an unexpected error. /v2/payments/boleto: post: tags: - Payment summary: Register Boleto description: |- This endpoint will receive bank slip data with the possibility of payment via pix, which will be registered with Banco Santander.

#### Printing of the duplicate of a bank slip When registering a payment with a bank slip, the payment_id field is returned in the response to the registration request. The payment_id will be used for the download request of the duplicate of the boleto. #### PIX When printing the ticket, the QRCode will be made available for payment via pix. __Note:__ The payment_id field can also be retrieved in the payment slip notification. More information about notifications is available at Notifications 1.1 parameters: - name: Content-type in: header description: Content-type required: true schema: type: string default: application/json; charset=utf-8 enum: - application/json; charset=utf-8 - name: Authentication in: header description: 'Authorization: Bearer *AuthString*
Where *AuthString* is access token obtained from the authentication endpoint.' required: true schema: type: string requestBody: description: Request containing data for payment by bank slip. content: application/json: schema: $ref: '#/components/schemas/payment_boleto_v2' required: true responses: '201': description: Ticket issued successfully. content: application/json: schema: $ref: '#/components/schemas/payment_boleto_response_v2' '400': description: Invalid request. content: application/json: schema: $ref: '#/components/schemas/error' '401': description: Invalid Authentication. content: application/json: schema: $ref: '#/components/schemas/error' '402': description: Request is valid but payment denied. can be denied by various business reasons/rules. content: application/json: schema: $ref: '#/components/schemas/error_boleto_402' '404': description: Not found. content: application/json: schema: $ref: '#/components/schemas/error' '500': description: Internal server or service error. content: application/json: schema: $ref: '#/components/schemas/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 '{ "idempotency_key": "7eb2412c-165a-41cd-b1d9-76c575d70a27", "request_id": "9eb2412c-165a-41cd-b1d9-76c575d70a29", "data": { "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" }, "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" } } } }' x-codegen-request-body-name: payment_boleto_v2 /v1/payments/info/{payment_id}: get: summary: Query Payment tags: - Payment operationId: get-v1-payments description: Query a payment by payment_id. responses: '200': description: OK content: application/json: schema: type: object properties: payment_id: $ref: '#/components/schemas/payment_id' order_id: $ref: '#/components/schemas/order_id' status: $ref: '#/components/schemas/statusInfo' payment: $ref: '#/components/schemas/payment' records: type: array items: $ref: '#/components/schemas/record' '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/notFound' application/xml: schema: type: object properties: {} '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/internalServerError' '503': description: Service Unavailable content: application/json: schema: $ref: '#/components/schemas/serviceUnavailable' '504': description: Gateway Timeout content: application/json: schema: $ref: '#/components/schemas/gatewayTimeout' parameters: - name: Content-type in: header description: Content-type required: true schema: type: string default: application/json; charset=utf-8 enum: - application/json; charset=utf-8 - name: Authentication in: header description: 'Authorization: Bearer *AuthString*
Where *AuthString* is access token obtained from the authentication endpoint.' required: true schema: type: string - schema: type: string format: uuid example: 8719d0c4-2c3f-4360-abd9-8daf3834fe1f minLength: 36 maxLength: 36 in: path name: payment_id description: Payment Identifier. required: true /v1/payments/info/{payment_id}/{idempotency_key}: parameters: - name: Content-type in: header description: Content-type required: true schema: type: string default: application/json; charset=utf-8 enum: - application/json; charset=utf-8 - name: Authentication in: header description: 'Authorization: Bearer *AuthString*
Where *AuthString* is access token obtained from the authentication endpoint.' required: true schema: type: string - schema: type: string format: uuid name: payment_id in: path required: true description: Payment identifier. - schema: type: string name: idempotency_key in: path required: true description: Idempotent ID of the operation. get: summary: Query Payment Idempotent Operation tags: - Payment responses: '200': description: OK content: application/json: schema: type: object properties: rel: $ref: '#/components/schemas/rel' idempotency_key: $ref: '#/components/schemas/idempotency_key' registred_at: $ref: '#/components/schemas/registred_at' items: type: array items: type: object properties: registred_at: $ref: '#/components/schemas/registred_at' type: type: string enum: - request - response - result description: Tipo de registro. example: request content: description: Conteúdo do registro. oneOf: - $ref: '#/components/schemas/requestPayment' - $ref: '#/components/schemas/paymentAuthorizationResponse' - $ref: '#/components/schemas/paymentPurchaseResponse' - $ref: '#/components/schemas/paymentCaptureResponse' - $ref: '#/components/schemas/V1PaymentsCaptureRequest' - $ref: '#/components/schemas/V1PaymentsCancelRequest' - $ref: '#/components/schemas/paymentCanceledCancelResponse' - $ref: '#/components/schemas/paymentAcceptedCancelResponse' - $ref: '#/components/schemas/cancelResult' '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/notFound' '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/internalServerError' '503': description: Service Unavailable content: application/json: schema: $ref: '#/components/schemas/serviceUnavailable' '504': description: Gateway Timeout content: application/json: schema: $ref: '#/components/schemas/gatewayTimeout' operationId: get-v1-payment-info-payment_id-component_id description: Query a payment idempotent operation by idempotency_key. /v2/payments/qrcode/pix: post: tags: - Pix summary: QR Code generation for PIX payment description: At this endpoint data will be received for PIX payment with QR Code. After the generation of the QR Code the return of the payment to the Commercial Establishment will take place through a Notification via HTTP. For more details please see "PIX Notifications" in Notifications 1.1 of this document. parameters: - name: seller_id in: header description: E-commerce identification code. schema: maxLength: 36 minLength: 36 type: string format: uuidv4 - name: Content-type in: header description: Content-type required: true schema: type: string default: application/json; charset=utf-8 - name: Authorization in: header description: 'Authorization: Bearer AuthString Where AuthString is token of access gained from the authentication endpoint.' required: true schema: type: string - name: x-qrcode-expiration-time in: header description: It is possible to customize the expiration time of the QR Code by entering the desired time in seconds, if it is not informed the operation will go with the default value of 180s, The maximum value for expiration time is 1800s required: false schema: type: number default: 180 maximum: 1800 requestBody: description: Request containing data for payment with PIX. content: application/json: schema: $ref: '#/components/schemas/pix' responses: '200': description: QR Code successfully generated and awaiting payment. content: application/json: schema: $ref: '#/components/schemas/payment_pix_qrcode' '400': description: Invalid request content: application/json: schema: $ref: '#/components/schemas/badRequest' '401': description: Invalid Authentication content: application/json: schema: $ref: '#/components/schemas/unauthorized' '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/paymentNotFound' '500': description: Internal server or service error content: application/json: schema: $ref: '#/components/schemas/internalServerError' /v1/3ds/tokens: post: tags: - 3DS Authentication summary: 3DS access token generation description: Endpoint responsible for generating the access token for opening of a 3DS authentication session with GetNet. parameters: - name: Content-type in: header description: Content-type required: true schema: type: string default: application/json; charset=utf-8 enum: - application/json; charset=utf-8 - name: Authorization in: header description: 'Authorization: Bearer *AuthString*
Where *AuthString* is access token obtained from the authentication endpoint.' required: true schema: type: string - name: seller_id in: header description: 'Authorization: E-commerce identification code.
Mandatory when the customer is treated as a Platform.' schema: maxLength: 36 minLength: 36 type: string format: uuidv4 requestBody: description: Data identifying the session and the purchase being made (Order). content: application/json: schema: $ref: '#/components/schemas/3ds_token' required: true responses: '201': description: Returns access token for 3DS authentication session along to Getnet content: application/json: schema: type: object properties: access_token: maxLength: 2000 type: string description: Taccess token for 3DS authentication session. example: | eyJhbGciOiJIUzI1NiJ9.eyJqdGkiOiIzZjczZGQ3MS03NjkyLTQyYTItYjU2Ni1jYmUzMzJkYzU3OTQiLCJpYXQiOjE1NzY2NzI3NDUsImlzcyI6IjVkNzVhYzYxNmZlM2QxMmYxODhmZmQ3YyIsIk9yZ1VuaXRJZCI6IjVkNzRlZDczZTA5MTlmMTk1ODNjMzE5MyIsIlBheWxvYWQiOiJ7XCJvcmRlck51bWJlclwiOlwic3RyaW5nXCIsXCJwYXltZW50SWRcIjpcImRhMGU4ZDkwLTQ0OGMtNGJhMC1iZGUyLTQxN2Q2YTdmZjliOVwiLFwibWVyY2hhbnRJZFwiOlwiMDU0Mzk5MlwiLFwibWVyY2hhbnROYW1lXCI6XCJFQyBUZXN0ZSBIVUIg4oCTIFBBRFJBT1wiLFwiY3VycmVuY3lcIjpcImJybFwiLFwidG90YWxBbW91bnRcIjpcIjEwMDBcIixcImpzVmVyc2lvblwiOlwic3RyaW5nXCIsXCJjbGllbnRDb2RlXCI6XCJzdHJpbmctM2Y3M2RkNzEtNzY5Mi00MmEyLWI1NjYtY2JlMzMyZGM1Nzk0XCIsXCJvdmVycmlkZVBheW1lbnRNZXRob2RcIjpcIjAyXCIsXCJpdGVtc1wiOlt7XCJ0b3RhbEFtb3VudFwiOlwiOTAwXCIsXCJ1bml0UHJpY2VcIjpcIjg5OVwiLFwicXVhbnRpdHlcIjowLFwic2t1XCI6XCJzdHJpbmdcIixcImRlc2NyaXB0aW9uXCI6XCJzdHJpbmdcIixcIm5hbWVcIjpcInN0cmluZ1wifSx7XCJ0b3RhbEFtb3VudFwiOlwiOTAwXCIsXCJ1bml0UHJpY2VcIjpcIjgwMFwiLFwicXVhbnRpdHlcIjowLFwic2t1XCI6XCJzdHJpbmdcIixcImRlc2NyaXB0aW9uXCI6XCJzdHJpbmdcIixcIm5hbWVcIjpcInN0cmluZ1wifV19IiwiT2JqZWN0aWZ5UGF5bG9hZCI6ZmFsc2UsIlJlZmVyZW5jZUlkIjoiM2Y3M2RkNzEtNzY5Mi00MmEyLWI1NjYtY2JlMzMyZGM1Nzk0IiwiZXhwIjoxNTc2NjcyODY1fQ.jrPvIjtvSY6HukI-PjBE0ACWo68whA2FhCCfKeEfB4g token_type: maxLength: 6 minLength: 6 type: string description: token type. example: bearer expiration_date: maxLength: 23 minLength: 23 type: string description: Token expiration date. format: YYYY-MM-DDTHH:mm:ss.SSS example: '2019-09-05T18:54:53.153' '400': description: Invalid request. content: application/json: schema: $ref: '#/components/schemas/error' '401': description: Invalid authentication. content: application/json: schema: $ref: '#/components/schemas/error' '403': description: Access denied. content: application/json: schema: $ref: '#/components/schemas/error' '404': description: Not found. content: application/json: schema: $ref: '#/components/schemas/error' '500': description: Internal server or service error. content: application/json: schema: $ref: '#/components/schemas/error' '503': description: Server error or service unavailable. content: application/json: schema: $ref: '#/components/schemas/error' '504': description: Erro gateway timeout. content: application/json: schema: $ref: '#/components/schemas/error' x-codegen-request-body-name: 3ds_token /v1/3ds/authentications: post: tags: - 3DS Authentication summary: Requests 3DS authentication description: Endpoint responsible for requesting 3DS authentication together to GetNet. parameters: - name: Content-type in: header description: Content-type. required: true schema: type: string default: application/json; charset=utf-8 enum: - application/json; charset=utf-8 - name: Authorization in: header description: 'Authorization: Bearer *AuthString*
Where *AuthString* is access token obtained from the authentication endpoint.' required: true schema: type: string - name: seller_id in: header description: 'Authorization: E-commerce identification code.
Required when the customer is treated as a Platform.' schema: maxLength: 36 minLength: 36 type: string format: uuidv4 requestBody: description: Data identifying the purchase being made (Order), authentication details, customer history, card details. content: application/json: schema: $ref: '#/components/schemas/3ds_authentication' required: true responses: '201': description: Returns from 3DS authentication with GetNet. content: application/json: schema: type: object properties: card: $ref: '#/components/schemas/3ds_authentications_resp_card_ref' id: maxLength: 26 type: string description: A unique identification number assigned by CyberSource to identify the submitted request. example: 5.785063465166933e+21 submit_time_utc: maxLength: 20 type: string description: Request time in UTC. format: YYYY-MM-DDThh:mm:ssZ example: '2019-12-18T17:46:02.000Z' status: maxLength: 25 type: string description: Status of 3DS authentication request. example: AUTHENTICATION_SUCCESSFUL enum: - AUTHENTICATION_SUCCESSFUL - PENDING_AUTHENTICATION - AUTHENTICATION_FAILED client_reference_information: $ref: '#/components/schemas/3ds_authentications_resp_client_reference_information_ref' consumer_authentication_information: $ref: '#/components/schemas/3ds_authentications_resp_consumer_authentication_information_ref' error_information: $ref: '#/components/schemas/3ds_authentications_resp_error_information_ref' reference_id: maxLength: 36 type: string description: Reference number generated by 3DS Getnet example: a1c1aaf5-28fe-44c8-8b06-26103afb101e org_unit_id: type: string description: Getnet id used to consume 3DS service. example: 5d74ed73e0919f19583c3193 send_ds_date: type: integer description: 3DS service submission date in long format that represents currentTimeMillis. example: 1578506345431 rec_ds_date: type: integer description: 3DS service receipt date in long format which represents currentTimeMillis. example: 1578506348886 '400': description: Invalid request. content: application/json: schema: $ref: '#/components/schemas/error' '401': description: Invalid authentication. content: application/json: schema: $ref: '#/components/schemas/error' '403': description: Access denied. content: application/json: schema: $ref: '#/components/schemas/error' '404': description: Not found. content: application/json: schema: $ref: '#/components/schemas/error' '500': description: Internal server or service error. content: application/json: schema: $ref: '#/components/schemas/error' '503': description: Server error or service unavailable. content: application/json: schema: $ref: '#/components/schemas/error' '504': description: Erro gateway timeout. content: application/json: schema: $ref: '#/components/schemas/error' x-codegen-request-body-name: 3ds_authentication /v1/3ds/authentications/results: post: tags: - 3DS Authentication summary: Request 3DS authentication result description: Endpoint responsible for requesting the authentication result 3DS together with GetNet. parameters: - name: Content-type in: header description: Content-type. required: true schema: type: string default: application/json; charset=utf-8 enum: - application/json; charset=utf-8 - name: Authorization in: header description: 'Authorization: Bearer *AuthString*
Where *AuthString* is access token obtained from the authentication endpoint.' required: true schema: type: string - name: seller_id in: header description: 'Authorization: E-commerce identification code. Mandatory when the customer is treated as a Platform.' schema: maxLength: 36 minLength: 36 type: string format: uuidv4 requestBody: content: application/json: schema: $ref: '#/components/schemas/3ds_results_ref' required: false responses: '201': description: Returns result of 3DS authentication with GetNet. content: application/json: schema: type: object properties: card: $ref: '#/components/schemas/3ds_authentications_resp_card_ref' id: type: string description: A unique identification number assigned by CyberSource to identify the submitted request. example: 5.785063465166933e+21 submit_time_utc: type: string description: Request time in UTC. example: '2019-12-18T17:46:02.000Z' status: maxLength: 25 type: string description: Status of 3DS authentication request. example: AUTHENTICATION_SUCCESSFUL enum: - AUTHENTICATION_SUCCESSFUL - PENDING_AUTHENTICATION - AUTHENTICATION_FAILED client_reference_information: $ref: '#/components/schemas/3ds_authentications_resp_client_reference_information_ref' consumer_authentication_information: $ref: '#/components/schemas/3ds_authentication_results_resp_consumer_authentication_information_ref' send_ds_date: type: string description: 3DS service submission date in long format that represents currentTimeMillis. example: '1578506345431' rec_ds_date: type: string description: 3DS service receipt date in long format which represents currentTimeMillis. example: '1578506348886' '400': description: Invalid request. content: application/json: schema: $ref: '#/components/schemas/error' '401': description: Invalid authentication. content: application/json: schema: $ref: '#/components/schemas/error' '403': description: Access denied. content: application/json: schema: $ref: '#/components/schemas/error' '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/error' '500': description: Erro interno do servidor ou serviço. content: application/json: schema: $ref: '#/components/schemas/error' '503': description: Server error or service unavailable. content: application/json: schema: $ref: '#/components/schemas/error' '504': description: Erro gateway timeout. content: application/json: schema: $ref: '#/components/schemas/error' x-codegen-request-body-name: body /v1/tokens/card: post: tags: - PCI Tokenization summary: Card token generation description: To securely transact card data, except CVV, must be *tokenized*, this process is done by the described endpoint below upon authentication. parameters: - name: Content-type in: header description: Content-type required: true schema: type: string default: application/json; charset=utf-8 enum: - application/json; charset=utf-8 - name: Authorization in: header description: 'Authorization: Bearer *AuthString*
Where *AuthString* is access token obtained from the authentication endpoint.' required: true schema: type: string - name: seller_id in: header description: 'Authorization: E-commerce identification code. Mandatory when the customer is treated as a Platform.' schema: maxLength: 36 minLength: 36 type: string format: uuidv4 requestBody: description: Card and buyer details content: application/json: schema: required: - card_number type: object properties: card_number: maxLength: 19 minLength: 13 type: string description: Card number example: '5155901222280001' customer_id: maxLength: 100 type: string description: Buyer identifier. Information defined by application that consumes the api of the Digital Platform. example: customer_21081826 required: false responses: '201': description: Returns the card token. content: application/json: schema: type: object properties: number_token: maxLength: 128 minLength: 128 type: string description: Token of the card that will be used in transactions. If the HTTP response contains the header "Content-Encoding:gzip" (RFC 2616 topic 14.11 Content-Encoding ) the response must go through a process unpacking process, depending on the technology used for integration it will be necessary to use a third-party library. example: dfe05208b105578c070f806c80abd3af09e246827d29b866cf4ce16c205849977c9496cbf0d0234f42339937f327747075f68763537b90b31389e01231d4d13c '400': description: Invalid request. content: application/json: schema: $ref: '#/components/schemas/error' '401': description: invalid authentication. content: application/json: schema: $ref: '#/components/schemas/error' '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/error' '500': description: Internal server or service error. content: application/json: schema: $ref: '#/components/schemas/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" }' x-codegen-request-body-name: token_card /v1/tokenization/token: post: summary: Card token generation description: To carry out transactions securely, card data, except CVV, must be *tokenized*, this process is done by the endpoint described below through authentication. tags: - Brand 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*
Where *AuthString* is the access token obtained from the authentication endpoint. - in: body name: token_card description: Card and buyer details schema: type: object required: - customer_id (cpf ou identificador unico) - card_pan - card_pan_source - card_brand - expiration_year - expiration_month - email properties: customer_id: type: string description: Buyer identifier. Information defined by the application that consumes the Digital Platform API. _Note:_ Use together with the Card Number. example: customer_45678900, 123.456.789-00 ou 12345678900 card_pan: type: string description: Card number minLength: 13 maxLength: 19 example: '4622943120000493' card_pan_source: type: string description: Card Source. Possible values. ON_FILE (The token requester already has the PAN data in their records), MANUALLY_ENTERED (The PAN data was entered by the cardholder) or VIA_APPLICATION (The PAN data (or reference) was provided by an Issuing Application). example: ON_FILE, MANUALLY_ENTERED ou VIA_APPLICATION card_brand: type: string description: Brand Identifier. Possible values VISA and MASTERCARD. example: VISA, MASTERCARD expiration_year: type: string description: Expiration year. format: string example: '2023' expiration_month: type: string description: Expiration month. format: string example: '07' security_code: type: string description: cvv. format: string example: 1234 email: type: string description: Buyer's email. format: email example: tokenizacao_bandeiras@getnet.com.br responses: '200': description: Returns the card token. schema: type: object properties: network_token_id: type: string description: Card token that will be used to generate the cryptogram. example: 1b110aaa71934ae492bff48baab9af81 status: type: string description: Token Status. example: ACTIVE '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/tokenization/token \ -H 'authorization: Bearer ca22a2ge-1914-4b0c-a0fb-d3ce0fde7346' \ -H 'content-type: application/json; charset=utf-8' \ -d '{ customer_id: 'customer_45678900' email: test@merchant.com card_brand: 'Mastercard' card_pan_source: ON_FILE card_pan: '5204731600014784' security_code: '226' expiration_month: '12' expiration_year: '2023' }' /v1/tokenization/crypt: post: summary: Card cryptogram generation description: To carry out transactions securely, card data and network_token_id must be *encrypted*, this process is done by the endpoint described below through authentication. tags: - Brand 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*
Where *AuthString* is the access token obtained from the authentication endpoint. - in: body name: token_card_crypt description: Card and buyer details schema: type: object required: - network_token_id - transaction_type - cryptogram_type - amount - customer_id - email - card_brand properties: network_token_id: type: string description: Token obtained from the previous endpoint. example: 1b110aaa71934ae492bff48baab9af81 transaction_type: type: string description: Cryptogram Type. Possible values. CIT (Customer Initiated Transaction) or MIT (Merchant Initiated Transaction - recurring payment). example: CIT ou MIT cryptogram_type: type: string description: Brand Identifier. Possible values. VISTA (VISA token authentication verification value) or MC_DSRP_LONG (Mastercard secure digital remote control) example: VISA_TAVV ou MC_DSRP_LONG amount: type: number description: Monetary value of the transaction in cents. example: 100 customer_id: type: string description: Buyer identifier. Information defined by the application that consumes the Digital Platform API. __Note:__ Use together with the Card Number. example: customer_45678900, 123.456.789-00 ou 12345678900 email: type: string description: Buyer's email. format: email example: tokenizacao_bandeira@getnet.com.br card_brand: type: string description: Brand Identifier. Possible values. VISA and MASTERCARD. example: VISA, MASTERCARD responses: '200': description: Returns the card cryptogram. schema: type: object properties: cryptogram: type: string description: Cryptogram of the card that will be used in transactions. example: MF5GJksAAJU1ASH4Eo7gAAADFAM= token_pan_card: type: string description: New tokenized pan. example: '5204731618934544' token_expiration_month: type: string description: New expiration month for tokenized bread. example: '11' token_expiration_year: type: string description: New year of tokenized pan expiration. example: '2026' token_status: type: string description: Cryptogram of the card that will be used in transactions. example: ACTIVE '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/tokenization/crypt \ -H 'authorization: Bearer ca22a2ge-1914-4b0c-a0fb-d3ce0fde7346' \ -H 'content-type: application/json; charset=utf-8' \ -d '{ cryptogram: "MF5GJksAAJU1ASH4Eo7gAAADFAM=", token_pan_card: "5204731618934544", token_expiration_month: "11", token_expiration_year: "2026", token_status: "ACTIVE" }' /v1/customers: post: summary: Register a new customer description: In this endpoint you can register the data of a new customer for recurrence. tags: - Clients parameters: - required: true description: Content type. schema: type: string enum: - application/json; charset=utf-8 default: application/json; charset=utf-8 name: Content-Type in: header - required: true description: | Authorization: Bearer *AuthString*
Where *AuthString* is the access token obtained from the authentication endpoint. schema: type: string name: Authorization in: header - required: true description: E-commerce identification code. name: seller_id schema: type: string minLength: 36 maxLength: 36 format: uuidv4 in: header - required: false description: User who is registering. This information may be used for auditing purposes. schema: type: string name: username in: header requestBody: description: Request containing data to register a new customer. content: application/json: schema: $ref: '#/definitions/customer_info' responses: '200': description: Customer registration successfully completed content: application/json: schema: $ref: '#/definitions/customer_info_response' '400': description: Invalid request. content: application/json: schema: $ref: '#/definitions/error' '401': description: Invalid authentication. content: application/json: schema: $ref: '#/definitions/error' '500': description: Internal server or service error. content: application/json: schema: $ref: '#/definitions/error' x-code-samples: - lang: cURL source: | curl -X POST \ https://api-homologacao.getnet.com.br/v1/customers \ -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 '{ "seller_id": "6eb2412c-165a-41cd-b1d9-76c575d70a28", "customer_id": "customer_21081826", "first_name": "João", "last_name": "da Silva", "document_type": "CPF", "document_number": "12345678912", "birth_date": "1976-02-21", "phone_number": "5551999887766", "celphone_number": "5551999887766", "email": "customer@email.com.br", "observation": "O cliente tem interesse no plano x.", "address": { "street": "Av. Brasil", "number": "1000", "complement": "Sala 1", "district": "São Geraldo", "city": "Porto Alegre", "state": "RS", "country": "Brasil", "postal_code": "90230060" } } get: summary: list of customers description: In this endpoint you can list all previously registered customers based on the chosen filters. tags: - Clients parameters: - required: true description: | Authorization: Bearer *AuthString*
Where *AuthString* is the access token obtained from the authentication endpoint. schema: type: string name: Authorization in: header - required: true description: E-commerce identification code. schema: type: string format: uuidv4 minLength: 36 maxLength: 36 name: seller_id in: header - required: true description: Page number where pagination starts. schema: type: number minimum: 1 name: page in: query - required: true description: Limit results per page. schema: minimum: 0 maximum: 9999 type: number name: limit in: query - required: false description: Buyer identifier. schema: type: string maxLength: 100 name: customer_id in: query - required: false description: Buyer's document number. schema: minLength: 11 maxLength: 15 type: string name: document_number in: query - required: false description: Buyer's first name. schema: maxLength: 40 type: string name: first_name in: query - required: false description: Buyer's last name. schema: maxLength: 80 type: string name: last_name in: query - required: false description: Field to carry out sorting. schema: default: last_name type: string name: sort in: query - required: false description: Sort type. Ascending or Descending. schema: enum: - asc - desc type: string name: sort_type in: query responses: '200': description: List of registered customers. content: application/json: schema: $ref: '#/definitions/customer_filter_response' '400': description: Invalid request. content: application/json: schema: $ref: '#/definitions/error' '401': description: Invalid authentication. content: application/json: schema: $ref: '#/definitions/error' '404': description: Not found. content: application/json: schema: $ref: '#/definitions/error' '500': description: Internal server or service error. content: application/json: schema: $ref: '#/definitions/error' x-code-samples: - lang: cURL source: | curl -X GET \ https://api-homologacao.getnet.com.br/v1/customers?page=1&limit=10 \ -H 'authorization: Bearer 72402c54-6bd3-4895-a6b4-adfded0c11dc' \ -H 'seller_id: 6eb2412c-165a-41cd-b1d9-76c575d70a28' /v1/customers/{customer_id}: get: summary: returns a customer description: In this endpoint you can search for the data of a specific customer, previously registered. tags: - Clients parameters: - required: true description: | Authorization: Bearer *AuthString*
Where *AuthString* is the access token obtained from the authentication endpoint. schema: type: string name: Authorization in: header - required: true description: E-commerce identification code. name: seller_id schema: format: uuidv4 minLength: 36 maxLength: 36 type: string in: header - required: true description: Buyer identifier. schema: type: string maxLength: 100 name: customer_id in: path responses: '200': description: Returns customer data. content: application/json: schema: $ref: '#/definitions/customer_info' '400': description: Invalid request. content: application/json: schema: $ref: '#/definitions/error' '401': description: Invalid authentication. content: application/json: schema: $ref: '#/definitions/error' '404': description: Not found. content: application/json: schema: $ref: '#/definitions/error' '500': description: Internal server or service error. content: application/json: schema: $ref: '#/definitions/error' x-code-samples: - lang: cURL source: | curl -X GET \ https://api-homologacao.getnet.com.br/v1/customers/123456 \ -H 'authorization: Bearer 72402c54-6bd3-4895-a6b4-adfded0c11dc' \ -H 'seller_id: 6eb2412c-165a-41cd-b1d9-76c575d70a28' /v1/plans: post: summary: Register a new plan description: In this endpoint you can create a recurrence plan. tags: - Plans parameters: - required: true description: Content type. schema: 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*
Where *AuthString* is the access token obtained from the authentication endpoint. schema: type: string name: Authorization in: header - required: true description: E-commerce identification code. name: seller_id schema: format: uuidv4 minLength: 36 maxLength: 36 type: string in: header - required: false description: User who is registering. This information may be used for auditing purposes. schema: type: string name: username in: header requestBody: description: Request containing data to register a new plan. content: application/json: schema: $ref: '#/definitions/plan' responses: '200': description: Successfully registered plan content: application/json: schema: $ref: '#/definitions/plan_response' '400': description: Invalid request. content: application/json: schema: $ref: '#/definitions/error' '401': description: Invalid authentication. content: application/json: schema: $ref: '#/definitions/error' '403': description: Recurrence product not enabled. content: application/json: schema: $ref: '#/definitions/error' '500': description: Internal server or service error. content: application/json: schema: $ref: '#/definitions/error' x-code-samples: - lang: cURL source: | curl -X POST \ https://api-homologacao.getnet.com.br/v1/plans \ -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 '{ "seller_id": "6eb2412c-165a-41cd-b1d9-76c575d70a28", "name": "Plano flex", "description": "Plano flex", "amount": 19990, "currency": "BRL", "payment_types": [ "credit_card" ], "sales_tax": 0, "product_type": "service", "period": { "type": "monthly", "billing_cycle": 30, "specific_cycle_in_days": 0 } } get: summary: list of plans description: 'In this endpoint you can list the previously registered plans based on the chosen filters. ' tags: - Plans parameters: - required: true description: | Authorization: Bearer *AuthString*
Where *AuthString* is the access token obtained from the authentication endpoint. schema: type: string name: Authorization in: header - required: true description: E-commerce identification code. name: seller_id schema: format: uuidv4 minLength: 36 maxLength: 36 type: string in: header - required: true description: Page number where pagination starts. schema: minimum: 1 type: number name: page in: query - required: true description: Limit of results per page. schema: minimum: 0 maximum: 9999 type: number name: limit in: query - required: false description: Plan identifier. name: plan_id schema: minLength: 36 maxLength: 36 format: uuidv4 type: string in: query - required: false description: Plan status. schema: default: active enum: - active - inactive type: string name: status in: query - required: false description: Plan name. schema: minLength: 3 type: string name: name in: query - required: false description: Field to carry out the ordering. schema: default: name type: string name: sort in: query - required: false description: Sort type. Ascending or Descending. schema: enum: - asc - desc type: string name: sort_type in: query - name: expand in: query schema: type: array items: type: string required: false description: | Displays additional information about the Plans, such as date and value changes expected for them. The display of some information may depend on enabling a specific product on Getnet. * `floating_data` - Include the information block of all date and value changes in the result. responses: '200': description: List of registered plans. content: application/json: schema: $ref: '#/definitions/plan_filter_response' '400': description: Invalid request. content: application/json: schema: $ref: '#/definitions/error' '401': description: Invalid authentication. content: application/json: schema: $ref: '#/definitions/error' '403': description: Recurrence product not enabled. content: application/json: schema: $ref: '#/definitions/error' '404': description: Not found. content: application/json: schema: $ref: '#/definitions/error' '500': description: Internal server or service error. content: application/json: schema: $ref: '#/definitions/error' x-code-samples: - lang: cURL source: | curl -X GET \ https://api-homologacao.getnet.com.br/v1/plans?page=1&limit=10 \ -H 'authorization: Bearer 72402c54-6bd3-4895-a6b4-adfded0c11dc' \ -H 'seller_id: 6eb2412c-165a-41cd-b1d9-76c575d70a28' /v1/plans/{plan_id}: get: summary: returns a plan description: In this endpoint you can search for data from a specific plan, previously registered. tags: - Plans parameters: - required: true description: | Authorization: Bearer *AuthString*
Where *AuthString* is the access token obtained from the authentication endpoint. schema: type: string name: Authorization in: header - required: true description: E-commerce identification code. name: seller_id schema: format: uuidv4 minLength: 36 maxLength: 36 type: string in: header - required: true description: Plan identifier. name: plan_id schema: minLength: 36 maxLength: 36 format: uuidv4 type: string in: path - name: expand in: query schema: type: array items: type: string required: false description: | Displays additional information about the Plan, such as date and value changes expected for it. The display of some information may depend on enabling a specific product on Getnet. * `floating_data` - Include the information block of all date and value changes in the result. responses: '200': description: Returns plan data. content: application/json: schema: $ref: '#/definitions/plan_response' '400': description: Invalid request. content: application/json: schema: $ref: '#/definitions/error' '401': description: Invalid authentication. content: application/json: schema: $ref: '#/definitions/error' '403': description: Recurrence product not enabled. content: application/json: schema: $ref: '#/definitions/error' '404': description: Not found. content: application/json: schema: $ref: '#/definitions/error' '500': description: Internal server or service error. content: application/json: schema: $ref: '#/definitions/error' x-code-samples: - lang: cURL source: | curl -X GET \ https://api-homologacao.getnet.com.br/v1/plans/51995e24-b1ae-4826-8e15-2a568a87abdd \ -H 'authorization: Bearer 72402c54-6bd3-4895-a6b4-adfded0c11dc' \ -H 'seller_id: 6eb2412c-165a-41cd-b1d9-76c575d70a28' patch: summary: Update a plan description: |- In this endpoint you can update the definitions of a previously registered plan. Remembering that Plans that have associated active subscriptions only allow changes to Name and Description information. tags: - Plans parameters: - required: true description: Content type. schema: enum: - application/json; charset=utf-8 type: string default: application/json; charset=utf-8 name: Content-Type in: header - required: true description: | Authorization: Bearer *AuthString*
Where *AuthString* is the access token obtained from the authentication endpoint. schema: type: string name: Authorization in: header - required: true description: E-commerce identification code. name: seller_id schema: type: string format: uuidv4 minLength: 36 maxLength: 36 in: header - required: false description: User who is registering. This information may be used for auditing purposes. schema: type: string name: username in: header - required: true description: Plan identifier. name: plan_id schema: minLength: 36 maxLength: 36 format: uuidv4 type: string in: path requestBody: description: Dataset of the plan to be updated. content: application/json: schema: $ref: '#/definitions/plan_update' responses: '200': description: Returns the updated plan. content: application/json: schema: $ref: '#/definitions/plan_response' '400': description: Invalid request. content: application/json: schema: $ref: '#/definitions/error' '401': description: Invalid authentication. content: application/json: schema: $ref: '#/definitions/error' '403': description: Recurrence product not enabled. content: application/json: schema: $ref: '#/definitions/error' '404': description: Not found. content: application/json: schema: $ref: '#/definitions/error' '500': description: Internal server or service error. content: application/json: schema: $ref: '#/definitions/error' x-code-samples: - lang: cURL source: | curl -X PATCH \ https://api-homologacao.getnet.com.br/v1/plans/51995e24-b1ae-4826-8e15-2a568a87abdd \ -H 'authorization: Bearer 72402c54-6bd3-4895-a6b4-adfded0c11dc' \ -H 'content-type: application/json; charset=utf-8' \ -H 'seller_id: 6eb2412c-165a-41cd-b1d9-76c575d70a28' \ -d '{ "name": "Updated flex plan", "description": "Updated flex plan", } /v1/plans/{plan_id}/status/{status}: patch: summary: Update plan status description: In this endpoint you can enable/disable the recurrence plan status. tags: - Plans parameters: - required: true description: Content type. schema: type: string enum: - application/json; charset=utf-8 default: application/json; charset=utf-8 name: Content-Type in: header - required: true description: | Authorization: Bearer *AuthString*
Where *AuthString* is the access token obtained from the authentication endpoint. schema: type: string name: Authorization in: header - required: true description: E-commerce identification code. name: seller_id schema: format: uuidv4 minLength: 36 maxLength: 36 type: string in: header - required: false description: User who is registering. This information may be used for auditing purposes. schema: type: string name: username in: header - required: true description: Plan identifier. name: plan_id schema: minLength: 36 maxLength: 36 format: uuidv4 type: string in: path - required: true description: Status of the plan. schema: type: string enum: - active - inactive name: status in: path responses: '200': description: Returns plan data. content: application/json: schema: $ref: '#/definitions/plan_response' '400': description: Invalid request. content: application/json: schema: $ref: '#/definitions/error' '401': description: Invalid authentication. content: application/json: schema: $ref: '#/definitions/error' '403': description: Recurrence product not enabled. content: application/json: schema: $ref: '#/definitions/error' '404': description: Not found. content: application/json: schema: $ref: '#/definitions/error' '500': description: Internal server or service error. content: application/json: schema: $ref: '#/definitions/error' x-code-samples: - lang: cURL source: | curl -X PATCH \ https://api-homologacao.getnet.com.br/v1/plans/51995e24-b1ae-4826-8e15-2a568a87abdd/status/active \ -H 'authorization: Bearer 72402c54-6bd3-4895-a6b4-adfded0c11dc' \ -H 'content-type: application/json; charset=utf-8' \ -H 'seller_id: 6eb2412c-165a-41cd-b1d9-76c575d70a28' /v1/plans/subscriptions/migration: post: summary: Change the Plan of a Subscription list. description: In this endpoint you can request to change the Plan of a list of Subscriptions, or even, request to change the Plan of all Subscriptions from an origin Plan to a destination Plan. tags: - Plans parameters: - required: true description: Content type. schema: type: string enum: - application/json; charset=utf-8 default: application/json; charset=utf-8 name: Content-Type in: header - required: true description: | Authorization: Bearer *AuthString*
Where *AuthString* is the access token obtained from the authentication endpoint. schema: type: string name: Authorization in: header - required: true description: E-commerce identification code. name: seller_id schema: format: uuidv4 minLength: 36 maxLength: 36 type: string in: header - required: false description: User who is registering. This information may be used for auditing purposes. schema: type: string name: username in: header requestBody: description: Here, the identifiers of the origin and destination Plans will be informed, that is, the Signatures of the origin Plan (from field) will be changed (migrated) to the destination Plan (to field). A list of Subscription identifiers can also be informed as optional for the need to change the Plan of only specific Subscriptions. If this list of Subscriptions is not informed, then the service will migrate all Subscriptions from the source Plan (from field) to the destination Plan (to field). content: application/json: schema: $ref: '#/definitions/subscription_plan_migration' responses: '202': description: Request accepted for processing, that is, the process of migrating Subscriptions from a source Plan to a destination Plan will be done asynchronously. It is possible to verify the migration progress of the Subscriptions through the GET /v1/subscriptions service, informing the identifier of the target plan. content: application/json: schema: $ref: '#/definitions/subscription_plan_migration' '400': description: Invalid request. content: application/json: schema: $ref: '#/definitions/error' '401': description: Invalid authentication. content: application/json: schema: $ref: '#/definitions/error' '403': description: Recurrence product not enabled. content: application/json: schema: $ref: '#/definitions/error' '404': description: Not found. content: application/json: schema: $ref: '#/definitions/error' '500': description: Internal server or service error. content: application/json: schema: $ref: '#/definitions/error' '503': description: Service unavailable. content: application/json: schema: $ref: '#/definitions/error' x-code-samples: - lang: cURL source: | curl -X POST \ https://api-homologacao.getnet.com.br/v1/plans/subscriptions/migration \ -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' -H 'username: Usuario' \ -d '{ \"from\": \"9aca75f2-bb03-42d7-aa09-7e46409ded26\", \"to\": \"a0ca3090-a4f6-4e1f-a91d-a535454dd72b\", \"subscriptions\": [ \"a0ca3090-a4f6-4e1f-a91d-a535454dd72b\", \"4fd5d55f-de02-4d0b-ab6a-33ea4d92511a\" ] }' /v1/subscriptions: post: summary: Register a new subscription description: On this endpoint you can create a new recurrence signature. tags: - Subscriptions parameters: - required: true description: Content type. schema: 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*
Where *AuthString* is the access token obtained from the authentication endpoint. schema: type: string name: Authorization in: header - required: true description: E-commerce identification code. name: seller_id schema: type: string format: uuidv4 minLength: 36 maxLength: 36 in: header - required: false description: User who is registering. This information may be used for auditing purposes. schema: type: string name: username in: header requestBody: description: Request containing data to register a new subscription. content: application/json: schema: $ref: '#/definitions/subscription' responses: '201': description: Signature created successfully. content: application/json: schema: $ref: '#/definitions/subscription_response' '400': description: Invalid request. content: application/json: schema: $ref: '#/definitions/error' '401': description: Invalid authentication. content: application/json: schema: $ref: '#/definitions/error' '403': description: Recurrence product not enabled. content: application/json: schema: $ref: '#/definitions/error' '500': description: Internal server or service error. content: application/json: schema: $ref: '#/definitions/error' x-code-samples: - lang: cURL source: | curl -X POST \ https://api-homologacao.getnet.com.br/v1/subscriptions \ -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 '{ "seller_id": "6eb2412c-165a-41cd-b1d9-76c575d70a28", "customer_id": "customer_21081826", "plan_id": "51995e24-b1ae-4826-8e15-2a568a87abdd", "order_id": "6d2e4380-d8a3-4ccb-9138-c289182818a3", "subscription": { "payment_type": { "credit": { "transaction_type": "FULL", "number_installments": 1, "soft_descriptor": "LOJA*TESTE*COMPRA-123", "billing_address": { "street": "Av. Brasil", "number": "1000", "complement": "Sala 1", "district": "São Geraldo", "city": "Porto Alegre", "state": "RS", "country": "Brasil", "postal_code": "90230060" }, "card": { "number_token": "dfe05208b105578c070f806c80abd3af09e246827d29b866cf4ce16c205849977c9496cbf0d0234f42339937f327747075f68763537b90b31389e01231d4d13c", "cardholder_name": "JOAO DA SILVA", "security_code": "123", "brand": "Mastercard", "expiration_month": "12", "expiration_year": "28", "bin": "123412", "card_id": "17b5ce46-db3f-4e03-90d0-42aa3131c41e" } } }, "shippings": [ { "first_name": "João", "last_name": "da Silva", "email": "customer@email.com.br", "phone_number": "5551999887766", "shipping_amount": 3000, "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" } } get: summary: subscription list description: 'In this endpoint you can list the subscriptions previously registered based on the chosen filters. ' tags: - Subscriptions parameters: - required: true description: | Authorization: Bearer *AuthString*
Onde *AuthString* é token de acesso obtido no endpoint de autenticação. schema: type: string name: Authorization in: header - required: true description: E-commerce identification code. name: seller_id schema: type: string format: uuidv4 minLength: 36 maxLength: 36 in: header - required: true description: Number of the page where pagination starts. name: page schema: minimum: 1 type: number in: query - required: true description: Limit of results per page. schema: minimum: 0 maximum: 9999 type: number name: limit in: query - required: false description: Buyer identifier. schema: type: string maxLength: 100 name: customer_id in: query - required: false description: Recurrence plan identifier. schema: type: string minLength: 36 maxLength: 36 format: uuidv4 name: plan_id in: query - required: false description: Recurrence signature identifier. name: subscription_id schema: minLength: 36 maxLength: 36 format: uuidv4 type: string in: query - required: false description: Start date of the next schedule. schema: type: string name: next_scheduled_date[start] in: query - required: false description: End date of the next appointment. schema: type: string name: next_scheduled_date[end] in: query - required: false description: Signature creation initial date. schema: type: string name: create_date[start] in: query - required: false description: Signature creation end date. schema: type: string name: create_date[end] in: query - required: false description: Start date of subscription. schema: type: string name: end_date[start] in: query - required: false description: Subscription end date. schema: type: string name: end_date[end] in: query - required: false description: Field to carry out the ordering. schema: default: create_date enum: - order_id - create_date - end_date type: string name: sort in: query - required: false description: Sort type. Ascending or Descending. schema: default: asc enum: - asc - desc type: string name: sort_type in: query - required: false description: Subscription status. schema: enum: - processing - canceled - success - delayed - expired type: string name: status in: query - name: expand in: query schema: type: array items: type: string required: false description: | Displays additional subscription information such as date and value changes expected for the subscription. The display of some information may depend on enabling a specific product on Getnet. * `floating_data` - Include the information block of all date and value changes in the result. responses: '200': description: List returned successfully. content: application/json: schema: $ref: '#/definitions/subscription_filter_response' '400': description: Invalid request. content: application/json: schema: $ref: '#/definitions/error' '401': description: Invalid authentication. content: application/json: schema: $ref: '#/definitions/error' '403': description: Recurrence product not enabled. content: application/json: schema: $ref: '#/definitions/error' '404': description: Not found. content: application/json: schema: $ref: '#/definitions/error' '500': description: Internal server or service error. content: application/json: schema: $ref: '#/definitions/error' x-code-samples: - lang: cURL source: | curl -X GET \ https://api-homologacao.getnet.com.br/v1/subscriptions?page=1&limit=10 \ -H 'authorization: Bearer 72402c54-6bd3-4895-a6b4-adfded0c11dc' \ -H 'seller_id: 6eb2412c-165a-41cd-b1d9-76c575d70a28' /v1/subscriptions/{subscription_id}: get: summary: Recurrence Signature description: In this endpoint you can search for data from a specific subscription, previously registered. tags: - Subscriptions parameters: - required: true description: | Authorization: Bearer *AuthString*
Where *AuthString* is the access token obtained from the authentication endpoint. schema: type: string name: Authorization in: header - required: true description: E-commerce identification code. name: seller_id schema: type: string format: uuidv4 minLength: 36 maxLength: 36 in: header - required: true description: Recurrence signature identifier. name: subscription_id schema: type: string minLength: 36 maxLength: 36 format: uuidv4 in: path - name: expand in: query schema: type: array items: type: string required: false description: | Displays additional subscription information such as date and value changes expected for the subscription. The display of some information may depend on enabling a specific product on Getnet. * `floating_data` - Include the information block of all date and value changes in the result. responses: '200': description: Subscription returned successfully. content: application/json: schema: $ref: '#/definitions/subscription_response' '400': description: Invalid request. content: application/json: schema: $ref: '#/definitions/error' '401': description: Invalid authentication. content: application/json: schema: $ref: '#/definitions/error' '403': description: Recurrence product not enabled. content: application/json: schema: $ref: '#/definitions/error' '404': description: Not found. content: application/json: schema: $ref: '#/definitions/error' '500': description: Internal server or service error. content: application/json: schema: $ref: '#/definitions/error' x-code-samples: - lang: cURL source: | curl -X GET \ https://api-homologacao.getnet.com.br/v1/subscriptions/5d740ea0-b7d1-42f5-ad64-5a5521e12er9 \ -H 'authorization: Bearer 72402c54-6bd3-4895-a6b4-adfded0c11dc' \ -H 'seller_id: 6eb2412c-165a-41cd-b1d9-76c575d70a28' /v1/subscriptions/{subscription_id}/cancel: post: summary: Cancels a recurrence subscription description: |- In this endpoint you can cancel a previously registered subscription. Remembering that the cancellation of the subscription also cancels the next scheduled charge. tags: - Subscriptions parameters: - required: true description: Content type. schema: 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*
Where *AuthString* is the access token obtained from the authentication endpoint. schema: type: string name: Authorization in: header - required: true description: E-commerce identification code. name: seller_id schema: type: string format: uuidv4 minLength: 36 maxLength: 36 in: header - required: false description: User who is registering. This information may be used for auditing purposes. schema: type: string name: username in: header - required: true description: Recurrence signature identifier. name: subscription_id schema: type: string minLength: 36 maxLength: 36 format: uuidv4 in: path requestBody: description: Additional dataset for cancellation. content: application/json: schema: $ref: '#/definitions/subscription_cancel' responses: '200': description: Subscription canceled successfully. content: application/json: schema: $ref: '#/definitions/subscription_response' '400': description: Invalid request. content: application/json: schema: $ref: '#/definitions/error' '401': description: Invalid authentication. content: application/json: schema: $ref: '#/definitions/error' '403': description: Recurrence product not enabled. content: application/json: schema: $ref: '#/definitions/error' '404': description: Not found. content: application/json: schema: $ref: '#/definitions/error' '500': description: Internal server or service error. content: application/json: schema: $ref: '#/definitions/error' x-code-samples: - lang: cURL source: | curl -X POST \ https://api-homologacao.getnet.com.br/v1/subscriptions/5d740ea0-b7d1-42f5-ad64-5a5521e12er9/cancel \ -H 'authorization: Bearer 72402c54-6bd3-4895-a6b4-adfded0c11dc' \ -H 'content-type: application/json; charset=utf-8' \ -H 'seller_id: 6eb2412c-165a-41cd-b1d9-76c575d70a28' \ -d '{ "seller_id": "6eb2412c-165a-41cd-b1d9-76c575d70a28", "status_details": "Cliente não tem mais interesse no serviço/produto" } /v1/subscriptions/{subscription_id}/charges/projection: get: summary: Demonstrates the projection of charges description: |- In this endpoint, it is possible to demonstrate the projection of scheduled charges for the recurrence subscription. Remembering that projections and charges that are registered with dates greater than 28, depending on the month, may respect the last day of the month. __For example:__ Dia de pagamento: 31 Projeção: * 31/10/2019 * 30/11/2019 * 31/12/2019 tags: - Subscriptions parameters: - required: true description: | Authorization: Bearer *AuthString*
Where *AuthString* is the access token obtained from the authentication endpoint. schema: type: string name: Authorization in: header - required: true description: E-commerce identification code. name: seller_id schema: type: string format: uuidv4 minLength: 36 maxLength: 36 in: header - required: true description: Recurrence signature identifier. schema: type: string minLength: 36 maxLength: 36 format: uuidv4 name: subscription_id in: path - name: expand in: query schema: type: array items: type: string required: false description: | Displays additional subscription information such as date and value changes expected for the subscription. The display of some information may depend on enabling a specific product on Getnet. * `installment` - Includes plot number information in the result * `floating_data` - Include the information block of all date and value changes in the result. responses: '200': description: Projection returned successfully. content: application/json: schema: $ref: '#/definitions/subscription_projection_response' '400': description: Invalid request. content: application/json: schema: $ref: '#/definitions/error' '401': description: Invalid authentication. content: application/json: schema: $ref: '#/definitions/error' '403': description: Recurrence product not enabled. content: application/json: schema: $ref: '#/definitions/error' '404': description: Not found. content: application/json: schema: $ref: '#/definitions/error' '500': description: Internal server or service error. content: application/json: schema: $ref: '#/definitions/error' x-code-samples: - lang: cURL source: | curl -X GET \ https://api-homologacao.getnet.com.br/v1/subscriptions/5d740ea0-b7d1-42f5-ad64-5a5521e12er9/charges/projection?limit=1 \ -H 'authorization: Bearer 72402c54-6bd3-4895-a6b4-adfded0c11dc' \ -H 'seller_id: 6eb2412c-165a-41cd-b1d9-76c575d70a28' /v1/subscriptions/{subscription_id}/confirmPayment: post: summary: Confirm subscription payment description: In this endpoint you can confirm the payment of a subscription made manually. tags: - Subscriptions parameters: - required: true description: Content type. schema: 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*
Where *AuthString* is the access token obtained from the authentication endpoint. schema: type: string name: Authorization in: header - required: true description: E-commerce identification code. name: seller_id schema: type: string format: uuidv4 minLength: 36 maxLength: 36 in: header - required: false description: User who is registering. This information may be used for auditing purposes. schema: type: string name: username in: header - required: true description: Recurrence signature identifier. name: subscription_id schema: type: string minLength: 36 maxLength: 36 format: uuidv4 in: path requestBody: description: Set of information for subscription payment confirmation. content: application/json: schema: $ref: '#/definitions/subscription_confirm' responses: '200': description: Payment confirmed successfully. content: application/json: schema: $ref: '#/definitions/subscription_response' '400': description: Invalid request. content: application/json: schema: $ref: '#/definitions/error' '401': description: Invalid authentication. content: application/json: schema: $ref: '#/definitions/error' '403': description: Recurrence product not enabled. content: application/json: schema: $ref: '#/definitions/error' '404': description: Not found. content: application/json: schema: $ref: '#/definitions/error' '500': description: Internal server or service error. content: application/json: schema: $ref: '#/definitions/error' x-code-samples: - lang: cURL source: | curl -X POST \ https://api-homologacao.getnet.com.br/v1/subscriptions/5d740ea0-b7d1-42f5-ad64-5a5521e12er9/confirmPayment \ -H 'authorization: Bearer 72402c54-6bd3-4895-a6b4-adfded0c11dc' \ -H 'content-type: application/json; charset=utf-8' \ -H 'seller_id: 6eb2412c-165a-41cd-b1d9-76c575d70a28' \ -d '{ "seller_id": "6eb2412c-165a-41cd-b1d9-76c575d70a28", "status_details": "Pagamento de assinatura confirmado", "charge_id": "52bc81b2-f079-4f7b-b63a-f653ff29d794" } /v1/subscriptions/{subscription_id}/paymentDate: patch: summary: Update billing details description: |- In this endpoint you can update the billing date of a previously registered subscription Remembering that when changing the billing date, all the next installments will be produced with the new date. tags: - Subscriptions parameters: - required: true description: Content-type schema: 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*
Where *AuthString* is the access token obtained from the authentication endpoint. schema: type: string name: Authorization in: header - required: true description: E-commerce identification code. name: seller_id schema: type: string format: uuidv4 minLength: 36 maxLength: 36 in: header - required: false description: User who is registering. This information may be used for auditing purposes. schema: type: string name: username in: header - required: true description: Recurrence signature identifier. name: subscription_id schema: type: string minLength: 36 maxLength: 36 format: uuidv4 in: path requestBody: description: Set of data for updating the payment date. content: application/json: schema: $ref: '#/definitions/subscription_payment_date' responses: '200': description: Date successfully updated. content: application/json: schema: $ref: '#/definitions/subscription_response' '400': description: Invalid request. content: application/json: schema: $ref: '#/definitions/error' '401': description: Invalid authentication. content: application/json: schema: $ref: '#/definitions/error' '403': description: Recurrence product not enabled. content: application/json: schema: $ref: '#/definitions/error' '404': description: Not found. content: application/json: schema: $ref: '#/definitions/error' '500': description: Internal server or service error. content: application/json: schema: $ref: '#/definitions/error' x-code-samples: - lang: cURL source: | curl -X PATCH \ https://api-homologacao.getnet.com.br/v1/subscriptions/5d740ea0-b7d1-42f5-ad64-5a5521e12er9/paymentDate \ -H 'authorization: Bearer 72402c54-6bd3-4895-a6b4-adfded0c11dc' \ -H 'content-type: application/json; charset=utf-8' \ -H 'seller_id: 6eb2412c-165a-41cd-b1d9-76c575d70a28' \ -d '{ "day": 25 } /v1/subscriptions/{subscription_id}/paymentType/credit/card: patch: summary: Update payment details description: In this endpoint you can update the payment data of a previously registered subscription tags: - Subscriptions parameters: - required: true description: Content type. schema: 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*
Where *AuthString* is the access token obtained from the authentication endpoint. schema: type: string name: Authorization in: header - required: true description: E-commerce identification code. name: seller_id schema: type: string format: uuidv4 minLength: 36 maxLength: 36 in: header - required: false description: User who is registering. This information may be used for auditing purposes. schema: type: string name: username in: header - required: true description: Recurrence signature identifier. name: subscription_id schema: type: string minLength: 36 maxLength: 36 format: uuidv4 in: path requestBody: description: Set of data for changing payment type. content: application/json: schema: $ref: '#/definitions/subscription_update_payment_type' responses: '200': description: Payment data updated successfully. content: application/json: schema: $ref: '#/definitions/subscription_response' '400': description: Invalid request. content: application/json: schema: $ref: '#/definitions/error' '401': description: Invalid authentication. content: application/json: schema: $ref: '#/definitions/error' '403': description: Recurrence product not enabled. content: application/json: schema: $ref: '#/definitions/error' '404': description: Not found. content: application/json: schema: $ref: '#/definitions/error' '500': description: Internal server or service error. content: application/json: schema: $ref: '#/definitions/error' x-code-samples: - lang: cURL source: | curl -X PATCH \ https://api-homologacao.getnet.com.br/v1/subscriptions/5d740ea0-b7d1-42f5-ad64-5a5521e12er9/paymentType/credit/card \ -H 'authorization: Bearer 72402c54-6bd3-4895-a6b4-adfded0c11dc' \ -H 'content-type: application/json; charset=utf-8' \ -H 'seller_id: 6eb2412c-165a-41cd-b1d9-76c575d70a28' \ -d '{ "number_token": "dfe05208b105578c070f806c80abd3af09e246827d29b866cf4ce16c205849977c9496cbf0d0234f42339937f327747075f68763537b90b31389e01231d4d13c", "cardholder_name": "JOAO DA SILVA", "brand": "Mastercard", "expiration_month": "12", "expiration_year": "28", "bin": "123412", "card_id": "17b5ce46-db3f-4e03-90d0-42aa3131c41e" } /v1/subscriptions/{subscription_id}/floating: post: summary: Registers a date or value change for the subscription description: |- On this endpoint you can create a new date and/or value change for one or more charges that are scheduled for the subscription. To use this endpoint, the establishment must be enabled for this specific product. For more details see the Date change rules. tags: - Subscriptions parameters: - required: true description: Content type. schema: 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*
Where *AuthString* is the access token obtained from the authentication endpoint. schema: type: string name: Authorization in: header - required: true description: E-commerce identification code. name: seller_id schema: type: string format: uuidv4 minLength: 36 maxLength: 36 in: header - required: true description: Recurrence signature identifier. name: subscription_id schema: type: string minLength: 36 maxLength: 36 format: uuidv4 in: path - required: false description: User who is registering. This information may be used for auditing purposes. schema: type: string name: username in: header requestBody: description: Request containing data to register changes in date and/or amount for certain charges. content: application/json: schema: $ref: '#/definitions/subscription_floating_data_array_creation' responses: '201': description: Subscription changed successfully. content: application/json: schema: $ref: '#/definitions/subscription_floating_data_response' '400': description: Invalid request. content: application/json: schema: $ref: '#/definitions/error' '401': description: Invalid authentication. content: application/json: schema: $ref: '#/definitions/error' '403': description: Recurrence product not enabled. content: application/json: schema: $ref: '#/definitions/error' '500': description: Internal server or service error. content: application/json: schema: $ref: '#/definitions/error' x-code-samples: - lang: cURL source: | curl -X POST \ https://api-homologacao.getnet.com.br/v1/subscriptions/9aca75f2-bb03-42d7-aa09-7e46409ded26/floating \ -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' -H 'username: Usuario' \ -d '{ \"subscription_id\": \"9aca75f2-bb03-42d7-aa09-7e46409ded26\", \"floating_data\": [ { \"installment\": 2, \"new_scheduled_date\": \"2020-07-16\", \"new_amount": 123, \"original_scheduled_date": \"2020-07-09\", \"original_amount": 10000 }, { \"installment\": 4, \"new_scheduled_date\": \"2020-09-05\", \"new_amount\": 321, \"original_scheduled_date\": \"2020-09-09\", \"original_amount\": 10000 } ] }' get: summary: Lists all date and/or value changes for a recurrence signature description: |- In this endpoint, you can search for data on all date and/or value changes in charges for a specific subscription. To use this endpoint, the establishment must be enabled for this specific product. For more details see the Date Change Rules. tags: - Subscriptions parameters: - required: true description: | Authorization: Bearer *AuthString*
Where *AuthString* is the access token obtained from the authentication endpoint. schema: type: string name: Authorization in: header - required: true description: E-commerce identification code. name: seller_id schema: type: string format: uuidv4 minLength: 36 maxLength: 36 in: header - required: true description: Recurrence signature identifier. name: subscription_id schema: type: string minLength: 36 maxLength: 36 format: uuidv4 in: path responses: '200': description: Date changes and/or amount of Subscription charges successfully returned. content: application/json: schema: $ref: '#/definitions/subscription_floating_data_response' '400': description: Invalid request. content: application/json: schema: $ref: '#/definitions/error' '401': description: Invalid authentication. content: application/json: schema: $ref: '#/definitions/error' '403': description: Recurrence product not enabled. content: application/json: schema: $ref: '#/definitions/error' '404': description: Not found. content: application/json: schema: $ref: '#/definitions/error' '500': description: Internal server or service error. content: application/json: schema: $ref: '#/definitions/error' x-code-samples: - lang: cURL source: | curl -X GET \ https://api-homologacao.getnet.com.br/v1/subscriptions/5d740ea0-b7d1-42f5-ad64-5a5521e12er9/floating \ -H 'authorization: Bearer 72402c54-6bd3-4895-a6b4-adfded0c11dc' \ -H 'seller_id: 6eb2412c-165a-41cd-b1d9-76c575d70a28' delete: summary: Removes all date and value changes from a subscription. description: In this endpoint you can remove all date and amount changes in charges for a specific subscription. The subscription will keep the original values and dates according to the associated plan. To use this endpoint, the establishment must be enabled for this specific product. tags: - Subscriptions parameters: - required: true description: | Authorization: Bearer *AuthString*
Where *AuthString* is the access token obtained from the authentication endpoint. schema: type: string name: Authorization in: header - required: true description: E-commerce identification code. name: seller_id schema: type: string format: uuidv4 minLength: 36 maxLength: 36 in: header - required: true description: Recurrence signature identifier. name: subscription_id schema: type: string minLength: 36 maxLength: 36 format: uuidv4 in: path - required: false description: User who is registering. This information may be used for auditing purposes. schema: type: string name: username in: header responses: '200': description: Date and value changes have been partially removed. content: application/json: schema: $ref: '#/definitions/subscription_floating_data_remove_response' '204': description: Date and value changes were successfully removed. '400': description: Invalid request. content: application/json: schema: $ref: '#/definitions/error' '401': description: Invalid authentication. content: application/json: schema: $ref: '#/definitions/error' '403': description: Vault product not enabled. content: application/json: schema: $ref: '#/definitions/error' '404': description: Resource not found. content: application/json: schema: $ref: '#/definitions/error' '500': description: Internal server or service error. content: application/json: schema: $ref: '#/definitions/error' x-code-samples: - lang: cURL source: | curl -X DELETE \ https://api-homologacao.getnet.com.br/v1/subscriptions/5d740ea0-b7d1-42f5-ad64-5a5521e12er9/floating \ -H 'authorization: Bearer 72402c54-6bd3-4895-a6b4-adfded0c11dc' \ -H 'seller_id: 7ea44e22-2af3-40a1-a10e-9bb6ebdb9892' -H 'username: Usuario' patch: summary: Adds new date and/or amount changes to charges for a subscription. description: |- On this endpoint you can add new date and/or amount changes to charges for a specific subscription. This endpoint can be used for subscriptions that already have date and value changes registered. To use this endpoint, the establishment must be enabled for this specific product. For more details see the Date Change Rules. tags: - Subscriptions parameters: - required: true description: Content type. schema: 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*
Where *AuthString* is the access token obtained from the authentication endpoint. schema: type: string name: Authorization in: header - required: true description: E-commerce identification code. name: seller_id schema: type: string format: uuidv4 minLength: 36 maxLength: 36 in: header - required: true description: Recurrence signature identifier. name: subscription_id schema: type: string minLength: 36 maxLength: 36 format: uuidv4 in: path - required: false description: User who is registering. This information may be used for auditing purposes. schema: type: string name: username in: header requestBody: description: Request containing data for adding date and/or value changes for certain charges. content: application/json: schema: $ref: '#/definitions/subscription_floating_data_array_creation' responses: '200': description: Date and value changes entered successfully. content: application/json: schema: $ref: '#/definitions/subscription_floating_data_response' '400': description: Invalid request. content: application/json: schema: $ref: '#/definitions/error' '401': description: Invalid authentication. content: application/json: schema: $ref: '#/definitions/error' '403': description: Recurrence product not enabled. content: application/json: schema: $ref: '#/definitions/error' '404': description: Not found. content: application/json: schema: $ref: '#/definitions/error' '422': description: Invalid request. content: application/json: schema: $ref: '#/definitions/error' '500': description: Internal server or service error. content: application/json: schema: $ref: '#/definitions/error' x-code-samples: - lang: cURL source: | curl -X PATCH \ https://api-homologacao.getnet.com.br/v1/subscriptions/5d740ea0-b7d1-42f5-ad64-5a5521e12er9/floating \ -H "content-type: application/json; charset=utf-8" \ -H "authorization: Bearer 72402c54-6bd3-4895-a6b4-adfded0c11dc" \ -H "seller_id: 7ea44e22-2af3-40a1-a10e-9bb6ebdb9892" -H "username: Usuario" \ -d "[ { \"installment\": 6, \"new_amount\": 7888, \"new_scheduled_date\": \"2020-08-26\" } ]" /v1/subscriptions/{subscription_id}/floating/installment/{installment}: delete: summary: Removes the date and amount change for a specific charge from a subscription. description: In this endpoint you can remove all date and amount changes for a specific charge for a subscription. The charge will remain with the original amounts and dates according to the associated plan. To use this endpoint, the establishment must be enabled for this specific product. tags: - Subscriptions parameters: - required: true description: | Authorization: Bearer *AuthString*
Where *AuthString* is the access token obtained from the authentication endpoint. schema: type: string name: Authorization in: header - required: true description: E-commerce identification code. name: seller_id schema: type: string format: uuidv4 minLength: 36 maxLength: 36 in: header - required: true description: Recurrence signature identifier. schema: type: string minLength: 36 maxLength: 36 format: uuidv4 name: subscription_id in: path - required: true description: Number of the installment that will be applied to the change. schema: type: integer minimum: 1 format: int32 name: installment in: path - required: false description: User who is registering. This information may be used for auditing purposes. schema: type: string name: username in: header responses: '200': description: Date and value changes have been partially removed. content: application/json: schema: $ref: '#/definitions/subscription_floating_data_remove_response' '204': description: Date and value changes were successfully removed. '400': description: Invalid request. content: application/json: schema: $ref: '#/definitions/error' '401': description: Invalid authentication. content: application/json: schema: $ref: '#/definitions/error' '403': description: Vault product not enabled. content: application/json: schema: $ref: '#/definitions/error' '404': description: Resource not found. content: application/json: schema: $ref: '#/definitions/error' '500': description: Internal server or service error. content: application/json: schema: $ref: '#/definitions/error' x-code-samples: - lang: cURL source: | curl -X DELETE \ https://api-homologacao.getnet.com.br/v1/subscriptions/5d740ea0-b7d1-42f5-ad64-5a5521e12er9/floating\installment\3 \ -H "content-type: application/json; charset=utf-8" \ -H "authorization: Bearer 72402c54-6bd3-4895-a6b4-adfded0c11dc" \ -H "seller_id: 7ea44e22-2af3-40a1-a10e-9bb6ebdb9892" -H "username: Usuario" \ put: summary: Updates the date and amount for a specific charge for a subscription. description: |- On this endpoint you can update the date and amount for a specific subscription charge. This endpoint can be used for a specific charge that already has a date and value registered. To use this endpoint, the establishment must be enabled for this specific product. For more details see the Date Change Rules. tags: - Subscriptions parameters: - required: true description: | Authorization: Bearer *AuthString*
Where *AuthString* is the access token obtained from the authentication endpoint. schema: type: string name: Authorization in: header - required: true description: E-commerce identification code. name: seller_id schema: type: string format: uuidv4 minLength: 36 maxLength: 36 in: header - required: true description: Recurrence signature identifier. name: subscription_id schema: type: string minLength: 36 maxLength: 36 format: uuidv4 in: path - required: true description: Number of the installment that will be applied to the change. schema: type: integer minimum: 1 format: int32 name: installment in: path - required: false description: User who is registering. This information may be used for auditing purposes. schema: type: string name: username in: header requestBody: description: Data for updating the date and/or value of a specific charge. content: application/json: schema: $ref: '#/definitions/subscription_floating_data_update' responses: '200': description: Date and value changes entered successfully. content: application/json: schema: $ref: '#/definitions/subscription_floating_data_response' '400': description: Invalid request. content: application/json: schema: $ref: '#/definitions/error' '401': description: Invalid authentication. content: application/json: schema: $ref: '#/definitions/error' '403': description: Recurrence product not enabled. content: application/json: schema: $ref: '#/definitions/error' '404': description: Not found. content: application/json: schema: $ref: '#/definitions/error' '422': description: Invalid request. content: application/json: schema: $ref: '#/definitions/error' '500': description: Internal server or service error. content: application/json: schema: $ref: '#/definitions/error' x-code-samples: - lang: cURL source: | curl -X PUT \ https://api-homologacao.getnet.com.br/v1/subscriptions/5d740ea0-b7d1-42f5-ad64-5a5521e12er9/floating/installment/3 \ -H "content-type: application/json; charset=utf-8" \ -H "authorization: Bearer 72402c54-6bd3-4895-a6b4-adfded0c11dc" \ -H "seller_id: 7ea44e22-2af3-40a1-a10e-9bb6ebdb9892" -H "username: Usuario" \ -d "{\"new_amount\": 3219, \"new_scheduled_date\": \"2020-10-17\"}" /v1/subscriptions/{subscription_id}/plans/migration: post: summary: Changing a Subscription Plan. description: In this endpoint you can request to change the Plan of a specific Subscription. tags: - Subscriptions parameters: - required: true description: | Authorization: Bearer *AuthString*
Where *AuthString* is the access token obtained from the authentication endpoint. schema: type: string name: Authorization in: header - required: true description: E-commerce identification code. name: seller_id schema: type: string format: uuidv4 minLength: 36 maxLength: 36 in: header - required: true schema: type: string name: subscription_id in: path - required: false description: User who is registering. This information may be used for auditing purposes. schema: type: string name: username in: header requestBody: content: application/json: schema: $ref: '#/definitions/plan_migration_request' responses: '200': description: Signature migrated successfully. content: application/json: schema: $ref: '#/definitions/subscription_response' '400': description: Invalid request. content: application/json: schema: $ref: '#/definitions/error' '404': description: Not found. content: application/json: schema: $ref: '#/definitions/error' '500': description: Internal server or service error. content: application/json: schema: $ref: '#/definitions/error' x-code-samples: - lang: cURL source: | curl -X POST \ https://api-homologacao.getnet.com.br/v1/subscriptions/9aca75f2-bb03-42d7-aa09-7e46409ded26/plans/migration \ -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' -H 'username: Usuario' \ -d '{ \"from\": \"9aca75f2-bb03-42d7-aa09-7e46409ded26\", \"to\": \"a0ca3090-a4f6-4e1f-a91d-a535454dd72b\" }' /v1/charges: get: summary: billing list description: In this endpoint you can list the registered charges based on the chosen filters tags: - Subscriptions parameters: - required: true description: | Authorization: Bearer *AuthString*
Where *AuthString* is the access token obtained from the authentication endpoint. schema: type: string name: Authorization in: header - required: true description: E-commerce identification code. name: seller_id schema: type: string format: uuidv4 minLength: 36 maxLength: 36 in: header - required: true description: Number of the page where pagination starts. schema: minimum: 1 type: number name: page in: query - required: true description: Limit of results per page. schema: minimum: 0 maximum: 9999 type: number name: limit in: query - required: false description: Identifier of the charge. name: charge_id schema: type: string minLength: 36 maxLength: 36 format: uuidv4 in: query - required: false description: E-commerce identification code. name: seller_id schema: type: string format: uuidv4 minLength: 36 maxLength: 36 in: query - required: false description: Recurrence signature identifier. name: subscription_id schema: type: string minLength: 36 maxLength: 36 format: uuidv4 in: query - required: false description: Billing status. schema: enum: - paid - denied - processing - scheduled - canceled type: string name: status in: query - required: false description: Start date. schema: type: string name: start_date in: query - required: false description: End date. schema: type: string name: end_date in: query - required: false description: Appointment date. schema: type: string name: scheduled_date in: query - required: false description: Number of retries. schema: minimum: 0 type: number name: retries in: query - required: false description: Field to carry out the ordering. schema: default: create_date enum: - create_date - installment - scheduled_date type: string name: sort in: query - required: false description: Sort type. Ascending or Descending. schema: enum: - asc - desc type: string name: sort_type in: query responses: '200': description: Returns the list of charges. content: application/json: schema: $ref: '#/definitions/charge_filter_response' '400': description: Invalid request. content: application/json: schema: $ref: '#/definitions/error' '401': description: Invalid authentication. content: application/json: schema: $ref: '#/definitions/error' '403': description: Recurrence product not enabled. content: application/json: schema: $ref: '#/definitions/error' '404': description: Not found. content: application/json: schema: $ref: '#/definitions/error' '500': description: Internal server or service error. content: application/json: schema: $ref: '#/definitions/error' x-code-samples: - lang: cURL source: | curl -X GET \ https://api-homologacao.getnet.com.br/v1/charges?page=1&limit=10 \ -H 'authorization: Bearer 72402c54-6bd3-4895-a6b4-adfded0c11dc' \ -H 'seller_id: 6eb2412c-165a-41cd-b1d9-76c575d70a28' /v1/cards/binlookup/{bin}: get: tags: - BIN Search summary: Returns the information of a Bin. description: This endpoint returns information from a BIN such as the name of the flag, flag code, issuing country, etc." operationId: consultaBinUsingGET parameters: - required: true description: | Authorization: Bearer *AuthString*
Onde *AuthString* is access token obtained from authentication endpoint. schema: type: string name: Authorization in: header - required: true name: bin in: path description: bin schema: type: string responses: '200': description: Returns the list of found BINs. content: application/json: schema: $ref: '#/definitions/consulta_bin_response' '401': description: Invalid authentication. content: application/json: schema: $ref: '#/definitions/error' '404': description: Not found. content: application/json: schema: $ref: '#/definitions/error' '500': description: Internal server or service error. content: application/json: schema: $ref: '#/definitions/error' deprecated: false /v1/cards: post: summary: Stores consumer card data in the vault description: Creates a cards resource within the Getnet digital platform from the consumer's card data, for use in future payments. tags: - Vault parameters: - in: header name: Content-type required: true schema: type: string enum: - application/json; charset=utf-8 default: application/json; charset=utf-8 description: | Content-type. - in: header name: Authorization required: true schema: type: string description: | Authorization: Bearer *AuthString*
Where *AuthString* is the access token obtained from the authentication endpoint. - in: header name: seller_id required: false schema: type: string minLength: 36 maxLength: 36 format: uuidv4 description: | Authorization: E-commerce identification code. requestBody: required: true description: Request containing card data to be saved in the vault. content: application/json: schema: $ref: '#/definitions/vault_card' responses: '201': description: Card identifier successfully created. Card saved in safe. content: application/json: schema: type: object properties: card_id: type: string description: Card identifier saved in the 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: Token of the card that will be used in transactions. example: dfe05208b105578c070f806c80abd3af09e246827d29b866cf4ce16c205849977c9496cbf0d0234f42339937f327747075f68763537b90b31389e01231d4d13c minLength: 128 maxLength: 128 '400': description: Invalid request. content: application/json: schema: $ref: '#/definitions/error' '401': description: Invalid Authentication. content: application/json: schema: $ref: '#/definitions/error' '403': description: Safe product not enabled. content: application/json: schema: $ref: '#/definitions/error' '404': description: Not found. content: application/json: schema: $ref: '#/definitions/error' '500': description: Internal server or service error. content: application/json: 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": "28", "customer_id": "customer_21081826", "cardholder_identification": "12345678912" }' get: summary: List of cards saved in the vault description: Returns a list of saved cards based on buyer identification data - customer_id. tags: - Vault parameters: - required: true description: | Authorization: Bearer *AuthString*
Where *AuthString* is the access token obtained from the authentication endpoint. schema: type: string name: Authorization in: header - in: header name: seller_id required: false schema: type: string minLength: 36 maxLength: 36 format: uuidv4 description: | Authorization: E-commerce identification code. Mandatory when the customer is treated as a Platform. - required: true description: Buyer identifier. Information defined by the application that consumes the Digital Platform API. schema: type: string maxLength: 100 name: customer_id in: query - required: false description: Returned cards status filter. If no filter is entered, active and renewed cards will be returned. schema: type: string maxLength: 25 enum: - all - active - renewed name: status in: query responses: '200': description: List of saved cards. content: application/json: schema: type: object properties: cards: type: array items: $ref: '#/definitions/vault_card_response' '400': description: Invalid request. content: application/json: schema: $ref: '#/definitions/error' '401': description: Invalid authentication. content: application/json: schema: $ref: '#/definitions/error' '403': description: Safe product not enabled. content: application/json: schema: $ref: '#/definitions/error' '404': description: Not found. content: application/json: schema: $ref: '#/definitions/error' '500': description: Internal server or service error. content: application/json: 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 card saved in the vault description: Gets the data of the card saved in the vault, from the card_id generated when the card is stored. tags: - Vault parameters: - required: true description: | Authorization: Bearer *AuthString*
Where *AuthString* is the access token obtained from the authentication endpoint. schema: type: string name: Authorization in: header - in: header name: seller_id required: false schema: type: string minLength: 36 maxLength: 36 format: uuidv4 description: | Authorization: E-commerce identification code. Mandatory when the customer is treated as a Platform. - required: true description: Unique identifier of the card on the Getnet digital platform. schema: type: string maxLength: 36 name: card_id in: path responses: '200': description: Card data. content: application/json: schema: $ref: '#/definitions/vault_card_response' '400': description: Invalid Request content: application/json: schema: $ref: '#/definitions/error' '401': description: Invalid authentication. content: application/json: schema: $ref: '#/definitions/error' '403': description: Safe product not enabled. content: application/json: schema: $ref: '#/definitions/error' '404': description: Not found content: application/json: schema: $ref: '#/definitions/error' '500': description: Internal server or service error. content: application/json: 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 card saved in the vault description: Removes a card saved on the Getnet digital platform, from the card_id. tags: - Vault parameters: - required: true description: | Authorization: Bearer *AuthString*
Where *AuthString* is the access token obtained from the authentication endpoint. schema: type: string name: Authorization in: header - in: header name: seller_id required: false schema: type: string minLength: 36 maxLength: 36 format: uuidv4 description: | Authorization: E-commerce identification code. Mandatory when the customer is treated as a Platform. - required: true description: Unique identifier of the card on the Getnet digital platform. schema: type: string maxLength: 36 name: card_id in: path responses: '204': description: Card removed successfully. '400': description: Invalid request. content: application/json: schema: $ref: '#/definitions/error' '401': description: Invalid authentication. content: application/json: schema: $ref: '#/definitions/error' '403': description: Safe product not enabled. content: application/json: schema: $ref: '#/definitions/error' '404': description: Resource not found. content: application/json: schema: $ref: '#/definitions/error' '500': description: Internal server or service error. content: application/json: 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' definitions: vault_card: type: object Description: Card Dice Set. mandatory: - number_token - expiration_month - expiration_year - customer_id properties: number_token: type: string description: Tokenized card number. Generated through the /v1/tokens/card endpoint. example: dfe05208b105578c070f806c80abd3af09e246827d29b866cf4ce16c205849977c9496cbf0d0234f42339937f327747075f68763537b90b31389e01231d4d13c Minimum length: 128 max length: 128 brand: type: string description: Card Banner. Automatically populated by the API if not informed. max length: 50 enumeration: - Mastercard - Visa - Amex - ELO - Hipercard example: mastercard cardholder_name: type: string description: 'Buyers name printed on card. ' maxlength: 26 Example: JOÃO DA SILVA expiration_month: type: string description: Two-digit card expiry month. minlength: 2 maxlength: 2 example: '12' expiration_year: type: string description: Two-digit card expiry year. minlength: 2 maxlength: 2 example: '28' customer_id: type: string description: | Buyer identifier. Information defined by the application that consumes the API of the Digital Platform. Only alphanumeric data is allowed in this field. The following special characters must not be used: %$, . / & ( ) + = = < > - * example: customer_21081826 maxLength: 100 cardholder_identification: type: string description: Buyer identification, such as CPF or RG. (without mask) example: '12345678912' verify_card: type: boolean description: Performs a transaction that verifies that the card entered is not cancelled, 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: Identifier of the card 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: 'Card expiry month with two digits. ' example: '12' minLength: 2 maxLength: 2 expiration_year: type: string description: Two-digit card expiry year. example: '28' minLength: 2 maxLength: 2 brand: type: string description: Flag. (Also used in anti-fraud). example: mastercard enum: - Mastercard - Visa - Amex - Link - Hipercard maxLength: 50 cardholder_name: type: string description: Buyer's name printed on the card. example: JOAO DA SILVA maxLength: 26 customer_id: type: string description: | Buyer identifier. It can be any information that identifies your consumer, such as an identification document, email or even an internal id of your system. example: customer_21081826 maxLength: 100 number_token: type: string description: Tokenized card number. Generated through the /v1/tokens/card endpoint. example: dfe05208b105578c070f806c80abd3af09e246827d29b866cf4ce16c205849977c9496cbf0d0234f42339937f327747075f68763537b90b31389e01231d4d13c minLength: 128 maxLength: 128 used_at: type: string description: Last used date. example: '2017-04-19T16:30:30Z' format: YYYY-MM-DDTHH:MM:SSZ minLength: 24 maxLength: 24 created_at: type: string description: Creation date. example: '2017-04-19T16:30:30Z' format: YYYY-MM-DDTHH:MM:SSZ minLength: 24 maxLength: 24 updated_at: type: string description: Updated date. example: '2017-04-19T16:30:30Z' format: YYYY-MM-DDTHH:MM:SSZ minLength: 24 maxLength: 24 status: type: string description: Status of the card in the vault. enum: - active - blocked - canceled - renewed example: active maxLength: 20 empty: type: object properties: {} 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' consulta_bin_response: type: object properties: results: type: array items: $ref: '#/definitions/results' status: description: BIN Status return message. type: string title: consulta_bin_response xml: name: consulta_bin_response attribute: false wrapped: false results: type: object description: BIN information list. properties: bin: type: integer description: BIN of the query. brand: type: string description: Flag name. brand_code: type: integer description: Flag code. brazilian_issued: type: string description: Informs if the sender is from Brazil. country: type: string description: Country name. country_code: type: string description: Numeric country code. country_code_iso: type: string description: ISO_3166-1 country code. issuer: type: string description: Name of issuer. product: type: string description: Product linked to the BIN. type: type: string description: BIN type (credit, debit, prepaid). enum: - credit - debit - prepaid title: results xml: name: results attribute: false wrapped: false realeseResponse: type: object properties: success: type: string description: Indicates whether the release was successful. example: true errors: type: array description: Array of errors. items: type: object properties: code_error: description: Error code if any. type: string example: 0 message: type: string description: Error message. example: string DefaultErrorHttpResponse: type: object properties: message: maxLength: 250 type: string description: Detailed error message. name: maxLength: 250 type: string description: Name of the module or system where the error occurred. status_code: type: integer description: HTTP status code of the error. format: int32 details: type: array description: Error details. items: $ref: '#/definitions/ErrorDetail' ErrorDetail: type: object properties: status: type: string description: Error status. default: DENIED error_code: type: string description: Error code. description: type: string description: Error description. description_detail: type: string description: Detailed description of the error. description: Detalhes do erro. OrderItemReleaseDTO: type: object required: - id - amount properties: id: type: string description: Dataset ID. example: MR1 amount: type: integer description: Purchase amount in cents format: int32 example: 118708 description: Dataset containing the order items. ReleaseDTO: type: object required: - release_payment_date - subseller_id - order_item_release properties: release_payment_date: type: string description: Payment Release Date for the seller (SubSeller). example: '2023-12-23T12:00:00.000' subseller_id: type: string description: ID of the subseller registered on the marketplace platform (MGM). example: '700104158' order_item_release: $ref: '#/definitions/OrderItemReleaseDTO' CancelRequestDTO: type: object properties: marketplace_subseller_payments: type: array items: $ref: '#/definitions/MarketplaceSubsellerPayment' payment_id: type: string amount: type: integer description: Valor da compra em centavos cancel_amount: type: integer format: int32 combined_id: type: string is_combined: type: boolean internal: $ref: '#/definitions/InternalDTO' cancel_custom_key: type: string InternalDTO: type: object properties: parameters: type: object additionalProperties: type: object card_brand: type: string MarketplaceSubsellerPayment: type: object properties: subseller_sales_amount: type: integer format: int32 subseller_id: type: string order_items: type: array items: $ref: '#/definitions/OrderItem' OrderItem: type: object properties: amount: type: integer description: Purchase amount in cents currency: type: string id: type: string description: type: string tax_percent: type: number format: double tax_amount: type: integer format: int32 items_array: type: array description: Set of data describing the purchase items. items: type: object properties: name: type: string description: Product Name
Required field for Antifraud example: Stanley black 473ML thermal cup price: type: integer description: Unit price in cents.
Required field for Antifraud example: 139.9 quantity: type: integer description: Number of items for this product.
Required field for Antifraud example: 1 sku: type: string description: Code of the item in the store (Stock Keeping Unit (SKU)).
Required field for Antifraud example: XXX-00-XXX-00 items: type: object properties: id: type: string example: 101803 name: type: string example: THERMAL CUP 473ML BLACK STANLEY price: type: string example: 139.9 quantity: type: string example: 1 discount: type: string example: 0 deliveryType: type: string example: PAC categoryId: type: string example: 913 sellerId: type: string example: MSC002 taxValue: type: string example: 0 taxRate: type: string example: 0 CapturetDTO: type: object required: - payment_id - idempotency_key - payment_method properties: idempotency_key: type: string description: Idempotency key, used to control requests, must be unique per request, because if it is repeated, it will always be returned the same data. minLength: 1 maxLength: 64 example: 1eb2412c-165a-41cd-b1d9-76c575d70a21 request_id: type: string description: Identifier of the request. Unique for each request. If not informed, it will be generated automatically. example: 449474ed-fd5a-421c-9108-9ecedcf02499 maxLength: 36 minLength: 36 format: uuidv4 payment_id: type: string description: Payment identifier example: a183f814-8c4c-47b8-8dcf-7a480bec7d7c amount: type: integer description: Amount equal to or less than the original transaction in cents example: 118708 payment_method: type: string description: Payment method enum: - CREDIT_AUTHORIZATION - CREDIT_PRE_AUTHORIZATION default: CREDIT_AUTHORIZATION example: CREDIT_AUTHORIZATION CaptureResponseDTO: type: object properties: idempotency_key: type: string description: Idempotency key, used to control requests, must be unique per request, because if it is repeated, it will always be returned the same data. example: 1eb2412c-165a-41cd-b1d9-76c575d70a21 seller_id: type: string description: E-commerce identification code. example: 6eb2412c-165a-41cd-b1d9-76c575d70a28 request_id: type: string description: Identifier of the request. Unique for each request. If not informed, it will be generated automatically. example: 449474ed-fd5a-421c-9108-9ecedcf02499 maxLength: 36 minLength: 36 format: uuidv4 payment_id: type: string description: Payment identifier example: a183f814-8c4c-47b8-8dcf-7a480bec7d7c order_id: type: string description: Purchase identification code used by the e-commerce example: 6d2e4380-d8a3-4ccb-9138-c289182818a3 amount: type: integer description: Amount equal to or less than the original transaction in cents example: 118708 currency: type: string description: Currency identification (See code at "https://www.currency-iso.org/en/home/tables/table-a1.html"). example: BRL status: type: string description: Transaction status. example: CAPTURED reason_code: type: string description: Return code. example: 0 reason_message: type: string description: Return message. example: transaction approved captured_at: type: string description: Capture date. format: YYYY-MM-DDTHH:mm:ss.SSSZ example: '2018-07-22T18:47:32.270Z' CancelDTO: type: object required: - idempotency_key - payment_id - payment_method properties: idempotency_key: type: string description: Idempotency key, used to control requests, must be unique per request, because if it is repeated, it will always be returned the same data. minLength: 1 maxLength: 64 example: 1eb2412c-165a-41cd-b1d9-76c575d70a21 request_id: type: string description: Identifier of the request. Unique for each request. If not informed, it will be generated automatically. example: 05b1d7f6-532b-41d5-ac17-c1913f84919b maxLength: 36 minLength: 36 format: uuidv4 payment_id: type: string description: Payment identifier example: 78ab3a70-ea73-4cbf-904a-5fd7b0184492 additional_data: type: object description: Additional cancellation data.
Required field for Payment Split. properties: split: $ref: '#/components/schemas/split_data' amount: type: integer format: int32 description: Value (less than or equal) of the purchase in cents. Partial cancellation (of lower value) is allowed only from the day following the transaction (D+N) example: 118708 payment_method: type: string description: Payment method enum: - CREDIT - DEBIT - CREDIT_AUTHORIZATION - CREDIT_PRE_AUTHORIZATION default: CREDIT_AUTHORIZATION example: CREDIT_AUTHORIZATION custom_key: type: string description: Customer key used to identify a cancellation request. (Key must be unique per transaction). minLength: 3 maxLength: 32 CancelResponseDTO: type: object properties: idempotency_key: type: string description: Idempotency key, used to control requests, must be unique per request, because if it is repeated, it will always be returned the same data. seller_id: type: string request_id: type: string description: Identifier of the request. Unique for each request. If not informed, it will be generated automatically. example: 449474ed-fd5a-421c-9108-9ecedcf02499 maxLength: 36 minLength: 36 format: uuidv4 payment_id: type: string description: Payment identifier example: a183f814-8c4c-47b8-8dcf-7a480bec7d7c order_id: type: string description: Purchase identification code used by the e-commerce amount: type: integer description: Amount equal to or less than the original transaction in cents example: 118708 currency: type: string description: Currency identification (See code at "https://www.currency-iso.org/en/home/tables/table-a1.html"). example: BRL status: type: string description: Transaction status. reason_code: type: string description: Return code. example: 0 reason_message: type: string description: Return message. example: transaction approved canceled_at: type: string description: Transaction cancellation date/time. format: YYYY-MM-DDTHH:mm:ss.SSSZ example: '2018-07-22T18:47:32.270Z' custom_key: type: string description: Customer key used to identify a cancellation request. (Key must be unique per transaction). example: 4ec33ee18f9e45bfb73c5c30667f9006 address_credit: type: object description: Set of data referring to the buyer's address properties: street: type: string description: Address.
Required field for Antifraud maxLength: 60 example: Av. Brasil number: type: string description: Street number.
Mandatory field for Antifraude maxLength: 10 example: '1000' complement: type: string description: Address complement.
Required field for Antifraude maxLength: 60 example: Room 1 district: type: string description: Neighborhood. maxLength: 40 example: Sao Geraldo city: type: string description: City.
Required field for Antifraud maxLength: 40 example: Porto Alegre state: type: string description: State (UF).
Mandatory field for Anti-fraud maxLength: 20 example: RS country: type: string description: Country.
Required field for Antifraud maxLength: 20 example: Brazil postal_code: type: string description: Postal Code, CEP in Brazil or ZIP in the United States. (without mask)
Required field for Antifraud maxLength: 8 example: '90230060' BillingAddressDTO: type: object description: Billing address data set properties: street: type: string description: Address.
Required field for Antifraud maxLength: 60 example: Av. Brazil number: type: string description: Street number.
Required field for Antifraud maxLength: 10 example: '1000' complement: type: string description: Complement of the street.
Required field for Antifraud maxLength: 60 example: Room 1 district: type: string description: Neighborhood. maxLength: 40 example: Sao Geraldo city: type: string description: City.
Required field for Antifraud maxLength: 40 example: Porto Alegre state: type: string description: State (UF).
Mandatory field for Anti-fraud maxLength: 20 example: RS country: type: string description: Country.
Required field for Antifraud maxLength: 20 example: Brazil postal_code: type: string description: Postal Code, CEP in Brazil or ZIP in the United States. (without mask)
Required field for Antifraud maxLength: 8 example: '90230060' BoletoDTO: type: object properties: our_number: type: string document_number: type: string description: Buyer's document number without punctuation. (without mask) instructions: type: string provider: type: string expiration_date: type: string guarantor_dame: type: string guarantor_document_type: type: string guarantor_document_number: type: string CardDTO: type: object required: - expiration_month - expiration_year - cardholder_name properties: number: type: string description: Card number (send only when the field number_token is not sent). maxLength: 36 example: '4012001037141112' expiration_month: type: string description: Two-digit card expiry month. maxLength: 2 example: '12' expiration_year: type: string description: Two-digit card expiry year. maxLength: 2 example: '30' cardholder_name: type: string description: Buyer's name printed on the card.
Mandatory field for Antifraude maxLength: 26 example: Roland Deschain security_code: type: string description: Security code. CVV or CVC.
Mandatory field for Antifraude maxLength: 4 minLength: 3 example: '517' brand: type: string description: Card flag. Automatically populated by the API if not informed.
Mandatory field for Antifraude enum: - MASTERCARD - VISA - AMEX - ELO - HIPERCARD maxLength: 50 example: Visa number_token: type: string description: Tokenized card number (send only when the number field is not sent). maxLength: 128 minLength: 128 example: e71084449bc70e344f77d4c382704ea2868b5e9775dced7ffcd40b3f66b167f51e352a2f289b518a11180c81478dfbdbeffd8a41f0b34564f2f0e41be8a88e11 description: Card data set. CustomerDTO: properties: first_name: type: string description: Buyer's first name.
Required field for Antifraud maxLength: 40 example: John last_name: type: string description: Buyer's last name.
Required field for Anti-fraud maxLength: 80 example: da Silva name: maxLength: 40 type: string description: Buyer's full name. Required for ticket. example: João da Silva document_type: type: string description: Type of the buyer's identification document. Mandatory for boleto.
Mandatory field for Antifraud maxLength: 26 example: CPF enum: - CPF - CNPJ document_number: type: string description: Purchaser's document number without punctuation. (without mask)
Required field for Antifraud minLength: 11 maxLength: 15 example: '12345678912' email: type: string description: Buyer's email.
Required field for Antifraud format: email example: customer@email.com.br phone_number: type: string description: Buyer's phone. (without mask)
Required field for Antifraud maxLength: 15 example: '5551999887766' billing_address: $ref: '#/components/schemas/address_boleto' description: Set of data referring to the buyer. DataDTO: description: Data for carrying out an authorization. type: object required: - amount - order - payment properties: amount: type: integer format: int32 description: Purchase amount in cents example: 118708 currency: type: string description: Currency identification (See code at "https://www.currency-iso.org/en/home/tables/table-a1.html").
Mandatory field for Antifraud example: BRL enum: - BRL customer_id: type: string description: Buyer identifier. Information defined by the application that consumes the Digital Platform api.
Mandatory field for Antifraud example: test payment: $ref: '#/definitions/PaymentDataDTO' sub_merchant: $ref: '#/definitions/SubMerchantDTO' additional_data: type: object description: Additional authorization data. Required field for payment split. required: - billing_address - shippings - customer properties: split: $ref: '#/components/schemas/split_data' device: $ref: '#/definitions/DeviceDTO' customer: $ref: '#/definitions/CustomerDTO' order: $ref: '#/definitions/OrderDTO' FundTransferDTO: type: object properties: pay_action: type: string receiver: $ref: '#/definitions/ReceiverDTO' OrderDTO: type: object properties: items: type: object $ref: '#/definitions/items_array' description: Purchase identification data set PaymentDTO: type: object required: - idempotency_key - request_id - order_id - data properties: idempotency_key: type: string description: Idempotency key, used to control requests, must be unique per request, because if it is repeated, it will always be returned the same data. minLength: 1 maxLength: 64 example: 1eb2412c-165a-41cd-b1d9-76c575d70a21 request_id: type: string description: Identifier of the request. Unique for each request. If not informed, it will be generated automatically. example: 20bde238-08f5-41a8-9925-8095b1b1db76 maxLength: 36 minLength: 36 format: uuidv4 order_id: type: string description: Purchase identification code used by the e-commerce (code or order number). maxLength: 36 example: 63c7f8ee-51a6-470d-bb76-ef762b62bfb7 data: $ref: '#/definitions/DataDTO' PaymentAdjustmentDTO: type: object required: - idempotency_key - request_id - order_id - data properties: idempotency_key: type: string description: Idempotency key, used to control requests, must be unique per request, because if it is repeated, it will always be returned the same data. minLength: 1 maxLength: 64 example: 1eb2412c-165a-41cd-b1d9-76c575d70a21 request_id: type: string description: Identifier of the request. Unique for each request. If not informed, it will be generated automatically. example: 20bde238-08f5-41a8-9925-8095b1b1db76 maxLength: 36 minLength: 36 format: uuidv4 order_id: type: string description: Purchase identification code used by the e-commerce (code or order number). maxLength: 36 example: 63c7f8ee-51a6-470d-bb76-ef762b62bfb7 data: $ref: '#/definitions/AdjustmentDataDTO' AdjustmentDataDTO: description: Data for carrying out an authorization. type: object required: - amount - order - payment properties: amount: type: integer format: int32 description: Purchase amount in cents example: 118708 currency: type: string description: Currency identification (See code at "https://www.currency-iso.org/en/home/tables/table-a1.html").
Mandatory field for Antifraud example: BRL enum: - BRL customer_id: type: string description: Buyer identifier. Information defined by the application that consumes the Digital Platform api.
Mandatory field for Antifraud example: test payment: $ref: '#/definitions/PaymentAdjustmentDataDTO' sub_merchant: $ref: '#/definitions/SubMerchantDTO' additional_data: type: object description: Additional authorization data. Required field for payment split. required: - billing_address - shippings - customer properties: split: $ref: '#/components/schemas/split_data' device: $ref: '#/definitions/DeviceDTO' customer: $ref: '#/definitions/CustomerDTO' order: $ref: '#/definitions/OrderDTO' PaymentDataDTO: type: object description: Dataset containing order items. required: - payment_id - payment_method - transaction_type - number_installments - card properties: payment_id: type: string description: Payment identification code. maxLength: 36 example: 173f9e8d-4e0b-4503-8016-5cdafba89bee payment_method: type: string description: Transaction type. example: CREDIT enum: - CREDIT - DEBIT - CREDIT_AUTHORIZATION - CREDIT_PRE_AUTHORIZATION 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. Payment in full, in installments without interest, paid in installments with interest. example: FULL enum: - FULL - INSTALL_NO_INTEREST - INSTALL_WITH_INTEREST number_installments: type: integer description: Number of installments for an installment credit transaction. example: 1 soft_descriptor: type: string maxLength: 22 description: |-

Text displayed on the buyer's card invoice, this field is optional, if nothing is informed, the trade name registered for the establishment will be considered. Only alphanumeric data and the following special characters: % $ , . / & ( ) + = < > - * Spaces will be replaced by the character ''*'' The transaction will not be denied if non-allowed characters are sent. Any information that exceeds the maximum size will be disregarded.

Mandatory for Payment and SDWO facilitators. In addition to the above, the following additional rules of the Flags must be followed:

Identification of the Payment Facilitator, with 3, 7 or 12 characters
Separator characters "*" (asterisk)
Sub-trade identification
Example 1: FAC*SUCOMERCIO
Example 2: FACILIT*SUBCOMERCIO
Example 3: FACILITADOR1*SUBCOMERC
Example 4: for SDWO back-to-back: Carteira*Subcomercio
Exemple 5: for SDWO cash-in just fill in the wallet name: Digital Wallet

example: LOJA*TESTE*COMPRA-123 dynamic_mcc: type: number maxLength: 4 minLength: 4 description: Field used to signal the transaction with another Merchant Category Code (Merchant Category Code) different from the registered one. If an invalid MCC is sent, the default will be used. Send numeric data only.

Mandatory for Payment Facilitators and SDWO. example: 1799 card: $ref: '#/definitions/CardDTO' tokenization: $ref: '#/definitions/TokenizationDTO' wallet: $ref: '#/definitions/WalletCreditDTO' xid: type: string description: Field available from version 2.0 onwards. MPI identifier for each authenticated transaction. The field content can be a HEXA or Base64 value, according to the MPI used. maxLength: 40 example: test ucaf: type: string description: Field available from version 2.0 onwards. Authentication code encrypted by the Flag. The field content can be a HEXA or Base64 value, according to the MPI used. maxLength: 40 example: string eci: type: string description: Field available from version 2.0 onwards. ECI code of the 3D Secure Authenticated transaction. Generated by an External MPI. maxLength: 2 example: '00' tdsdsxid: type: string description: 3DS server version 2 transaction identifier. example: string tdsver: type: string description: Indicates the 3DS version used in authentication, example: 2.1.0 credentials_on_file_type: type: string description: |-

Type of COF (Credential On File).

ONE_CLICK: Used when the first transaction (installment) of a normal payment is made.
ONE_CLICK_PAYMENT: Used when making transactions for the remaining installments of a normal payment. Note: It is necessary to inform the transaction_id of the first transaction carried out.
RECURRING: Used when the first transaction (installment) of a recurring payment is made.
RECURRING_PAYMENT: Used when making transactions for the remaining installments of a recurring payment. Note: It is necessary to inform the transaction_id of the first transaction carried out.

Mandatory for Payment and SDWO facilitators. In addition to the above, the following additional rules of the Flags must be followed:

Identification of the Payment Facilitator, with 3, 7 or 12 characters
Separator characters "*" (asterisk)
Sub-trade identification
Example 1: FAC*SUCOMERCIO
Example 2: FACILIT*SUBCOMERCIO
Example 3: FACILITADOR1*SUBCOMERC
Example 4: for SDWO back-to-back: Carteira*Subcomercio
Exemple 5: for SDWO cash-in just fill in the wallet name: Digital Wallet

Type of COF (Credential On File).

ONE_CLICK: Used when the first transaction (installment) of a normal payment is made.
ONE_CLICK_PAYMENT: Used when making transactions for the remaining installments of a normal payment. Note: It is necessary to inform the transaction_id of the first transaction carried out.
RECURRING: Used when the first transaction (installment) of a recurring payment is made.
RECURRING_PAYMENT: Used when making transactions for the remaining installments of a recurring payment. Note: It is necessary to inform the transaction_id of the first transaction carried out.

example: ONE_CLICK_PAYMENT enum: - ONE_CLICK - ONE_CLICK_PAYMENT - RECURRING - RECURRING_PAYMENT transaction_id: type: string description: ID of other transaction which had the same card. This ID will be used as a COF (Credential On File). example: '1002217281190421' ReceiverDTO: type: object properties: account_number: type: string account_type: type: string first_name: type: string description: Buyer's first name. middle_name: type: string last_name: type: string addr_street: type: string addr_city: type: string addr_state: type: string addr_country: type: string addr_postal_code: type: string nationality: type: string phone: type: string date_of_birth: type: string id_type: type: string id_num: type: string SubMerchantDTO: type: object description: In order for Getnet to comply with the rules of the Flags and Arrangements, the Federal Laws and determinations of BACEN (Central Bank of Brazil) for the identification of the final entities (sub-commerces) that make the financial transactions, the Payment Facilitators must send the data of identification of its clients with each transaction sent to Getnet. required: - identification_code - business_name - document_type - document_number - address - city - state - postal_code properties: identification_code: type: string description: ID do Sub-trade. maxLength: 15 example: '9058345' business_name: type: string description: Name of the recipient or Company Name of the Sub-Business. (Must correspond to the existing registration on the gov.br website) example: 'Loja de roupas LTDA' maxLength: 80 document_type: type: string enum: - CPF - CNPJ description: Sub-trade document type example: CNPJ minLength: 3 maxLength: 4 document_number: type: string description: CNPJ or CPF of the Sub-trade. minLength: 11 maxLength: 14 example: '77415914000148' foreign_type: type: string description: |-

There are 3 types of submerchants, which are described as:

F - Full Foreign:
All submerchants are international.
P - Partial Foreign:
Mixed cart with submerchants international and nationals.
D - Full Domestic:
All submerchants are nationals.

enum: - F - P - D example: D minLength: 1 maxLength: 1 address: type: string description: Sub-commerce address. (No commas allowed) example: Dark Tower 207 maxLength: 40 city: type: string description: city of Sub-commerce example: city maxLength: 13 state: type: string description: State (UF) of Sub-commerce example: RS minLength: 2 maxLength: 2 postal_code: type: string description: Postal Code, CEP in Brazil or ZIP in the United States. (without mask) of Sub-commerce example: '90520000' minLength: 8 maxLength: 8 TokenizationDTO: type: object required: - type - cryptogram properties: type: type: string description: tokenization type example: TAVV enum: - UCAF - TAVV cryptogram: type: string description: Value of the cryptogram generated by the TSP (Token Service Provider) example: '0006010865799300000620111679930000000000' eci: type: string description: ECI Indicator (Electronic Commerce Indicator) example: '00' requestor_id: type: string description: Indicates the identifier of the Token requester. example: '1234567' description: Type of cryptogram used by the TSP (Token Service Provider). Values can be - TAVV For Visa and ELO cards; - UCAF For Mastercard brand cards. WalletCreditDTO: type: object description: |-

Fields for compliance with digital wallet rules of the SDWO arrangement - (Staged Digital Wallet Operator). The Model is about digital wallets (Wallets) that accredit merchants to accept their means of payment, similar to the Payment Facilitators model. As for settlement, amounts from payments through the Wallets are sent to the EC Wallet and, secondly, it transfers them to its final sub-trades. Today the model is structured for Visa, Mastercard and Elo. The transactions of a Scaled Digital Wallet (SDWO) basically have two models:

Cash-In: flagged transaction not linked to a purchase:
Topping up Wallet Funds using a Card. E.g.: top up wallet balance via card
Transfer to another person's balance using card

Purchase (also known as back-to-back):
Payment of printed QR Code / wallet owner using card. Ex.: QR Code of the digital wallet printed at the counter and paid by card
Online payment through the logged-in area of the wallet using a card

For Cash-in transactions, in addition to filling in the wallet subgroup tags, it is also necessary to send the dynamic_mcc and soft_descriptor fields present in the payment subgroups present in the “payments” tab of this documentation. For Back-to-Back transactions, in addition to filling in the wallet subgroup tags, dynamic_mcc, with the number that best describes the activity of the sub-merchant that carried out the transaction and soft_descriptor, it is also necessary to fill in the sub_merchant subgroup, informing the respective data of the sub-merchant that carried out the transaction.

For each type of use case, it is necessary to fill in some data available in the list below, in which it is possible to check their respective rules and obligations.

properties: type: type: string description: Wallet Type:

01: MasterPass Wallet
02: Visa Checkout
10: Generic Tokenized Wallet
55: Local Brazil Wallet (SDWO)

maxLength: 2 enum: - '01' - '02' - '10' - '55' example: '55' id: type: string description: Wallet Identification.

- MasterPass:
101 = Wallet Remote
102 = Wallet Remote NFC Payment
- Generic Tokenized Wallet
000 = Unspecified
101 = Wallet Remote
102 = Wallet Remote NFC Payment
103 = Apple Pay
216 = Android Pay
217 = Samsung Pay
327 = MDES for merchants (M4M)
example: '000' default: BRL maxLength: 5 enum: - '000' - '101' - '102' - '103' - '216' - '217' - '327' merchant_id: type: string description: Identification number of the Digital Wallet registered with the flags.
Visa = MVV (Merchant Value Verification) with 6 positions
Mastercard = WID (Wallet ID) with 3 positions
Elo = WID (Wallet ID) with 11 positions
example: '327' maxLength: 12 fund_transfer: type: object description: Data for SDWO (Staged Digital Wallet Operator) array transactions properties: pay_action: type: string description: Financing Type.

FT Funding Transfer – Which must be marked in Funding transactions Cash-in SDWO for all flags.

FP Funding and Purchase – Which must be marked in transactions of Back-to-Back SDWO for all brands.

BP Billpay – Bill payment marking in the Visa CBPS program. enum: - FT - FP - BP example: FT maxLength: 2 receiver: type: object description: Dados Receiver Account properties: account_number: type: string description: Receiver Account Number which can be filled in with one of following values "#NA" or "9999999999999995". necessary the fulfillment only for the Mastercard brand, for Cash-in SDWO transactions, for other brands or padding is optional. example: '9999999999999995' maxLength: 20 account_type: type: string description: Account Type which must be filled with 00.

- 00 - Other (Default, currently the only allowed value)
- 01 — RTN + Bank Account
- 02 — IBAN
- 03 — Card Account (for getnet currently only available type)
- 04 — E-mail
- 05 — Phone Number
- 06 — Bank account number (BAN) + Code
Bank Identification (BIC)
- 07 — Wallet ID
- 08 — Social Network ID
Completion required only for the Mastercard brand for Cash-in SDWO transactions, for other brands, filling is optional enum: - '00' - '01' - '02' - '03' - '04' - '05' - '06' - '07' - '08' example: '00' maxLength: 2 first_name: type: string description: |- Receiver First Name which must be filled in with the first transfer recipient's name. Ex Jane. necessary the padding just for the Mastercard brand for transactions of Cash-in SDWO, for the others flags filling is optional example: Jane maxLength: 35 middle_name: type: string description: 'Receiver Middle Name that must be filled in with the abbreviation the transfer recipient''s middle name. Eg: T. Padding is optional for all flags. minLength: 1 maxLength: 1' example: T last_name: type: string description: 'Receiver Last Name that must be filled in with last name (last name) of the transfer recipient. For example: Smith. Completion only for the Mastercard brand for Cash-in SDWO transactions, for other brands filling is optional' example: Smith maxLength: 35 addr_street: type: string description: 'Receiver Addr Street which must be filled in with the address of the recipient of the transfer (street and number). Eg: 1 Main ST. Padding is optional for all flags.' example: 1 Main ST maxLength: 50 addr_city: type: string description: 'Receiver Addr City which must be filled in with the city of recipient of the transfer. For example: SAO PAULO. Filling it is optional for all flags.' example: SAO PAULO maxLength: 25 addr_state: type: string description: 'Receiver Addr State that must be filled in with the state of the recipient of the transfer. Eg: SP. the filling is optional for all flags.' example: SP maxLength: 3 addr_country: type: string description: Receiver Addr Country which must be filled in with the country of recipient of the transfer. Following the ISO 3166-1 alpha 3 standard. fulfillment only for the Mastercard brand for Cash-in SDWO transactions, for other brands or padding is optional example: BRA maxLength: 3 addr_postal_code: type: string description: 'Receiver Addr Postal Code that must be filled in with the postal code (ZIP code) of the recipient of the transfer. Ex: 01408000. Filling is optional for all flags.' example: '1408000' maxLength: 10 nationality: type: string description: Receiver Nationality which must be filled in with the transfer recipient's nationality. Following the ISO 3166-1 alpha 3 standard. padding is optional for all flags. example: BRA maxLength: 3 phone: type: string description: 'Receiver Phone which must be filled in with the number of Transfer recipient''s phone number, including code from the country. Ex: 5511977778888. Completion is optional for all flags.' example: '5511977778888' maxLength: 20 date_of_birth: type: string description: |- Receiver Date Of Birth which must be filled in with the date of birth of recipient of the transfer with the YYYYMMDD format. Ex 19901230. Filling is optional for all flags. example: '19901230' maxLength: 8 id_type: type: string description: |- Receiver Id Type that must be filled in with the type of document used by the recipient of the transfer (CPF or CNPJ). In this case, fill in 03. The filling out for Mastercard, Visa and Elo brands to Cash-in SDWO transactions, for other brands the filling in is optional.
- 00 = Passport
- 01 = National Identification Card
- 02 = Driver's License
- 03 = Issued by the Government
- 04 = Other
enum: - '00' - '01' - '02' - '03' - '04' example: '03' maxLength: 2 id_num: type: string description: |- Receiver Id Number that must be filled in with the CPF number or CNPJ of the transfer recipient. Ex 12345678900000. Completion required for Mastercard, Visa and Elo brands for Cash-in SDWO transactions, for other brands the filling is optional. example: '12345678900000' maxLength: 25 sender: type: object description: Dados Sender Account properties: account_number: type: string description: Sender Account Number which can be filled in with one of following values "#NA" or "9999999999999995". necessary the fulfillment only for the Mastercard brand, for Cash-in SDWO transactions, for other brands or padding is optional. example: '9999999999999995' maxLength: 20 account_type: type: string description: Account Type which must be filled with 00.

- 00 - Other (Default, currently the only allowed value)
- 01 — RTN + Bank Account
- 02 — IBAN
- 03 — Card Account (for getnet currently only available type)
- 04 — E-mail
- 05 — Phone Number
- 06 — Bank account number (BAN) + Code
Bank Identification (BIC)
- 07 — Wallet ID
- 08 — Social Network ID
Completion required only for the Mastercard brand for Cash-in SDWO transactions, for other brands, filling is optional enum: - '00' - '01' - '02' - '03' - '04' - '05' - '06' - '07' - '08' example: '00' maxLength: 2 first_name: type: string description: |- Sender First Name which must be filled in with the first transfer sender name. Ex Jane. necessary the padding just for the Mastercard brand for transactions of Cash-in SDWO, for the others flags filling is optional example: Jane maxLength: 35 middle_name: type: string description: 'Sender Middle Name that must be filled in with the abbreviation the transfer sender middle name. Eg: T. Padding is optional for all flags. minLength: 1 maxLength: 1' example: T last_name: type: string description: 'Sender Last Name that must be filled in with last name (last name) of the transfer sender. For example: Smith. Completion only for the Mastercard brand for Cash-in SDWO transactions, for other brands filling is optional' example: Smith maxLength: 35 addr_street: type: string description: 'Sender Addr Street which must be filled in with the address of the sender of the transfer (street and number). Eg: 1 Main ST. Padding is optional for all flags.' example: 1 Main ST maxLength: 50 addr_city: type: string description: 'Sender Addr City which must be filled in with the city of sender of the transfer. For example: SAO PAULO. Filling it is optional for all flags.' example: SAO PAULO maxLength: 25 addr_state: type: string description: 'Sender Addr State that must be filled in with the state of the sender of the transfer. Eg: SP. the filling is optional for all flags.' example: SP maxLength: 3 addr_country: type: string description: 'Sender Addr Country which must be filled in with the country of sender of the transfer. Following the ISO 3166-1 alpha 3 standard. fulfillment only for the Mastercard brand for Cash-in SDWO transactions, for other brands or padding is optional' example: BRA maxLength: 3 addr_postal_code: type: string description: 'Sender Addr Postal Code that must be filled in with the postal code (ZIP code) of the sender of the transfer. Ex: 01408000. Filling is optional for all flags.' example: '1408000' maxLength: 10 nationality: type: string description: Sender Nationality which must be filled in with the transfer sender nationality. Following the ISO 3166-1 alpha 3 standard. padding is optional for all flags. example: BRA maxLength: 3 phone: type: string description: 'Sender Phone which must be filled in with the number of Transfer sender phone number, including code from the country. Ex: 5511977778888. Completion is optional for all flags.' example: '5511977778888' maxLength: 20 date_of_birth: type: string description: |- Sender Date Of Birth which must be filled in with the date of birth of sender of the transfer with the YYYYMMDD format. Ex 19901230. Filling is optional for all flags. example: '19901230' maxLength: 8 id_type: type: string description: |- Sender Id Type that must be filled in with the type of document used by the sender of the transfer (CPF or CNPJ). In this case, fill in 03. The filling out for Mastercard, Visa and Elo brands to Cash-in SDWO transactions, for other brands the filling in is optional.
- 00 = Passport
- 01 = National Identification Card
- 02 = Driver's License
- 03 = Issued by the Government
- 04 = Other
enum: - '00' - '01' - '02' - '03' - '04' example: '03' maxLength: 2 id_num: type: string description: |- Sender Id Number that must be filled in with the CPF number or CNPJ of the transfer sender. Ex 12345678900000. Completion required for Mastercard, Visa and Elo brands for Cash-in SDWO transactions, for other brands the filling is optional. example: '12345678900000' maxLength: 25 AutorizationResponseDTO: type: object properties: idempotency_key: type: string description: Idempotency key, used to control requests, must be unique per request, because if it is repeated, the same data will always be returned. example: 1eb2412c-165a-41cd-b1d9-76c575d70a21 seller_id: type: string description: E-commerce identification code. example: 6eb2412c-165a-41cd-b1d9-76c575d70a28 request_id: type: string description: Identifier of the request. Unique for each request. example: 6eb2412c-165a-41cd-b1d9-76c575d70a28 maxLength: 36 minLength: 36 format: uuidv4 payment_id: type: string description: Payment identifier. Unique for each payment. example: 06f256c8-1bbf-42bf-93b4-ce2041bfb87e order_id: type: string description: Purchase identification code used by the e-commerce (code or order number). example: 6d2e4380-d8a3-4ccb-9138-c289182818a3 amount: type: string description: Purchase amount in cents. example: 118708 currency: type: string description: Currency identification (See code at "https://www.currency-iso.org/en/home/tables/table-a1.html"). example: BRL status: type: string description: Transaction status. default: AUTHORIZED example: AUTHORIZED payment_method: type: string description: Transaction type. example: CREDIT_AUTHORIZATION received_at: type: string description: Date and time of payment record. example: '2017-03-19T16:30:30.764Z' transaction_id: type: string description: Authorization transaction code. example: '1002217281190421' original_transaction_id: type: string description: Authorization transaction code. authorized_at: type: string description: Date/time of credit authorization. example: '2017-03-19T16:30:30Z' reason_code: type: string description: Return code from the sender or the getnet capture system. reason_message: type: string description: Return message from the sender or the getnet capture system. example: 0 acquirer: type: string description: Name of the acquirer. example: GETNET soft_descriptor: type: string description: Description for the card invoice. example: Description for invoice brand: type: string description: Flag responsible for processing the transaction. example: conductor authorization_code: type: string description: Authorization code. example: '6964722471672911' acquirer_transaction_id: type: string description: Acquirer transaction code. example: '113880914' eci: type: string description: | Field available from version 2.0 onwards. ECI code of the 3D Secure Authenticated transaction. Generated by an External MPI. example: '01' merchant_advice_code: type: string description: Complementary code to the reason_code exclusive for the Mastercard brand. Its combination with reason_code suggests whether the transaction can be retried or not. example: '210' PreAutorizationResponseDTO: type: object properties: idempotency_key: type: string description: Chave de idempotência, utilizada para controle de requisições, deve ser única por requisição, pois caso se repita, sempre será retornado os mesmos dados. example: 1eb2412c-165a-41cd-b1d9-76c575d70a21 seller_id: type: string description: Código de identificação do e-commerce. example: 6eb2412c-165a-41cd-b1d9-76c575d70a28 payment_id: type: string description: Identificador da pagamento. Único para cada pagamento. example: 06f256c8-1bbf-42bf-93b4-ce2041bfb87e order_id: type: string description: Código de identificação da compra utilizado pelo e-commerce (código ou número do pedido). example: 6d2e4380-d8a3-4ccb-9138-c289182818a3 amount: type: string description: Valor da compra em centavos. example: 118708 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 status: type: string description: Status da transação. default: AUTHORIZED example: AUTHORIZED adjustment_transaction_id: type: string description: Código de ajuste da transação identificado pelo Ecommerce. example: '377241145590926400' received_at: type: string description: Data e hora do registro de pagamento. example: '2017-03-19T16:30:30.764Z' original_transaction_id: type: string description: Código de transação da autorização. authorized_at: type: string description: Data/hora da autorização de crédito. example: '2017-03-19T16:30:30Z' reason_code: type: string description: Código de retorno do emissor ou do sistema de captura da getnet. reason_message: type: string description: Mensagem de retorno do emissor ou do sistema de captura da getnet. example: TRANSACAO EXECUTADA COM SUCESSO acquirer: type: string description: Nome do adquirente. example: GETNET soft_descriptor: type: string description: Descrição para a fatura do cartão. example: Descrição para fatura brand: type: string description: Bandeira resposável pelo o processamento da transação. example: Maestro authorization_code: type: string description: Código de autorização. example: '6964722471672911' acquirer_transaction_id: type: string description: Código de transação do adquirente. example: '113880914' total_installment_amount: $ref: '#/components/schemas/total_installment_amount' first_installment_amount: $ref: '#/components/schemas/first_installment_amount' other_installment_amount: $ref: '#/components/schemas/other_installment_amount' customer_info: type: object description: Buyer dataset. required: - seller_id - first_name - last_name - document_type - document_number properties: seller_id: description: E-commerce identification code. type: string format: uuidv4 minLength: 36 maxLength: 36 example: 6eb2412c-165a-41cd-b1d9-76c575d70a28 customer_id: description: Buyer identifier. If not informed, the system will generate an identifier in uuidv4 format with 36 positions. type: string example: customer_21081826 maxLength: 100 first_name: description: Buyer's first name. type: string maxLength: 40 example: John last_name: description: Buyer's last name. type: string maxLength: 80 example: da Silva document_type: description: Buyer's document type. type: string enum: - CPF - CNPJ example: CPF document_number: description: Buyer's document number. (without mask) type: string minLength: 11 maxLength: 15 example: '12345678912' birth_date: description: Buyer's date of birth. type: string format: YYYY-MM-DD example: '1976-02-21' minLength: 10 maxLength: 10 phone_number: description: Buyer's phone number. (without mask) type: string maxLength: 15 example: '5551999887766' cellphone_number: description: Buyer's cell phone number. (without mask) type: string example: '5551999887766' maxLength: 15 email: description: Buyer's email. type: string format: email example: customer@email.com.br observation: description: Notes. type: string example: The customer is interested in plan x. address: $ref: '#/definitions/address' customer_info_response: description: Buyer dataset. properties: seller_id: description: E-commerce identification code. type: string format: uuidv4 example: 6eb2412c-165a-41cd-b1d9-76c575d70a28 minLength: 36 maxLength: 36 customer_id: description: Buyer identifier. type: string example: customer_21081826 maxLength: 100 first_name: description: Buyer's first name. type: string example: John maxLength: 40 last_name: description: Buyer's last name. type: string example: da Silva maxLength: 80 document_type: description: Buyer's document type. type: string enum: - CPF - CNPJ example: CPF document_number: description: Buyer's document number. (without mask) type: string minLength: 11 maxLength: 15 example: '12345678912' birth_date: description: Buyer's date of birth. type: string format: YYYY-MM-DD example: '1976-02-21' minLength: 10 maxLength: 10 phone_number: description: Buyer's phone number. (without mask) type: string maxLength: 15 example: '5551999887766' cellphone_number: description: Buyer's cell phone number. (without mask) type: string example: '5551999887766' maxLength: 15 email: description: Buyer's email. type: string format: email example: customer@email.com.br observation: description: Notes. type: string example: The customer is interested in plan x. status: description: Status of the buyer's registration. type: string example: success maxLength: 20 address: $ref: '#/definitions/address' customer_filter_response: type: object required: - page - limit - total properties: customers: description: customer list type: array items: $ref: '#/definitions/customer_filter_info_response' page: description: Current page. type: number example: 1 limit: description: Number of records per page. type: number example: 10 total: description: Total registered customers. type: number example: 1 customer_filter_info_response: type: object properties: customer_id: description: Buyer identifier. type: string example: customer_21081826 maxLength: 100 first_name: description: Buyer's first name. type: string example: John maxLength: 40 last_name: description: Buyer's last name. type: string example: da Silva maxLength: 80 document_type: description: Buyer's document type. type: string enum: - CPF - CNPJ example: CPF document_number: description: Buyer's document number. (without mask) type: string example: '12345678912' minLength: 11 maxLength: 15 phone_number: description: Buyer's phone number. (without mask) type: string example: '5551999887766' maxLength: 15 cellphone_number: description: Buyer's cell phone number. (without mask) type: string example: '5551999887766' maxLength: 15 email: description: Buyer's email. type: string format: email example: customer@email.com.br plan: type: object required: - seller_id - name - amount - currency - payment_types - period properties: seller_id: description: E-commerce identification code. type: string minLength: 36 maxLength: 36 format: uuidv4 example: 6eb2412c-165a-41cd-b1d9-76c575d70a28 name: description: Plan name. type: string example: flex plan description: description: Plan description. type: string example: flex plan amount: description: Value of the plan. type: integer example: 19990 currency: description: Currency identification (See code at "https://en.wikipedia.org/wiki/ISO_4217"). type: string minLength: 3 maxLength: 3 example: BRL payment_types: description: Accepted payment types. type: array enum: - - credit_card items: type: string example: - credit_card sales_tax: description: Tax amount. type: integer default: 0 product_type: description: Identifier of the type of product sold among the options. type: string enum: - cash_carry - digital_content - digital_goods - gift_card - physical_goods - renew_subs - shareware - service example: service period: $ref: '#/definitions/period' floating_data: type: array description: Preconfigured list of installments that will have a different value when the Subscription is created. This functionality can be used to create tasting installments with zero value, an entry value or discounted installments. The use of this functionality and its expected purpose will depend on enabling a specific product on Getnet. items: $ref: '#/definitions/plan_floating_data_with_details' plan_update: type: object required: - name - description properties: name: description: Plan name. type: string example: Updated flex plan description: description: Plan description. type: string example: Updated flex plan floating_data: type: array description: Preconfigured list of installments that will have a different value when the Subscription is created. This functionality can be used to create tasting installments with zero value, an entry value or discounted installments. The use of this functionality and its expected purpose will depend on enabling a specific product on Getnet. items: $ref: '#/definitions/plan_floating_data_with_details' plan_floating_data_with_details: type: object required: - installment properties: installment: type: integer format: int32 example: 2 description: Number of the installment to which the change will be applied. minimum: 1 amount: type: integer example: 19990 description: New billing amount for a certain portion of the plan. When a Subscription is created with this Plan, it will have this characteristic, for example, for installment 2, apply the value of R$ 10.00. This value can be zero, greater or less than the original value of the Plan. minimum: 0 plan_filter_response: type: object required: - page - limit - total properties: plans: description: List of registered plans. type: array items: $ref: '#/definitions/plan_filter' page: description: Current page. type: number example: 1 limit: description: Number of records per page. type: number example: 10 total: description: Total registered plans. type: number example: 1 plan_filter: type: object properties: plan_id: description: Plan identifier. type: string format: uuidv4 example: 51995e24-b1ae-4826-8e15-2a568a87abdd minLength: 36 maxLength: 36 name: description: Plan name. type: string example: flex plan status: description: Status of the plan. type: string enum: - active - inactive example: active maxLength: 20 amount: description: Value of the plan. type: integer example: 19990 currency: description: Currency identification (See code at "https://www.currency-iso.org/en/home/tables/table-a1.html"). type: string example: BRL minLength: 3 maxLength: 3 payment_types: description: Accepted payment types. type: array enum: - - credit_card items: type: string example: - credit_card create_date: description: Plan creation date. type: string format: YYYY-MM-DDTHH:MM:SSZ example: '2017-04-19T16:30:30Z' minLength: 24 period: $ref: '#/definitions/period' floating_data: type: array description: Preconfigured list of installments that will have a different value when the Subscription is created. This functionality can be used to create tasting installments with zero value, an entry value or discounted installments. The use of this functionality and its expected purpose will depend on enabling a specific product on Getnet. items: $ref: '#/definitions/plan_floating_data_with_details' plan_response: type: object properties: seller_id: description: E-commerce identification code. type: string format: uuidv4 example: 6eb2412c-165a-41cd-b1d9-76c575d70a28 minLength: 36 maxLength: 36 plan_id: description: Plan identifier. type: string format: uuidv4 example: 51995e24-b1ae-4826-8e15-2a568a87abdd minLength: 36 maxLength: 36 name: description: Plan name. type: string example: flex plan description: description: Plan description. type: string example: flex plan amount: description: Value of the plan. type: integer example: 19990 currency: description: Currency identification (See code at "https://www.currency-iso.org/en/home/tables/table-a1.html"). type: string example: BRL minLength: 3 maxLength: 3 payment_types: description: Accepted payment types. type: string enum: - credit_card items: type: string example: - credit_card sales_tax: description: Tax amount. type: integer default: 0 product_type: description: Identifier of the type of product sold among the options. type: string enum: - cash_carry - digital_content - digital_goods - gift_card - physical_goods - renew_subs - shareware - service example: service create_date: description: Plan creation date. type: string format: YYYY-MM-DDTHH:MM:SSZ example: '2017-04-19T16:30:30Z' maxLength: 24 status: description: Status of the plan. type: string enum: - active - inactive example: active maxLength: 20 period: $ref: '#/definitions/period' floating_data: type: array description: Preconfigured list of installments that will have a different value when the Subscription is created. This functionality can be used to create tasting installments with zero value, an entry value or discounted installments. The use of this functionality and its expected purpose will depend on enabling a specific product on Getnet. items: $ref: '#/definitions/plan_floating_data_with_details' plan_migration_request: type: object required: - from - to properties: from: type: string format: uuid description: Identifier of the original plan, that is, the original plan_id of the Subscription. to: type: string format: uuid description: Identifier of the target plan, that is, the plan_id to which you want to migrate the Subscription. period: type: object description: Plan period. required: - type - billing_cycle properties: type: description: Periodicity type. type: string enum: - yearly - monthly - bimonthly - quarterly - semesterly - specific example: monthly maxLength: 15 billing_cycle: description: Duration of the plan based on the type of periodicity. For example, for a 12-month plan, where billing will be carried out monthly (type = monthly), the value to be assigned is 12. type: integer minimum: 0 maximum: 9999 example: 12 specific_cycle_in_days: description: Specific billing cycle in days. When the type of periodicity is specific (type = specific), the number of days in which the billing cycle will be carried out must be assigned. For example, if the plan duration is 12 (billing_cycle = 12) and the specific cycle is 10 (specific_cycle_in_days = 10), it means that the billing will occur every 10 days for a total of 12 billings. type: number minimum: 1 maximum: 30 soft_descriptor_global: type: string maxLength: 22 description: 'Text displayed on the buyer`s card invoice. This field is optional, if nothing is informed, the trade name registered for the establishment will be considered. 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 non-allowed characters are sent. Any information that exceeds the maximum size will be disregarded.' example: LOJA*TESTE*COMPRA-123 error_payment_subscription: type: object description: Return of payment error details in case of failed status when creating the Subscription. properties: message: type: string description: Detailed error message in case of Subscription status equal to failed. 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, see Error Table. items: $ref: '#/definitions/error_payment_subscription_detail' error_payment_subscription_detail: type: object properties: acquirer_transaction_id: type: string description: Transaction code. maxLength: 36 description: type: string description: characters Description of the transaction. maxLength: 250 description_detail: type: string description: Transaction description detail. maxLength: 250 error_code: type: string description: Transaction error code. maxLength: 36 payment_id: type: string description: Payment Code. maxLength: 36 status: type: string description: Status of Transaction. maxLength: 36 terminal_nsu: type: string description: NSU Terminal Code. maxLength: 36 address: type: object description: Set of data referring to the buyer's address properties: street: type: string description: Backyard. maxLength: 60 example: Av. Brazil number: type: string description: Street number. maxLength: 10 example: '1000' complement: type: string description: Address complement. maxLength: 60 example: Sala 1 district: type: string description: Neighborhood. maxLength: 40 example: Sao Geraldo city: type: string description: City. maxLength: 40 example: Porto Alegre state: type: string description: State (UF). maxLength: 20 example: RS country: type: string description: Country. maxLength: 20 example: Brazil postal_code: type: string description: Postal Code, CEP in Brazil or ZIP in the United States. (without mask) maxLength: 8 example: '90230060' subscription_plan_migration: type: object required: - from - to properties: from: type: string format: uuid description: Source Plane Identifier. All Subscriptions with this Plan will be migrated to the destination Plan (to field) to: type: string format: uuid description: Identifier of the Plan to which the Subscriptions will be destined. subscriptions: $ref: '#/definitions/subscription_ids_array' charge_filter: description: Billing information. type: object properties: seller_id: description: E-commerce identification code. type: string format: uuidv4 example: 6eb2412c-165a-41cd-b1d9-76c575d70a28 minLength: 36 maxLength: 36 charge_id: description: Identifier of the charge. type: string format: uuidv4 example: 52bc81b2-f079-4f7b-b63a-f653ff29d794 minLength: 36 maxLength: 36 subscription_id: description: Signature identifier. type: string format: uuidv4 example: 5d740ea0-b7d1-42f5-ad64-5a5521e12er9 minLength: 36 maxLength: 36 customer_id: description: Buyer identifier. type: string example: customer_21081826 maxLength: 100 plan_id: description: Plan identifier. type: string format: uuidv4 example: 51995e24-b1ae-4826-8e15-2a568a87abdd minLength: 36 maxLength: 36 payment_id: description: Identification code of the original transaction payment. type: string format: uuidv4 example: 06f256c8-1bbf-42bf-93b4-ce2041bfb87e minLength: 36 maxLength: 36 amount: description: Charge amount. type: integer example: 19990 status: description: Billing status. enum: - paid - denied - processing - scheduled - canceled type: string example: paid maxLength: 20 scheduled_date: description: Billing schedule date. type: string format: YYYY-MM-DDTHH:MM:SSZ example: '2017-04-19T16:30:30Z' create_date: description: Charge creation date. type: string format: YYYY-MM-DDTHH:MM:SSZ example: '2017-03-19T16:30:30Z' retry_number: description: Number of retries. type: integer example: 1 payment_date: description: Recurrence subscription payment date. type: integer format: YYYY-MM-DDTHH:MM:SSZ example: '2017-04-19T16:30:30Z' maxLength: 24 payment_type: description: Type of payment. type: string example: credit_card terminal_nsu: type: string description: Authorization Code generated by the Issuer when the transaction is successfully performed. example: 13978 authorization_code: type: string description: Authorization number generated by the card verification system. example: '6964722471672911' minLength: 1 maxLength: 18 acquirer_transaction_id: type: string description: ID of the acquirer of the original transaction. example: '113880914' charge_filter_response: type: object required: - page - limit - total properties: charges: type: array items: $ref: '#/definitions/charge_filter' page: description: Current page. type: number example: 1 limit: description: Number of records per page. type: number example: 10 total: description: Total charges registered. type: number example: 1 device: type: object description: Set of data referring 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 analyses. format: IPv4 example: 127.0.0.1 device_id: type: string description: Identification hash (Device Fingerprint) of the device. More information in the Antifraud topic. example: hash-device-id subscription: type: object required: - seller_id - customer_id - plan_id properties: seller_id: description: E-commerce identification code. type: string minLength: 36 maxLength: 36 format: uuidv4 example: 6eb2412c-165a-41cd-b1d9-76c575d70a28 customer_id: description: Buyer identifier. type: string example: customer_21081826 maxLength: 100 plan_id: description: Recurrence plan identifier. type: string minLength: 36 maxLength: 36 format: uuidv4 example: 51995e24-b1ae-4826-8e15-2a568a87abdd order_id: description: Purchase identification code used by e-commerce. type: string maxLength: 36 example: 6d2e4380-d8a3-4ccb-9138-c289182818a3 subscription: $ref: '#/definitions/subscription_payment_type_shippings' device: $ref: '#/definitions/device' installment_start_date: description: Subscription billing start date. Until that date, the Subscription will remain Scheduled, that is, with the status created. The use of this field and its expected purpose will depend on enabling a specific product on Getnet. type: string format: YYYY-MM-DD example: '2020-09-14' maxLength: 10 subscription_payment_type_shippings: description: Subscription information. type: object properties: payment_type: $ref: '#/definitions/subscription_payment_type_credit' shippings: description: Set of delivery addresses. type: array items: $ref: '#/definitions/subscription_shippings' subscription_payment_type_credit: description: Subscription payment type information. type: object required: - credit properties: credit: $ref: '#/definitions/subscription_credit' subscription_shippings: type: object properties: first_name: description: Buyer's first name. type: string maxLength: 40 example: John last_name: description: Buyer's last name. type: string maxLength: 80 example: da Silva email: description: Buyer's email. type: string format: email example: customer@email.com.br phone_number: description: Buyer's phone. type: string maxLength: 15 example: '5551999887766' shipping_amount: description: Delivery value. type: integer example: 3000 address: $ref: '#/definitions/address' subscription_credit: description: Conjunto de dados referentes a transação de crédito. type: object required: - transaction_type - number_installments - card properties: transaction_type: description: Tipo de transação. Pagamento completo à vista. type: string enum: - FULL example: FULL number_installments: description: Número de parcelas para uma transação de crédito parcelado. Para o transaction_type=FULL o valor que deverá ser enviado será sempre 1. type: integer example: 1 soft_descriptor: $ref: '#/definitions/soft_descriptor_global' billing_address: $ref: '#/definitions/address' card: $ref: '#/definitions/subscription_card' subscription_response: type: object properties: seller_id: description: E-commerce identification code. type: string format: uuidv4 example: 6eb2412c-165a-41cd-b1d9-76c575d70a28 minLength: 36 maxLength: 36 order_id: description: Purchase identification code used by the e-commerce type: string example: 6d2e4380-d8a3-4ccb-9138-c289182818a3 maxLength: 36 create_date: description: Recurrence subscription creation date. type: string format: YYYY-MM-DDTHH:MM:SSZ example: '2017-04-19T16:30:30Z' maxLength: 24 end_date: description: End date of the recurrence signature. type: string format: YYYY-MM-DDTHH:MM:SSZ example: '2018-04-19T16:30:30Z' maxLength: 24 payment_date: description: Recurrence subscription payment date. type: integer format: YYYY-MM-DDTHH:MM:SSZ example: '2017-04-19T16:30:30Z' maxLength: 24 next_scheduled_date: description: Next schedule date of the recurrence subscription. type: string format: YYYY-MM-DDTHH:MM:SSZ example: '2017-05-19T16:30:30Z' maxLength: 24 subscription: $ref: '#/definitions/subscription_payment_type_shippings_response' customer: $ref: '#/definitions/subscription_customer_response' plan: $ref: '#/definitions/subscription_plan_response' device: $ref: '#/definitions/device' status: description: Recurrence subscription status. type: string enum: - processing - canceled - success - delayed - failed - expired example: success maxLength: 20 status_details: description: Details of the recurrence subscription status. type: string example: Subscription Plan flex successfully created maxLength: 500 payment: description: Subscription payment information type: object properties: error: $ref: '#/definitions/error_payment_subscription' installment_start_date: description: Subscription billing start date. Until that date, the Subscription will remain Scheduled, that is, with the status created. The use of this field and its expected purpose will depend on enabling a specific product on Getnet. type: string format: YYYY-MM-DD example: '2020-09-14' maxLength: 10 subscription_payment_type_shippings_response: description: Subscription information. type: object properties: subscription_id: description: Recurrence signature identifier. type: string format: uuidv4 example: 5d740ea0-b7d1-42f5-ad64-5a5521e12er9 minLength: 36 maxLength: 36 payment_type: $ref: '#/definitions/subscription_payment_type_credit_response' shippings: description: Set of delivery addresses. type: array items: $ref: '#/definitions/subscription_shippings' subscription_payment_type_credit_response: description: Subscription payment type information. type: object properties: credit: $ref: '#/definitions/subscription_credit_response' subscription_credit_response: description: Set of data referring to the credit transaction. type: object properties: transaction_type: description: Transaction type. Full payment upfront. type: string enum: - FULL example: FULL number_installations: description: Number of installments for an installment credit transaction. type: integer example: 1 billing_address: $ref: '#/definitions/address' card: $ref: '#/definitions/subscription_card_response' subscription_card_response: type: object description: Card data set. properties: cardholder_name: type: string description: Buyer's name printed on the card. Required if card details were not permanently stored with the token. example: JOAO DA SILVA maxLength: 26 brand: type: string description: Flag. (Also used in anti-fraud). Required if card details were not permanently stored with the token. example: mastercard enum: - Mastercard - Visa - Amex - Elo - Hipercard maxLength: 50 expiration_month: type: string description: Card expiry month with two digits. Required if card details were not permanently stored with the token. example: '12' minLength: 2 maxLength: 2 expiration_year: type: string description: Two-digit card expiry year. Required if card details were not permanently stored with the token. example: '28' minLength: 2 maxLength: 2 bin: type: string description: First six numbers of the card. example: '123412' minLength: 6 maxLength: 9 subscription_customer_response: type: object description: Buyer dataset. properties: customer_id: description: Buyer identifier. type: string example: customer_21081826 maxLength: 100 first_name: description: Buyer's first name. type: string example: John maxLength: 40 last_name: description: Buyer's last name. type: string example: da Silva maxLength: 80 document_type: description: Buyer's document type. type: string enum: - CPF - CNPJ example: CPF document_number: description: Buyer's document number. (without mask) type: string minLength: 11 maxLength: 15 example: '12345678912' birth_date: description: Buyer's date of birth. type: string format: YYYY-MM-DD example: '1976-02-21' minLength: 10 maxLength: 10 phone_number: description: Buyer's phone number. (without mask) type: string maxLength: 15 example: '5551999887766' cellphone_number: description: Buyer's cell phone number. (without mask) type: string example: '5551999887766' maxLength: 15 email: description: Buyer's email. type: string format: email example: customer@email.com.br observation: description: Notes. type: string example: The customer is interested in plan x. address: $ref: '#/definitions/address' subscription_plan_response: description: Plan information. type: object properties: plan_id: description: Plan identifier. type: string format: uuidv4v4 example: 51995e24-b1ae-4826-8e15-2a568a87abdd minLength: 36 maxLength: 36 name: description: Plan name. type: string example: flex plan description: description: Plan description. type: string example: flex plan amount: description: Value of the plan. type: integer example: 19990 currency: description: Currency identification (See code at "https://www.currency-iso.org/en/home/tables/table-a1.html"). type: string example: BRL minLength: 3 maxLength: 3 payment_types: description: Accepted payment types. type: string enum: - credit_card items: type: string example: - credit_card sales_tax: description: Tax amount. type: integer default: 0 product_type: description: Identifier of the type of product sold among the options. type: string enum: - cash_carry - digital_content - digital_goods - gift_card - physical_goods - renew_subs - shareware - service example: service status: description: Plan status. type: string enum: - active - inactive example: active maxLength: 20 period: $ref: '#/definitions/period' subscription_filter_response: type: object properties: subscriptions: description: Recurrence signature set. type: array items: $ref: '#/definitions/subscription_response' page: description: Current page. type: number example: 1 limit: description: Number of records per page. type: number example: 10 total: description: Total registered plans. type: number example: 1 subscription_cancel: type: object required: - seller_id - status_details properties: seller_id: description: E-commerce identification code. type: string minLength: 36 maxLength: 36 format: uuidv4v4 example: 6eb2412c-165a-41cd-b1d9-76c575d70a28 status_details: description: Details of the recurrence subscription status. type: string maxLength: 500 example: Customer is no longer interested in the service/product subscription_projection_response: type: object required: - amount properties: amount: description: Total value of the projection. type: number example: 199900 projection: description: Set of billing projections. type: array items: properties: gives you: description: Projected billing date. type: string format: YYYY-MM-DD example: '2017-05-19' minLength: 10 maxLength: 10 amount: description: Billing projection value. type: number example: 100000 installment: description: Parcel number. type: number example: 2 floating_data: $ref: '#/definitions/subscription_floating_data_projection' subscription_confirm: type: object required: - seller_id - status_details - charge_id properties: seller_id: description: E-commerce identification code. type: string format: uuidv4v4 minLength: 36 maxLength: 36 example: 6eb2412c-165a-41cd-b1d9-76c575d70a28 status_details: description: Details of the recurrence subscription status. type: string maxLength: 500 example: Confirmed subscription payment charge_id: description: Identifier of the charge. type: string minLength: 36 maxLength: 36 format: uuidv4v4 example: 52bc81b2-f079-4f7b-b63a-f653ff29d794 subscription_payment_date: type: object required: - day properties: day: description: Payment date of the new charge. type: integer minimum: 1 maximum: 31 example: 25 subscription_update_payment_type: type: object description: Card data set. properties: number_token: type: string description: Tokenized card number. example: dfe05208b105578c070f806c80abd3af09e246827d29b866cf4ce16c205849977c9496cbf0d0234f42339937f327747075f68763537b90b31389e01231d4d13c minLength: 128 maxLength: 128 cardholder_name: type: string description: Buyer's name printed on card. Required if card details were not permanently stored with the token. maxLength: 26 example: JOAO DA SILVA brand: type: string description: Flag. (Also used in anti-fraud). Required if card details were not permanently stored with the token. example: mastercard enum: - Mastercard - Visa - Amex - link - Hipercard maxLength: 50 expiration_month: type: string description: Two-digit card expiry month. Required if card details were not permanently stored with the token. minLength: 2 maxLength: 2 example: '12' expiration_year: type: string description: Two-digit card expiry year. Required if card details were not permanently stored with the token. minLength: 2 maxLength: 2 example: '28' bin: type: string description: First six numbers of the card. minLength: 6 maxLength: 9 example: '123412' subscription_floating_data_response: type: object required: - subscription_id properties: subscription_id: type: string format: uuid description: Recurrence signature identifier. minLength: 36 maxLength: 36 example: 9aca75f2-bb03-42d7-aa09-7e46409ded26 floating_data: type: array description: List of charges with date and/or amount changes items: $ref: '#/definitions/subscription_floating_data' subscription_floating_data_array_creation: type: array description: List of charges with date and/or amount changes items: $ref: '#/definitions/subscription_floating_data_creation' subscription_floating_data_update: type: object properties: new_amount: type: integer example: 19990 description: New billing amount. minimum: 0 new_scheduled_date: type: string format: YYYY-MM-DD description: New billing date example: '2020-06-10' maxLength: 12 subscription_floating_data_remove_response: type: object required: - subscription_id properties: subscription_id: type: string format: uuid description: Recurrence signature identifier. minLength: 36 maxLength: 36 example: 9aca75f2-bb03-42d7-aa09-7e46409ded26 floating_data: type: array description: List of charges with date and/or amount changes items: $ref: '#/definitions/subscription_floating_data_with_details' subscription_floating_data_creation: type: object required: - installment properties: installment: type: integer format: int32 example: 2 description: Number of the installment to which the change will be applied. minimum: 1 new_amount: type: integer example: 19990 description: New charge amount. minimum: 0 new_scheduled_date: type: string format: YYYY-MM-DD description: New billing date example: '2020-06-10' maxLength: 12 subscription_floating_data: type: object required: - installment properties: installment: type: integer format: int32 example: 2 description: Number of the installment to which the change will be applied. minimum: 1 new_amount: type: integer example: 19990 description: New charge amount. minimum: 0 new_scheduled_date: type: string format: YYYY-MM-DD description: New billing date example: '2020-06-10' maxLength: 12 original_scheduled_date: type: string format: YYYY-MM-DD description: Date the billing was originally scheduled, before it was changed, according to the plan associated with the subscription. example: '2020-06-10' maxLength: 12 original_amount: type: integer example: 19990 description: Original billing amount, before it was changed, according to the plan associated with the subscription. minimum: 0 subscription_floating_data_with_details: type: object required: - installment properties: installment: type: integer format: int32 example: 2 description: Number of the installment to which the change will be applied. minimum: 1 new_amount: type: integer example: 19990 description: New charge amount. minimum: 0 new_scheduled_date: type: string format: YYYY-MM-DD description: New billing date example: '2020-06-10' maxLength: 12 original_scheduled_date: type: string format: YYYY-MM-DD description: Date of the original billing schedule, before it was changed, according to the plan associated with the subscription. example: '2020-06-10' maxLength: 12 original_amount: type: integer example: 19990 description: Original billing amount, before being changed, according to the plan associated with the subscription. minimum: 0 details: type: string description: Reason why it was not possible to remove the date and/or value change from the billing. subscription_floating_data_projection: type: object description: This field will be displayed if the expand=floating_data parameter is entered and will also depend on whether the Flexible Recurrence product is contracted. properties: new_date: type: string format: YYYY-MM-DD description: New changed billing date. example: '2020-06-10' maxLength: 12 new_amount: type: integer example: 19990 description: New changed charge amount. minimum: 0 subscription_ids_array: type: array description: List of Subscription identifiers that will be migrated to the destination Plan (to field). If this list is not informed, then the service will migrate all Subscriptions from the source Plan (from field) to the destination Plan (to field). items: type: string format: uuid subscription_card: type: object description: Card data set. properties: number_token: type: string description: Tokenized card number. example: dfe05208b105578c070f806c80abd3af09e246827d29b866cf4ce16c205849977c9496cbf0d0234f42339937f327747075f68763537b90b31389e01231d4d13c minLength: 128 maxLength: 128 cardholder_name: type: string description: Buyer's name printed on card. Required if card details were not permanently stored with the token. maxLength: 26 example: JOAO DA SILVA security_code: type: string description: Security code. CVV or CVC. minLength: 3 maxLength: 4 example: '123' brand: type: string description: Flag. (Also used in anti-fraud). Required if card details were not permanently stored with the token. maxLength: 50 example: Mastercard enum: - Mastercard - Visa - Amex - Elo - Hipercard expiration_month: type: string description: Card expiry month with two digits. Required if card details were not permanently stored with the token. minLength: 2 maxLength: 2 example: '12' expiration_year: type: string description: Two-digit card expiry year. Required if card details were not permanently stored with the token. minLength: 2 maxLength: 2 example: '28' bin: type: string description: First six numbers of the card. minLength: 6 maxLength: 9 example: '123412' BoletoResponseDTO: type: object properties: boleto_id: type: string bank: type: string status_code: type: string status_label: type: string typeful_line: type: string bar_code: type: string issue_date: type: string expiration_date: type: string our_number: type: string document_number: type: string description: Buyer's document number without punctuation. (without mask) _links: type: array items: $ref: '#/definitions/LinkBoletoDTO' LinkBoletoDTO: type: object properties: href: type: string rel: type: string type: type: string ConfirmRequestDTO: type: object properties: marketplace_subseller_payments: type: array items: $ref: '#/definitions/MarketplaceSubsellerPayment' amount: type: integer format: int32 internal: $ref: '#/definitions/InternalDTO' ConfirmResponseDTO: type: object properties: seller_id: type: string amount: type: integer format: int32 currency: type: string order_id: type: string status: type: string payment_id: type: string description: Payment identification code. credit_confirm: $ref: '#/definitions/CreditConfirmDTO' CreditConfirmDTO: type: object properties: confirm_date: type: string message: type: string AddressDTO: type: object description: Set of data referring to the buyer's address properties: street: type: string description: Address. maxLength: 60 example: Av. Brazil number: type: string description: Street number. maxLength: 10 example: '1000' complement: type: string description: Complement of the street. maxLength: 60 example: Room 1 district: type: string description: Bairro. maxLength: 40 example: São Geraldo city: type: string description: City. example: Porto Alegre state: type: string description: State (UF). maxLength: 20 example: RS country: type: string description: Country.
Report in the ISO 3166-1 alpha-3 standard
Example "BRA", "USA" and "ARG" maxLength: 20 example: BRA postal_code: type: string description: Postal Code, CEP in Brazil or ZIP in the United States. (without mask) example: '90230060' CreditDTO: type: object properties: recurring: type: boolean delayed: type: boolean fraud_risk_check: type: object authenticated: type: boolean pre_authorization: type: boolean save_card_data: type: boolean transaction_type: type: integer format: int32 number_installments: type: integer format: int32 subscription_id: type: string plan_id: type: string charge_id: type: string installment: type: integer format: int32 dynamic_mcc: type: integer format: int32 soft_descriptor: type: string cardholder_mobile: type: string card: $ref: '#/definitions/CardDTO' wallet: $ref: '#/definitions/WalletCreditDTO' tokenization: $ref: '#/definitions/TokenizationDTO' transaction_id: type: string credentials_on_file_type: type: string CreditRequestDTO: type: object properties: seller_id: type: string amount: type: integer description: Purchase amount in cents payment_id: type: string combined_id: type: string link_id: type: string hash_qr_code: type: string currency: type: string order: $ref: '#/definitions/OrderDTO' device: $ref: '#/definitions/DeviceDTO' shippings: type: array items: $ref: '#/definitions/ShippingsDTO' marketplace_subseller_payments: type: array items: $ref: '#/definitions/MarketplaceSubsellerPaymentsDTO' wallet: $ref: '#/definitions/WalletDTO' credit: $ref: '#/definitions/CreditDTO' customer: $ref: '#/definitions/CustomerDTO' sub_merchant: $ref: '#/definitions/SubMerchantDTO' internal: $ref: '#/definitions/InternalDTO' DeviceDTO: type: object description: Set of data referring to the device used by the buyer. properties: ip_address: type: string description: string IP address (IPv4) of the buyer's device. This attribute must be captured by your application, from the device of the buyer (mobile; browser; etc.) and sent in the payload, in order to enrich our preventive analyses.
Required field for Antifraud example: 10.0.0.1 device_id: type: string description: Identification hash (Device Fingerprint) of the device. More information in the Antifraude topic.
Required field for Antifraud example: ae44e06c-3e85-44af-8542-bcaccd54ef2e MarketplaceSubsellerPaymentsDTO: type: object properties: subseller_sales_amount: type: integer format: int32 subseller_id: type: string order_items: type: array items: $ref: '#/definitions/OrderItemsDTO' OrderItemsDTO: type: object properties: amount: type: integer format: int32 description: Purchase amount in cents description: type: string currency: type: string id: type: string ShippingsDTO: type: object properties: address: $ref: '#/definitions/AddressDTO' description: Set of data referring to the delivery address. WalletDTO: type: object properties: type: type: string identification: type: string payee_document: type: string payee_name: type: string authorization_token: type: string CreditResponseDTO: type: object properties: delayed: type: boolean authorization_code: type: string authorized_at: type: string reason_code: type: string reason_message: type: string acquirer: type: string soft_descriptor: type: string brand: type: string terminal_nsu: type: string acquirer_transaction_id: type: string transaction_id: type: string first_installment_amount: type: string other_installment_amount: type: string total_installment_amount: type: string PaymentResponseDTO: type: object properties: payment_id: type: string seller_id: type: string amount: type: integer format: int32 description: Purchase amount in cents currency: type: string order_id: type: string status: type: string received_at: type: string credit: $ref: '#/definitions/CreditResponseDTO' CancelCustomKeyResponseDTO: type: object properties: seller_id: type: string payment_id: type: string cancel_request_at: type: string cancel_request_id: type: string cancel_custom_key: type: string terminal_nsu: type: string acquirer_transaction_id: type: string transaction_date: type: string currency: type: string transaction_type: type: string number_installments: type: integer format: int32 amount: type: integer format: int32 description: Purchase amount in cents cancel_amount: type: integer format: int32 status_processing_cancel_code: type: string status_processing_cancel_message: type: string components: schemas: serviceUnavailable: title: serviceUnavailable type: object properties: message: type: string description: Error Message name: type: string description: Name of the module or system where the error occurred status_code: type: number description: HTTP Status Code format: double details: type: array description: Array of objects containing error details items: type: object properties: status: type: string description: Status example: ERROR error_code: type: string description: Error code example: GENERIC-503 description: type: string description: Short error description example: Service Unavailable description_detail: type: string description: Detailed error description example: The service is unavailable description: Set of information returned in case of errors genericErrorResponse: title: genericErrorResponse type: object properties: message: type: string description: Error message name: type: string description: Name of the module or system where the error occurred status_code: type: number description: HTTP StatusCode format: double details: type: array description: Array of objects containing error details items: type: object properties: {} description: Set of information returned in case of errors PaymentDTO: type: object properties: idempotency_key: type: string request_id: type: string maxLength: 36 minLength: 36 format: uuidv4 order_id: type: string data: $ref: '#/components/schemas/DataDTO' customer: $ref: '#/components/schemas/CustomerDTO' Biling_address: $ref: '#/components/schemas/BillingAddressDTO' shippings: $ref: '#/components/schemas/shippingsDTO' name: type: string example: Jose da Silva phone_number: type: string example: 11999999999 order: type: object properties: items: type: object properties: id: type: string example: 101803 name: type: string example: THERMAL CUP 473ML BLACK STANLEY price: type: string example: 139.9 quantity: type: string example: 1 discount: type: string example: 0 deliveryType: type: string example: PAC catagoryId: type: string example: 913 sellerId: type: string example: MSC002 taxValue: type: string example: 0 taxRate: type: string example: 0 DataDTO: type: object properties: device: type: object properties: device_id: type: string example: id ip_address: type: string example: 127.0.0.0 CustomerDTO: type: object properties: document_type: type: string example: CPF description: Type of the buyer's identification document. Mandatory for billet.
Suggested Values CPF, CNPJ, RNE, RG, CNAE, PASSPORT ou Document in accordance with current legislation in the country of origin

Mandatory field for Antifraude document_number: type: string example: '2441356709' description: Purchaser's document number without punctuation. (without mask)
Mandatory field for Antifraud email: type: string example: aceiti@getnet.com.br description: Purchaser's email.
Mandatory field for Antifraud name: type: string example: Jose da Silva description: Purchaser's name.
Mandatory field for Antifraud phone_number: type: string example: '11999999999' description: Purchaser's phone number.
Mandatory field for Antifraud billing_address: $ref: '#/definitions/BillingAddressDTO' shippings: $ref: '#/definitions/ShippingsDTO' order: $ref: '#/components/schemas/orderDTO' BillingAddressDTO: type: object properties: street: type: string description: Street.
Mandatory field for Antifraud number: type: string description: Street number.
Mandatory field for Antifraud district: type: string description: District.
Mandatory field for Antifraud city: type: string description: City.
Mandatory field for Antifraud state: type: string description: State (UF).
Mandatory field for Antifraud country: type: string description: Country.
Report in the ISO 3166-1 alpha-3 standard
Example "BRA", "USA" and "ARG"
Mandatory field for Antifraud postal_code: type: string description: Postal Code, CEP in Brazil or ZIP in the United States. (without mask)
Mandatory field for Antifraud complement: type: string description: Address complement.
Mandatory field for Antifraud type: type: string enum: - RESIDENCIAL - INSTALACAO - CORRESPONDENCIA - FISCAL - COBRANCA shippingsDTO: type: object properties: address: type: string description: Set of data referring to the buyer's address street: type: string number: type: string district: type: string city: type: string country: type: string postal_code: type: string complement: type: string type: type: string nameDTO: properties: name: type: string phone_number: type: string orderDTO: type: object properties: items: type: object $ref: '#/definitions/items' description: Purchase identification data set ReleaseDTO: type: object properties: release_payment_date: type: string subseller_id: type: string paymentPurchaseResponse: title: paymentPurchaseResponse type: object properties: idempotency_key: type: string description: idempotency key example: ORDER-10187383-8719d0c4-2c3f-4360-abd9-8daf3834fe1f seller_id: type: string description: eCommerce identification code format: uuid example: 9406df6c-3100-49ba-b4df-d81c1ad8a62b request_id: type: string description: Identifier of the request. Unique for each request. Case is not informed, it will be generated automatically. maxLength: 36 minLength: 36 format: uuidv4 example: daac03dc-73db-453f-9bea-b1391669d5d3 payment_id: type: string description: Payment identifier format: uuid example: 2c341d28-491b-4cf8-aec7-eeb60136b7a5 order_id: type: string description: Order identifier example: ORDER-10187383 amount: type: number description: Purchase amount in cents format: double example: 8900 currency: maxLength: 3 minLength: 3 type: string description: Currency identification (See code at "https://www.currency-iso.org/en/home/tables/table-a1.html") example: BRL status: $ref: '#/components/schemas/Status' payment_method: $ref: '#/components/schemas/payment_method' received_at: type: string description: transaction date example: '2020-06-30T18:32:51.222Z' transaction_id: maxLength: 18 type: string description: Transaction identifier generated by the eCommerce platform example: '3729756321501820' original_transaction_id: maxLength: 18 type: string description: Identifier of the original transaction example: '6534812321501821' authorized_at: type: string description: Transaction authorization date example: '2020-06-30T18:32:51.815Z' reason_code: maxLength: 2 minLength: 2 type: string description: Transaction response code. If different from '00' transaction denied. example: '00' reason_message: type: string description: Reply message example: TRANSACAO EXECUTADA COM SUCESSO acquirer: type: string description: Adquirente. example: GETNET default: GETNET soft_descriptor: maxLength: 22 type: string description: 'Text displayed on the buyer`s card statement, This field it is optional, if nothing is informed, the fantasy name will be considered registered for the establishment. Only data is allowed in this field alphanumeric characters and the following special characters: % $ , . / & ( ) + = = < > - * Spaces will be replaced by the ''*'' character. will be denied if non-allowed characters are sent. Any information that exceeds the maximum size will be disregarded.' example: MYUECOMM*ORDER10187383 brand: $ref: '#/components/schemas/brand' authorization_code: maxLength: 6 minLength: 6 type: string description: Authorization Code generated by the Issuer when the transaction is performed successfully example: '017060' acquirer_transaction_id: maxLength: 12 minLength: 12 type: string description: GETNET transaction NSU (Acquirer) example: '152147981' eci: $ref: '#/components/schemas/eci' total_installment_amount: $ref: '#/components/schemas/total_installment_amount' first_installment_amount: $ref: '#/components/schemas/first_installment_amount' other_installment_amount: $ref: '#/components/schemas/other_installment_amount' description: Credit and debit response data set. statusInfo: type: string example: APPROVED description: transaction status enum: - APPROVED - AUTHORIZED - DENIED - CANCELED - CAPTURED - ERROR idempotency_key: type: string title: idempotency_key format: uuid example: 8719d0c4-2c3f-4360-abd9-8daf3834fe1f minLength: 36 maxLength: 36 description: idempotency key rel: title: rel type: string example: AUTHORIZATION enum: - AUTHORIZATION - CANCEL - CONFIRM - PURCHASE description: Relationship of the item with the payment. protocol: title: protocol type: string minLength: 18 maxLength: 18 example: '202006302344230001' description: Pcancellation letter brand: title: brand maxLength: 50 type: string description: |- Card brand. Automatically filled by the API if not provided. Mandatory field for Anti-fraud usage. enum: - MASTERCARD - VISA - AMEX - ELO - HIPERCARD paymentCaptureResponse: title: paymentCaptureResponse type: object properties: idempotency_key: type: string description: idempotency key example: ORDER-10187383-8719d0c4-2c3f-4360-abd9-8daf3834fe1f seller_id: type: string description: eCommerce identification code format: uuid example: 9406df6c-3100-49ba-b4df-d81c1ad8a62b request_id: type: string description: Identifier of the request. Unique for each request. Case is not informed, it will be generated automatically. maxLength: 36 minLength: 36 format: uuidv4 example: daac03dc-73db-453f-9bea-b1391669d5d3 payment_id: type: string description: Payment identifier format: uuid example: 2c341d28-491b-4cf8-aec7-eeb60136b7a5 order_id: type: string description: Order identifier example: ORDER-10187383 amount: type: number description: Purchase amount in cents format: double example: 8900 currency: maxLength: 3 minLength: 3 type: string description: Currency identification (See code at "https://www.currency-iso.org/en/home/tables/table-a1.html") example: BRL status: type: string description: transaction status example: CAPTURED captured_at: type: string description: Capture date example: '2020-06-30T22:33:41.172Z' reason_code: maxLength: 2 minLength: 2 type: string description: Transaction response code. If different from '00' transaction denied. example: '00' reason_message: type: string description: Reply message example: TRANSACAO EXECUTADA COM SUCESSO payment_method: title: payment_method type: string description: Payment method enum: - CREDIT - DEBIT - CREDIT_AUTHORIZATION seller_id: title: seller_id type: string example: 9406df6c-3100-49ba-b4df-d81c1ad8a62b minLength: 36 maxLength: 36 format: uuid description: eCommerce ID Code request_id: title: request_id type: string example: daac03dc-73db-453f-9bea-b1391669d5d3 minLength: 36 maxLength: 36 format: uuidv4 description: Request identifier. Unique to each request payment_id: title: payment_id type: string description: payment identifier example: 2c341d28-491b-4cf8-aec7-eeb60136b7a5 format: uuid minLength: 36 maxLength: 36 order_id: title: order_id type: string example: ORDER-10187383 description: order identifier minLength: 1 maxLength: 32 amount: type: integer title: amount description: Purchase amount in cents example: 8900 currency: title: currency type: string example: BRL minLength: 3 maxLength: 3 description: Currency identification (See code at "https://www.currency-iso.org/en/home/tables/table-a1.html") received_at: title: received_at type: string example: '2020-06-30T18:32:51.222Z' description: transaction date transaction_id: title: transaction_id type: string example: '3729756321501820' description: Transaction identifier generated by the e-commerce platform maxLength: 18 authorized_at: title: authorized_at type: string example: '2020-06-30T18:32:51.815Z' description: Transaction authorization date acquirer: title: acquirer type: string example: GETNET description: Buyer. default: GETNET soft_descriptor: title: soft_descriptor type: string example: MYUECOMM*ORDER10187383 maxLength: 22 description: 'Text displayed on the buyer`s card invoice. This field is optional, if nothing is informed it will be considered the commercial name registered for the establishment. Only alphanumeric data and the following special characters are allowed in this field: % $ , . / & ( ) + = = < > - * The spaces will be replaced by the character ''*'' The transaction will not be denied if characters not allowed are sent. Any information that exceeds the maximum size will be disregarded.' reason_code: title: reason code type: string minLength: 2 maxLength: 2 example: '00' description: Transaction response code. If different from '00' transaction is denied. reason_message: title: reason_message type: string example: SUCCESSFULLY EXECUTED TRANSACTION description: reply message authorization_code: title: authorization_code type: string example: '017060' minLength: 6 maxLength: 6 description: Authorization Code generated by the Issuer when the transaction is successfully performed acquirer_transaction_id: title: acquirer_transaction_id type: string example: '000152147981' maxLength: 12 minLength: 12 description: NSU of transaction GETNET (Acquirer) eci: maxLength: 2 minLength: 2 type: string description: |- Code indicating whether the transaction was processed with Bearer Authentication. 00, 01 and 02 for Mastercard and 05, 06 and 07 for Visa and other brands example: '07' total_installment_amount: type: number description: For installment transactions, this contains the total amount to be be paid (amount plus interest, taxes, fees, etc.). format: double example: 8900 first_installment_amount: type: number description: For installment transactions, this contains the value of the first installment to be paid. format: double example: 1485 other_installment_amount: type: number description: For installment transactions, this contains the value of the other installments to be paid. format: double example: 1483 registred_at: type: string description: Date and time of payment record. paymentCancelResponse: title: paymentCancelResponse type: object properties: idempotency_key: type: string description: Idempotency key example: ORDER-10187383-8719d0c4-2c3f-4360-abd9-8daf3834fe1f seller_id: type: string description: eCommerce identification code format: uuid example: 9406df6c-3100-49ba-b4df-d81c1ad8a62b request_id: type: string description: Identifier of the request. Unique for each request. Case is not informed, it will be generated automatically. maxLength: 36 minLength: 36 format: uuidv4 example: daac03dc-73db-453f-9bea-b1391669d5d3 payment_id: type: string description: Payment identifier format: uuid example: 2c341d28-491b-4cf8-aec7-eeb60136b7a5 order_id: type: string description: Order identifier example: ORDER-10187383 amount: type: number description: Purchase amount in cents format: double example: 8900 currency: maxLength: 3 minLength: 3 type: string description: Currency identification (See code at "https://www.currency-iso.org/en/home/tables/table-a1.html") example: BRL status: type: string description: Status of the transaction example: CANCELED canceled_at: type: string description: Cancellation date example: '2020-07-01T02:15:03.603Z' reason_code: maxLength: 2 minLength: 2 type: string description: Transaction response code. If different from '00' transaction denied. example: '00' reason_message: type: string description: Reply message example: TRANSACAO EXECUTADA COM SUCESSO custom_key: maxLength: 32 minLength: 3 type: string description: Customer key used to identify a request of cancellation. (Key must be unique per transaction). example: 20200630-8900 protocol: maxLength: 18 minLength: 18 type: string description: Cancellation protocol example: '202006302344230001' errorOAuth: title: errorOAuth type: object properties: error: type: string description: Error message error_description: type: string description: Error description KeysRequest: title: KeysRequest type: object properties: expiration_in_days: minimum: 1 type: number description: Encryption public key expiration time in days example: 1 KeysResponse: title: KeysResponse type: object properties: public_key: type: string description: 'Public key generated for creating cryptograms. Format from key: X509 SubjectKeyInfo in Base64 encoded DER format' example: MIICXAIBAAKBgQCqGKukO1De7zhZj6+H0qtjTkVxwTCpvKe4eCZ0FPqri0cb2JZfXJ/DgYSF6vUp wmJG8wVQZKjeGcjDOL5UlsuusFncCzWBQ7RKNUSesmQRMSGkVb1/3j+skZ6UtW+5u09lHNsj6tQ5 1s1SPrCBkedbNf0Tp0GbMJDyR4e9T04ZZwIDAQABAoGAFijko56+qGyN8M0RVyaRAXz++xTqHBLh 3tx4VgMtrQ+WEgCjhoTwo23KMBAuJGSYnRmoBZM3lMfTKevIkAidPExvYCdm5dYq3XToLkkLv5L2 pIIVOFMDG+KESnAFV7l2c+cnzRMW0+b6f8mR1CJzZuxVLL6Q02fvLi55/mbSYxECQQDeAw6fiIQX GukBI4eMZZt4nscy2o12KyYner3VpoeE+Np2q+Z3pvAMd/aNzQ/W9WaI+NRfcxUJrmfPwIGm63il AkEAxCL5HQb2bQr4ByorcMWm/hEP2MZzROV73yF41hPsRC9m66KrheO9HPTJuo3/9s5p+sqGxOlF L0NDt4SkosjgGwJAFklyR1uZ/wPJjj611cdBcztlPdqoxssQGnh85BzCj/u3WqBpE2vjvyyvyI5k X6zk7S0ljKtt2jny2+00VsBerQJBAJGC1Mg5Oydo5NwD6BiROrPxGo2bpTbu/fhrT8ebHkTz2epl U9VQQSQzY1oZMVX8i1m5WUTLPz2yLJIBQVdXqhMCQBGoiuSoSjafUhV7i1cEGpb88h5NBYZzWXGZ 37sJ5QsW+sJyoNde3xH8vdXhzU7eT82D6X/scw9RZz+/6rCJ4p0= key_id: type: string description: Key identification key. Required parameter in the payload from "decrypt". format: uuid example: 010161f9-d4d5-46c7-a925-8e7858300bf5 encrypted_data: type: string description: Set of data to be encrypted. See field specification in the Encryption session example: Nmk09p+5EjslbqYJqguiWcmwWUHpHbbmKyay/Hos8IdN3KrqJ8KuuVedyrsz48rBBrnmiCp9dS3sLfd0ADCztzbIBCuiT2VD1sPzXferiufnEc3UGT5k+eg1qbP0JzRxw53ZEvtjwp+WiKYGI8uLGwt0ZCIoL8bq7j7kdjuhaI1ayEBly2/ADjvw9uuvwuOqxeYxjJe7+1GQznh51uhwGbNM6NAAYNYe+0/YFcMKLfAL1PaiDsKEApdLi+AR5DTuLbYFbk6tTmc9bVSj+ASGGa+Ciiyu0J+VpvwQe/0z6mWQb91wajrw6hhoeHLfUf4baAaFdf8BOHtTDSkqXsQ1Qg== expires_in: type: integer description: Maximum public key validity time from creation in seconds. format: int32 example: 86400 description: GET Keys method response object verify_request: title: verify_request required: - key_id type: object properties: number_token: type: string description: Tokenized card number. Pre-generated via endpoint /v1/tokens/card example: dfe05208b105578c070f806c80abd3af09e246827d29b866cf4ce16c205849977c9496cbf0d0234f42339937f327747075f68763537b90b31389e01231d4d13c minLength: 128 maxLength: 128 brand: type: string description: Card banner. Automatically populated by the API if not informed. maxLength: 50 example: Mastercard enum: - Mastercard - Visa - Amex - Elo - Hipercard cardholder_name: type: string description: Buyer's name printed on card. maxLength: 26 example: JOAO DA SILVA expiration_month: type: string description: Card expiry month with two digits. minLength: 2 maxLength: 2 example: '12' expiration_year: type: string description: Two-digit card expiry year. minLength: 2 maxLength: 2 example: '28' security_code: type: string description: Security code. CVV or CVC. minLength: 3 maxLength: 4 example: '123' gateway_id: type: string description: | Merchant Payment Gateway ID. example: '00000999998' verify_response: title: verify_response type: object properties: seller_id: type: string description: eCommerce ID Code format: uuid example: 9406df6c-3100-49ba-b4df-d81c1ad8a62b request_id: type: string description: Identifier of the request. Unique for each request. Case is not informed, it will be generated automatically. maxLength: 36 minLength: 36 format: uuidv4 example: daac03dc-73db-453f-9bea-b1391669d5d3 status: $ref: '#/components/schemas/Status1' received_at: type: string description: Transaction date example: '2020-06-30T18:32:51.222Z' transaction_id: maxLength: 18 type: string description: Transaction identifier generated by the eCommerce platform example: '3729756321501820' authorized_at: type: string description: Transaction authorization date example: '2020-06-30T18:32:51.815Z' reason_code: maxLength: 2 minLength: 2 type: string description: Transaction response code. If different from '00' transaction denied. example: '00' reason_message: type: string description: Reply message example: SUCCESSFULLY EXECUTED TRANSACTION brand: $ref: '#/components/schemas/brand' authorization_code: maxLength: 6 minLength: 6 type: string description: Authorization Code generated by the Issuer when the transaction is performed successfully example: '017060' acquirer_transaction_id: maxLength: 12 minLength: 12 type: string description: GETNET transaction NSU (Acquirer) example: '152147981' description: Credit and debit response dataset. AuthOauthV2TokenResponse: title: AuthOauthV2TokenResponse type: object properties: access_token: type: string format: uuid example: 0acc450b-cb7a-4e94-9881-d674f9e31947 token_type: type: string description: Token type, must be sent in the header with the token (https://tools.ietf.org/html/rfc6750) example: Bearer expires_in: type: string description: Token expiration time in seconds example: '3600' default: '3600' scope: type: string description: Scope example: oob default: oob Status: title: Status type: string description: transaction status enum: - APPROVED - AUTHORIZED - DENIED Status1: title: Status1 type: string description: Status of the transaction enum: - VERIFIED - NOT VERIFIED - DENIED - ERROR V1PaymentsCancelRequest: title: V1PaymentsCancelRequest required: - idempotency_key - payment_id - payment_method type: object properties: idempotency_key: maxLength: 64 minLength: 1 type: string description: idempotency key example: ORDER-10187383-8719d0c4-2c3f-4360-abd9-8daf3834fe1f request_id: type: string description: Identifier of the request. Unique for each request. Case is not informed, it will be generated automatically. maxLength: 36 minLength: 36 format: uuidv4 example: daac03dc-73db-453f-9bea-b1391669d5d3 payment_id: type: string description: Payment identifier format: uuid example: 2c341d28-491b-4cf8-aec7-eeb60136b7a5 payment_method: $ref: '#/components/schemas/payment_method' amount: type: number description: Value equal to or less than the original transaction. Use only in case of partial cancellations in D+N. If not informed, it will be considered the original transaction amount. format: double example: 8900 custom_key: maxLength: 32 minLength: 3 type: string description: Customer key used to identify a request of cancellation. (Key must be unique per transaction). example: 20200630-8900 additional_data: type: object properties: split: $ref: '#/components/schemas/split_data' description: Additional payment data. Required fields for split of payment. V1PaymentsCaptureRequest: title: V1PaymentsCaptureRequest required: - idempotency_key - payment_id - payment_method type: object properties: idempotency_key: maxLength: 64 minLength: 1 type: string description: idempotency key example: ORDER-10187383-8719d0c4-2c3f-4360-abd9-8daf3834fe1f request_id: type: string description: Identifier of the request. Unique for each request. Case is not informed, it will be generated automatically. maxLength: 36 minLength: 36 format: uuidv4 example: daac03dc-73db-453f-9bea-b1391669d5d3 payment_id: type: string description: Payment identifier format: uuid example: 2c341d28-491b-4cf8-aec7-eeb60136b7a5 payment_method: type: string description: Payment method example: CREDIT_AUTHORIZATION default: CREDIT_AUTHORIZATION amount: type: number description: Amount equal to or less than the original transaction in cents format: double example: 8900 additional_data: type: object properties: split: $ref: '#/components/schemas/split_data' description: Additional payment data. Required fields for split of payment. V1PaymentsRequest: title: V1PaymentsRequest required: - idempotency_key - order_id type: object properties: idempotency_key: maxLength: 64 minLength: 1 type: string description: Idempotency key example: ORDER-10187383-8719d0c4-2c3f-4360-abd9-8daf3834fe1f request_id: type: string description: Identifier of the request. Unique for each request. Case is not informed, it will be generated automatically. maxLength: 36 minLength: 36 format: uuidv4 example: daac03dc-73db-453f-9bea-b1391669d5d3 order_id: type: string description: Order identifier example: ORDER-10187383 key_id: maxLength: 36 minLength: 36 type: string description: Public encryption key identifier. Mandatory only if the encrypted_data attribute is present. example: 50113aa3-fc17-4e3c-8db0-ec3bb3a9ae99 data: type: object properties: seller_id: maxLength: 36 minLength: 36 type: string description: E-commerce identification code. format: uuidv4 example: 6eb2412c-165a-41cd-b1d9-76c575d70a28 amount: type: integer description: Purchase amount in cents. example: 100 payment: $ref: '#/components/schemas/payment' currency: maxLength: 3 minLength: 3 type: string description: Currency identification (See code at "https://www.currency-iso.org/en/home/tables/table-a1.html"). example: BRL order: $ref: '#/components/schemas/order' boleto: $ref: '#/components/schemas/boleto' customer: $ref: '#/components/schemas/customer_boleto' additional_data: type: object properties: split: $ref: '#/components/schemas/split_data' description: Additional payment data. Required fields for payment split. description: Payment details. paymentAuthorizationResponse: title: Authorization response type: object description: Authorization response body object. properties: seller_id: $ref: '#/components/schemas/seller_id' request_id: $ref: '#/components/schemas/request_id' payment_id: $ref: '#/components/schemas/payment_id' order_id: $ref: '#/components/schemas/order_id' amount: $ref: '#/components/schemas/amount' currency: $ref: '#/components/schemas/currency' status: type: string example: AUTHORIZED description: transaction status payment_method: type: string example: CREDIT_AUTHORIZATION description: Payment method enum: - CREDIT_AUTHORIZATION received_at: $ref: '#/components/schemas/received_at' transaction_id: $ref: '#/components/schemas/transaction_id' original_transaction_id: type: string example: '-1' maxLength: 18 description: Original transaction identifier authorized_at: $ref: '#/components/schemas/authorized_at' reason_code: $ref: '#/components/schemas/reason_code' reason_message: $ref: '#/components/schemas/reason_message' acquirer: $ref: '#/components/schemas/acquirer' soft_descriptor: $ref: '#/components/schemas/soft_descriptor' brand: $ref: '#/components/schemas/brand' authorization_code: $ref: '#/components/schemas/authorization_code' acquirer_transaction_id: $ref: '#/components/schemas/acquirer_transaction_id' eci: $ref: '#/components/schemas/eci' total_installment_amount: $ref: '#/components/schemas/total_installment_amount' first_installment_amount: $ref: '#/components/schemas/first_installment_amount' other_installment_amount: $ref: '#/components/schemas/other_installment_amount' record: title: Record Object type: object description: '' properties: rel: $ref: '#/components/schemas/rel' registred_at: $ref: '#/components/schemas/registred_at' idempotency_key: $ref: '#/components/schemas/idempotency_key' href: type: string format: uri description: URI to query a component related to the item. requestPayment: type: object title: Request for authorization or purchase properties: idempotency_key: $ref: '#/components/schemas/idempotency_key' request_id: $ref: '#/components/schemas/request_id' order_id: $ref: '#/components/schemas/order_id' date: type: object description: Set of data to be encrypted required: - payment properties: amount: $ref: '#/components/schemas/amount' currency: $ref: '#/components/schemas/currency' customer_id: type: string maxLength: 100 description: buyer identifier example: 6df370e7-8f97-4e7a-a36e-16ad2db6c5fc payment: $ref: '#/components/schemas/payment' sub_merchant: type: object description: Dataset referring to the payment facilitator. If informed, all attributes are mandatory. properties: identification_code: type: string example: '9058344' maxLength: 15 description: Identifier of the sub-negotiation. document_type: type: string enum: - CPF - CNPJ example: CNPJ maxLength: 4 minLength: 3 description: Document type. document_number: type: string example: '20551625000159' minLength: 11 maxLength: 14 description: Sub-negotiation document (without mask). address: type: string example: Dark Tower, 44 maxLength: 40 description: Sub-trade address. city: type: string maxLength: 13 example: city description: City of the sub-trade. state: type: string example: RS minLength: 2 maxLength: 2 description: State of the sub-trade postal_code: type: string example: '90520000' maxLength: 8 description: Postal Code (ZIP Code) of the sub-trade required: - identification_code - document_type - document_number - address - city - state - postal_code additional_data: type: object required: - idempotency_key - request_id - order_id - data description: Request for authorization or purchase. paymentCanceledCancelResponse: title: Cancel completed answer type: object properties: idempotency_key: type: string description: Idempotency Key example: ORDER-10187383-8719d0c4-2c3f-4360-abd9-8daf3834fe1f seller_id: type: string description: e-commerce identification code format: uuid example: 9406df6c-3100-49ba-b4df-d81c1ad8a62b request_id: type: string description: Request identifier. Unique to each request. If not informed, it will be generated automatically. maxLength: 36 minLength: 36 format: uuidv4 example: daac03dc-73db-453f-9bea-b1391669d5d3 payment_id: type: string description: Payment identifier format: uuid example: 2c341d28-491b-4cf8-aec7-eeb60136b7a5 order_id: type: string description: Order identifier example: ORDER-10187383 maxLength: 32 minLength: 1 amount: type: integer description: Purchase amount in cents example: 8900 currency: maxLength: 3 minLength: 3 type: string description: Currency Identification (See "https://www.currency-iso.org/en/home/tables/table-a1.html") example: BRL status: type: string description: Status of the transaction example: CANCELED canceled_at: type: string description: Cancellation Date example: '2020-07-01T02:15:03.603Z' reason_code: maxLength: 2 minLength: 2 type: string description: Transaction response code. If different from '00' the transaction is denied. example: '00' reason_message: type: string description: Response Message example: SUCCESSFULLY EXECUTED TRANSACTION custom_key: maxLength: 32 minLength: 3 type: string description: Customer key used to identify a cancellation request. (The key must be unique per transaction). example: 20200630-8900 description: Synchronous cancellation response body object. paymentAcceptedCancelResponse: title: Cancel accepted answer type: object properties: idempotency_key: type: string description: Idempotency Key example: ORDER-10187383-8719d0c4-2c3f-4360-abd9-8daf3834fe1f seller_id: type: string description: e-commerce identification code format: uuid example: 9406df6c-3100-49ba-b4df-d81c1ad8a62b request_id: type: string description: Request identifier. Unique to each request. If not informed, it will be generated automatically. maxLength: 36 minLength: 36 format: uuidv4 example: daac03dc-73db-453f-9bea-b1391669d5d3 payment_id: type: string description: Payment identifier format: uuid example: 2c341d28-491b-4cf8-aec7-eeb60136b7a5 order_id: type: string description: Order identifier example: ORDER-10187383 maxLength: 32 minLength: 1 amount: type: integer description: Purchase amount in cents example: 8900 currency: maxLength: 3 minLength: 3 type: string description: Currency identification (See "https://www.currency-iso.org/en/home/tables/table-a1.html") example: BRL status: type: string description: transaction status example: CANCELED reason_code: maxLength: 2 minLength: 2 type: string description: Transaction response code. If different from '00' the transaction is denied. example: '00' reason_message: type: string description: Reply message example: SUCCESSFULLY EXECUTED TRANSACTION custom_key: maxLength: 32 minLength: 3 type: string description: Customer key used to identify a cancellation request. (The key must be unique per transaction). example: 20200630-8900 protocol: maxLength: 18 minLength: 18 type: string description: Cancellation protocol example: '202006302344230001' description: Cancel the accepted response body. The asynchronous refund has been accepted and is being processed. cancelResult: title: Cancel result type: object properties: payment_id: $ref: '#/components/schemas/payment_id' protocol: $ref: '#/components/schemas/protocol' authorization_code: $ref: '#/components/schemas/authorization_code' acquirer_transaction_id: $ref: '#/components/schemas/acquirer_transaction_id' currency: $ref: '#/components/schemas/currency' amount: $ref: '#/components/schemas/amount' status_processing_cancel_code: type: string description: Cancellation request status code. status_processing_cancel_message: type: string description: Cancellation request status message. description: Cancel result object. This result is only logged when an asynchronous refund is processed. badRequest: title: badRequest type: object properties: message: type: string description: Error message example: Bad Request name: type: string description: Module or service that returned the error example: GatewayPaymentServiceError status_code: type: number description: HTTP StatusCode example: 400 details: type: array description: Error details items: type: object properties: status: type: string description: Status example: DENIED error_code: type: string description: Error code example: GENERIC-400 payment_id: type: string description: Payment identifier format: uuid example: 2c341d28-491b-4cf8-aec7-eeb60136b7a5 description: type: string description: Short description of the error example: payment_method is invalid description_detail: type: string description: Detailed description of the error example: The payment_method attribute is required. Please check your request and try again badRequestKey: title: badRequest type: object properties: message: type: string description: Error message example: Bad Request name: type: string description: Module or service that returned the error example: GatewayCryptoServiceError status_code: type: number description: HTTP StatusCode example: 400 details: type: array description: Error details items: type: object properties: status: type: string description: Status example: DENIED error_code: type: string description: Error code example: GENERIC-400 description: type: string description: Short description of the error example: expiration_in_days is invalid description_detail: type: string description: Detailed description of the error example: The expiration_in_days attribute is invalid. Please check your request and try again badRequestVerify: title: badRequest type: object properties: message: type: string description: Error message example: Bad Request name: type: string description: Module or service that returned the error example: GatewayVerifyServiceError status_code: type: number description: HTTP StatusCode example: 400 details: type: array description: Error details items: type: object properties: status: type: string description: Status example: DENIED error_code: type: string description: Error code example: GENERIC-400 description: type: string description: Short description of the error example: Short description of the error description_detail: type: string description: Detailed description of the error example: Detailed description of the error unauthorized: title: unauthorized type: object properties: message: type: string description: Error message example: Unauthorized name: type: string description: Module or service that returned the error example: GatewayAuthenticationOAuth2ServiceError status_code: type: number description: HTTP StatusCode example: 401 details: type: array description: Error details items: type: object properties: status: type: string description: Status example: DENIED error_code: type: string description: Error code example: AUTHENTICATION-401 description: type: string description: Short description of the error example: Unauthorized description_detail: type: string description: Detailed description of the error example: Invalid client credentials forbidden: title: forbidden type: object properties: message: type: string description: Error message example: Forbidden name: type: string description: Module or service that returned the error example: GatewayPaymentServiceError status_code: type: number description: HTTP StatusCode example: 403 details: type: array description: Error details items: type: object properties: status: type: string description: Status example: DENIED error_code: type: string description: Error code example: CONFIG-403 payment_id: type: string description: Payment identifier format: uuid example: 2c341d28-491b-4cf8-aec7-eeb60136b7a5 description: type: string description: Short description of the error example: Forbidden description_detail: type: string description: Detailed description of the error example: The credit product not enabled notFound: title: notFound type: object properties: message: type: string description: Error message example: Not Found name: type: string description: Module or service that returned the error example: GatewayCryptoServiceError status_code: type: number description: HTTP StatusCode example: 404 details: type: array description: Error details items: type: object properties: status: type: string description: Status example: DENIED error_code: type: string description: Error code example: GENERIC-404 payment_id: type: string description: Payment identifier format: uuid example: 2c341d28-491b-4cf8-aec7-eeb60136b7a5 description: type: string description: Short description of the error example: Not Found description_detail: type: string description: Detailed description of the error example: The key_id not found paymentNotFound: title: notFoundCapture type: object properties: message: type: string description: Error message example: Not Found name: type: string description: Module or service that returned the error example: GatewayPaymentServiceError status_code: type: number description: HTTP StatusCode example: 404 details: type: array description: Error details items: type: object properties: status: type: string description: Status example: DENIED error_code: type: string description: Error code example: GENERIC-404 description: type: string description: Short description of the error example: Not Found description_detail: type: string description: Detailed description of the error example: Payment not found tooManyRequests: title: tooManyRequests type: object properties: message: type: string description: Error message example: Too Many Requests name: type: string description: Module or service that returned the error example: GatewayPaymentServiceError status_code: type: number description: HTTP StatusCode example: 429 details: type: array description: Error details items: type: object properties: status: type: string description: Status example: DENIED error_code: type: string description: Error code example: GENERIC-429 payment_id: type: string description: Payment identifier format: uuid example: 2c341d28-491b-4cf8-aec7-eeb60136b7a5 description: type: string description: Short description of the error example: Too Many Requests description_detail: type: string description: Detailed description of the error example: The service only allow 10 requests per second to this endpoint. Try again soon. internalServerError: title: internalServerError type: object properties: message: type: string description: Error message example: Internal Server Error name: type: string description: Module or service that returned the error example: GatewayRouterHTTPServicesError status_code: type: number description: HTTP StatusCode example: 500 details: type: array description: Error details items: type: object properties: status: type: string description: Status example: ERROR error_code: type: string description: Error code example: GENERIC-500 description: type: string description: Short description of the error example: Internal Server Error description_detail: type: string description: Detailed description of the error example: The server encountered an unexpected error gatewayTimeout: title: gatewayTimeout type: object properties: message: type: string description: Error message example: Gateway Timeout name: type: string description: Module or service that returned the error example: GatewayRouterHTTPServicesError status_code: type: number description: HTTP StatusCode example: 504 details: type: array description: Error details items: type: object properties: status: type: string description: Status example: ERROR error_code: type: string description: error code example: GENERIC-504 description: type: string description: Short description of the error example: Gateway Timeout description_detail: type: string description: Detailed description of the error example: Connection timeout payment_boleto: required: - amount - boleto - customer - idempotency_key - order - payment - request_id - seller_id type: object properties: idempotency_key: maxLength: 64 minLength: 1 type: string description: Idempotency key, used to control requests, must be unique per request, because if it is repeated, it will always be returned the same data. example: 1eb2412c-165a-41cd-b1d9-76c575d70a21 request_id: maxLength: 36 minLength: 36 type: string description: request identification ID. format: uuidv4 example: 6eb2412c-165a-41cd-b1d9-76c575d70a28 currency: maxLength: 3 minLength: 3 type: string description: Currency identification (See code at "https://www.currency-iso.org/en/home/tables/table-a1.html"). example: BRL seller_id: maxLength: 36 minLength: 36 type: string description: E-commerce identification code. format: uuidv4 example: 6eb2412c-165a-41cd-b1d9-76c575d70a28 amount: type: integer description: Purchase amount in cents. example: 100 payment: $ref: '#/components/schemas/payment' boleto: $ref: '#/components/schemas/boleto' customer: $ref: '#/components/schemas/customer_boleto' order: $ref: '#/components/schemas/order_final' aditional_data: $ref: '#/components/schemas/additional_data' description: Set of data referring to the billet transaction. customer_boleto: type: object description: Set of data referring to the buyer. required: - name - document_type - document_number - billing_address properties: first_name: type: string description: Buyer's first name. maxLength: 40 example: John last_name: type: string description: Buyer's second name. maxLength: 40 example: da Silva name: type: string description: Buyer's full name. Required for ticket. maxLength: 40 example: João da Silva document_type: type: string description: Type of the buyer's identification document. Required for ticket. enum: - CPF - CNPJ example: CPF phone_number: type: string description: Buyer's phone. maxLength: 15 example: '5511955554444' email: type: string description: Buyer's email. maxLength: 50 example: joaodasilva@dominio.com document_number: type: string description: Purchaser's document number without punctuation. (without mask) minLength: 11 maxLength: 15 example: '12345678912' billing_address: $ref: '#/components/schemas/address_boleto' orders: required: - order_id type: object properties: order_id: maxLength: 36 type: string description: Purchase identification code used by the e-commerce example: 6d2e4380-d8a3-4ccb-9138-c289182818a3 sales_tax: type: number description: Tax value in percentage. example: 12 product_type: type: string description: Identifier of the type of product sold among the options example: service enum: - cash_carry - digital_content - digital_goods - digital_physical - gift_card - physical_goods - renew_subs - shareware - service description: Set of data for identifying the purchase payment: type: object required: - payment_method properties: payment_id: maxLength: 36 type: string description: payment code example: 6d2e4380-d8a3-4ccb-9138-c289182818a3 payment_method: type: string description: Payment method example: BOLETO enum: - BOLETO description: Payment id boleto: description: Data for generating the billet type: object properties: our_number: maxLength: 12 minLength: 12 type: string description: Named by banks as "Our Number". is the identification billet only in the billing system and does not have a mask. It's composed by rules that vary depending on the bank and collection service. Per For example, in the case of Santander there are two ways of numbering: 1) If the customer informs the number, the customer is in charge of informing the dv (check digit); 2) If the customer omits the number, the Bank is in charge of generating a sequel, without a DV. example: '1946598.0' document_number: maxLength: 15 minLength: 15 type: string description: Your Number. Number controlled by the customer, it is usually managed by the system that is generating the ticket. (without mask) example: '170500000019763' expiration_date: type: string description: Ticket expiration date. If not informed, it will be considered the pre-registered standard number of days for expiration. format: mm/dd/yyyy example: 11/16/2030 instructions: maxLength: 1000 type: string description: Instructions to be printed on the ticket. The line break can be performed in two ways. 1) Automatic line wrapping: it will be A line break is made in up to 100 characters without the words being truncated; 2) Manual line break: line break using the "\n" escape character. Example: "This is a break test line.\nThe second line will be printed now.\nAnd finally, the third line."; example: Do not receive after expiration provider: maxLength: 40 type: string description: Provider bank. example: santander default: santander enum: - santander guarantor_name: type: string description: Name of the guarantor. example: Ze small default: Ze small guarantor_document_type: type: string description: Type of document of the guarantor. example: CPF guarantor_document_number: type: string description: Number of the guarantor's document. example: '78009200021' default: '78009200021' order_final: type: object description: Set of data for identifying the purchase required: - order_id properties: order_id: type: string description: Purchase identification code used by e-commerce maxLength: 36 example: 6d2e4380-d8a3-4ccb-9138-c289182818a3 sales_tax: type: number description: Tax value in percentage. example: 12 product_type: type: string description: Identifier of 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 payment_boleto_response: type: object properties: payment_id: maxLength: 24 minLength: 24 type: string description: Payment identification code. example: 599ca35059028b001023b323 seller_id: maxLength: 36 minLength: 36 type: string description: E-commerce identification code. format: uuidv4 example: 6eb2412c-165a-41cd-b1d9-76c575d70a28 amount: type: string description: Purchase amount in cents . example: '100' currency: maxLength: 3 minLength: 3 type: string description: Currency identification (See code at "https://www.currency-iso.org/en/home/tables/table-a1.html"). example: BRL order_id: maxLength: 36 type: string description: Purchase identification code used by the e-commerce example: 6d2e4380-d8a3-4ccb-9138-c289182818a3 status: maxLength: 20 type: string description: Transaction status. For more information about status return, see Notifications 1.1 example: PENDING enum: - PENDING ticket: $ref: '#/components/schemas/payment_boleto_detail' description: Set of data from the ticket issue reply. address_boleto: required: - city - district - number - postal_code - state - street type: object properties: street: maxLength: 20 type: string description: Logradouro. example: Av. Brasil number: maxLength: 6 type: string description: Street number. example: '1000' complement: maxLength: 12 type: string description: Address complement. example: Room 1 district: maxLength: 30 type: string description: Neighborhood. example: Sao Geraldo city: maxLength: 20 type: string description: City. example: Porto Alegre state: maxLength: 2 type: string description: State (UF). example: RS postal_code: maxLength: 8 minLength: 8 type: string description: Postal Code, CEP in Brazil or ZIP in the United States. (without mask) example: '90230060' description: Set of data referring to the buyer's address payment_boleto_detail: type: object properties: boleto_id: maxLength: 36 minLength: 36 type: string description: Ticket ID. format: uuidv4 example: e587cefe-8832-4fc0-acff-acc83dd66e9e bank: maxLength: 4 minLength: 3 type: string description: EC bank number. (without mask) example: '0033' status_code: type: string description: Payment status code. example: '1' status_label: maxLength: 20 type: string description: Payment status in text example: OPEN typeful_line: maxLength: 54 minLength: 54 type: string description: Typeable line of the billet. example: '03399.58910 93000.000013 94659.801016 8 71670000030015' bar_code: maxLength: 44 minLength: 44 type: string description: Boleto barcode. (without mask) example: '03397999200000002309235515900000026629840101' issue_date: maxLength: 10 minLength: 10 type: string description: Date of generation of the payment slip. example: '17/05/2017' expiration_date: maxLength: 10 minLength: 10 type: string description: Ticket expiration date. example: '22/05/2017' our_number: maxLength: 13 minLength: 12 type: string description: Our number. (without mask) example: '0000001946598' document_number: maxLength: 15 minLength: 15 type: string description: Number of the document controlled by the client. (without mask) example: '170500000019763' _links: type: array example: - href: /v1/payments/boleto/593948e8589f66000ed575e0/pdf?ack=eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiI2N2UxZWJhNWE0YmFlNmE1MDExZmMzMGIiLCJpYXQiOjE3NDI4NTkxNzMsImF1ZGllbmNlIjoiWW05c1pYUnZMV1J2ZDI1c2IyRmtMWE5sY25acFkyVT0iLCJleHAiOjE3NDg3MzYwMDB9.HXX3kOf95MiXUG9fJUE4d8QsDlr3acTGsCpfvd2RFX6HYPHiywnlFq-mXCKCYPkdY3mUJVwW7ct7WXStKkDZG2ZqfC7d9CnMQs5b5Tjw4sg2vbeZrMkbd69ih6pt6f0hpmecPA_Jbonl995suzW67zQNy-oJ-4ULDlNLuu4FdmRRX31uLho3Gtu3PoQhC3p876m5oFJ1MTxdZwcIqiGQIXWv96elhx-LpIfT4yzisSkZGgRe-EVdh-q31hRrAH3HqsS6_BdXX0XSoFBhEbCtkjOlST0Rknm_kMyk1QCvrh5vCh9EAJQ5DTeglcyE8NgDG5CLzRcJcM6B1KpKOH0oHw rel: boleto_pdf type: GET - href: /v1/payments/boleto/593948e8589f66000ed575e0/html?ack=eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiI2N2UxZWJhNWE0YmFlNmE1MDExZmMzMGIiLCJpYXQiOjE3NDI4NTkxNzMsImF1ZGllbmNlIjoiWW05c1pYUnZMV1J2ZDI1c2IyRmtMWE5sY25acFkyVT0iLCJleHAiOjE3NDg3MzYwMDB9.HXX3kOf95MiXUG9fJUE4d8QsDlr3acTGsCpfvd2RFX6HYPHiywnlFq-mXCKCYPkdY3mUJVwW7ct7WXStKkDZG2ZqfC7d9CnMQs5b5Tjw4sg2vbeZrMkbd69ih6pt6f0hpmecPA_Jbonl995suzW67zQNy-oJ-4ULDlNLuu4FdmRRX31uLho3Gtu3PoQhC3p876m5oFJ1MTxdZwcIqiGQIXWv96elhx-LpIfT4yzisSkZGgRe-EVdh-q31hRrAH3HqsS6_BdXX0XSoFBhEbCtkjOlST0Rknm_kMyk1QCvrh5vCh9EAJQ5DTeglcyE8NgDG5CLzRcJcM6B1KpKOH0oHw rel: boleto_html type: GET items: type: object properties: {} description: Body with the billet data. error: type: object properties: message: maxLength: 250 type: string description: Detailed error message. name: maxLength: 250 type: string description: Name of the module or system where the error occurred. status_code: type: number description: HTTP Status code. details: type: array description: Error details. items: $ref: '#/components/schemas/empty' error_boleto_402: type: object properties: message: maxLength: 250 type: string description: Detailed error message. name: maxLength: 250 type: string description: Name of the module or system where the error occurred. status_code: type: number description: HTTP Status code. details: type: array description: For more details see Error Table. items: $ref: '#/components/schemas/empty' empty: type: object additional_data: type: object properties: split: $ref: '#/components/schemas/split_data' description: Additional payment details. Required field for payment split. split_data: type: object required: - subseller_list_payment properties: subseller_list_payment: type: array description: List of Stores and their due amounts for payment. items: type: object required: - subseller_id - document_number - subseller_sale_amount - items properties: subseller_id: maxLength: 25 minLength: 0 type: string description: Subseller ID registered on the marketplace platform (MGM). example: '700104158' document_type: maxLength: 4 minLength: 3 type: string description: Sub-trade document type. example: CNPJ enum: - CPF - CNPJ document_number: maxLength: 15 minLength: 11 type: string description: Sub-trade document number without punctuation. (without mask) example: '12345678912' subseller_sale_amount: type: integer description: Part of the Store Value in relation to the Order (in cents). example: 118708 items: type: array description: List of Subtrade items. items: type: object required: - id - description - amount properties: id: maxLength: 25 minLength: 1 type: string description: Item/Product Identifier. example: MR1 description: type: string description: Item/Product Description. example: Product MR1. amount: type: integer description: Item/Product value (in cents). example: 118708 transaction_rate_percent: type: number description: 'Fee to be charged on the item in percentage if not send the rate will be set the same as the registration.
If transaction_rate_percent is informed, the transaction_rate_amount should not be sent.
Note: If transaction_rate_percent and transaction_rate_amount are sent for the same item the values will be added together.' example: 1.2 transaction_rate_amount: type: integer description: 'Fee to be charged on the item in value (in cents) if you do not send the fee will be set the same as the registration.
If transaction_rate_amount is informed, the transaction_rate_percent must not be sent.
Note: If transaction_rate_percent and transaction_rate_amount are sent to the same item the values will be added.' example: 235 payment_plan: type: integer description: Subseller Payment Plan. example: 3 description: Data for split payment. Required field for payment split. payment_boleto_v2: required: - idempotency_key - request_id type: object properties: idempotency_key: maxLength: 64 minLength: 1 type: string description: Idempotency key, used to control requests, must be unique per request, because if it is repeated, it will always be returned the same data. example: 1eb2412c-165a-41cd-b1d9-76c575d70a21 request_id: maxLength: 36 minLength: 36 type: string description: request identification ID. format: uuidv4 example: 6eb2412c-165a-41cd-b1d9-76c575d70a28 data: type: object required: - amount - payment - order - boleto - customer properties: amount: type: integer description: Purchase value in cents. example: 100 payment: $ref: '#/components/schemas/payment' currency: maxLength: 3 minLength: 3 type: string description: Currency identification (See code at "https://www.currency-iso.org/en/home/tables/table-a1.html"). example: BRL order: $ref: '#/components/schemas/order_final' boleto: $ref: '#/components/schemas/boleto' customer: $ref: '#/components/schemas/customer_boleto' additional_data: type: object description: Additional authorization data. Required field for payment split. properties: split: $ref: '#/components/schemas/split_data' description: Payment details. description: Set of data referring to the billet transaction. payment_boleto_response_v2: type: object properties: payment_id: maxLength: 24 minLength: 24 type: string description: Payment identification code. example: 599ca35059028b001023b323 status: maxLength: 20 type: string description: Transaction status. For more information about status return, see Notifications 1.1 example: EM ABERTO enum: - EM ABERTO seller_id: maxLength: 36 minLength: 36 type: string description: E-commerce identification code. format: uuidv4 example: 6eb2412c-165a-41cd-b1d9-76c575d70a28 amount: type: string description: Purchase amount in cents. example: '100' currency: maxLength: 3 minLength: 3 type: string description: Currency identification (See code at "https://www.currency-iso.org/en/home/tables/table-a1.html"). example: BRL order_id: maxLength: 36 type: string description: Purchase identification code used by e-commerce. example: 6d2e4380-d8a3-4ccb-9138-c289182818a3 ticket: $ref: '#/components/schemas/payment_boleto_detail_pix' description: Set of data from the ticket issue reply. payment_boleto_detail_pix: type: object properties: boleto_id: maxLength: 36 minLength: 36 type: string description: Boleto identification. format: uuidv4 example: e587cefe-8832-4fc0-acff-acc83dd66e9e bank: maxLength: 4 minLength: 3 type: string description: EC bank number. (without mask) example: '0033' status_code: type: string description: Payment status code. example: '1' status_label: maxLength: 20 type: string description: Payment status in text example: OPEN typeful_line: maxLength: 54 minLength: 54 type: string description: Typeable line of the billet. example: '03399.58910 93000.000013 94659.801016 8 71670000030015' bar_code: maxLength: 44 minLength: 44 type: string description: Boleto barcode. (without mask) example: '03397999200000002309235515900000026629840101' issue_date: maxLength: 10 minLength: 10 type: string description: Date of generation of the payment slip. example: '17/05/2017' expiration_date: maxLength: 10 minLength: 10 type: string description: Ticket expiration date. example: '22/05/2017' our_number: maxLength: 13 minLength: 12 type: string description: Our number. (without mask) example: '0000001946598' document_number: maxLength: 15 minLength: 15 type: string description: Number of the document controlled by the client. (without mask) example: '170500000019763' pix: type: object properties: cod_qrcode: type: string description: Base64 code for generating the QRCode image. format: Base64 example: '00020101021226900014br.gov.bcb.pix2568pix.santander.com.br/qr/v2/cobv/5d877814-6974-42b9-aed8-4bab01ddb1eb52040000530398654042.305802BR5925ESTABELECIMENTO E SERVICO6009SAO PAULO12345678***63047FF0' cod_url_qrcode: type: string description: QRCode visualization URL. format: url example: 'pix.santander.com.br/qr/v2/cobv/a796c937-80ee-483c-a8d5-72f95759fd99' description: Payment data via Pix. _links: type: array example: - href: /v1/payments/boleto/593948e8589f66000ed575e0/pdf?ack=eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiI2N2UxZWJhNWE0YmFlNmE1MDExZmMzMGIiLCJpYXQiOjE3NDI4NTkxNzMsImF1ZGllbmNlIjoiWW05c1pYUnZMV1J2ZDI1c2IyRmtMWE5sY25acFkyVT0iLCJleHAiOjE3NDg3MzYwMDB9.HXX3kOf95MiXUG9fJUE4d8QsDlr3acTGsCpfvd2RFX6HYPHiywnlFq-mXCKCYPkdY3mUJVwW7ct7WXStKkDZG2ZqfC7d9CnMQs5b5Tjw4sg2vbeZrMkbd69ih6pt6f0hpmecPA_Jbonl995suzW67zQNy-oJ-4ULDlNLuu4FdmRRX31uLho3Gtu3PoQhC3p876m5oFJ1MTxdZwcIqiGQIXWv96elhx-LpIfT4yzisSkZGgRe-EVdh-q31hRrAH3HqsS6_BdXX0XSoFBhEbCtkjOlST0Rknm_kMyk1QCvrh5vCh9EAJQ5DTeglcyE8NgDG5CLzRcJcM6B1KpKOH0oHw rel: boleto_pdf type: GET - href: /v1/payments/boleto/593948e8589f66000ed575e0/html?ack=eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiI2N2UxZWJhNWE0YmFlNmE1MDExZmMzMGIiLCJpYXQiOjE3NDI4NTkxNzMsImF1ZGllbmNlIjoiWW05c1pYUnZMV1J2ZDI1c2IyRmtMWE5sY25acFkyVT0iLCJleHAiOjE3NDg3MzYwMDB9.HXX3kOf95MiXUG9fJUE4d8QsDlr3acTGsCpfvd2RFX6HYPHiywnlFq-mXCKCYPkdY3mUJVwW7ct7WXStKkDZG2ZqfC7d9CnMQs5b5Tjw4sg2vbeZrMkbd69ih6pt6f0hpmecPA_Jbonl995suzW67zQNy-oJ-4ULDlNLuu4FdmRRX31uLho3Gtu3PoQhC3p876m5oFJ1MTxdZwcIqiGQIXWv96elhx-LpIfT4yzisSkZGgRe-EVdh-q31hRrAH3HqsS6_BdXX0XSoFBhEbCtkjOlST0Rknm_kMyk1QCvrh5vCh9EAJQ5DTeglcyE8NgDG5CLzRcJcM6B1KpKOH0oHw rel: boleto_html type: GET items: type: object properties: {} description: Body with billet data. authorization: type: object properties: idempotency_key: maxLength: 64 minLength: 1 type: string description: Idempotency key, used to control requests, must be unique per request, because if it is repeated, it will always be returned the same data. example: 1eb2412c-165a-41cd-b1d9-76c575d70a21 request_id: type: string description: Identifier of the request. Unique for each request. Case is not informed, it will be generated automatically. maxLength: 36 minLength: 36 format: uuidv4 example: daac03dc-73db-453f-9bea-b1391669d5d3 order_id: maxLength: 36 type: string description: | Purchase identification code used by the e-commerce (code or order number). example: 6d2e4380-d8a3-4ccb-9138-c289182818a3 amount: type: string description: Item/Product Value (in cents) example: '10202' currency: maxLength: 3 minLength: 3 type: string description: Currency identification (See code at "https://www.currency-iso.org/en/home/tables/table-a1.html") example: BRL payment: type: array description: Dataset containing the order items. items: $ref: '#/components/schemas/payment_complete' sub_merchant: $ref: '#/components/schemas/sub_merchant' additional_data: type: object properties: split: $ref: '#/components/schemas/split_data' description: Additional payment data. Required fields for split of payment. description: Return of authorization confirmation. payment_complete: type: object properties: payment_id: maxLength: 36 type: string description: payment code example: 6d2e4380-d8a3-4ccb-9138-c289182818a3 payment_method: type: string description: Payment method example: BOLETO 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. Payment in full, in installments without interest, paid in installments with interest. example: FULL enum: - FULL - INSTALL_NO_INTEREST - INSTALL_WITH_INTEREST number_installations: type: number description: Number of installments for an installment credit transaction. example: 1 soft_descriptor: $ref: '#/components/schemas/soft_descriptor_global_sub_merchant' dynamic_mcc: $ref: '#/components/schemas/dynamic_mcc_sub_merchant' card: $ref: '#/components/schemas/card_credit' tokenization: $ref: '#/components/schemas/tokenization' wallet: $ref: '#/components/schemas/wallet' xid: maxLength: 40 minLength: 40 type: string description: | Field available from version 2.0 onwards. Identifier of MPI for each authenticated transaction. Field content can be a value HEXA or Base64, according to the MPI used. ucaf: maxLength: 40 minLength: 40 type: string description: Field available from version 2.0. authentication code Encrypted by Flag. Field content can be a HEXA value or Base64, according to the MPI used. eci: maxLength: 2 minLength: 2 type: string description: Field available from version 2.0. Transaction ECI code Authenticated 3D Secure. Generated by an External MPI. tdsdsxid: type: string description: Identificador da transação do servidor 3DS versão 2. example: dbdcb82d-63c5-496f-ae27-1ecfc3a8dbec tdsver: type: string description: Indicates the 3DS version used for authentication, example: 2.1.0 credentials_on_file_type: type: string description: |-

Type of COF (Credential On File).

ONE_CLICK: Used when the first transaction (installment) of a normal payment is made.
ONE_CLICK_PAYMENT: Used when making transactions for the remaining installments of a normal payment. Note: It is necessary to inform the transaction_id of the first transaction carried out.
RECURRING: Used when the first transaction (installment) of a recurring payment is made.
RECURRING_PAYMENT: Used when making transactions for the remaining installments of a recurring payment. Note: It is necessary to inform the transaction_id of the first transaction carried out.

There are 3 types of submerchants, which are described as:

F - Full Foreign:
All submerchants are international.
P - Partial Foreign:
Mixed cart with submerchants international and nationals.
D - Full Domestic:
All submerchants are nationals.

enum: - F - P - D example: D minLength: 1 maxLength: 1 address: maxLength: 40 type: string description: Sub-commerce address. (No commas allowed) example: Dark Tower 44 city: maxLength: 13 type: string description: City of Subtrade. example: city state: maxLength: 2 minLength: 2 type: string description: State of the Sub-trade. example: RS postal_code: maxLength: 8 minLength: 8 type: string description: Postal code (CEP) of the Sub-trade. example: '90520000' description: In order for Getnet to comply with the rules of Flags and Arrangements, Federal Laws and determinations of BACEN (Central Bank of Brazil) for identification of the final entities (sub-businesses) that make the financial transactions, the Payment Facilitators must send the identification data of their customers for every transaction sent to Getnet. soft_descriptor_global_sub_merchant: maxLength: 22 type: string description: |- Text displayed on the buyer's card invoice, this field is optional, if nothing is informed, the trade name registered for the establishment will be considered. 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 non-allowed characters are sent. Any information that exceeds the maximum size will be disregarded. Mandatory for Payment Facilitators. In addition to the above, you must adhere to the following additional Flag rules:

Identification of the Payment Facilitator, with 3, 7 or 12 characters
Separator characters "*" (asterisk)
Sub-trade identification
Example 1: FAC*SUCOMERCIO
Example 2: FACILIT*SUBCOMERCIO
Example 3: FACILITATOR1*SUBCOMERC

example: STORE*TEST*BUY-123 dynamic_mcc_sub_merchant: maxLength: 4 minLength: 4 type: number description: |- Field used to signal the transaction with another Merchant Category Code (Merchant Category Code) different from the registered one. If an invalid MCC is sent, the default will be used. Send numeric data only.

Mandatory for Payment Facilitators and SDWO. example: 1799 card_credit: required: - expiration_month - expiration_year - number_token type: object properties: number: minLength: 23 type: string description: Card number. example: '5155901222280001' number_token: maxLength: 128 minLength: 128 type: string description: Tokenized card number. example: dfe05208b105578c070f806c80abd3af09e246827d29b866cf4ce16c205849977c9496cbf0d0234f42339937f327747075f68763537b90b31389e01231d4d13c cardholder_name: maxLength: 26 type: string description: Buyer's name printed on the card.
Mandatory field for Antifraude example: JOAO DA SILVA security_code: maxLength: 4 minLength: 3 type: string description: Security code. CVV or CVC.
Mandatory field for Antifraude example: '123' brand: maxLength: 50 type: string description: Card flag. Auto-populated by API case not be informed.
Required field for Antifraud example: mastercard enum: - Mastercard - Visa - Amex - Link - Hipercard expiration_month: maxLength: 2 minLength: 2 type: string description: Two-digit card expiry month. example: '12' expiration_year: maxLength: 2 minLength: 2 type: string description: Two-digit card expiry year. example: '20' description: Card data set. tokenization: title: Tokenização type: object properties: type: type: string description: tokenization type example: TAVV enum: - UCAF - TAVV cryptogram: type: string description: Value of the cryptogram generated by the TSP (Token Service Provider) example: 'AM1BmNLpj5+nADA4gol2AAABBB==' eci: type: string description: ECI Indicator (Electronic Commerce Indicator) example: '05' requestor_id: type: string description: Array of objects containing error details example: '1234567' description: Type of cryptogram used by the TSP (Token Service Provider). Values can be - TAVV For Visa and ELO cards; - UCAF For Mastercard branded cards; wallet: type: object description: |- Fields for compliance with digital wallet rules of the SDWO arrangement - (Staged Digital Wallet Operator). The Model is about digital wallets (Wallets) that accredit establishments to accept their means of payment, similar to the Payment Facilitators model. As for settlement, the amounts arising from payments through the Wallets are sent to EC Wallet and, secondly, it transfers to its final sub-trades. Today the model is structured for Visa, Mastercard and Elo. Transactions in a Scaled Digital Wallet (SDWO) basically have two models. >- Cash-In flagged transaction not linked to a purchase; o Supplying Funds in the Wallet using the Card. Ex. wallet balance recharge via card o Transfer to another person's balance using a card.>- Purchase (also known as back-to-back); o Payment of printed QR Code / wallet owner using card. Ex. QR Code of the digital wallet printed at the counter and paid by card o Online payment through the logged-in area of the wallet using a card. >- For Cash-in transactions, in addition to filling in the wallet subgroup tags, it is also necessary to send the dynamic_mcc and soft_descriptor fields present in the payment subgroups present in the “payments” tab of this documentation. For Back-to-Back transactions, in addition to filling in the wallet subgroup tags, dynamic_mcc, with the number that best describes the activity of the sub-merchant that carried out the transaction and soft_descriptor, it is also necessary to fill in the sub_merchant subgroup, informing the respective data of the sub-commerce that carried out the transaction. For each type of use case, it is necessary to fill in some data available in the list below, in which it is possible to check their respective rules and obligations. properties: type: type: string description: Portfolio Type maxLength: 2 enum: - 01 MasterPass Wallet - 02 Visa Checkout - 10 Generic Tokenized Wallet - 55 Local Brazil Wallet (SDWO) example: '55' id: type: string description: BRL Local Brazil Wallet (SDWO) (Valor default ) example: BRL maxLength: 5 merchant_id: type: string description: Identification number of the Digital Wallet registered together with the brands For example Mastercard WID with 3 positions, Visa MVV with 6 positions and ELO WID with 11 positions. example: '327' maxLength: 12 fund_transfer: type: object description: Data for transactions of the SDWO (Staged Digital Wallet Operator) array properties: pay_action: type: string description: Financing Type enum: - FT Funding Transfer – Which must be marked in transactions of SDWO cash-in for all brands. - FP Funding and Purchase – Which must be checked in Funding Transactions Back-to-Back SDWO for all flags. - BP Billpay – Scheduling of bill payment in the Visa CBPS program example: FT maxLength: 2 receiver: type: object description: Receiver Account Data properties: account_number: type: string description: Receiver Account Number which can be filled in with one of following values "#NA" or "9999999999999995". necessary the fulfillment only for the Mastercard brand, for Cash-in SDWO transactions, for other brands or padding is optional. example: '9999999999999995' maxLength: 20 account_type: type: string description: Required filling only for the Mastercard brand for Cash-in SDWO transactions, for other brands or padding is optional. enum: - 01 — RTN + Bank Account - 02 — IBAN - 03 — Card Account (for getnet currently only available type) - 04 — Email - 05 — Telephone Number - 06 — Bank account number (BAN) + Payment code Bank Identification (BIC) - 07 — Portfolio ID - 08 — Social Network ID - 00 - Other (Default, currently only allowed value) example: '00' maxLength: 2 first_name: type: string description: |- Receiver First Name which must be filled in with the first transfer recipient's name. Ex Jane. necessary the padding just for the Mastercard brand for transactions of Cash-in SDWO, for the others flags filling is optional example: Jane maxLength: 35 middle_name: type: string description: 'Receiver Middle Name that must be filled in with the abbreviation the transfer recipient''s middle name. Eg: T. Padding is optional for all flags. minLength: 1 maxLength: 1' example: T last_name: type: string description: 'Receiver Last Name that must be filled in with last name (last name) of the transfer recipient. For example: Smith. Completion only for the Mastercard brand for Cash-in SDWO transactions, for other brands filling is optional' example: Smith maxLength: 35 addr_street: type: string description: 'Receiver Addr Street which must be filled in with the address of the recipient of the transfer (street and number). Eg: 1 Main ST. Padding is optional for all flags.' example: 1 MainST maxLength: 50 addr_city: type: string description: 'Receiver Addr City which must be filled in with the city of recipient of the transfer. For example: SAO PAULO. Filling it is optional for all flags.' example: SAO PAULO maxLength: 25 addr_state: type: string description: 'Receiver Addr State that must be filled in with the state of the recipient of the transfer. Eg: SP. the filling is optional for all flags.' example: SP maxLength: 3 addr_country: type: string description: Receiver Addr Country which must be filled in with the country of recipient of the transfer. E.g. BR. necessary the fulfillment only for the Mastercard brand for Cash-in SDWO transactions, for other brands or padding is optional example: BRA maxLength: 3 addr_postal_code: type: string description: 'Receiver Addr Postal Code that must be filled in with the postal code (ZIP code) of the recipient of the transfer. Ex: 01408000. Filling is optional for all flags.' example: '1408000' maxLength: 10 nationality: type: string description: Receiver Nationality which must be filled in with the nationality of the recipient of the transfer. E.g. BR. O padding is optional for all flags. example: BRA maxLength: 3 phone: type: string description: 'Receiver Phone which must be filled in with the number of Transfer recipient''s phone number, including code from the country. Ex: 5511977778888. Completion is optional for all flags.' example: '5511977778888' maxLength: 20 date_of_birth: type: string description: |- Receiver Date Of Birth which must be filled in with the date of birth of recipient of the transfer with the YYYYMMDD format. Ex 19901230. Filling is optional for all flags. example: '19901230' maxLength: 8 id_type: type: string description: Receiver Id Type that must be filled in with the type of document used by the recipient of the transfer (CPF or CNPJ). In this case, fill in 03. The filling out for Mastercard, Visa and Elo brands to Cash-in SDWO transactions, for other brands the filling in is optional. enum: - 00 = Passport - 01 = National Identification Card - 02 = Driver's License - 03 = Issued by the Government - 04 = Other example: '03' maxLength: 2 id_num: type: string description: Receiver Id Number that must be filled in with the CPF number or CNPJ of the transfer recipient. Ex 12345678900000. Completion required for Mastercard, Visa and Elo brands for Cash-in SDWO transactions, for other brands the filling is optional. example: '12345678900000' maxLength: 25 sender: type: object description: Sender Account Data properties: account_number: type: string description: Sender Account Number which can be filled in with one of following values "#NA" or "9999999999999995". necessary the fulfillment only for the Mastercard brand, for Cash-in SDWO transactions, for other brands or padding is optional. example: '9999999999999995' maxLength: 20 account_type: type: string description: Required filling only for the Mastercard brand for Cash-in SDWO transactions, for other brands or padding is optional. enum: - 01 — RTN + Bank Account - 02 — IBAN - 03 — Card Account (for getnet currently only available type) - 04 — Email - 05 — Telephone Number - 06 — Bank account number (BAN) + Payment code Bank Identification (BIC) - 07 — Portfolio ID - 08 — Social Network ID - 00 - Other (Default, currently only allowed value) example: '00' maxLength: 2 first_name: type: string description: |- Sender First Name which must be filled in with the first transfer sender name. Ex Jane. necessary the padding just for the Mastercard brand for transactions of Cash-in SDWO, for the others flags filling is optional example: Jane maxLength: 35 middle_name: type: string description: 'Sender Middle Name that must be filled in with the abbreviation the transfer sender middle name. Eg: T. Padding is optional for all flags. minLength: 1 maxLength: 1' example: T last_name: type: string description: 'Sender Last Name that must be filled in with last name (last name) of the transfer sender. For example: Smith. Completion only for the Mastercard brand for Cash-in SDWO transactions, for other brands filling is optional' example: Smith maxLength: 35 addr_street: type: string description: 'Sender Addr Street which must be filled in with the address of the sender of the transfer (street and number). Eg: 1 Main ST. Padding is optional for all flags.' example: 1 MainST maxLength: 50 addr_city: type: string description: 'Sender Addr City which must be filled in with the city of sender of the transfer. For example: SAO PAULO. Filling it is optional for all flags.' example: SAO PAULO maxLength: 25 addr_state: type: string description: 'Sender Addr State that must be filled in with the state of the sender of the transfer. Eg: SP. the filling is optional for all flags.' example: SP maxLength: 3 addr_country: type: string description: 'Sender Addr Country which must be filled in with the country of sender of the transfer. E.g. BR. necessary the fulfillment only for the Mastercard brand for Cash-in SDWO transactions, for other brands or padding is optional' example: BRA maxLength: 3 addr_postal_code: type: string description: 'Sender Addr Postal Code that must be filled in with the postal code (ZIP code) of the sender of the transfer. Ex: 01408000. Filling is optional for all flags.' example: '1408000' maxLength: 10 nationality: type: string description: Sender Nationality which must be filled in with the nationality of the sender of the transfer. E.g. BR. O padding is optional for all flags. example: BRA maxLength: 3 phone: type: string description: 'Sender Phone which must be filled in with the number of Transfer sender phone number, including code from the country. Ex: 5511977778888. Completion is optional for all flags.' example: '5511977778888' maxLength: 20 date_of_birth: type: string description: |- Sender Date Of Birth which must be filled in with the date of birth of sender of the transfer with the YYYYMMDD format. Ex 19901230. Filling is optional for all flags. example: '19901230' maxLength: 8 id_type: type: string description: 'Sender Id Type that must be filled in with the type of document used by the sender of the transfer (CPF or CNPJ). In this case, fill in 03. The filling out for Mastercard, Visa and Elo brands to Cash-in SDWO transactions, for other brands the filling in is optional.' enum: - 00 = Passport - 01 = National Identification Card - 02 = Driver's License - 03 = Issued by the Government - 04 = Other example: '03' maxLength: 2 id_num: type: string description: 'Sender Id Number that must be filled in with the CPF number or CNPJ of the transfer sender. Ex 12345678900000. Completion required for Mastercard, Visa and Elo brands for Cash-in SDWO transactions, for other brands the filling is optional.' example: '12345678900000' maxLength: 25 release: type: object properties: idempotency_key: maxLength: 64 minLength: 1 type: string description: Idempotency key, used to control requests, must be unique per request, because if it is repeated, it will always be returned the same data. example: 1eb2412c-165a-41cd-b1d9-76c575d70a21 release_payment_date: maxLength: 24 type: string description: Payment Release Date for the seller (SubSeller). example: '2017-04-19T16:30:30.000Z' subseller_id: type: string description: Store identifier in the system. example: '10' order_item_release: type: array description: Dataset containing the order items. items: $ref: '#/components/schemas/order_item' payment: type: array description: Dataset containing the order items. items: $ref: '#/components/schemas/payment' description: Return payment error details in case of failed status in creating the Subscription. order_item: type: object properties: id: type: string description: Item/Product Identifier example: X0001 amount: type: string description: Item/Product Value (in cents) example: '10202' description: Dataset containing the order items. 3ds_token: required: - client_code - currency - js_version - override_payment_method - total_amount type: object properties: client_code: maxLength: 13 type: string description: | 3DS authentication session identifier code. The value must be an order reference generated by ecommerce or a tracking number. We recommend that you submit a unique amount for each transaction. This one value will be returned in response to requests on endpoints /v1/3ds/authentications and /v1/3ds/authentications/results. The return will be in the field client_reference_information.code na forma de uma string composta por [client_code] + [-] + [UUID] (Exemplo: client_code-00000000-0000-0000-0000-000000000000). currency: maxLength: 3 minLength: 3 type: string description: | Currency identification (See code at "https://en.wikipedia.org/wiki/ISO_4217"). example: BRL default: BRL items: $ref: '#/components/schemas/3ds_item_array_ref' js_version: maxLength: 10 type: string description: JavaScript library version identification getnet_3ds220.js. example: 1.0.0 order_number: maxLength: 40 type: string description: Purchase identification code used by your e-commerce (code or order number). example: 1234-2019 override_payment_method: maxLength: 2 minLength: 2 type: string description: | Indica o tipo de conta.
02 = Crédito
03 = Débito example: '02' enum: - '02' - '03' total_amount: type: integer description: Purchase value in cents. example: 100 additional_data: type: string description: Additional Data example: '' additional_object: type: object properties: {} description: Additional Object example: null 3ds_authentication: required: - override_payment_method type: object properties: customer_card_alias: maxLength: 50 type: string description: 'Alias that uniquely identifies the account and credit card registered customer.
Note: This field is mandatory if tokenization is enabled in the ecommerce profile settings.' example: João da Silva override_payment_method: maxLength: 2 minLength: 2 type: string description: | Indicates the type of account.
02 = Credit
03 = Debit example: '02' enum: - '02' - '03' alternate_authentication_method: maxLength: 2 minLength: 2 type: string description: | Mechanism used by the cardholder to authenticate to their ecommerce.
Possible values:
01: No authentication occurred
02: Login using trading system credentials
03: Login using federated ID
04: Login using the FIDO Authenticator example: '02' enum: - '01' - '02' - '03' - '04' authentication: $ref: '#/components/schemas/3ds_authentication_ref' device: $ref: '#/components/schemas/3ds_device_ref' costumer_risk_information: $ref: '#/components/schemas/3ds_costumer_risk_information_ref' recurring: $ref: '#/components/schemas/3ds_recurring_ref' card: $ref: '#/components/schemas/3ds_card_ref' order: $ref: '#/components/schemas/3ds_order_ref' additional_data: type: string description: Additional data example: '' additional_object: type: object properties: {} description: Additional Object example: null 3ds_item_array_ref: type: array description: List of order items. items: $ref: '#/components/schemas/3ds_item_ref' 3ds_ship_to_ref: type: object properties: address1: maxLength: 60 minLength: 0 type: string description: | First line of the delivery address requested by the carrier. example: Street XXXX, XX address2: maxLength: 60 minLength: 0 type: string description: Second line of the delivery address requested by the carrier. Additional address information. example: Apartment XX administrative_area: maxLength: 2 minLength: 2 type: string description: | State (UF) of the delivery address requested by the carrier. example: RS country: maxLength: 2 minLength: 2 type: string description: Country of the delivery address requested by the carrier (Consult code at "https://www.iso.org/iso-3166-country-codes.html"). example: BR first_name: maxLength: 60 minLength: 0 type: string description: Recipient`s first name. example: John last_name: maxLength: 60 minLength: 0 type: string description: | Recipient`s last name. example: da Silva locality: maxLength: 50 minLength: 0 type: string description: | City of the delivery address requested by the carrier. example: Porto Alegre method: maxLength: 8 type: string description: | Shipping method for the product. Possible values:
lowcost = lowest cost service
sameday = courier service or same day
oneday = next day or overnight service
twoday = two-day service
threeday = three-day service
pickup = withdrawal from the store
other = another shipping method
none = no shipping method because the product is a service or signature. Required for American Express SafeKey (US). example: lowcost enum: - lowcost - sameday - oneday - twoday - threeday - pickup - other - none phone_number: maxLength: 15 minLength: 0 type: string description: 'Phone number of the delivery address requested by the carrier. (without mask) Country code: 1–3 characters' example: '555199988776' postal_code: maxLength: 10 minLength: 5 type: string description: zip code of the delivery address requested by the carrier. example: '686593' description: Delivery address dataset. 3ds_item_ref: type: object properties: description: maxLength: 255 type: string description: Item description. example: Item description name: maxLength: 255 type: string description: Name of the item. example: Item name sku: maxLength: 255 type: string description: Code of the item in the store (Stock Keeping Unit (SKU)). example: XXX-00-XXX-00 quantity: type: integer description: Quantity of items in this product. example: 1 total_amount: type: integer description: Total value of the item/product in cents. example: 100 unit_price: type: integer description: Unit value of the item/product in cents. example: 100 3ds_authentication_ref: required: - token type: object properties: token: maxLength: 2000 type: string description: Access token for 3DS authentication session. example: eyJhbGciOiJIUzI1NiJ9.eyJqdGkiOiIzZjczZGQ3MS03NjkyLTQyYTItYjU2Ni1jYmUzMzJkYzU3OTQiLCJpYXQiOjE1NzY2NzI3NDUsImlzcyI6IjVkNzVhYzYxNmZlM2QxMmYxODhmZmQ3YyIsIk9yZ1VuaXRJZCI6IjVkNzRlZDczZTA5MTlmMTk1ODNjMzE5MyIsIlBheWxvYWQiOiJ7XCJvcmRlck51bWJlclwiOlwic3RyaW5nXCIsXCJwYXltZW50SWRcIjpcImRhMGU4ZDkwLTQ0OGMtNGJhMC1iZGUyLTQxN2Q2YTdmZjliOVwiLFwibWVyY2hhbnRJZFwiOlwiMDU0Mzk5MlwiLFwibWVyY2hhbnROYW1lXCI6XCJFQyBUZXN0ZSBIVUIg4oCTIFBBRFJBT1wiLFwiY3VycmVuY3lcIjpcImJybFwiLFwidG90YWxBbW91bnRcIjpcIjEwMDBcIixcImpzVmVyc2lvblwiOlwic3RyaW5nXCIsXCJjbGllbnRDb2RlXCI6XCJzdHJpbmctM2Y3M2RkNzEtNzY5Mi00MmEyLWI1NjYtY2JlMzMyZGM1Nzk0XCIsXCJvdmVycmlkZVBheW1lbnRNZXRob2RcIjpcIjAyXCIsXCJpdGVtc1wiOlt7XCJ0b3RhbEFtb3VudFwiOlwiOTAwXCIsXCJ1bml0UHJpY2VcIjpcIjg5OVwiLFwicXVhbnRpdHlcIjowLFwic2t1XCI6XCJzdHJpbmdcIixcImRlc2NyaXB0aW9uXCI6XCJzdHJpbmdcIixcIm5hbWVcIjpcInN0cmluZ1wifSx7XCJ0b3RhbEFtb3VudFwiOlwiOTAwXCIsXCJ1bml0UHJpY2VcIjpcIjgwMFwiLFwicXVhbnRpdHlcIjowLFwic2t1XCI6XCJzdHJpbmdcIixcImRlc2NyaXB0aW9uXCI6XCJzdHJpbmdcIixcIm5hbWVcIjpcInN0cmluZ1wifV19IiwiT2JqZWN0aWZ5UGF5bG9hZCI6ZmFsc2UsIlJlZmVyZW5jZUlkIjoiM2Y3M2RkNzEtNzY5Mi00MmEyLWI1NjYtY2JlMzMyZGM1Nzk0IiwiZXhwIjoxNTc2NjcyODY1fQ.jrPvIjtvSY6HukI-PjBE0ACWo68whA2FhCCfKeEfB4g npa_code: maxLength: 2 minLength: 2 type: string description: NPA code.
01 = Add card
02 = Keep card information
03 = Cardholder verification for the EMV token example: '01' enum: - '01' - '02' - '03' challenge_code: maxLength: 2 minLength: 2 type: string description: 'Indicates whether a challenge is required by the requester for this transaction.
01 = No preference.
02 = Please do not challenge.
03 = Challenge requested (3DS Requestor preference).
04 = Challenge requested (mandate)
Note: If this element is not supplied if the value 01 is used.' example: '01' enum: - '01' - '02' - '03' - '04' installment_total_count: maximum: 9999 minimum: 2 type: integer description: Indicates the maximum number of installments allowed for a payment in installments.
Value must be greater than 1 only for purchases in installments.
Note: It is required if the ecommerce and the cardholder agree with payments in installments. example: 3 message_category: maxLength: 2 minLength: 2 type: string description: | Message category for a specific use case.
Possible values:
01: PA payment authentication
02: Authentication without NPA payment
80: to indicate mastercard dataonly. example: '01' enum: - '01' - '02' - '80' transaction_mode: maxLength: 1 minLength: 1 type: string description: 'Transaction mode identifier.
Identifies the channel from which the transaction originates.
Possible values:
M = Order by email or phone
P = Mobile Device
R = Retail (Store Physics)
S = Computer
T = Tablet' example: M enum: - M - P - R - S - T device_channel: maxLength: 10 type: string description: Device Channel example: Browser acs_window_size: maxLength: 2 type: string description: 'Indication of the desired size (pixels) of the challenge screen, When it`s the case.
Possible values:
01: (250x400)
02: (390x400)
03: (500x600)
04: (600x400)
05: (Full page)' example: '02' enum: - '01' - '02' - '03' - '04' - '05' description: Authentication process data set. 3ds_device_ref: type: object properties: http_accept_browser_value: maxLength: 255 type: string description: | Value of the Accept header sent by the user`s web browser client.
Note: If the client`s browser provides a value, you must include it in your request. example: text/html,application/xhtml+xml,application/xml http_accept_content: maxLength: 255 type: string description: The exact content of the HTTP accepter header. example: text/html user_agent_browser_value: maxLength: 255 type: string description: 'Value of the User-Agent header of the user sent by the browser from the client`s web.
Note: If the client`s browser provides a value, you must include it in your request.' example: Mozilla/5.0 (Windows NT 6.1; Win64; x64; rv:47.0) http_browser_color_depth: maxLength: 2 type: string description: The value represents the bit depth of the color palette to display images, in bits per pixel. example: '24' http_browser_java_enabled: maxLength: 1 type: string description: Value that represents the browser skill of the holder of the card to run Java. example: 'N' enum: - 'Y' - 'No' http_browser_java_script_enabled: maxLength: 1 type: string description: Value that represents the browser skill of the holder of the card to run JavaScript. example: 'Y' enum: - 'Y' - 'No' http_browser_language: maxLength: 8 type: string description: The value represents the language of the browser as defined in IETF BCP47. example: pt-BR http_browser_screen_height: maxLength: 6 type: string description: Total height of the cardholder's screen in pixels. example: '260' http_browser_screen_width: maxLength: 6 type: string description: Total width of the cardholder's screen in pixels. example: '1366' http_browser_time_difference: maxLength: 5 type: string description: Time difference between UTC time and the local time of the cardholder, in minutes. example: '180' ip_address: maxLength: 45 type: string description: IP adress. of the customer. example: 127.0.0.1 description: Set of data referring to the device used by the buyer. 3ds_costumer_risk_information_ref: type: object properties: transaction_count_year: maximum: 999 minimum: 0 type: integer description: Number of successful and abandoned transactions for this account of the cardholder with their ecommerce in the last year. example: 12 transaction_count_day: maximum: 999 minimum: 0 type: integer description: Number of successful and abandoned transactions for this account of the cardholder with your ecommerce in the last 24 hours. example: 1 add_card_attempts: maximum: 999 minimum: 0 type: integer description: 'Number of attempts to add card in the last 24 hours. ' example: 1 customer_id: maxLength: 26 type: string description: | Identification document number (NATIONAL, CPF, CPNJ, CURP, SSN, DRIVER_LICENSE). example: '12345678912' customer_type_id: maxLength: 14 type: string description: | Type of identification document. example: CPF enum: - NATIONAL - CPF - CPNJ - CURP - SSN - DRIVER_LICENSE payment_account_history: maxLength: 23 type: string description: | Indicates the type of payment account. This only applies the NEWACCOUNT and EXISTINGACCOUNT in the creation_history field. enum: - PAYMENTACCOUNTEXISTS - PAYMENTACCOUNTADDED_NOW payment_account_date: maxLength: 8 minLength: 8 type: string description: | Date of creation of the payment account. This only applies to PAYMENTACCOUNTEXISTS in the payment_account_history field. format: YYYYMMDD example: '20191125' prior_suspicious_activity: type: boolean description: | Indicates whether the ecommerce has had suspicious activity (including fraud previous) in the account. example: false description: Customer risk dataset. 3ds_recurring_ref: type: object properties: end_date: maxLength: 8 minLength: 8 type: string description: | Date after which no further recurring authorizations must to be fulfilled.
Note: This field is required for recurring transactions. format: YYYYMMDD example: '20191201' frequency: maximum: 999 minimum: 0 type: integer description: | Indicates the minimum number of days between authorization requests of recurring transactions. A monthly frequency is indicated by the value 28. Multiples of 28 days will be used to indicate months.
Example: 6 months = 168
Note: This field is required for recurring transactions. example: 4 original_purchase_date: maxLength: 17 minLength: 17 type: string description: | Date of original purchase. Required for recurring transactions.
Note: If this field is empty, the current date will be used. format: YYYYMMDD:HH:MM:SS example: 4361299465223 description: Set of data referring to the recurring payment. 3ds_card_ref: required: - expiration_month - expiration_year - number_token - type_card type: object properties: number_token: maxLength: 128 minLength: 128 type: string description: Tokenized card number. example: dfe05208b105578c070f806c80abd3af09e246827d29b866cf4ce16c205849977c9496cbf0d0234f42339937f327747075f68763537b90b31389e01231d4d13c expiration_month: maxLength: 2 minLength: 2 type: string description: | Card expiry month with two digits. Required if the card data was not permanently stored with the token. example: '12' expiration_year: maxLength: 4 minLength: 4 type: string description: | Card expiry year with two digits. Required if the card data was not permanently stored with the token. example: '28' type_card: maxLength: 3 minLength: 3 type: string description: | Indicates the flag type code.
001 = Visa
002 = Mastercard
003 = Amex
054 = ELO example: '1' enum: - '001' - '002' - '003' - '054' description: Card data set. 3ds_order_ref: required: - currency - product_code type: object properties: product_code: maxLength: 2 type: string description: | Specifies the product code, which designates the transaction type.
Specify one of the following values for this field:
01 = Purchase of goods / services
03 = Acceptance of checks
10 = Account Funding
11 = Near-cash transaction
28 = Prepaid activation and account funding example: '1' default: '01' enum: - '01' - '03' - '10' - '11' - '28' currency: maxLength: 3 minLength: 3 type: string description: | Currency identification (See code at "https://www.currency-iso.org/en/home/tables/table-a1.html"). example: BRL default: BRL total_amount: type: integer description: Total value of the item/product in cents of the order. example: 1000 bill_to: $ref: '#/components/schemas/3ds_bill_to_ref' items: $ref: '#/components/schemas/3ds_item_array_ref' ship_to: $ref: '#/components/schemas/3ds_ship_to_ref' description: Set of data for identification of the purchase. 3ds_bill_to_ref: required: - mobile_phone type: object properties: address1: maxLength: 60 minLength: 0 type: string description: | First line of associated carrier billing address to the card used for the purchase. example: Rua XXXX, XX address2: maxLength: 60 minLength: 0 type: string description: | Second line of associated carrier billing address to the card used for the purchase. Additional address information. example: Apartment XX administrative_area: maxLength: 2 minLength: 2 type: string description: | State (UF) of the associated carrier`s billing address to the card used for the purchase. example: RS country: maxLength: 2 minLength: 2 type: string description: | Country of the cardholder billing address associated with the card used in the purchase (See code at "https://www.iso.org/iso-3166-country-codes.html"). example: BR email: maxLength: 255 minLength: 0 type: string description: | Email address associated with the account that was provided by bearer or was already stored in a previous registration by the 3DS Requestor. example: customer@email.com first_name: maxLength: 60 minLength: 0 type: string description: Customer's first name. This name must be the same as the name on the card. example: John last_name: maxLength: 60 minLength: 0 type: string description: Last name of the customer. This surname must be the same as the last name on the card. example: da Silva locality: maxLength: 50 minLength: 0 type: string description: | City of the cardholder`s billing address associated with the card used on purchase. example: Porto Alegre mobile_phone: maxLength: 15 minLength: 0 type: string description: | Mobile number provided by the carrier. (without mask) Code country: 1–3 characters example: '5551999887766' phone_number: maxLength: 15 minLength: 0 type: string description: | Phone number provided by the carrier. (without mask) Country code: 1–3 characters example: '555199988776' postal_code: maxLength: 10 minLength: 5 type: string description: | Postal code of the cardholder`s billing address associated with the card used on purchase. example: '90230060' description: Billing address dataset. 3ds_authentications_resp_card_ref: type: object properties: number_token: maxLength: 128 minLength: 128 type: string description: | Token of the card that will be used in transactions. If HTTP response contains header "Content-Encoding:gzip" ( RFC 2616 topic 14.11 Content-Encoding ) the response must go through an unpacking process, depending on the technology used to integration will require the use of a third-party library. example: dfe05208b105578c070f806c80abd3af09e246827d29b866cf4ce16c205849977c9496cbf0d0234f42339937f327747075f68763537b90b31389e01231d4d13c description: Card data set. 3ds_authentications_resp_client_reference_information_ref: type: object properties: code: maxLength: 13 type: string description: | 3DS authentication session identifier code. The value returned follows the form of a string composed of [client_code] + [-] + [UUID] (Example: client_code-00000000-0000-0000-0000-000000000000). The client_code value matches the value sent in the endpoint request /v1/3ds/tokens. description: Customer reference dataset. 3ds_authentications_resp_consumer_authentication_information_ref: type: object properties: acs_url: maxLength: 2048 type: string description: | URL to the card issuing bank authentication form that you receive when the card is enrolled. example: https://merchantacsstag.cardinalcommerce.com/MerchantACSWeb/pareq.jsp?vaa=b&gold=AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA authentication_path: maxLength: 12 type: string description: | Indicates what is displayed to the customer during the checkout process. authentication. This field can contain one of these values:
ADS = customer (card not enrolled) asked to activate the card during the process checkout.
ATTEMPTS = (processing attempts) the processing is displayed briefly before the checkout process completes.
ENROLLED = (Card Enrolled) the issuer authentication window of the card is displayed.
UNKNOWN = the enrollment status of the card cannot be determined.
NOREDIRECT = (card not enrolled, authentication unavailable or error) nothing is displayed to the client.
The following values may be returned if you are using payer-based authentication in rules.
RIBA = card issuing bank supports authentication risk-based, but it is not possible to determine whether the cardholder is open to challenge.
RIBA_PASS = the card issuing bank supports risk-based authentication and the cardholder is likely to don`t be challenged for credentials, also known as authentication silent. example: ADS enum: - ADS - ATTEMPTS - ROLLED - UNKNOWN - NOREDIRECT - RIBA - RIBA_PASS authentication_transaction_id: maxLength: 20 type: string description: | The identifier of the passed payer authentication transaction to link the verification enrollment and validate the verification messages authentication. example: gz3aQ1z6YBS8kK4B0A40 pareq: type: string description: | Payer authentication request (PAReq) message you need be forwarded to the ACS. example: eNpVkm1P4zAMx9/nU1Rw4hVaHja6dphIHQMNJMYYHOzuXS/1rUVrWtL0xr79Jd3Gw5vIP8t27L8NT7lBnDyiag1KuMOmSVcYFNnFUbb8uxwXabMK86Gtn0X7ELIjCfNkgW8S/qFpikpL3mM9AfSAxJUwKk+1lZCqt/HNTA7CWPAQ6B4JlGhuJpKdDfpx7FJ3SECnJcqry+AJG4vB9Oc4ODkWIjw/OeYi8u9geB7Mk8kiuQfaBRNQVaut2cpowIAegEBr1jK3tm5GlG42m57a/nH9Va1R2FNVCdQHEKCfvc5bbzVOgvcik7+v8/Ll6rb+tZzpWbnqZ9Pxy51+XsxekwugPoJAllqUggnGOIsCPhydxSMWAe38BNLSdyMXPwJ2yribfscEav9TsiPn/4puntYY1Gor48gp9kEE8L2uNLoYJ9iHTaDQjU3Xa+89mG6sz2Eup34NyjqB+yLmcRj7PXTc1SycXEJw3hUtOu2oz6H7LdP9QTjr26H8B6XetU0= proof_xml: type: string description: | Date and time of enrollment verification combined with VEReq and VERes elements. example: 2020 Jan 08 17:59:08https://merchantacsstag.cardinalcommerce.com/MerchantACSWeb/vereq.jsp?acqid=CYBS1.0.2XXXXXXXXXXXX1112469216054399201.0.2Y3291969https://merchantacsstag.cardinalcommerce.com/MerchantACSWeb/pareq.jsp?gold=AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAThreeDSecure proxy_pan: type: string description: | Encrypted version of the card number used in the message payer authentication request. example: '3291969' specification_version: maxLength: 10 type: string description: | This field contains the 3D Secure version that was used to process the transaction. example: 2.0.0 veres_enrolled: maxLength: 1 minLength: 1 type: string description: | Enrollment verification result.
This field can contain one of these values:
Y = card enrolled or may be enrolled; you must authenticate. Change of responsibility.
N = card not enrolled; proceed with authorization. Change of responsibility.
U = unable to authenticate regardless of reason. None change of responsibility. example: 'Y' enum: - 'Y' - 'No' - U xid: maxLength: 255 type: string description: | Field available from version 2.0. Identifier of MPI for each authenticated transaction. Field content can be a value HEXA or Base64, according to the MPI used. example: ODZ3MlMyZFpMZG5DRmJPUnM1ODA= token: type: string description: | Token example: AxjzbwSTOJ/N1W2cYUdd/+YBUaf/qJNr7RTZSQkiIZNJMvRiueI7APAAqRQK description: Set of consumer authentication data. 3ds_authentications_resp_error_information_ref: type: object properties: reason: type: string description: The status reason. example: PENDING_AUTHENTICATION enum: - AVS_FAILED - CONTACT_PROCESSOR - EXPIRED_CARD - PROCESSOR_DECLINED - INSUFFICIENT_FUND - STOLEN_LOST_CARD - ISSUER_UNAVAILABLE - UNAUTHORIZED_CARD - CVN_NOT_MATCH - EXCEEDS_CREDIT_LIMIT - INVALID_CVN - DECLINED_CHECK - BLACKLISTED_CUSTOMER - SUSPENDED_ACCOUNT - PAYMENT_REFUSED - CV_FAILED - INVALID_ACCOUNT - GENERAL_DECLINE - INVALID_MERCHANT_CONFIGURATION - DECISION_PROFILE_REJECT - SCORE_EXCEEDS_THRESHOLD - PENDING_AUTHENTICATION message: type: string description: 'The message describing the reason for the status. ' example: This field is not being returned by the cybersource API. description: Error information. 3ds_results_ref: required: - currency - override_payment_method - total_amount type: object properties: currency: maxLength: 3 minLength: 3 type: string description: | Currency identification (See code at "https://www.currency-iso.org/en/home/tables/table-a1.html"). example: BRL default: BRL override_payment_method: maxLength: 2 minLength: 2 type: string description: | Indicates the type of account.
02 = Credit
03 = Debit example: '02' enum: - '02' - '03' token: type: string description: Token token_challenge: type: string description: Token returned in the challenge. total_amount: type: integer description: Total value of the item/product in cents of the order. example: 1000 card: $ref: '#/components/schemas/3ds_card_ref' additional_data: type: string description: Additional Data example: '' additional_object: type: object properties: {} description: Additional Object example: null 3ds_authentication_results_resp_consumer_authentication_information_ref: type: object properties: authentication_result: maxLength: 1 type: string description: 'Primary authentication field that indicates whether authentication was successful and whether there was a change of responsibility.
This field contains one of these values:
-1: Invalid PARs,
0: Validation successful,
1: Cardholder is not participating, but the authentication attempt was logged,
6: Issuer unable to perform authentication,
9: Cardholder has not completed authentication.' example: '0' enum: - -1 - '0' - '1' - '6' - '9' authentication_status_msg: type: string description: | Message that explains the authenticationresult of the response field. example: Success indicator: maxLength: 1 type: string description: Indicator used to differentiate Internet transactions from other types.
The value of this field is automatically transferred to the authorization service if you order the services together.
example: spa enum: - aesk - aesk_attempted - dipb - dipb_attempted - internet - js - js_attempted - moto - pb_attempted - recurring - spa - spa_failure - vbv - vbv_attempted - vbv_failure eci: maxLength: 2 minLength: 2 type: string description: | Field available from version 2.0 onwards. Transaction ECI code Authenticated 3D Secure. Generated by an External MPI. status_pairs: maxLength: 1 minLength: 1 type: string description: 'Authentication check result.
This field can contain one of these values:
A: Proof of Attempt was generated of authentication.
B: Bypassed authentication.
N: The customer failed or canceled authentication. Transaction denied.
A: Authentication rejected (used only for 3D Secure 2.0 transactions)
U: Authentication not completed regardless of reason.
Y: The client has been authenticated successfully.' example: 'Y' enum: - A - B - 'No' - R - U - 'Y' specification_version: type: string description: This field contains the 3D Secure version that was used to process the transaction. xid: maxLength: 40 minLength: 40 type: string description: | Field available from version 2.0. Identifier of MPI for each authenticated transaction. Field content can be a value HEXA or Base64, according to the MPI used. Returns for Visa only. token: type: string description: Token cavv_algorithm: maxLength: 1 type: string description: 'Field that is returned only when the CAVV is generated, which occurs when paresStatus contains Y values (successful authentication) or A (authentication attempt).
This field contains one of these values:
2: Visa, American Express, JCB, Diners Club e Discover
3: Mastercard' example: '2' enum: - '2' - '3' ucaf: maxLength: 40 minLength: 40 type: string description: | Field available from version 2.0 onwards. authentication code Encrypted by Flag. Field content can be a HEXA value or Base64, according to the MPI used. ucaf_authentication_data: type: string description: The AAV is a unique identifier generated by the card bank for Mastercard SecureCode transactions after the customer is authenticated. Returns only for Mastercard, for Visa the corresponding field is the CAVV. example: jELUbgG+Tfj0AREACMLdCae+oIs= ucaf_collection_indicator: maxLength: 1 minLength: 1 type: string description: 'For enrollment, returned only for mastercard transactions.
Indicates that authentication is not required because the client is not enrolled.
This field contains one of these values:
0: Authentication data not collected, and client authentication did not complete.
1: Authentication data not collected because client authentication did not complete.
2: Authentication data collected because the client has completed authentication.' example: '2' enum: - '0' - '1' - '2' cavv: maxLength: 255 type: string description: Unique identifier generated by the issuing bank after the client is authenticated. example: AAABAWFlmQAAAABjRWWZEEFgFz+= description: Set of consumer authentication data. pix: required: - amount - currency - idempotency_key type: object properties: amount: type: integer description: Purchase amount in cents. example: 9000 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_id: type: string description: | Purchase identification code used by the e-commerce. If informed, it will be forwarded to the PIX Payment Notification. example: DEV-1608748980 customer_id: type: string description: | Buyer identifier used by e-commerce. Case be informed it will be passed on in the PIX Payment Notification. maxLength: 36 idempotency_key: maxLength: 64 minLength: 1 type: string description: Idempotency key, used to control requests, must be unique per request, because if it is repeated, it will always be returned the same data. example: 1eb2412c-165a-41cd-b1d9-76c575d30a21 payment_pix_qrcode: type: object properties: payment_id: type: string description: Payment Identifier. maxLength: 36 minLength: 36 format: uuidv4 example: cd966c8a-cda4-4ea6-8d20-bfdd1c3da312 status: type: string description: Transaction status. For more information about status return, see Notifications 1.1 maxLength: 8 example: WAITING enum: - PENDING - WAITING - EXPIRED - ERROR - APPROVED - DENIED description: type: string description: | Text with a message describing the result of the request. example: The QR Code was successfully generated and awaiting payment. additional_data: type: object description: | Group of additional information about the result of the request of QR Code or PIX transaction. properties: transaction_id: type: string description: | Identifier of the transaction started after the generation of the QR Code PIX with the institution. example: 9000TRXIDdnmnefxzmvfckki qr_code: type: string description: | Payload of generated QR Code PIX. With this text it will be possible present it in graphic mode or the customer can pay it via function "Copy and Paste" by PIX. example: 00020101021226740014br.gov.bcb.pix210812345678 22041234230812345678242000112233445566778899520400005303986540690005802BR5913JOHN DOE6008SAO PAULO62190515RP12345678-201980720014br.gov.bcb.pix2550bx.com.br/spi/U0VHUkVET1RPVEFMTUVOVEVBTEVBVE9SSU8=630434D1 creation_date_qrcode: type: string description: Creation date of the generated QR Code. format: YYYY-MM-DDTHH:MM:SSZ example: '2022-06-08T10:55:07.890' expiration_date_qrcode: type: string description: Expiration date of the generated QR Code. format: YYYY-MM-DDTHH:MM:SSZ example: '2022-06-08T10:56:07.890' psp_code: type: string description: | Recipient`s PSP code. PSP (Payment Service Provider, which is the financial institution responsible for the payment or the receipt of values on Pix. example: 45454 idempotency_key: maxLength: 64 minLength: 1 type: string description: Chave of idempotency, used to control requests, must be unique per request, because if it is repeated, it will always be returned the same data. example: 1eb2412c-165a-41cd-b1d9-76c575d30a21

Idempotency API | Digital Platform