swagger: '2.0' schemes: - https consumes: - application/json produces: - application/json host: api-homologacao.getnet.com.br info: title: API | Digital Platform reference version: 1.0.10 description: | # API ## Introduction The purpose of this document is to describe the interface of Getnet's Digital Platform integration APIs with E-commerce. tags: - name: Authentication x-displayName: Authentication description: The APIs listed in this documentation use OAuth2 authentication, which means that in all requests it is necessary to enter an access token that will be obtained through authentication with its Client ID and Client Secret. - name: PCI Tokenization x-displayName: PCI Tokenization description: In order to carry out transactions safely, the card number must be previously tokenized in all the requisitions before being trafficked along with the other data, such as name of the bearer, expiration date and CVV. - name: 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: * 07 (Visa) * 06 (Mastercard) **Note**: 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: Vault x-displayName: Vault description: | This product gives customers the ability to keep the card information of their purchasers to be used in future purchases. All of this is guaranteed by the best security practices according to the PCI certification guidelines. With this solution it is possible to store card data (card number, bearer’s name and due date) for recurring payments, for example: Subscriptions that can be offered to your customers, thus ensuring that installment payments of this signature are made without the need for the gift card, but with the guarantees required by the Card Issuers and Brands. In this product the following methods are available: * Stores consumer card data in the vault (new card). * List of saved cards. * Recovering data from a saved card. * Removal of a saved card. ***It is important to note that Getnet's Vault solution is a product available on the Digital Platform, that is, it can only be used by hiring a package that has this product.*** - name: Payment x-displayName: Payment description: | To perform payment-related transactions, use the endpoints described below through authentication. - name: Combined Payment x-displayName: Combined Payment description: | To carry out transactions related to combined payment use the endpoints described below through authentication. - name: QRCode x-displayName: QRCode description: | To make payment-related transactions with QRCode use the endpoints described below by OAuth2 authentication. - name: PIX x-displayName: PIX description: | To make instant payments (PIX) with QR Code use the endpoints described by OAuth2 authentication. - name: 3DS Authentication x-displayName: 3DS Authentication description: | To perform transactions related to 3DS authentication use the endpoints described below by OAuth2 authentication. - name: 3DS Authenticated Payment x-displayName: 3DS Authenticated Payment description: | To carry out transactions related to certified payment use the endpoints described below by OAuth2 authentication. - name: GetPay x-displayName: GetPay description: | The GetPay API allows shopkeeper, create, edit and query transactions by payment link. When clicking in GetPay, the buyer is taken for the Getnet environment with buyer identification, delivery adress and checkout Getnet to finalize the purchase. For hiring, look for your manager or contact the number 4020 4009. Bellow are the endpoints for creating and managing GetPays: - name: Cancellation x-displayName: Cancellation description: | To enable a request for cancellation of payments with credit cards, use the endpoints below through authentication. - name: Recurrence x-displayName: Recurrence description: | Getnet Recurrence provides easy and fast charge management. You simply must register the client, the periodicity plan and a subscription to link the customer to the plan. To attain the recurrence service, you need to contract 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: | You must register a client for the recurrence to work. The client is the consumer of the product/service in the subscription. - name: Plans x-displayName: Plans description: | You must register a plan for the recurrence work. The plan is what will define the way the recurring payments will be applied. The plan has the define information about the amount for each installment, the periodicity and the number of installments. The number of installments may be lifelong or finite, within lifelong considered an unlimited time to complete the installments and finite a specific time to settle the installments. Periodicity can be: * Annual, charged once a year; * Monthly, charged once a month; * Bimonthly, charged every two months; * Quarterly, charged every 3 months; * Biannually, charged every six months; * Specific, specific cycle charged on days. - name: Subscriptions x-displayName: Subscriptions description: | For the purpose of recurrence, it is necessary to link a client with a plan through a subscription. The subscription is the binding contract for recurring charges based on the description and parameters of its creation. - name: BIN Search x-displayName: BIN Search description: | Perform the verification of the BINs of the cards, validating the data to avoid fraud. The BIN of a card corresponds from the first 4 to the ninth digit. paths: /auth/oauth/v2/token: post: summary: Generating the access token description: | Endpoint responsible for generating the access token used in other requests, for this we use [HTTP Basic Authentication]( https://www.w3.org/Protocols/HTTP/1.0/draft-ietf-http-spec.html#BasicAA) tags: - Authentication consumes: - application/x-www-form-urlencoded produces: - application/json parameters: - in: header name: Content-type required: true type: string enum: - application/x-www-form-urlencoded default: application/x-www-form-urlencoded description: | Default content type application/x-www-form-urlencoded. - in: header name: Authorization required: true type: string description: 'Authorization: Basic *AuthString*
In which *AuthString* is the concatenation of your Client ID, followed by ":"(colon) plus your Client Secret, converted to base64.
For example: For Client ID equal to client-01 and Client Secret equal to secret-key-02, we will have the text client-01:secret-key-02 after the concatenation, converting to base64 we will have the result 2xpZW50LTAxOnNlY3JldC1rZXktMDI=.
In this case the Authorization in the header of the request will be:
Authorization: Basic 2xpZW50LTAxOnNlY3JldC1rZXktMDI=' - in: formData required: true type: string name: scope description: Use the fixed value "oob" default: oob - in: formData required: true type: string name: grant_type description: Use The fixed value "client_credentials" default: client_credentials responses: '200': description: Returns the access token. schema: type: object properties: access_token: type: string description: API access token to be submitted with all requests example: ca22a2ge-1914-4b0c-a0fb-d3ce0fde7346 format: uuidv4 minLength: 36 maxLength: 36 token_type: type: string description: Token type, must be submitted in the header with the token (https://tools.ietf.org/html/rfc6750) example: Bearer expires_in: type: number description: Token expiration period in seconds example: 3600 scope: type: string description: Token scope example: oob '400': description: Invalid request. schema: $ref: '#/definitions/error_authentication' '401': description: Unauthorized. schema: $ref: '#/definitions/error_authentication' x-code-samples: - lang: cURL source: | curl -X POST \ https://api-homologacao.getnet.com.br/auth/oauth/v2/token \ -H 'authorization: Basic 2xpZW50LTAxOnNlY3JldC1rZXktMDI=' \ -H 'content-type: application/x-www-form-urlencoded' \ -d 'scope=oob&grant_type=client_credentials' /v1/tokens/card: post: summary: Card Token Generation description: To perform transactions securely, card data except CVV must be *tokenized*, this process is done by the endpoint described below through authentication. tags: - PCI Tokenization consumes: - application/json produces: - application/json parameters: - in: header name: Content-type required: true type: string enum: - application/json; charset=utf-8 default: application/json; charset=utf-8 description: | Content type. - in: header name: Authorization required: true type: string description: | Authorization: Bearer *AuthString*
In which *AuthString* is an access token obtained at the authentication endpoint. - in: header name: seller_id required: false type: string description: 'Authorization: E-commerce identification code. Required when the client is treated as a Platform.' format: uuidv4 minLength: 36 maxLength: 36 - in: body name: token_card description: Card and Buyer Data schema: type: object required: - card_number properties: card_number: type: string description: Card number minLength: 13 maxLength: 19 example: '5155901222280001' customer_id: type: string description: Buyer ID. Information defined by the application that consumes the api of the Digital Platform. example: customer_21081826 maxLength: 100 responses: '201': description: Returns the token of the card. schema: type: object properties: number_token: type: string description: The Card Token that will be used in the transactions. If the HTTP response contains the "Content-Encoding:gzip"( RFC 2616 topic 14.11 Content-Encoding ) header, the response must go through an unzipping process, depending on the technology used for integration, it will require the use of a third party library. example: dfe05208b105578c070f806c80abd3af09e246827d29b866cf4ce16c205849977c9496cbf0d0234f42339937f327747075f68763537b90b31389e01231d4d13c minLength: 128 maxLength: 128 '400': description: Invalid request. schema: $ref: '#/definitions/error' '401': description: Invalid authentication. schema: $ref: '#/definitions/error' '404': description: Not found. schema: $ref: '#/definitions/error' '500': description: Internal server or service error. schema: $ref: '#/definitions/error' x-code-samples: - lang: cURL source: | curl -X POST \ https://api-homologacao.getnet.com.br/v1/tokens/card \ -H 'authorization: Bearer ca22a2ge-1914-4b0c-a0fb-d3ce0fde7346' \ -H 'content-type: application/json; charset=utf-8' \ -d '{ "card_number": "5155901222280001" }' /v1/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/cards/verification: post: summary: Card verification description: This transaction verifies if the credit card informed by the cardholder is valid. A valid credit card is one that is not canceled, blocked or restricted. To check functionality, click here tags: - Payment consumes: - application/json produces: - application/json parameters: - in: header name: Content-type required: true type: string enum: - application/json; charset=utf-8 default: application/json; charset=utf-8 description: | Content type. - in: header name: Authorization required: true type: string description: 'Authorization: Bearer *AuthString*
In which *AuthString* is an access token obtained at the authentication endpoint.' - in: header name: seller_id required: false type: string description: | Authorization: E-commerce identification code. Required when the client is treated as a Platform. format: uuidv4 minLength: 36 maxLength: 36 - in: body name: verification_card_body required: true description: Request containing the card data for verification. schema: $ref: '#/definitions/verification_card_body' responses: '200': description: Card verification performed successfully. schema: type: object properties: status: type: string description: Card verification status, where VERIFIED indicates that the card has been successfully validated. enum: - VERIFIED - NOT VERIFIED - DENIED - ERROR example: VERIFIED minLength: 5 maxLength: 20 verification_id: type: string format: uuidv4 description: Verification request identification on the digital platform. example: ae267804-503c-4163-b1b1-f5da5120b74e minLength: 36 maxLength: 36 authorization_code: type: string description: Authorization number generated by the card verification system. example: '6964722471672911' minLength: 1 maxLength: 18 transaction_id: type: string description: Verification transaction code. example: '6964722471672911' '400': description: Invalid request. schema: $ref: '#/definitions/error' '401': description: Invalid authentication. schema: $ref: '#/definitions/error' '500': description: Internal server or service error. schema: $ref: '#/definitions/error' x-code-samples: - lang: cURL source: | curl -X POST \ https://api-homologacao.getnet.com.br/v1/cards/verification \ -H 'authorization: Bearer 4d98da5d-767b-4db6-b581-b664e829bd41' \ -H 'content-type: application/json; charset=utf-8' \ -d ' { "number_token": "3fdb3ac9a6def80bf64cd241b9035e77ed8757032d356718864d03465a1130e20d8a897005e144dd6c1a5b4e63fcc99d3755f9e18a7cd852ad82778c65008988", "brand":"mastercard", "cardholder_name": "JOAO DA SILVA", "expiration_month" : "10", "expiration_year" : "18", "security_code" : "123" }' /v1/cards: post: summary: Stores consumer card data in safe description: Creates a feature within the Getnet digital platform from consumer card data for use in future payments. tags: - Vault consumes: - application/json produces: - application/json parameters: - in: header name: Content-type required: true type: string enum: - application/json; charset=utf-8 default: application/json; charset=utf-8 description: | Content type. - in: header name: Authorization required: true type: string description: | Authorization: Bearer *AuthString*
In which *AuthString* is an access token obtained at the authentication endpoint. - in: header name: seller_id required: false type: string description: | Authorization: E-commerce identification code. format: uuidv4 minLength: 36 maxLength: 36 - in: body name: vault_card_body required: true description: Request containing the card data to be saved in the safe. schema: $ref: '#/definitions/vault_card' responses: '201': description: Identifier of the card successfully created. Card saved in safe. schema: type: object properties: card_id: type: string description: Card identifier saved in vault can be used to retrieve a valid number_token for future purchases as well as can be used to remove saved cards. example: e8ad2ae4-9e3e-4532-998f-1a5a11e56e58 format: uuidv4 minLength: 36 maxLength: 36 number_token: type: string description: The Card Token that will be used in the transactions. example: dfe05208b105578c070f806c80abd3af09e246827d29b866cf4ce16c205849977c9496cbf0d0234f42339937f327747075f68763537b90b31389e01231d4d13c minLength: 128 maxLength: 128 '400': description: Invalid request. schema: $ref: '#/definitions/error' '401': description: Invalid authentication. schema: $ref: '#/definitions/error' '403': description: Product safe not enabled. schema: $ref: '#/definitions/error' '404': description: Not found. schema: $ref: '#/definitions/error' '500': description: Internal server or service error. schema: $ref: '#/definitions/error' x-code-samples: - lang: cURL source: | curl -X POST \ https://api-homologacao.getnet.com.br/v1/cards \ -H 'authorization: Bearer ca22a2ge-1914-4b0c-a0fb-d3ce0fde7346' \ -H 'content-type: application/json; charset=utf-8' \ -d '{ "number_token": "dfe05208b105578c070f806c80abd3af09e246827d29b866cf4ce16c205849977c9496cbf0d0234f42339937f327747075f68763537b90b31389e01231d4d13c", "cardholder_name": "JOAO DA SILVA", "expiration_month": "12", "expiration_year": "20", "customer_id": "customer_21081826", "cardholder_identification": "12345678912" }' get: summary: List of cards saved in the safe description: Returns a list of saved cards based on buyer ID data - customer_id. tags: - Vault produces: - application/json parameters: - required: true description: | Authorization: Bearer *AuthString *
In which *AuthString* is an access token obtained at the authentication endpoint. type: string name: Authorization in: header - in: header name: seller_id required: false type: string description: | Authorization: E-commerce identification code. Required when the client is treated as a Platform. format: uuidv4 minLength: 36 maxLength: 36 - required: true description: Buyer ID. Information defined by the application that consumes the api of the Digital Platform. type: string name: customer_id maxLength: 100 in: query - required: false description: Status filter of returned cards. If no filter is entered, the active and renewed cards are returned. enum: - all - active - renewed type: string name: status maxLength: 25 in: query responses: '200': description: List of saved cards. schema: type: object properties: cards: type: array items: $ref: '#/definitions/vault_card_response' '400': description: Invalid request. schema: $ref: '#/definitions/error' '401': description: Invalid authentication. schema: $ref: '#/definitions/error' '403': description: Product safe not enabled. schema: $ref: '#/definitions/error' '404': description: Not found. schema: $ref: '#/definitions/error' '500': description: Internal server or service error. schema: $ref: '#/definitions/error' x-code-samples: - lang: cURL source: | curl -X GET \ https://api-homologacao.getnet.com.br/v1/cards?customer_id=customer_21081826 \ -H 'authorization: Bearer 72402c54-6bd3-4895-a6b4-adfded0c11dc' /v1/cards/{card_id}: get: summary: Retrieve a saved card in the safe description: Gets the data from the card saved in the safe, from the card_id generated at the time of card storage. tags: - Vault produces: - application/json parameters: - required: true description: | Authorization: Bearer *AuthString*
In which *AuthString* is an access token obtained at the authentication endpoint. type: string name: Authorization in: header - in: header name: seller_id required: false type: string description: | Authorization: E-commerce identification code. Required when the client is treated as a Platform. format: uuidv4 minLength: 36 maxLength: 36 - required: true description: Unique identifier of the card in Getnet digital platform. type: string name: card_id maxLength: 36 in: path responses: '200': description: Card data. schema: $ref: '#/definitions/vault_card_response' '400': description: Invalid request. schema: $ref: '#/definitions/error' '401': description: Invalid authentication. schema: $ref: '#/definitions/error' '403': description: Product safe not enabled. schema: $ref: '#/definitions/error' '404': description: Not found. schema: $ref: '#/definitions/error' '500': description: Internal server or service error. schema: $ref: '#/definitions/error' x-code-samples: - lang: cURL source: | curl -X GET \ https://api-homologacao.getnet.com.br/v1/cards/14a2ce5d-ebc3-49dc-a516-cb5239b02285 \ -H 'authorization: Bearer 72402c54-6bd3-4895-a6b4-adfded0c11dc' delete: summary: Removes a saved card in the safe description: Removes a saved card from Getnet's digital platform, from card_id. tags: - Vault produces: - application/json parameters: - required: true description: | Authorization: Bearer *AuthString*
In which *AuthString* is an access token obtained at the authentication endpoint. type: string name: Authorization in: header - in: header name: seller_id required: false type: string description: | Authorization: E-commerce identification code. Required when the client is treated as a Platform. format: uuidv4 minLength: 36 maxLength: 36 - required: true description: Unique identifier of the card in Getnet digital platform. type: string name: card_id maxLength: 36 in: path responses: '204': description: Card removed successfully. '400': description: Invalid request. schema: $ref: '#/definitions/error' '401': description: Invalid authentication. schema: $ref: '#/definitions/error' '403': description: Product safe not enabled. schema: $ref: '#/definitions/error' '404': description: Resource not found. schema: $ref: '#/definitions/error' '500': description: Internal server or service error. schema: $ref: '#/definitions/error' x-code-samples: - lang: cURL source: | curl -X DELETE \ https://api-homologacao.getnet.com.br/v1/cards/14a2ce5d-ebc3-49dc-a516-cb5239b02285 \ -H 'authorization: Bearer 72402c54-6bd3-4895-a6b4-adfded0c11dc' /v1/payments/credit: post: summary: Payment by credit card description: At this endpoint data for payment by credit card will be received.

For the delayed and pre_authorization fields, only one of them can be set to true, thus indicating only one credit service to be processed. tags: - Payment consumes: - application/json produces: - application/json parameters: - in: header name: Content-type required: true type: string enum: - application/json; charset=utf-8 default: application/json; charset=utf-8 description: | Content type. - in: header name: Authorization required: true type: string description: | Authorization: Bearer *AuthString*
In which *AuthString* is an access token obtained at the authentication endpoint. - in: body name: credit_body required: true description: Request containing data for credit card payment and fraud analysis. schema: $ref: '#/definitions/payment_credit' responses: '200': description: Payment successful. Transaction approved. schema: $ref: '#/definitions/payment_credit_response' '202': description: Request for credit payment with late confirmation or pre-authorization received, accepted and stored awaiting confirmation. schema: $ref: '#/definitions/payment_credit_pre_response' '400': description: Invalid request. schema: $ref: '#/definitions/error_table' '401': description: Invalid authentication. schema: $ref: '#/definitions/error_table' '402': description: Request is valid but payment denied. Can be denied for various reasons / business rules. schema: $ref: '#/definitions/error_table' '404': description: Not found. schema: $ref: '#/definitions/error_table' '500': description: Internal server or service error. schema: $ref: '#/definitions/error_table' x-code-samples: - lang: cURL source: | curl -X POST \ https://api-homologacao.getnet.com.br/v1/payments/credit \ -H 'authorization: Bearer 72402c54-6bd3-4895-a6b4-adfded0c11dc' \ -d '{ "seller_id": "6eb2412c-165a-41cd-b1d9-76c575d70a28", "amount": 100, "currency": "BRL", "order": { "order_id": "6d2e4380-d8a3-4ccb-9138-c289182818a3", "sales_tax": 0, "product_type": "service" }, "customer": { "customer_id": "customer_21081826", "first_name": "João", "name": "João da Silva", "email": "customer@email.com.br", "document_type": "CPF", "phone_number": "5551999887766", "billing_address": { "street": "Av. Brasil", "number": "1000", "complement": "Sala 1", "district": "São Geraldo", "city": "Porto Alegre", "state": "RS", "country": "Brasil", "postal_code": "90230060" } }, "credit": { "delayed": false, "save_card_data": false, "transaction_type": "FULL", "number_installments": 1, "soft_descriptor": "LOJA*TESTE*COMPRA-123", "dynamic_mcc": 1799, "card": { "number_token": "dfe05208b105578c070f806c80abd3af09e246827d29b866cf4ce16c205849977c9496cbf0d0234f42339937f327747075f68763537b90b31389e01231d4d13c", "bin": "123412", "security_code": "123", "expiration_month": "12", "expiration_year": "20", "cardholder_name": "JOAO DA SILVA" } } }' /v1/payments/credit/{payment_id}/confirm: post: summary: Late payment or pre authorization confirmation with credit card description: When a credit transaction is made with the option delayed = true or pre_authorization = true, late acknowledgment or pre authorization, it can be confirmed later, this endpoint is responsible for the confirmation. tags: - Payment consumes: - application/json produces: - application/json parameters: - in: header name: Content-type required: true type: string enum: - application/json; charset=utf-8 default: application/json; charset=utf-8 description: | Content type. - in: header name: Authorization required: true type: string description: | Authorization: Bearer *AuthString*
In which *AuthString* is an access token obtained at the authentication endpoint. - in: path name: payment_id description: Payment identifier previously received and accepted. type: string minLength: 36 maxLength: 36 format: uuidv4 required: true - in: body name: body description: Request containing the data for a late or pre-authorized credit confirmation request. schema: $ref: '#/definitions/credit_confirm' required: false responses: '200': description: Payment confirmed successfully. schema: $ref: '#/definitions/credit_delayed_confirm' '400': description: Invalid request. schema: $ref: '#/definitions/error' '401': description: Invalid authentication. schema: $ref: '#/definitions/error' '402': description: Request is valid but payment denied. Can be denied for various reasons / business rules. schema: $ref: '#/definitions/error' '404': description: Not found. schema: $ref: '#/definitions/error' '500': description: Internal server or service error. schema: $ref: '#/definitions/error' x-code-samples: - lang: cURL source: | curl -X POST \ https://api-homologacao.getnet.com.br/v1/payments/credit/06f256c8-1bbf-42bf-93b4-ce2041bfb87e/confirm \ -H 'authorization: Bearer 72402c54-6bd3-4895-a6b4-adfded0c11dc' \ -H 'cache-control: no-cache' \ -H 'content-type: application/json; charset=utf-8' \ /v1/payments/credit/{payment_id}/adjustment: post: summary: Adjust value of a pre-authorization transaction description: Performs an adjustment (Increase/Decrease) in the amount previously reserved in the Holder’s balance for a Pre-Authorization Transaction. The value of the Pre-Authorization Adjustment Transaction can be greater or less than the original value. In the call of the adjustment process, the desired final value must always be sent in the amount field. tags: - Payment consumes: - application/json produces: - application/json parameters: - in: header name: Content-type required: true type: string enum: - application/json; charset=utf-8 default: application/json; charset=utf-8 description: | Content type. - in: header name: Authorization required: true type: string description: | Authorization: Bearer *AuthString*
In which *AuthString* is an access token obtained at the authentication endpoint. - in: path name: payment_id description: Payment identifier previously received and accepted. type: string minLength: 36 maxLength: 36 format: uuidv4 required: true - in: body name: body description: Request containing the data for a Pre-Authorization value adjustment request. schema: $ref: '#/definitions/credit_preauthorized_adjustment' required: true responses: '200': description: Adjustment made successfully. schema: $ref: '#/definitions/credit_preauthorized_adjustment_response' '400': description: Invalid request. schema: $ref: '#/definitions/error' '401': description: Invalid authentication. schema: $ref: '#/definitions/error' '402': description: Request is valid but the setting has been denied. Can be denied for various reasons / business rules. schema: $ref: '#/definitions/error' '404': description: Not found. schema: $ref: '#/definitions/error' '500': description: Internal server or service error. schema: $ref: '#/definitions/error' x-code-samples: - lang: cURL source: | curl -X POST \ https://api-homologacao.getnet.com.br/v1/payments/credit/06f256c8-1bbf-42bf-93b4-ce2041bfb87e/adjustment \ -H 'authorization: Bearer 72402c54-6bd3-4895-a6b4-adfded0c11dc' \ -H 'cache-control: no-cache' \ -H 'content-type: application/json; charset=utf-8' \ -d '{ "amount": 19990, "currency": "BRL", "dynamic_mcc": 6666, "soft_descriptor": "LOJA*TESTE*COMPRA-123" }' /v1/payments/credit/{payment_id}/cancel: post: summary: Cancel payment on credit card description: | Cancel full credit transaction or cancel/undo late credit transaction or pre-authorization transaction*.* If the transaction is already confirmed, the cancellation is allowed only on the same day (D0) that this transaction was made. However, if the transaction is authorized (late credit transaction or pre-authorization) undoing can be done within 7 days * Cancel or reverse transactions made on the same day (D0). tags: - Payment consumes: - application/json produces: - application/json parameters: - in: header name: Content-type required: true type: string enum: - application/json; charset=utf-8 default: application/json; charset=utf-8 description: | Content type. - in: header name: Authorization required: true type: string description: | Authorization: Bearer *AuthString*
In which *AuthString* is an access token obtained at the authentication endpoint. - in: path name: payment_id description: Payment identifier previously received and accepted. type: string minLength: 36 maxLength: 36 format: uuidv4 required: true responses: '200': description: Payment canceled successfully. schema: $ref: '#/definitions/credit_delayed_cancel' '400': description: Invalid request. schema: $ref: '#/definitions/error' '401': description: Invalid authentication. schema: $ref: '#/definitions/error' '402': description: Request is valid but payment denied. Can be denied for various reasons / business rules. schema: $ref: '#/definitions/error' '404': description: Not found. schema: $ref: '#/definitions/error' '500': description: Internal server or service error. schema: $ref: '#/definitions/error' x-code-samples: - lang: cURL source: | curl -X POST \ https://api-homologacao.getnet.com.br/v1/payments/credit/06f256c8-1bbf-42bf-93b4-ce2041bfb87e/cancel \ -H 'authorization: Bearer 72402c54-6bd3-4895-a6b4-adfded0c11dc' \ -H 'cache-control: no-cache' \ -H 'content-type: application/json; charset=utf-8' \ /v1/payments/debit: post: summary: Debit card payment description: | At this endpoint data for payment by debit card will be received. ### Unauthenticated Debit Transaction Flow Unauthenticated debit is one that has no challenge, to enable you need to contact the call center through the number: 4020 4009.

Remembering that for the transaction to happen in addition to being enabled in Getnet the issuer needs to allow this modality. The following are the necessary endpoints: tags: - Payment consumes: - application/json produces: - application/json parameters: - in: header name: Content-type required: true type: string enum: - application/json; charset=utf-8 default: application/json; charset=utf-8 description: | Content type. - in: header name: Authorization required: true type: string description: | Authorization: Bearer *AuthString*
In which *AuthString* is an access token obtained at the authentication endpoint. - in: body name: debit_body required: true description: Request containing data for debit card payment and fraud analysis. schema: $ref: '#/definitions/payment_debit' responses: '200': description: Payment successful. Transaction approved. schema: $ref: '#/definitions/payment_debit_response' '400': description: Invalid request. schema: $ref: '#/definitions/error_table' '401': description: Invalid authentication. schema: $ref: '#/definitions/error_table' '402': description: Request is valid but payment denied. Can be denied for various reasons / business rules. schema: $ref: '#/definitions/error_table' '404': description: Not found. schema: $ref: '#/definitions/error_table' '500': description: Internal server or service error. schema: $ref: '#/definitions/error_table' x-code-samples: - lang: cURL source: | curl -X POST \ https://api-homologacao.getnet.com.br/v1/payments/debit \ -H 'authorization: Bearer 72402c54-6bd3-4895-a6b4-adfded0c11dc' \ -d '{ "seller_id": "6eb2412c-165a-41cd-b1d9-76c575d70a28", "amount": 100, "currency": "BRL", "order": { "order_id": "6d2e4380-d8a3-4ccb-9138-c289182818a3", "sales_tax": 0, "product_type": "service" }, "customer": { "customer_id": "customer_21081826", "first_name": "João", "name": "João Silva", "document_type": "CPF", "document_number": "12345678912", "phone_number": "5551999887766", "billing_address": { "street": "Av. Brasil", "complement": "Sala 1", "number": "1000", "district": "São Geraldo", "city": "Porto Alegre", "state": "RS", "country": "Brasil", "postal_code": "90230060" } }, "device": { "ip_address": "127.0.0.1", "device_id": "hash-device-id" }, "shippings": [{ "first_name": "João", "name": "João da Silva", "email": "customer@email.com.br", "phone_number": "5551999887766", "shipping_amount": 3000, "address": { "street": "Av. Brasil", "complement": "Sala 1", "number": "1000", "district": "São Geraldo", "city": "Porto Alegre", "state": "RS", "country": "Brasil", "postal_code": "90230060" } }], "debit": { "cardholder_mobile": "5551999887766", "soft_descriptor": "LOJA*TESTE*COMPRA-123", "dynamic_mcc": 1799, "card": { "number_token": "dfe05208b105578c070f806c80abd3af09e246827d29b866cf4ce16c205849977c9496cbf0d0234f42339937f327747075f68763537b90b31389e01231d4d13c", "security_code": "123", "expiration_month": "12", "expiration_year": "20", "cardholder_name": "JOAO DA SILVA" } } }' /v1/payments/debit/{payment_id}/cancel: post: summary: Cancel payment on debit card description: | Cancel a full debit transaction. * Cancel or reverse transactions made on the same day (D0). tags: - Payment consumes: - application/json produces: - application/json parameters: - in: header name: Content-type required: true type: string enum: - application/json; charset=utf-8 default: application/json; charset=utf-8 description: | Content type. - in: header name: Authorization required: true type: string description: | Authorization: Bearer *AuthString*
In which *AuthString* is an access token obtained at the authentication endpoint. - in: path name: payment_id description: Payment identifier previously received and accepted. type: string minLength: 36 maxLength: 36 format: uuidv4 required: true responses: '200': description: Payment canceled successfully. schema: $ref: '#/definitions/debit_cancel' '400': description: Invalid request. schema: $ref: '#/definitions/error' '401': description: Invalid authentication. schema: $ref: '#/definitions/error' '402': description: Request is valid but payment denied. Can be denied for various reasons / business rules. schema: $ref: '#/definitions/error' '404': description: Not found. schema: $ref: '#/definitions/error' '500': description: Internal server or service error. schema: $ref: '#/definitions/error' x-code-samples: - lang: cURL source: | curl -X POST \ https://api-homologacao.getnet.com.br/v1/payments/debit/06f256c8-1bbf-42bf-93b4-ce2041bfb87e/cancel \ -H 'authorization: Bearer 72402c54-6bd3-4895-a6b4-adfded0c11dc' \ -H 'cache-control: no-cache' \ -H 'content-type: application/json; charset=utf-8' \ /v1/payments/boleto: post: summary: Registration for payment with bank slip description: | This endpoint will receive the data of the new bank payment slip, which will be registered with Banco Santander.

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

__Note:__ The payment_id field can also be recovered in the bank payment slip notification. More information on notifications is available in Notifications 1.1. tags: - Payment consumes: - application/json produces: - application/json parameters: - in: header name: Content-type required: true type: string enum: - application/json; charset=utf-8 default: application/json; charset=utf-8 description: | Content type. - in: header name: Authorization required: true type: string description: | Authorization: Bearer *AuthString*
In which *AuthString* is an access token obtained at the authentication endpoint. - in: body name: boleto_body required: true description: Requisition containing the data for payment by bank slip. schema: $ref: '#/definitions/payment_boleto' responses: '201': description: Bank slip issued successfully. schema: $ref: '#/definitions/payment_boleto_response' '400': description: Invalid request. schema: $ref: '#/definitions/error' '401': description: Invalid authentication. schema: $ref: '#/definitions/error' '402': description: Request is valid but payment denied. Can be denied for various reasons / business rules. schema: $ref: '#/definitions/error_table' '404': description: Not found. schema: $ref: '#/definitions/error' '500': description: Internal server or service error. schema: $ref: '#/definitions/error' x-code-samples: - lang: cURL source: | curl -X POST \ https://api-homologacao.getnet.com.br/v1/payments/boleto \ -H 'authorization: Bearer 151f3061-d162-41c0-a3e7-474c49e60f57' \ -H 'cache-control: no-cache' \ -H 'content-type: application/json; charset=utf-8' \ -d '{ "seller_id": "6eb2412c-165a-41cd-b1d9-76c575d70a28", "amount": 100, "currency": "BRL", "order": { "order_id": "6d2e4380-d8a3-4ccb-9138-c289182818a3", "sales_tax": 0, "product_type": "service" }, "boleto": { "our_number": "000001946598", "document_number": "170500000019763", "instructions": "Pagar até o vencimento", "provider": "santander", "expiration_date": "10/05/2018" }, "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" } } }' /v2/payments/boleto: post: summary: Registration for payment with bank v2 slip. description: | This endpoint will receive the data of the new bank payment slip, which will be registered with Banco Santander.

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

#### PIX When printing the bank slip, the QRCode will be made available for payment by pix mode. __Note:__ The payment_id field can also be recovered in the bank payment slip notification. More information on notifications is available in Notifications 1.0 or Notifications 1.1. tags: - Payment consumes: - application/json produces: - application/json parameters: - in: header name: Content-type required: true type: string enum: - application/json; charset=utf-8 default: application/json; charset=utf-8 description: | Content type. - in: header name: Authorization required: true type: string description: | Authorization: Bearer *AuthString*
In which *AuthString* is an access token obtained at the authentication endpoint. - in: body name: boleto_body required: true description: Requisition containing the data for payment by bank slip. schema: $ref: '#/definitions/payment_boleto_v2' responses: '201': description: Bank slip issued successfully. schema: $ref: '#/definitions/payment_boleto_response_v2' '400': description: Invalid request. schema: $ref: '#/definitions/error' '401': description: Invalid authentication. schema: $ref: '#/definitions/error' '402': description: Request is valid but payment denied. Can be denied for various reasons / business rules. schema: $ref: '#/definitions/error_table' '404': description: Not found. schema: $ref: '#/definitions/error' '500': description: Internal server or service error. schema: $ref: '#/definitions/error' x-code-samples: - lang: cURL source: | curl -X POST \ https://api-homologacao.getnet.com.br/v1/payments/boleto \ -H 'authorization: Bearer 151f3061-d162-41c0-a3e7-474c49e60f57' \ -H 'cache-control: no-cache' \ -H 'content-type: application/json; charset=utf-8' \ -d '{ "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" } } } }' /v1/payments/boleto/{payment_id}/pdf: get: summary: Download pdf of the bank slip description: At this endpoint, the user can download the bank slip PDF to the ID entered in the path. tags: - Payment produces: - application/json parameters: - in: path name: payment_id description: | Bank slip identifier Hash.
Exemplo: 67e1eba5a4bae6a5011fc30b type: string minLength: 24 maxLength: 24 required: true - in: query name: ack description: |

Security parameter.

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

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

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

Security parameter.

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

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

The QRCode has an expiration limit, which is 3 minutes, after that period should be generated a new QRCode and the previous one should be disregarded.
This service is available for VISA and MASTER brand only. tags: - QRCode consumes: - application/json produces: - application/json parameters: - required: false description: E-commerce identification code. type: string name: seller_id format: uuidv4 minLength: 36 maxLength: 36 in: header - in: header name: Content-type required: true type: string enum: - application/json; charset=utf-8 default: application/json; charset=utf-8 description: Content type. - in: header name: Authorization required: true type: string description: | Authorization: Bearer *AuthString*
In which *AuthString* is an access token obtained at the authentication endpoint. - in: body name: credit_body required: true description: Requisition containing the details for payment by credit card and fraud analysis. schema: $ref: '#/definitions/payment_qrcode_request' responses: '200': description: QRCode successfully generated. Transaction approved. schema: $ref: '#/definitions/payment_qrcode_response' '400': description: Invalid requisition. 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/payments/qrcode \ -H 'authorization: Bearer 41460520-13ed-479a-93e7-a501c89212f9' \ -H 'content-type: application/json' \ -d '{ "amount": 199, "currency": "BRL", "order": { "order_id": "HTI-1608309698", "sales_tax": 100, "product_type": "service" }, "customer": { "customer_id": "bf8292ec-8c76-416b-a435-f9fce0b90f22", "first_name": "Winston", "last_name": "Smith", "name": "Winston Smith", "email": "aceitei@getnet.com.br", "document_type": "RG", "document_number": "GI6660001984", "phone_number": "66999991984", "billing_address": { "street": "Av. Ministério da Pujança", "number": "1984", "complement": "Mansão Victory", "district": "Minipuja", "city": "Novafala", "state": "OC", "country": "BR", "postal_code": "19840000" } }, "device": { "ip_address": "127.0.0.1", "device_id": "ldskfq7laskdfjljLKJOIULKSLSFFAS" }, "shippings": [ { "first_name": "Winston", "name": "Winston Smith", "email": "aceitei@getnet.com.br", "phone_number": "66999991984", "shipping_amount": 99, "address": { "street": "Av. Ministério da Pujança", "number": "1984", "complement": "Mansão Victory", "district": "Minipuja", "city": "Novafala", "state": "OC", "country": "BR", "postal_code": "19840000" } } ], "payments": [ { "type": "CREDIT", -- OU DEBIT "delayed": false, "authenticated": false, "pre_authorization": false, "save_card_data": false, "transaction_type": "FULL", "number_installments": 1, "soft_descriptor": "GI*PEDIDO*1984", "dynamic_mcc": 1234 } ] }' /v1/payments/qrcode/pix: post: summary: QR Code generator for PIX instant payments description: At this endpoint, data for PIX instant payments with QR Code will be received.

The QR Code PIX has an expiration limit, default which is 3 minutes, after that period should be generated a new QR Code and the previous one must be disregarded.
After the QR Code is generated, the payment will be returned to the Merchant through an HTTP Notification. For more details please consult by "Notification PIX" in the sections Notification 1.0 e Notification 1.1 this document. tags: - PIX consumes: - application/json produces: - application/json parameters: - required: false description: E-commerce identification code. type: string name: seller_id format: uuidv4 minLength: 36 maxLength: 36 in: header - in: header name: Content-type required: true type: string enum: - application/json; charset=utf-8 default: application/json; charset=utf-8 description: Content type. - in: header name: Authorization required: true type: string description: | Authorization: Bearer *AuthString*
In which *AuthString* is an access token obtained at the authentication endpoint. - in: header name: x-qrcode-expiration-time required: false type: number default: 180 maximum: 1800 description: It is possible to customize the QR Code expiration time by entering the desired time in seconds, if not informed, the operation will go with the default value of 180s. The maximum value for the expiration time is 1800s. - in: body name: pix_body required: true description: Request containing data for payment with PIX. schema: $ref: '#/definitions/payment_qrcode_pix_request' responses: '200': description: QR Code generated successfully and awaiting payment. schema: $ref: '#/definitions/payment_qrcode_pix_response' '400': description: Invalid request. schema: $ref: '#/definitions/error' '401': description: Invalid authentication. schema: $ref: '#/definitions/error' '404': description: Not found. schema: $ref: '#/definitions/error' '500': description: Server internal error. schema: $ref: '#/definitions/error' x-code-samples: - lang: cURL source: | curl -X POST \ https://api-homologacao.getnet.com.br/v1/payments/qrcode/pix \ -H 'authorization: Bearer 41460520-13ed-479a-93e7-a501c89212f9' \ -H 'content-type: application/json' \ -H 'seller_id: 1584b7ad-f2a4-4082-9285-73689c98d793' \ -d '{ "amount": 199, "currency": "BRL", "order_id": "INV-1608309698", "customer_id": "bf8292ec-8c76-416b-a435" }' /v1/payments/qrcode/{payment_id}: get: summary: Query payment status description: | Returns payment data with QRCode.

The query should last a maximum of 1 minute 50 seconds, as it is the validity time of a QRCode.
If the transaction is still PENDING after this time, it no longer changes status. tags: - QRCode produces: - application/json parameters: - required: true description: | Authorization: Bearer *AuthString*
In which *AuthString* is an access token obtained at the authentication endpoint. type: string name: Authorization in: header - required: false description: E-commerce identification code. type: string name: seller_id format: uuidv4 minLength: 36 maxLength: 36 in: header - in: path name: payment_id description: Payment identifier. type: string minLength: 36 maxLength: 36 format: uuidv4 required: true responses: '200': description: Payment transaction status and data. schema: $ref: '#/definitions/qrcode_response' '400': description: Invalid requisition. 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' /v1/3ds/tokens: post: summary: Generation of 3DS access token description: | Endpoint responsible for generating the access token for opening 3DS authentication session with GetNet. tags: - 3DS Authentication consumes: - application/json produces: - application/json parameters: - in: header name: Content-type required: true type: string enum: - application/json; charset=utf-8 default: application/json; charset=utf-8 description: | Content type. - in: header name: Authorization required: true type: string description: | Authorization: Bearer *AuthString*
In which *AuthString* is an access token obtained at the authentication endpoint. - in: body name: 3ds_token required: true description: | Data that identifies the session and purchase being made (Order). schema: $ref: '#/definitions/3ds_token' responses: '201': description: | Returns the access token for 3DS authentication session next to the GetNet schema: type: object properties: access_token: type: string description: Access token for 3DS authentication session. example: | eyJhbGciOiJIUzI1NiJ9.eyJqdGkiOiIzZjczZGQ3MS03NjkyLTQyYTItYjU2Ni1jYmUzMzJkYzU3OTQiLCJpYXQiOjE1NzY2NzI3NDUsImlzcyI6IjVkNzVhYzYxNmZlM2QxMmYxODhmZmQ3YyIsIk9yZ1VuaXRJZCI6IjVkNzRlZDczZTA5MTlmMTk1ODNjMzE5MyIsIlBheWxvYWQiOiJ7XCJvcmRlck51bWJlclwiOlwic3RyaW5nXCIsXCJwYXltZW50SWRcIjpcImRhMGU4ZDkwLTQ0OGMtNGJhMC1iZGUyLTQxN2Q2YTdmZjliOVwiLFwibWVyY2hhbnRJZFwiOlwiMDU0Mzk5MlwiLFwibWVyY2hhbnROYW1lXCI6XCJFQyBUZXN0ZSBIVUIg4oCTIFBBRFJBT1wiLFwiY3VycmVuY3lcIjpcImJybFwiLFwidG90YWxBbW91bnRcIjpcIjEwMDBcIixcImpzVmVyc2lvblwiOlwic3RyaW5nXCIsXCJjbGllbnRDb2RlXCI6XCJzdHJpbmctM2Y3M2RkNzEtNzY5Mi00MmEyLWI1NjYtY2JlMzMyZGM1Nzk0XCIsXCJvdmVycmlkZVBheW1lbnRNZXRob2RcIjpcIjAyXCIsXCJpdGVtc1wiOlt7XCJ0b3RhbEFtb3VudFwiOlwiOTAwXCIsXCJ1bml0UHJpY2VcIjpcIjg5OVwiLFwicXVhbnRpdHlcIjowLFwic2t1XCI6XCJzdHJpbmdcIixcImRlc2NyaXB0aW9uXCI6XCJzdHJpbmdcIixcIm5hbWVcIjpcInN0cmluZ1wifSx7XCJ0b3RhbEFtb3VudFwiOlwiOTAwXCIsXCJ1bml0UHJpY2VcIjpcIjgwMFwiLFwicXVhbnRpdHlcIjowLFwic2t1XCI6XCJzdHJpbmdcIixcImRlc2NyaXB0aW9uXCI6XCJzdHJpbmdcIixcIm5hbWVcIjpcInN0cmluZ1wifV19IiwiT2JqZWN0aWZ5UGF5bG9hZCI6ZmFsc2UsIlJlZmVyZW5jZUlkIjoiM2Y3M2RkNzEtNzY5Mi00MmEyLWI1NjYtY2JlMzMyZGM1Nzk0IiwiZXhwIjoxNTc2NjcyODY1fQ.jrPvIjtvSY6HukI-PjBE0ACWo68whA2FhCCfKeEfB4g maxLength: 2000 token_type: type: string description: Token type. example: bearer minLength: 6 maxLength: 6 expiration_date: type: string description: Token expiration date. minLength: 23 maxLength: 23 format: YYYY-MM-DDTHH:mm:ss.SSS example: '2019-09-05T18:54:53.153' '400': description: Invalid requisition. schema: $ref: '#/definitions/error' '401': description: Invalid authentication. schema: $ref: '#/definitions/error' '403': description: Access denied. schema: $ref: '#/definitions/error' '404': description: Not found. schema: $ref: '#/definitions/error' '500': description: Internal server or service error. schema: $ref: '#/definitions/error' '503': description: Server or service error unavailable. schema: $ref: '#/definitions/error' '504': description: Error gateway timeout. schema: $ref: '#/definitions/error' /v1/3ds/authentications: post: summary: Requests 3DS authentication description: | Endpoint responsible for the 3DS authentication request with the GetNet. tags: - 3DS Authentication consumes: - application/json produces: - application/json parameters: - in: header name: Content-type required: true type: string enum: - application/json; charset=utf-8 default: application/json; charset=utf-8 description: | Content type. - in: header name: Authorization required: true type: string description: | Authorization: Bearer *AuthString*
In which *AuthString* is an access token obtained at the authentication endpoint. - in: body name: 3ds_authentication required: true description: | Data that identifies the purchase being made (Order), details about authentication, customer history, card data. schema: $ref: '#/definitions/3ds_authentication' responses: '201': description: Returns from 3DS authentication with GetNet. schema: type: object properties: card: $ref: '#/definitions/3ds_authentications_resp_card_ref' id: type: string maxLength: 26 description: | A unique identification number assigned by the CyberSource to identify the request sent. example: 5.785063465166933e+21 submit_time_utc: type: string description: | Request time in UTC. maxLength: 20 example: '2019-12-18T17:46:02.000Z' format: YYYY-MM-DDThh:mm:ssZ status: type: string description: | Status of the 3DS authentication request. example: AUTHENTICATION_SUCCESSFUL maxLength: 25 enum: - AUTHENTICATION_SUCCESSFUL - PENDING_AUTHENTICATION - AUTHENTICATION_FAILED client_reference_information: $ref: '#/definitions/3ds_authentications_resp_client_reference_information_ref' consumer_authentication_information: $ref: '#/definitions/3ds_authentications_resp_consumer_authentication_information_ref' error_information: $ref: '#/definitions/3ds_authentications_resp_error_information_ref' reference_id: type: string description: | Reference number generated by 3DS Getnet. maxLength: 36 example: a1c1aaf5-28fe-44c8-8b06-26103afb101e org_unit_id: type: string description: | Getnet id used to consume the 3DS service. example: 5d74ed73e0919f19583c3193 send_ds_date: type: integer description: | Date of submission of the 3DS service in long format representing currentTimeMillis. example: 1578506345431 rec_ds_date: type: integer description: | Date of receipt of the 3DS service in long format that represents currentTimeMillis. example: 1578506348886 '400': description: Invalid requisition. schema: $ref: '#/definitions/error' '401': description: Invalid authentication. schema: $ref: '#/definitions/error' '403': description: Access denied. schema: $ref: '#/definitions/error' '404': description: Not found. schema: $ref: '#/definitions/error' '500': description: Internal server or service error. schema: $ref: '#/definitions/error' '503': description: Internal server or service error. schema: $ref: '#/definitions/error' '504': description: Error gateway timeout. schema: $ref: '#/definitions/error' /v1/3ds/authentications/results: post: summary: Requests result of 3DS authentication description: | Endpoint responsible for requesting the result of 3DS authentication with GetNet. tags: - 3DS Authentication consumes: - application/json produces: - application/json parameters: - in: header name: Content-type required: true type: string enum: - application/json; charset=utf-8 default: application/json; charset=utf-8 description: | Content type. - in: header name: Authorization required: true type: string description: | Authorization: Bearer *AuthString*
In which *AuthString* is an access token obtained at the authentication endpoint. - in: body name: body schema: $ref: '#/definitions/3ds_results_ref' responses: '201': description: Returns result of 3DS authentication with GetNet. schema: type: object properties: card: $ref: '#/definitions/3ds_authentications_resp_card_ref' id: type: string description: A unique identification number assigned by the CyberSource to identify the request sent. example: 5.785063465166933e+21 submit_time_utc: type: string description: Request time in UTC. example: '2019-12-18T17:46:02.000Z' status: type: string description: | Status of the 3DS authentication request. example: AUTHENTICATION_SUCCESSFUL maxLength: 25 enum: - AUTHENTICATION_SUCCESSFUL - PENDING_AUTHENTICATION - AUTHENTICATION_FAILED client_reference_information: $ref: '#/definitions/3ds_authentications_resp_client_reference_information_ref' consumer_authentication_information: $ref: '#/definitions/3ds_authentication_results_resp_consumer_authentication_information_ref' send_ds_date: type: string description: 'Date of submission of the 3DS service in long format representing currentTimeMillis. ' example: 1578506345431 rec_ds_date: type: string description: Date of receipt of the 3DS service in long format that represents currentTimeMillis. example: 1578506348886 '400': description: Invalid requisition. schema: $ref: '#/definitions/error' '401': description: Invalid authentication. schema: $ref: '#/definitions/error' '403': description: Access denied. schema: $ref: '#/definitions/error' '404': description: Not found. schema: $ref: '#/definitions/error' '500': description: Internal server or service error. schema: $ref: '#/definitions/error' '503': description: Server error or service unavailable. schema: $ref: '#/definitions/error' '504': description: Error gateway timeout. schema: $ref: '#/definitions/error' /v1/payments/authenticated: post: summary: 3DS authenticated payment with credit or debit card. description: | In this endpoint, data will be received for 3DS authenticated payment with credit or debit card. tags: - 3DS Authenticated Payment consumes: - application/json produces: - application/json parameters: - in: header name: Content-type required: true type: string enum: - application/json; charset=utf-8 default: application/json; charset=utf-8 description: | Content type. - in: header name: Authorization required: true type: string description: | Authorization: Bearer *AuthString*
In which *AuthString* is an access token obtained at the authentication endpoint. - in: header name: seller_id required: false type: string description: | Authorization: E-commerce identification code. Required when the client is treated as a Platform. format: uuidv4 minLength: 36 maxLength: 36 - in: body name: body schema: $ref: '#/definitions/3ds_payments_authenticated_ref' responses: '200': description: Payment made successfully. Transaction approved. schema: $ref: '#/definitions/3ds_payments_authenticated_res_ref' '202': description: | Request for payment of credit with late or pre-confirmed confirmation authorization received, accepted and stored awaiting confirmation. schema: $ref: '#/definitions/3ds_payments_authenticated_pre_res_ref' '400': description: Invalid requisition. schema: $ref: '#/definitions/error' '401': description: Invalid authentication. schema: $ref: '#/definitions/error' '403': description: Access denied. schema: $ref: '#/definitions/error' '404': description: Not found. schema: $ref: '#/definitions/error' '500': description: Internal server or service error. schema: $ref: '#/definitions/error' '503': description: Server error or service unavailable. schema: $ref: '#/definitions/error' '504': description: Error gateway timeout. schema: $ref: '#/definitions/error' '/v1/payments/authenticated/{payment_id}/confirm ': post: summary: | Late payment confirmation or pre-authorization confirmation with credit card with 3DS authentication. description: | When a credit transaction with 3DS authentication is made with the late confirmation or pre-authorization, it can be subsequently confirmed, this endpoint is responsible for the confirmation. tags: - 3DS Authenticated Payment consumes: - application/json produces: - application/json parameters: - in: header name: Content-type required: true type: string enum: - application/json; charset=utf-8 default: application/json; charset=utf-8 description: | Content type. - in: header name: Authorization required: true type: string description: | Authorization: Bearer *AuthString*
In which *AuthString* is an access token obtained at the authentication endpoint. - in: header name: seller_id required: false type: string description: | Authorization: E-commerce identification code. Required when the client is treated as a Platform. format: uuidv4 minLength: 36 maxLength: 36 - in: path name: payment_id description: Payment identifier previously received and accepted. type: string minLength: 36 maxLength: 36 format: uuidv4 required: true - in: body name: body schema: $ref: '#/definitions/3ds_payments_authenticated_confirm_ref' responses: '200': description: Payment successfully confirmed. schema: $ref: '#/definitions/3ds_payments_authenticated_confirm_res_ref' '400': description: Invalid requisition. schema: $ref: '#/definitions/error' '401': description: Invalid authentication. schema: $ref: '#/definitions/error' '403': description: Access denied. schema: $ref: '#/definitions/error' '404': description: Not found. schema: $ref: '#/definitions/error' '500': description: Internal server or service error. schema: $ref: '#/definitions/error' '503': description: Server error or service unavailable. schema: $ref: '#/definitions/error' '504': description: Error gateway timeout. schema: $ref: '#/definitions/error' /v1/payments/authenticated/{payment_id}/adjustment: post: summary: Adjust the value of a pre-authorization transaction with 3DS authentication. description: | Performs an adjustment (increment/decrement) to the previously reserved value the bearer's balance for a pre-authorization transaction. The value of the pre-authorization adjustment transaction may be greater than or less than the original value. In the call of the adjustment process should always be sent the desired final value in the amount field. tags: - 3DS Authenticated Payment consumes: - application/json produces: - application/json parameters: - in: header name: Content-type required: true type: string enum: - application/json; charset=utf-8 default: application/json; charset=utf-8 description: | Content type. - in: header name: Authorization required: true type: string description: | Authorization: Bearer *AuthString*
In which *AuthString* is an access token obtained at the authentication endpoint. - in: header name: seller_id required: false type: string description: | Authorization: E-commerce identification code. Required when the client is treated as a Platform. format: uuidv4 minLength: 36 maxLength: 36 - in: path name: payment_id description: Payment identifier previously received and accepted. type: string minLength: 36 maxLength: 36 format: uuidv4 required: true - in: body name: body schema: $ref: '#/definitions/3ds_payments_authenticated_adjustment_ref' responses: '200': description: Adjustment performed successfully. schema: $ref: '#/definitions/3ds_payments_authenticated_adjustment_res_ref' '400': description: Invalid requisition. schema: $ref: '#/definitions/error' '401': description: Invalid authentication. schema: $ref: '#/definitions/error' '403': description: Access denied. schema: $ref: '#/definitions/error' '404': description: Not found. schema: $ref: '#/definitions/error' '500': description: Internal server or service error. schema: $ref: '#/definitions/error' '503': description: Server error or service unavailable. schema: $ref: '#/definitions/error' '504': description: Error gateway timeout. schema: $ref: '#/definitions/error' /v1/payments/authenticated/{payment_id}/cancel: post: summary: Cancel credit card payment with 3DS authentication. description: | Cancel a transaction with full credit 3DS authentication or transaction with late credit 3DS authentication or transactionwith 3DS authentication of pre-authorized credit. * Estorna or undo transactions made on the same day (D0). tags: - 3DS Authenticated Payment consumes: - application/json produces: - application/json parameters: - in: header name: Content-type required: true type: string enum: - application/json; charset=utf-8 default: application/json; charset=utf-8 description: | Content type. - in: header name: Authorization required: true type: string description: | Authorization: Bearer *AuthString*
In which *AuthString* is an access token obtained at the authentication endpoint. - in: header name: seller_id required: false type: string description: | Authorization: E-commerce identification code. Required when the client is treated as a Platform. format: uuidv4 minLength: 36 maxLength: 36 - in: path name: payment_id description: Payment identifier previously received and accepted. type: string minLength: 36 maxLength: 36 format: uuidv4 required: true - in: body name: body schema: $ref: '#/definitions/3ds_payments_authenticated_cancel_ref' responses: '200': description: Payment cancelled successfully. schema: $ref: '#/definitions/3ds_payments_authenticated_cancel_res_ref' '400': description: Invalid requisition. schema: $ref: '#/definitions/error' '401': description: Invalid authentication. schema: $ref: '#/definitions/error' '403': description: Access denied. schema: $ref: '#/definitions/error' '404': description: Not found. schema: $ref: '#/definitions/error' '500': description: Internal server or service error. schema: $ref: '#/definitions/error' '503': description: Server error or service unavailable. schema: $ref: '#/definitions/error' '504': description: Error gateway timeout. schema: $ref: '#/definitions/error' /v1/payment-links: post: summary: GetPay Creation. description: Endpoint responsible for creating the payment link tags: - GetPay consumes: - application/json produces: - application/json parameters: - required: true description: Content type. enum: - application/json; charset=utf-8 default: application/json; charset=utf-8 type: string name: Content-Type in: header - required: true description: | Authorization: Bearer *AuthString*
Where *AuthString* is access token obtained in the endpoint of authentication. type: string name: Authorization in: header - required: false description: E-commerce identification code. type: string name: seller_id format: uuidv4 minLength: 36 maxLength: 36 in: header - required: true in: body name: body description: Requisition containing the data for GetPay. schema: $ref: '#/definitions/payment_link_request' responses: '201': description: Created schema: $ref: '#/definitions/payment_link_request_response' '400': description: Invalid request. schema: $ref: '#/definitions/error' '401': description: Invalid authentication. schema: $ref: '#/definitions/errorgetpay401' '500': description: Internal server or service error. schema: $ref: '#/definitions/error' get: summary: Getpay query by filter description: In this endpoint it´s possible to get data from all the payment links that were created by the establishment. This API should be used with the objective of analysing all the created links for more detail a different API should be used.A number of filters can be used to to help analise data tags: - GetPay produces: - application/json parameters: - required: true description: | Authorization: Bearer *AuthString*
Where *AuthString* is access token obtained in the endpoint of authentication. type: string name: Authorization in: header - required: false description: E-commerce identification code. type: string name: seller_id format: uuidv4 minLength: 36 maxLength: 36 in: header - name: label description: Filter by identification label of the payment link. type: string in: query - name: expiration_since description: Expiration date and tima in the ISO format. Filter "a partir de" . type: string in: query - name: credit description: Filter by enabled credit payment type. type: string in: query - name: debit description: Filter by enabled debit payment type. type: string in: query - name: created_since description: Date and time of the creation in the ISO format. Filter "a partir de". type: string in: query - name: created_until description: Date and time of the creation in the ISO format. Filter "antes de". type: string in: query - name: status description: Filter by GetPay status. type: string enum: - SUSPENDED - ACTIVE - EXPIRED in: query - name: limit description: Limit of results by search. type: string minimum: 1 maximum: 20 default: 10 in: query - name: page description: Results page. type: integer in: query - name: expiration_until description: Expiration date and time in the ISO format. Filter "antes de". type: string in: query responses: '200': description: OK schema: $ref: '#/definitions/payment_link_filter_response' '400': description: Invalid request. schema: $ref: '#/definitions/error' '401': description: Invalid authentication. schema: $ref: '#/definitions/errorgetpay401' '404': description: Not Found schema: $ref: '#/definitions/error' '500': description: Internal server or service error. schema: $ref: '#/definitions/error' /v1/payment-links/{link_id}: patch: summary: Change Getpay data. description: Update Getpay properties. tags: - GetPay consumes: - application/json produces: - application/json parameters: - required: false description: E-commerce identification code. type: string name: seller_id format: uuidv4 minLength: 36 maxLength: 36 in: header - required: true description: Content type. enum: - application/json; charset=utf-8 default: application/json; charset=utf-8 type: string name: Content-Type in: header - required: true description: | Authorization: Bearer *AuthString*
Where *AuthString* is access token obtained in the endpoint of authentication. type: string name: Authorization in: header - required: true in: body name: body description: GetPay dataset to be updated. schema: $ref: '#/definitions/payment_link_alteration' - required: true type: string description: GetPay ID that originated the payment order. name: link_id in: path responses: '200': description: OK schema: $ref: '#/definitions/payment_link_alteration_response' '400': description: Invalid request. schema: $ref: '#/definitions/error' '401': description: Invalid authentication. schema: $ref: '#/definitions/error' '500': description: Internal server or service error. schema: $ref: '#/definitions/error' get: summary: Getpay data query. description: A payment link can have numerous sale orders, this API with the main objectif to demonstrate registration information of the link and how many orders and sales it had tags: - GetPay produces: - application/json parameters: - required: false description: E-commerce identification code. type: string name: seller_id format: uuidv4 minLength: 36 maxLength: 36 in: header - required: true description: | Authorization: Bearer *AuthString*
Where *AuthString* is access token obtained in the endpoint of authentication. type: string name: Authorization in: header - required: true type: string description: GetPay ID that originated the payment request. name: link_id in: path responses: '200': description: OK schema: $ref: '#/definitions/payment_link_consult_response' '400': description: Invalid request. schema: $ref: '#/definitions/error' '401': description: Invalid authentication. schema: $ref: '#/definitions/error' '500': description: Internal server or service error. schema: $ref: '#/definitions/error' /v1/payment-links/{link_id}/payment-orders/{payment_order_id}: get: summary: GetPay related payment query. description: This API allows getting all information of atempted payments, returning all authorized data processed by GetNet. This API is esential to determine the motive of a payment being denied, the date and time of wich the payment was processed etc... All this information return independetly if the transaction was aproved or denied. tags: - GetPay produces: - application/json parameters: - required: false description: E-commerce identification code. type: string name: seller_id format: uuidv4 minLength: 36 maxLength: 36 in: header - required: true description: | Authorization: Bearer *AuthString*
Where *AuthString* is access token obtained in the endpoint of authentication. type: string name: Authorization in: header - required: true description: GetPay ID that originated the payment request. type: string name: link_id in: path - required: true description: Payment request ID. type: string name: payment_order_id in: path responses: '200': description: OK - The Block transaction within payments may vary according to the type of payment being (DEBIT, UNAUTHENTICATED DEBIT, CREDIT, UNAUTHENTICATED CREDIT, PIX, QRCODE) schema: $ref: '#/definitions/payment_link_payment_consult_response' '400': description: Invalid request. schema: $ref: '#/definitions/error' '401': description: Invalid authentication. schema: $ref: '#/definitions/error' '500': description: Internal server or service error. schema: $ref: '#/definitions/error' /v1/payment-links/{link_id}/payment-orders: get: summary: GetPay linked payment query. description: A payment link can have a number of orders and sales, in sale order the payment is only considered successfull when an a payment attempt is aproved with success. This API allowes getting information of orders and sales that were sent at the moment of the transaction tags: - GetPay produces: - application/json parameters: - required: false description: E-commerce identification code. type: string name: seller_id format: uuidv4 minLength: 36 maxLength: 36 in: header - required: true description: | Authorization: Bearer *AuthString*
Where *AuthString* is access token obtained in the endpoint of authentication. type: string name: Authorization in: header - type: string in: query name: customer_email description: Search filter by costumer's email adress. - type: string in: query name: payment_id description: ID of the payment linked to the payment request. - type: string in: query name: created_since description: Creation date and time in ISO format. Filter "a partir de". - type: string in: query name: created_until description: Creation date and time in ISO format. Filter "antes de". - type: string description: ID that originated the payment request. name: link_id in: path required: true responses: '200': description: OK schema: $ref: '#/definitions/payment_link_linked_response' '400': description: Invalid request. schema: $ref: '#/definitions/error' '401': description: Invalid authentication. schema: $ref: '#/definitions/error' '500': description: Internal server or service error. schema: $ref: '#/definitions/error' /v1/payment-links/enabled-products: get: summary: Consult products enabled to use Getpay description: Consult products enabled to use Getpay tags: - GetPay produces: - application/json parameters: - required: true description: | Authorization: Bearer *AuthString*
Where *AuthString* is access token obtained in the endpoint of authentication. type: string name: Authorization in: header - required: false description: E-commerce identification code. type: string name: seller_id format: uuidv4 minLength: 36 maxLength: 36 in: header responses: '200': description: OK schema: $ref: '#/definitions/payment_link_filter_response_enabled_products' '400': description: Invalid request. schema: $ref: '#/definitions/error' '401': description: Invalid authentication. schema: $ref: '#/definitions/error' '500': description: Internal server or service error. schema: $ref: '#/definitions/error' /v1/payments/cancel/request: post: summary: Request a cancellation description: '* Request the cancellation of transactions that were made more than 1 day ago (D + n).' tags: - Cancellation consumes: - application/json produces: - application/json parameters: - required: true description: Content type. enum: - application/json; charset=utf-8 default: application/json; charset=utf-8 type: string name: Content-Type in: header - required: true description: | Authorization: Bearer *AuthString*
In which *AuthString* is an access token obtained at the authentication endpoint. type: string name: Authorization in: header - required: false description: E-commerce identification code. type: string name: seller_id format: uuidv4 minLength: 36 maxLength: 36 in: header - required: true in: body name: body description: Request containing the data for a cancellation request. schema: $ref: '#/definitions/cancel_request' responses: '202': description: Accepted cancellation request schema: $ref: '#/definitions/cancel_request_response' '400': description: Invalid request. schema: $ref: '#/definitions/error' '401': description: Invalid authentication. schema: $ref: '#/definitions/error' '404': description: Not found. schema: $ref: '#/definitions/error' '409': description: Conflict. Duplicate client key (cancel_custom_key). schema: $ref: '#/definitions/error' '500': description: Internal server or service error. schema: $ref: '#/definitions/error' x-code-samples: - lang: cURL source: | curl -X POST \ https://api-homologacao.getnet.com.br/v1/payments/cancel/request \ -H 'authorization: Bearer 151f3061-d162-41c0-a3e7-474c49e60f57' \ -H 'cache-control: no-cache' \ -H 'content-type: application/json; charset=utf-8' \ -H 'seller_id: 6eb2412c-165a-41cd-b1d9-76c575d70a28' \ -d '{ "payment_id": "06f256c8-1bbf-42bf-93b4-ce2041bfb87e", "cancel_amount": 19990, "cancel_custom_key": "4ec33ee18f9e45bfb73c5c30667f9006" } get: summary: Returns a cancellation request by the client key description: Returns the cancellation request data by the key generated by the client. tags: - Cancellation produces: - application/json parameters: - required: true description: | Authorization: Bearer *AuthString*
In which *AuthString* is an access token obtained at the authentication endpoint. type: string name: Authorization in: header - required: false description: E-commerce identification code. type: string name: seller_id format: uuidv4 minLength: 36 maxLength: 36 in: header - required: true description: Customer generated key for the cancellation request. type: string name: cancel_custom_key maxLength: 32 in: query responses: '200': description: Returns the data for the cancellation request. schema: $ref: '#/definitions/cancel_query_response' '400': description: Invalid request. schema: $ref: '#/definitions/error' '401': description: Invalid authentication. schema: $ref: '#/definitions/error' '404': description: Not found. schema: $ref: '#/definitions/error' '500': description: Internal server or service error. schema: $ref: '#/definitions/error' x-code-samples: - lang: cURL source: | curl -X GET \ https://api-homologacao.getnet.com.br/v1/payments/cancel/request?cancel_custom_key=4ec33ee18f9e45bfb73c5c30667f9006 \ -H 'authorization: Bearer 72402c54-6bd3-4895-a6b4-adfded0c11dc' \ -H 'seller_id: 6eb2412c-165a-41cd-b1d9-76c575d70a28' /v1/payments/cancel/request/{cancel_request_id}: get: summary: Returns a request for cancellation by the identifier description: Returns the cancellation request data by the identifier. tags: - Cancellation produces: - application/json parameters: - required: true description: | Authorization: Bearer *AuthString*
In which *AuthString* is an access token obtained at the authentication endpoint. type: string name: Authorization in: header - required: false description: E-commerce identification code. type: string name: seller_id format: uuidv4 minLength: 36 maxLength: 36 in: header - required: true description: Identification of the cancellation request. type: string name: cancel_request_id minLength: 18 maxLength: 18 in: path responses: '200': description: Returns the data for the cancellation request. schema: $ref: '#/definitions/cancel_query_response' '400': description: Invalid request. schema: $ref: '#/definitions/error' '401': description: Invalid authentication. schema: $ref: '#/definitions/error' '404': description: Not found. schema: $ref: '#/definitions/error' '500': description: Internal server or service error. schema: $ref: '#/definitions/error' x-code-samples: - lang: cURL source: | curl -X GET \ https://api-homologacao.getnet.com.br/v1/payments/cancel/request/20171117084237501 \ -H 'authorization: Bearer 72402c54-6bd3-4895-a6b4-adfded0c11dc' \ -H 'seller_id: 6eb2412c-165a-41cd-b1d9-76c575d70a28' /v1/customers: post: summary: Register a new customer description: At this endpoint, you can register the data for a new customer for subscription. tags: - Clients consumes: - application/json produces: - application/json parameters: - required: true description: Content type. enum: - application/json; charset=utf-8 default: application/json; charset=utf-8 type: string name: Content-Type in: header - required: true description: | Authorization: Bearer *AuthString*
In which *AuthString* is an access token obtained at the authentication endpoint. type: string name: Authorization in: header - required: true description: E-commerce identification code. type: string name: seller_id format: uuidv4 minLength: 36 maxLength: 36 in: header - required: false description: User who is registering. This information may be used for audit purposes. type: string name: username in: header - required: true in: body name: body description: Request containing the data to register a new client. schema: $ref: '#/definitions/customer_info' responses: '200': description: Successful customer registration schema: $ref: '#/definitions/customer_info_response' '400': description: Invalid request. schema: $ref: '#/definitions/error' '401': description: Invalid authentication. schema: $ref: '#/definitions/error' '500': description: Internal server or service error. schema: $ref: '#/definitions/error' x-code-samples: - lang: cURL source: | curl -X POST \ https://api-homologacao.getnet.com.br/v1/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: At this endpoint, you can list all the previously registered customers based on the selected filters. tags: - Clients produces: - application/json parameters: - required: true description: | Authorization: Bearer *AuthString*
In which *AuthString* is an access token obtained at the authentication endpoint. type: string name: Authorization in: header - required: true description: E-commerce identification code. type: string name: seller_id format: uuidv4 minLength: 36 maxLength: 36 in: header - required: true description: The number of the page where you start paging. minimum: 1 type: number name: page in: query - required: true description: Results limit per page. minimum: 0 maximum: 9999 type: number name: limit in: query - required: false description: Buyer ID. type: string name: customer_id maxLength: 100 in: query - required: false description: Buyer's document number. minLength: 11 maxLength: 15 type: string name: document_number in: query - required: false description: First name of buyer. maxLength: 40 type: string name: first_name in: query - required: false description: Last name of buyer. maxLength: 80 type: string name: last_name in: query - required: false description: Field to perform sorting. default: last_name type: string name: sort in: query - required: false description: Sort type. Ascending or Descending. enum: - asc - desc type: string name: sort_type in: query responses: '200': description: List of registered customers. schema: $ref: '#/definitions/customer_filter_response' '400': description: Invalid request. schema: $ref: '#/definitions/error' '401': description: Invalid authentication. schema: $ref: '#/definitions/error' '404': description: Not found. schema: $ref: '#/definitions/error' '500': description: Internal server or service error. schema: $ref: '#/definitions/error' x-code-samples: - lang: cURL source: | curl -X GET \ https://api-homologacao.getnet.com.br/v1/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: At this end-point, you can search data on a specific customer that has previously been registered. tags: - Clients produces: - application/json parameters: - required: true description: | Authorization: Bearer *AuthString*
In which *AuthString* is an access token obtained at the authentication endpoint. type: string name: Authorization in: header - required: true description: E-commerce identification code. type: string name: seller_id format: uuidv4 minLength: 36 maxLength: 36 in: header - required: true description: Buyer ID. type: string name: customer_id maxLength: 100 in: path responses: '200': description: Returns the customer data. schema: $ref: '#/definitions/customer_info' '400': description: Invalid request. schema: $ref: '#/definitions/error' '401': description: Invalid authentication. schema: $ref: '#/definitions/error' '404': description: Not found. schema: $ref: '#/definitions/error' '500': description: Internal server or service error. schema: $ref: '#/definitions/error' x-code-samples: - lang: cURL source: | curl -X GET \ https://api-homologacao.getnet.com.br/v1/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: At this endpoint, you can create a subscription plan. consumes: - application/json produces: - application/json tags: - Plans parameters: - required: true description: Content type. enum: - application/json; charset=utf-8 default: application/json; charset=utf-8 type: string name: Content-Type in: header - required: true description: | Authorization: Bearer *AuthString*
In which *AuthString* is an access token obtained at the authentication endpoint. type: string name: Authorization in: header - required: true description: E-commerce identification code. type: string name: seller_id format: uuidv4 minLength: 36 maxLength: 36 in: header - required: false description: User who is registering. This information may be used for audit purposes. type: string name: username in: header - required: true in: body name: body description: Request containing the data to register a new plan. schema: $ref: '#/definitions/plan' responses: '200': description: Successful plan registration schema: $ref: '#/definitions/plan_response' '400': description: Invalid request. schema: $ref: '#/definitions/error' '401': description: Invalid authentication. schema: $ref: '#/definitions/error' '403': description: Recurrence product not enabled. 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/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: At this endpoint, you can list all the previously registered plans based on the selected filters. tags: - Plans produces: - application/json parameters: - required: true description: | Authorization: Bearer *AuthString*
In which *AuthString* is an access token obtained at the authentication endpoint. type: string name: Authorization in: header - required: true description: E-commerce identification code. type: string name: seller_id format: uuidv4 minLength: 36 maxLength: 36 in: header - required: true description: The number of the page where you start paging. minimum: 1 type: number name: page in: query - required: true description: Results limit per page. minimum: 0 maximum: 9999 type: number name: limit in: query - required: false description: Identifier of the plan. type: string name: plan_id minLength: 36 maxLength: 36 format: uuidv4 in: query - required: false description: Status of the plan. default: active enum: - active - inactive type: string name: status in: query - required: false description: Name of plan. minLength: 3 type: string name: name in: query - required: false description: Field to perform sorting. default: name type: string name: sort in: query - required: false description: Sort type. Ascending or Descending. enum: - asc - desc type: string name: sort_type in: query - name: expand in: query type: array items: type: string required: false description: | Displays additional information from the Plans such as the expected value changes for them. The display of some information may depend on the activation of a product specific on Getnet. * `floating_data` - The result includes the information block of all date and value changes. responses: '200': description: List of plans. schema: $ref: '#/definitions/plan_filter_response' '400': description: Invalid request. schema: $ref: '#/definitions/error' '401': description: Invalid authentication. schema: $ref: '#/definitions/error' '403': description: Recurrence product not enabled. schema: $ref: '#/definitions/error' '404': description: Not found. schema: $ref: '#/definitions/error' '500': description: Internal server or service error. schema: $ref: '#/definitions/error' x-code-samples: - lang: cURL source: | curl -X GET \ https://api-homologacao.getnet.com.br/v1/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: At this endpoint, you can search data on a specific plan that has previously been registered. tags: - Plans produces: - application/json parameters: - required: true description: | Authorization: Bearer *AuthString*
In which *AuthString* is an access token obtained at the authentication endpoint. type: string name: Authorization in: header - required: true description: E-commerce identification code. type: string name: seller_id format: uuidv4 minLength: 36 maxLength: 36 in: header - required: true description: Identifier of the plan. type: string name: plan_id minLength: 36 maxLength: 36 format: uuidv4 in: path - name: expand in: query type: array items: type: string required: false description: | Displays additional information from the Plans such as the expected value changes for them. The display of some information may depend on the activation of a product specific on Getnet. * `floating_data` - The result includes the information block of all date and value changes. responses: '200': description: Returns the plan data. schema: $ref: '#/definitions/plan_response' '400': description: Invalid request. schema: $ref: '#/definitions/error' '401': description: Invalid authentication. schema: $ref: '#/definitions/error' '403': description: Recurrence product not enabled. schema: $ref: '#/definitions/error' '404': description: Not found. schema: $ref: '#/definitions/error' '500': description: Internal server or service error. schema: $ref: '#/definitions/error' x-code-samples: - lang: cURL source: | curl -X GET \ https://api-homologacao.getnet.com.br/v1/plans/51995e24-b1ae-4826-8e15-2a568a87abdd \ -H 'authorization: Bearer 72402c54-6bd3-4895-a6b4-adfded0c11dc' \ -H 'seller_id: 6eb2412c-165a-41cd-b1d9-76c575d70a28' patch: summary: Updates a plan description: At this endpoint, you can update the definition of previously registered plan. Remember, Plans with associated active subscriptions only allow Name and Description alterations. tags: - Plans consumes: - application/json produces: - application/json parameters: - required: true description: Content type. enum: - application/json; charset=utf-8 default: application/json; charset=utf-8 type: string name: Content-Type in: header - required: true description: | Authorization: Bearer *AuthString*
In which *AuthString* is an access token obtained at the authentication endpoint. type: string name: Authorization in: header - required: true description: E-commerce identification code. type: string name: seller_id format: uuidv4 minLength: 36 maxLength: 36 in: header - required: false description: User who is registering. This information may be used for audit purposes. type: string name: username in: header - required: true description: Identifier of the plan. type: string name: plan_id minLength: 36 maxLength: 36 format: uuidv4 in: path - required: true description: Set of data of the plan to be updated. in: body name: body schema: $ref: '#/definitions/plan_update' responses: '200': description: Returns the updated plan. schema: $ref: '#/definitions/plan_response' '400': description: Invalid request. schema: $ref: '#/definitions/error' '401': description: Invalid authentication. schema: $ref: '#/definitions/error' '403': description: Recurrence product not enabled. schema: $ref: '#/definitions/error' '404': description: Not found. schema: $ref: '#/definitions/error' '500': description: Internal server or service error. schema: $ref: '#/definitions/error' x-code-samples: - lang: cURL source: | curl -X 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": "Plano flex atualizado", "description": "Plano flex atualizado", } /v1/plans/{plan_id}/status/{status}: patch: summary: Updates plan status description: At this endpoint, you can activate/deactivate the status of the subscription plan. tags: - Plans produces: - application/json parameters: - required: true description: Content type. enum: - application/json; charset=utf-8 default: application/json; charset=utf-8 type: string name: Content-Type in: header - required: true description: | Authorization: Bearer *AuthString*
In which *AuthString* is an access token obtained at the authentication endpoint. type: string name: Authorization in: header - required: true description: E-commerce identification code. type: string name: seller_id format: uuidv4 minLength: 36 maxLength: 36 in: header - required: false description: User who is registering. This information may be used for audit purposes. type: string name: username in: header - required: true description: Identifier of the plan. type: string name: plan_id minLength: 36 maxLength: 36 format: uuidv4 in: path - required: true description: Status of the plan. enum: - active - inactive type: string name: status in: path responses: '200': description: Returns the plan data. schema: $ref: '#/definitions/plan_response' '400': description: Invalid request. schema: $ref: '#/definitions/error' '401': description: Invalid authentication. schema: $ref: '#/definitions/error' '403': description: Recurrence product not enabled. schema: $ref: '#/definitions/error' '404': description: Not found. schema: $ref: '#/definitions/error' '500': description: Internal server or service error. schema: $ref: '#/definitions/error' x-code-samples: - lang: cURL source: | curl -X 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: Changes the Plan of a list of Subscriptions. description: In this endpoint you can request the change of the Plan of a list of Subscriptions or request the change of the Plan of all Subscriptions from a source Plan to a destination Plan. consumes: - application/json produces: - application/json tags: - Plans parameters: - required: true description: Type of content. enum: - application/json; charset=utf-8 default: application/json; charset=utf-8 type: string name: Content-Type in: header - required: true description: | Authorization: Bearer *AuthString*
In which *AuthString* is an access token obtained at the authentication endpoint. type: string name: Authorization in: header - required: true description: E-commerce identification code. type: string name: seller_id format: uuidv4 minLength: 36 maxLength: 36 in: header - required: false description: User who is registering. This information may be used for audit purposes. type: string name: username in: header - in: body required: true name: body description: Here, the identifiers of the source and destination Plans will be informed, that is, the Subscriptions of the source Plan (key from) will be changed (migrated) to the destination Plan (key to). A list of Subscription identifiers may also be informed as optional for the need to change the Plan for specific Subscriptions only. If this list of Subscriptions is not informed then the service will migrate all Subscriptions from the source Plan (key from) to Destination Plan (key to). schema: $ref: '#/definitions/subscription_plan_migration' responses: '202': description: Request accepted for processing. The process of migrating Subscriptions from a source Plan to a destination Plan will be done asynchronously. It is possible to check the migration progress of the Subscriptions through the GET /v1/subscriptions service informing the identifier of the target Plan. schema: $ref: '#/definitions/subscription_plan_migration' '400': description: Invalid request. schema: $ref: '#/definitions/error' '401': description: Invalid authentication. schema: $ref: '#/definitions/error' '403': description: Recurrence product not enabled. schema: $ref: '#/definitions/error' '404': description: Not found. schema: $ref: '#/definitions/error' '500': description: Internal server error. schema: $ref: '#/definitions/error' '503': description: Service unavailable. 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: John' \ -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: Registers a new subscription description: At this endpoint, you can create a new subscription. tags: - Subscriptions consumes: - application/json produces: - application/json parameters: - required: true description: Content type. enum: - application/json; charset=utf-8 default: application/json; charset=utf-8 type: string name: Content-Type in: header - required: true description: | Authorization: Bearer *AuthString*
In which *AuthString* is an access token obtained at the authentication endpoint. type: string name: Authorization in: header - required: true description: E-commerce identification code. type: string name: seller_id format: uuidv4 minLength: 36 maxLength: 36 in: header - required: false description: User who is registering. This information may be used for audit purposes. type: string name: username in: header - required: false description: Request containing the data to register a new subscription. in: body name: body schema: $ref: '#/definitions/subscription' responses: '201': description: Subscription created successfully. schema: $ref: '#/definitions/subscription_response' '400': description: Invalid request. schema: $ref: '#/definitions/error' '401': description: Invalid authentication. schema: $ref: '#/definitions/error' '403': description: Recurrence product not enabled. 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/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": "20", "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: List of subscriptions description: At this endpoint, you can list all the previously registered subscriptions based on the selected filters. tags: - Subscriptions produces: - application/json parameters: - required: true description: | Authorization: Bearer *AuthString*
In which *AuthString* is an access token obtained at the authentication endpoint. type: string name: Authorization in: header - required: true description: E-commerce identification code. type: string name: seller_id format: uuidv4 minLength: 36 maxLength: 36 in: header - required: true description: The number of the page where you start paging. minimum: 1 type: number name: page in: query - required: true description: Results limit per page. minimum: 0 maximum: 9999 type: number name: limit in: query - required: false description: Buyer ID. type: string name: customer_id maxLength: 100 in: query - required: false description: Recurrence plan identifier. type: string name: plan_id minLength: 36 maxLength: 36 format: uuidv4 in: query - required: false description: Recurrence subscription identifier. type: string name: subscription_id minLength: 36 maxLength: 36 format: uuidv4 in: query - required: false description: Start date of the next schedule. type: string name: next_scheduled_date[start] in: query - required: false description: End date of next schedule. type: string name: next_scheduled_date[end] in: query - required: false description: Initial subscription creation date. type: string name: create_date[start] in: query - required: false description: Final subscription creation date. type: string name: create_date[end] in: query - required: false description: Initial subscription date. type: string name: end_date[start] in: query - required: false description: End subscription date. type: string name: end_date[end] in: query - required: false description: Field to perform sorting. default: create_date enum: - order_id - create_date - end_date type: string name: sort in: query - required: false description: Sort type. Ascending or Descending. default: asc enum: - asc - desc type: string name: sort_type in: query - required: false description: Subscription status. enum: - processing - canceled - success - error - delayed type: string name: status in: query - name: expand in: query type: array items: type: string required: false description: | Displays additional subscription information such as date and amount changes expected for it. The display of some information may depend on the activation of a product specific on Getnet. * `floating_data` - The result includes the information block of all date and value changes. responses: '200': description: List returned successfully. schema: $ref: '#/definitions/subscription_filter_response' '400': description: Invalid request. schema: $ref: '#/definitions/error' '401': description: Invalid authentication. schema: $ref: '#/definitions/error' '403': description: Recurrence product not enabled. schema: $ref: '#/definitions/error' '404': description: Not found. schema: $ref: '#/definitions/error' '500': description: Internal server or service error. schema: $ref: '#/definitions/error' x-code-samples: - lang: cURL source: | curl -X GET \ https://api-homologacao.getnet.com.br/v1/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 subscription description: At this endpoint, you can search data on a specific subscription that has previously been registered. tags: - Subscriptions produces: - application/json parameters: - required: true description: | Authorization: Bearer *AuthString*
In which *AuthString* is an access token obtained at the authentication endpoint. type: string name: Authorization in: header - required: true description: E-commerce identification code. type: string name: seller_id format: uuidv4 minLength: 36 maxLength: 36 in: header - required: true description: Recurrence subscription identifier. type: string name: subscription_id minLength: 36 maxLength: 36 format: uuidv4 in: path - name: expand in: query type: array items: type: string required: false description: | Displays additional subscription information such as date and amount changes expected for it. The display of some information may depend on the activation of a product specific on Getnet. * `floating_data` - The result includes the information block of all date and value changes. responses: '200': description: Subscription returned successfully. schema: $ref: '#/definitions/subscription_response' '400': description: Invalid request. schema: $ref: '#/definitions/error' '401': description: Invalid authentication. schema: $ref: '#/definitions/error' '403': description: Recurrence product not enabled. schema: $ref: '#/definitions/error' '404': description: Not found. schema: $ref: '#/definitions/error' '500': description: Internal server or service error. schema: $ref: '#/definitions/error' x-code-samples: - lang: cURL source: | curl -X GET \ https://api-homologacao.getnet.com.br/v1/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: At this endpoint, you can cancel a previously registered subscription. Remember, cancellation of the subscription also effects the cancellation of the next scheduled charge. tags: - Subscriptions consumes: - application/json produces: - application/json parameters: - required: true description: Content type. enum: - application/json; charset=utf-8 default: application/json; charset=utf-8 type: string name: Content-Type in: header - required: true description: | Authorization: Bearer *AuthString*
In which *AuthString* is an access token obtained at the authentication endpoint. type: string name: Authorization in: header - required: true description: E-commerce identification code. type: string name: seller_id format: uuidv4 minLength: 36 maxLength: 36 in: header - required: false description: User who is registering. This information may be used for audit purposes. type: string name: username in: header - required: true description: Recurrence subscription identifier. type: string name: subscription_id minLength: 36 maxLength: 36 format: uuidv4 in: path - required: false description: Additional data set for cancellation. in: body name: body schema: $ref: '#/definitions/subscription_cancel' responses: '200': description: Subscription canceled successfully. schema: $ref: '#/definitions/subscription_response' '400': description: Invalid request. schema: $ref: '#/definitions/error' '401': description: Invalid authentication. schema: $ref: '#/definitions/error' '403': description: Recurrence product not enabled. schema: $ref: '#/definitions/error' '404': description: Not found. schema: $ref: '#/definitions/error' '500': description: Internal server or service error. schema: $ref: '#/definitions/error' x-code-samples: - lang: cURL source: | curl -X POST \ https://api-homologacao.getnet.com.br/v1/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: | At this endpoint, you can visualize a projection of scheduled charges for the subscription. Remember, the projections and charges registered for dates after the 28th will, depending on the month, may apply to the last day of the month. __For example:__ Date of payment: 31 Forecast: * 31/10/2019 * 30/11/2019 * 31/12/2019 tags: - Subscriptions produces: - application/json parameters: - required: true description: | Authorization: Bearer *AuthString*
In which *AuthString* is an access token obtained at the authentication endpoint. type: string name: Authorization in: header - required: true description: E-commerce identification code. type: string name: seller_id format: uuidv4 minLength: 36 maxLength: 36 in: header - required: true description: Recurrence subscription identifier. type: string name: subscription_id minLength: 36 maxLength: 36 format: uuidv4 in: path - required: false description: Number of records to be returned. default: 3 minimum: 1 maximum: 1000 type: integer name: limit in: query - name: expand in: query type: array items: type: string required: false description: | Displays additional subscription information such as date and amount changes expected for it. The display of some information may depend on the activation of a product specific on Getnet. * `installment` - Includes the number information of the installment in the result * `floating_data` - The result includes the information block of all date and value changes. responses: '200': description: Projection returned successfully. schema: $ref: '#/definitions/subscription_projection_response' '400': description: Invalid request. schema: $ref: '#/definitions/error' '401': description: Invalid authentication. schema: $ref: '#/definitions/error' '403': description: Recurrence product not enabled. schema: $ref: '#/definitions/error' '404': description: Not found. schema: $ref: '#/definitions/error' '500': description: Internal server or service error. schema: $ref: '#/definitions/error' x-code-samples: - lang: cURL source: | curl -X GET \ https://api-homologacao.getnet.com.br/v1/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: At this endpoint, you can manually confirm a subscription payment. tags: - Subscriptions consumes: - application/json produces: - application/json parameters: - required: true description: Content type. enum: - application/json; charset=utf-8 default: application/json; charset=utf-8 type: string name: Content-Type in: header - required: true description: | Authorization: Bearer *AuthString*
In which *AuthString* is an access token obtained at the authentication endpoint. type: string name: Authorization in: header - required: true description: E-commerce identification code. type: string name: seller_id format: uuidv4 minLength: 36 maxLength: 36 in: header - required: false description: User who is registering. This information may be used for audit purposes. type: string name: username in: header - required: true description: Recurrence subscription identifier. type: string name: subscription_id minLength: 36 maxLength: 36 format: uuidv4 in: path - required: false description: Set of information for confirmation of subscription payment. in: body name: body schema: $ref: '#/definitions/subscription_confirm' responses: '200': description: Payment confirmed successfully. schema: $ref: '#/definitions/subscription_response' '400': description: Invalid request. schema: $ref: '#/definitions/error' '401': description: Invalid authentication. schema: $ref: '#/definitions/error' '403': description: Recurrence product not enabled. schema: $ref: '#/definitions/error' '404': description: Not found. schema: $ref: '#/definitions/error' '500': description: Internal server or service error. schema: $ref: '#/definitions/error' x-code-samples: - lang: cURL source: | curl -X POST \ https://api-homologacao.getnet.com.br/v1/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 date description: At this endpoint, you can update the date of payment for a previously registered subscription. Remember, by altering the date of payment, all future installments will be updated according to the new date. tags: - Subscriptions consumes: - application/json produces: - application/json parameters: - required: true description: Content type. enum: - application/json; charset=utf-8 default: application/json; charset=utf-8 type: string name: Content-Type in: header - required: true description: | Authorization: Bearer *AuthString*
In which *AuthString* is an access token obtained at the authentication endpoint. type: string name: Authorization in: header - required: true description: E-commerce identification code. type: string name: seller_id format: uuidv4 minLength: 36 maxLength: 36 in: header - required: false description: User who is registering. This information may be used for audit purposes. type: string name: username in: header - required: true description: Recurrence subscription identifier. type: string name: subscription_id minLength: 36 maxLength: 36 format: uuidv4 in: path - required: false description: Set of data to update payment date. in: body name: body schema: $ref: '#/definitions/subscription_payment_date' responses: '200': description: Date updated successfully. schema: $ref: '#/definitions/subscription_response' '400': description: Invalid request. schema: $ref: '#/definitions/error' '401': description: Invalid authentication. schema: $ref: '#/definitions/error' '403': description: Recurrence product not enabled. schema: $ref: '#/definitions/error' '404': description: Not found. schema: $ref: '#/definitions/error' '500': description: Internal server or service error. schema: $ref: '#/definitions/error' x-code-samples: - lang: cURL source: | curl -X 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: Updates payment data description: At this endpoint, you can update the payment information for a previously registered subscription. tags: - Subscriptions consumes: - application/json produces: - application/json parameters: - required: true description: Content type. enum: - application/json; charset=utf-8 default: application/json; charset=utf-8 type: string name: Content-Type in: header - required: true description: | Authorization: Bearer *AuthString*
In which *AuthString* is an access token obtained at the authentication endpoint. type: string name: Authorization in: header - required: true description: E-commerce identification code. type: string name: seller_id format: uuidv4 minLength: 36 maxLength: 36 in: header - required: false description: User who is registering. This information may be used for audit purposes. type: string name: username in: header - required: true description: Recurrence subscription identifier. type: string name: subscription_id minLength: 36 maxLength: 36 format: uuidv4 in: path - required: true description: Set of data for change of payment type. in: body name: body schema: $ref: '#/definitions/subscription_update_payment_type' responses: '200': description: Payment data updated successfully. schema: $ref: '#/definitions/subscription_response' '400': description: Invalid request. schema: $ref: '#/definitions/error' '401': description: Invalid authentication. schema: $ref: '#/definitions/error' '403': description: Recurrence product not enabled. schema: $ref: '#/definitions/error' '404': description: Not found. schema: $ref: '#/definitions/error' '500': description: Internal server or service error. schema: $ref: '#/definitions/error' x-code-samples: - lang: cURL source: | curl -X 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": "20", "bin": "123412", "card_id": "17b5ce46-db3f-4e03-90d0-42aa3131c41e" } /v1/subscriptions/{subscription_id}/floating: post: summary: Register a change of date or amount for the subscription description: | In this endpoint you can create a new date and / or value change for one or more charges that are scheduled for the subscription. For to use this endpoint your company must be enabled for that specific product. For more details see the Rules for updating date. tags: - Subscriptions consumes: - application/json produces: - application/json parameters: - required: true description: Content type. enum: - application/json; charset=utf-8 default: application/json; charset=utf-8 type: string name: Content-Type in: header - required: true description: | Authorization: Bearer *AuthString*
In which *AuthString* is an access token obtained at the authentication endpoint. type: string name: Authorization in: header - required: true description: E-commerce identification code. Required when the client is treated as a Platform.. type: string name: seller_id format: uuidv4 minLength: 36 maxLength: 36 in: header - required: true description: Recurrence subscription identifier. type: string name: subscription_id minLength: 36 maxLength: 36 format: uuidv4 in: path - required: false description: | User who is registering. This information can be used for audit purposes. type: string name: username in: header - required: false description: | Request containing the data to register the date changes and / or amount for certain charges. in: body name: body schema: $ref: '#/definitions/subscription_floating_data_array_creation' responses: '201': description: Subscription updated successfully. schema: $ref: '#/definitions/subscription_floating_data_response' '400': description: Invalid request. schema: $ref: '#/definitions/error' '401': description: Invalid authentication. schema: $ref: '#/definitions/error' '403': description: Recurrence product not enabled. schema: $ref: '#/definitions/error' '404': description: Not found. schema: $ref: '#/definitions/error' '500': description: Internal server or service error. schema: $ref: '#/definitions/error' x-code-samples: - lang: cURL source: | curl -X POST \ https://api-homologacao.getnet.com.br/v1/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 changes to the date and / or value of a subscription description: | In this endpoint you can retrieve the data for all date changes and / or amount in charges for a specific subscription. To use this endpoint your company must be enabled for this endpoint specific product. For more details see the Rules for updating date. tags: - Subscriptions produces: - application/json parameters: - required: true description: | Authorization: Bearer *AuthString*
In which *AuthString* is an access token obtained at the authentication endpoint. type: string name: Authorization in: header - required: true description: E-commerce identification code. Required when the client is treated as a Platform. type: string name: seller_id format: uuidv4 minLength: 36 maxLength: 36 in: header - required: true description: Recurrence subscription identifier. type: string name: subscription_id minLength: 36 maxLength: 36 format: uuidv4 in: path responses: '200': description: | Changes to date and / or amount of Subscription charges returned successfully. schema: $ref: '#/definitions/subscription_floating_data_response' '400': description: Invalid request. schema: $ref: '#/definitions/error' '401': description: Invalid authentication. schema: $ref: '#/definitions/error' '403': description: Recurrence product not enabled. schema: $ref: '#/definitions/error' '404': description: Not found. schema: $ref: '#/definitions/error' '500': description: Internal server or service error. schema: $ref: '#/definitions/error' x-code-samples: - lang: cURL source: | curl -X GET \ https://api-homologacao.getnet.com.br/v1/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 changes to date and value in charges for a specific subscription. The signature will remain with the original values and dates according to the associated plan. To use this endpoint your company must be enabled for this endpoint specific product. tags: - Subscriptions produces: - application/json parameters: - required: true description: | Authorization: Bearer *AuthString*
In which *AuthString* is an access token obtained at the authentication endpoint. type: string name: Authorization in: header - required: true description: E-commerce identification code. Required when the client is treated as a Platform. type: string name: seller_id format: uuidv4 minLength: 36 maxLength: 36 in: header - required: true description: Recurrence subscription identifier. type: string name: subscription_id minLength: 36 maxLength: 36 format: uuidv4 in: path - required: false description: | User who is registering. This information can be used for audit purposes. type: string name: username in: header responses: '200': description: Date and value changes have been partially removed. schema: $ref: '#/definitions/subscription_floating_data_remove_response' '204': description: Date and value changes have been successfully removed. '400': description: Invalid request. schema: $ref: '#/definitions/error' '401': description: Invalid authentication. schema: $ref: '#/definitions/error' '403': description: Recurrence product not enabled. schema: $ref: '#/definitions/error' '404': description: Not found. schema: $ref: '#/definitions/error' '500': description: Internal server or service error. schema: $ref: '#/definitions/error' x-code-samples: - lang: cURL source: | curl -X 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 value changes to charges for a subscription. description: | In this endpoint you can add new date and / or value changes for charges for a specific subscription. This endpoint can be used for subscriptions that already have changes in date and amount indexed. To use this endpoint, it is necessary your company be enabled for that specific product. For more details see the Rules for updating date. tags: - Subscriptions consumes: - application/json produces: - application/json parameters: - required: true description: Tipo do conteúdo. enum: - application/json; charset=utf-8 default: application/json; charset=utf-8 type: string name: Content-Type in: header - required: true description: | Authorization: Bearer *AuthString*
In which *AuthString* is an access token obtained at the authentication endpoint. type: string name: Authorization in: header - required: true description: E-commerce identification code. Required when the client is treated as a Platform. type: string name: seller_id format: uuidv4 minLength: 36 maxLength: 36 in: header - required: true description: Recurrence subscription identifier. type: string name: subscription_id minLength: 36 maxLength: 36 format: uuidv4 in: path - required: false description: | User who is registering. This information can be used for audit purposes. type: string name: username in: header - required: false description: | Request containing the data for adding the date and / or changes amount for certain charges. in: body name: body schema: $ref: '#/definitions/subscription_floating_data_array_creation' responses: '200': description: Date and value changes successfully inserted. schema: $ref: '#/definitions/subscription_floating_data_response' '400': description: Invalid request. schema: $ref: '#/definitions/error' '401': description: Invalid authentication. schema: $ref: '#/definitions/error' '403': description: Recurrence product not enabled. schema: $ref: '#/definitions/error' '404': description: Not found. schema: $ref: '#/definitions/error' '422': description: Invalid Request. schema: $ref: '#/definitions/error' '500': description: Internal server or service error. 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 installment from a subscription. description: | In this endpoint you can remove all date and value changes for a specific subscription charge. The charge will remain with the original values and dates according to the associated plan. To use this endpoint your company must be enabled for this endpoint specific product. tags: - Subscriptions produces: - application/json parameters: - required: true description: | Authorization: Bearer *AuthString*
In which *AuthString* is an access token obtained at the authentication endpoint. type: string name: Authorization in: header - required: true description: E-commerce identification code. Required when the client is treated as a Platform. type: string name: seller_id format: uuidv4 minLength: 36 maxLength: 36 in: header - required: true description: Recurrence subscription identifier. type: string name: subscription_id minLength: 36 maxLength: 36 format: uuidv4 in: path - required: true description: Number of the installment to be applied to the change. type: integer format: int32 name: installment minimum: 1 in: path - required: false description: | User who is registering. This information can be used for audit purposes. type: string name: username in: header responses: '204': description: Date and value changes have been successfully removed. '400': description: Invalid request. schema: $ref: '#/definitions/error' '401': description: Invalid authentication. schema: $ref: '#/definitions/error' '403': description: Recurrence product not enabled. schema: $ref: '#/definitions/error' '404': description: Not found. schema: $ref: '#/definitions/error' '500': description: Internal server or service error. schema: $ref: '#/definitions/error' x-code-samples: - lang: cURL source: | curl -X 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 subscription charge. description: | Neste endpoint você pode atualizar a data e valor para uma cobrança específica de uma assinatura. Este endpoint pode ser utilizado para uma cobrança específica que já possui alteração data e valor cadastrado. Para utilizar esse endpoint é necessário o estabelecimento estar habilitado para esse produto específico. For more details see the Rules for updating date. tags: - Subscriptions consumes: - application/json produces: - application/json parameters: - required: true description: | Authorization: Bearer *AuthString*
In which *AuthString* is an access token obtained at the authentication endpoint. type: string name: Authorization in: header - required: true description: E-commerce identification code. Required when the client is treated as a Platform. type: string name: seller_id format: uuidv4 minLength: 36 maxLength: 36 in: header - required: true description: Recurrence subscription identifier. type: string name: subscription_id minLength: 36 maxLength: 36 format: uuidv4 in: path - required: true description: Number of the installment to be applied to the change. type: integer format: int32 name: installment minimum: 1 in: path - required: false description: | User who is registering. This information can be used for audit purposes. type: string name: username in: header - required: false description: | Data for updating the date and / or value of a given charge. in: body name: body schema: $ref: '#/definitions/subscription_floating_data_update' responses: '200': description: Date and value changes successfully inserted. schema: $ref: '#/definitions/subscription_floating_data_response' '400': description: Invalid request. schema: $ref: '#/definitions/error' '401': description: Invalid authentication. schema: $ref: '#/definitions/error' '403': description: Recurrence product not enabled. schema: $ref: '#/definitions/error' '404': description: Not found. schema: $ref: '#/definitions/error' '422': description: Invalid Request. schema: $ref: '#/definitions/error' '500': description: Internal server or service error. 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: At this endpoint you can request to change the Plan of a specific Subscription. consumes: - application/json produces: - application/json tags: - Subscriptions parameters: - required: true description: | Authorization: Bearer *AuthString*
In which *AuthString* is an access token obtained at the authentication endpoint. type: string name: Authorization in: header - required: true description: E-commerce identification code. Required when the client is treated as a Platform. type: string name: seller_id format: uuidv4 minLength: 36 maxLength: 36 in: header - required: true type: string name: subscription_id in: path - required: false description: | User who is registering. This information can be used for audit purposes. type: string name: username in: header - required: false in: body name: body schema: $ref: '#/definitions/plan_migration_request' responses: '200': description: Subscription successfully migrated. schema: $ref: '#/definitions/subscription_response' '400': description: Invalid request. schema: $ref: '#/definitions/error' '404': description: Not Found. schema: $ref: '#/definitions/error' '500': description: Internal server or service error. schema: $ref: '#/definitions/error' x-code-samples: - lang: cURL source: | curl -X 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: John' \ -d '{ \"from\": \"9aca75f2-bb03-42d7-aa09-7e46409ded26\", \"to\": \"a0ca3090-a4f6-4e1f-a91d-a535454dd72b\" }' /v1/cards/binlookup/{bin}: get: tags: - BIN Search summary: Perform the verification of the BINs of the cards, validating the data to avoid fraud. The BIN of a card corresponds from the first 4 to the ninth digit. description: This endpoint returns the information of a BIN such as the flag name, flag code, issuing country, etc. operationId: consultaBinUsingGET produces: - application/json parameters: - required: true description: | Authorization: Bearer *AuthString*
In which *AuthString* is an access token obtained at the authentication endpoint. type: string name: Authorization in: header - required: true name: bin in: path description: bin type: string responses: '200': description: Returns the list of found BINs. schema: $ref: '#/definitions/consulta_bin_response' '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' deprecated: false /v1/charges: get: summary: List of charges description: At this endpoint, you can list all the previously registered charges based on the selected filters. tags: - Subscriptions produces: - application/json parameters: - required: true description: | Authorization: Bearer *AuthString*
In which *AuthString* is an access token obtained at the authentication endpoint. type: string name: Authorization in: header - required: true description: E-commerce identification code. type: string name: seller_id format: uuidv4 minLength: 36 maxLength: 36 in: header - required: true description: The number of the page where you start paging. minimum: 1 type: number name: page in: query - required: true description: Results limit per page. minimum: 0 maximum: 9999 type: number name: limit in: query - required: false description: Billing ID. type: string name: charge_id minLength: 36 maxLength: 36 format: uuidv4 in: query - required: false description: E-commerce identification code. type: string name: seller_id format: uuidv4 minLength: 36 maxLength: 36 in: query - required: false description: Recurrence subscription identifier. type: string name: subscription_id minLength: 36 maxLength: 36 format: uuidv4 in: query - required: false description: Billing status. enum: - paid - denied - processing - scheduled - canceled type: string name: status in: query - required: false description: Start date. type: string name: start_date in: query - required: false description: End date. type: string name: end_date in: query - required: false description: Scheduled date. type: string name: scheduled_date in: query - required: false description: Number of retries. minimum: 0 type: number name: retries in: query - required: false description: Field to perform sorting. default: create_date type: string name: sort in: query enum: - create_date - installment - scheduled_date - required: false description: Sort type. Ascending or Descending. enum: - asc - desc type: string name: sort_type in: query responses: '200': description: Returns the list of charges. schema: $ref: '#/definitions/charge_filter_response' '400': description: Invalid request. schema: $ref: '#/definitions/error' '401': description: Invalid authentication. schema: $ref: '#/definitions/error' '403': description: Recurrence product not enabled. schema: $ref: '#/definitions/error' '404': description: Not found. schema: $ref: '#/definitions/error' '500': description: Internal server or service error. schema: $ref: '#/definitions/error' x-code-samples: - lang: cURL source: | curl -X GET \ https://api-homologacao.getnet.com.br/v1/charges?page=1&limit=10 \ -H 'authorization: Bearer 72402c54-6bd3-4895-a6b4-adfded0c11dc' \ -H 'seller_id: 6eb2412c-165a-41cd-b1d9-76c575d70a28' definitions: payment_credit: type: object description: Credit payment transaction dataset. required: - amount - credit - order - customer properties: seller_id: type: string description: E-commerce identification code. minLength: 36 maxLength: 36 format: uuidv4 example: 6eb2412c-165a-41cd-b1d9-76c575d70a28 amount: type: integer description: Value of the purchase in cents. example: 100 currency: type: string description: Currency identification (See code at "https://www.currency-iso.org/en/home/tables/table-a1.html"). example: BRL minLength: 3 maxLength: 3 order: $ref: '#/definitions/order' customer: $ref: '#/definitions/customer_credit' device: $ref: '#/definitions/device_credit' shippings: type: array items: $ref: '#/definitions/shipping_credit' sub_merchant: $ref: '#/definitions/sub_merchant' credit: $ref: '#/definitions/credit' wallet: $ref: '#/definitions/wallet' payment_debit: type: object description: Data concerning the payment transaction. required: - seller_id - amount - debit - order - customer properties: seller_id: type: string description: E-commerce identification code. minLength: 36 maxLength: 36 format: uuidv4 example: 6eb2412c-165a-41cd-b1d9-76c575d70a28 amount: type: integer description: Value of the purchase in cents. example: 100 currency: type: string description: Currency identification (See code at "https://www.currency-iso.org/en/home/tables/table-a1.html"). example: BRL minLength: 3 maxLength: 3 order: $ref: '#/definitions/order' customer: $ref: '#/definitions/customer_debit' device: $ref: '#/definitions/device_debit' shippings: type: array items: $ref: '#/definitions/shipping_debit' sub_merchant: $ref: '#/definitions/sub_merchant' debit: $ref: '#/definitions/debit' wallet: $ref: '#/definitions/wallet' payment_boleto: type: object description: Bank payment slip transaction dataset. required: - seller_id - amount - order - boleto - customer properties: seller_id: type: string description: E-commerce identification code. minLength: 36 maxLength: 36 format: uuidv4 example: 6eb2412c-165a-41cd-b1d9-76c575d70a28 amount: type: integer description: Value of the purchase in cents. example: 100 currency: type: string description: Currency identification (See code at "https://www.currency-iso.org/en/home/tables/table-a1.html"). minLength: 3 maxLength: 3 example: BRL order: $ref: '#/definitions/order' boleto: $ref: '#/definitions/boleto' customer: $ref: '#/definitions/customer_boleto' payment_boleto_v2: type: object description: Set of data referring to boleto transaction. required: - seller_id - amount - order - boleto - customer - idempotency_key - request_id properties: idempotency_key: type: string description: Idempotence key, used to control requests, must be unique per request, because if it is repeated, the same data will always be returned. minLength: 1 maxLength: 64 example: 1eb2412c-165a-41cd-b1d9-76c575d70a21 request_id: type: string description: Request identification ID. minLength: 36 maxLength: 36 format: uuidv4 example: 6eb2412c-165a-41cd-b1d9-76c575d70a28 data: type: object description: Payment details. properties: amount: type: integer description: Purchase amount in cents. example: 100 currency: type: string description: Currency identification (See code at "https://www.currency-iso.org/en/home/tables/table-a1.html"). minLength: 3 maxLength: 3 example: BRL payment: $ref: '#/definitions/payment' order: $ref: '#/definitions/order' boleto: $ref: '#/definitions/boleto' customer: $ref: '#/definitions/customer_boleto' additional_data: type: object description: Additional payment details. properties: split: $ref: '#/definitions/split_data' split_data: type: object description: Data for payment split execution. properties: subseller_list_payment: type: array description: List of Stores and their due amounts for payment. items: properties: subseller_id: type: string description: Subseller ID registered on the marketplace platform (MGM). minLength: 0 maxLength: 25 document_type: type: string description: Sub-commerce document type. enum: - CPF - CNPJ example: CNPJ minLength: 3 maxLength: 4 document_number: type: string description: Subtrade document number without punctuation. (without mask). minLength: 11 maxLength: 15 example: '12345678912' subseller_sale_amount: type: integer description: Part of the Store Value in relation to the Order (in cents). example: 10520 items: type: array description: List of Sub-Trade Items. required: - id - description - amount properties: id: type: string description: Item/Product Identifier. minLength: 1 maxLength: 25 example: 6bbaee93-d6d8-4d93-a0e8-d1558ccdf08b description: type: string description: Item/Product Description. amount: type: integer description: Item/Product Value (in cents). example: 1099 transaction_rate_percent: type: number description: 'Fee to be charged on the item in percentage if you do not send the fee will be set the same as the registration.
If tax_percent is informed, the tax_amount must not be sent.
Note: If tax_percent and tax_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 fee.
If tax_amount is informed, the tax_percent must not be sent.
Note: If tax_percent and tax_amount are sent for the same item, the values will be added together.' example: 235 order: type: object description: Set of data for purchase identification required: - order_id properties: order_id: type: string description: Order identification code used by the e-commerce maxLength: 36 example: 6d2e4380-d8a3-4ccb-9138-c289182818a3 sales_tax: type: number description: Tax amount example: 0 product_type: type: string description: Identifies the type of product sold among the options enum: - cash_carry - digital_content - digital_goods - digital_physical - gift_card - physical_goods - renew_subs - shareware - service example: service payment: type: object description: Payment method. properties: payment_method: type: string description: Payment method. example: BOLETO enum: - BOLETO address: type: object description: Set of data relating to the buyer's address properties: street: type: string description: Street. maxLength: 60 example: Av. Brasil number: type: string description: Street number. maxLength: 10 example: '1000' complement: type: string description: Street complement. maxLength: 60 example: Sala 1 district: type: string description: District. maxLength: 40 example: São Geraldo city: type: string description: City. maxLength: 40 example: Porto Alegre state: type: string description: State. maxLength: 20 example: RS country: type: string description: Country. maxLength: 20 example: Brasil postal_code: type: string description: Postal Code, CEP in Brazil or ZIP in the United States - (without mask) maxLength: 8 example: '90230060' address_credit: type: object description: Set of data relating to the buyer's address properties: street: type: string description: Street.
Required for the Anti-fraud maxLength: 60 example: Av. Brasil number: type: string description: Street number.
Required for the Anti-fraud maxLength: 10 example: '1000' complement: type: string description: Street complement.
Required for the Anti-fraud maxLength: 60 example: Sala 1 district: type: string description: District. maxLength: 40 example: São Geraldo city: type: string description: City.
Required for the Anti-fraud maxLength: 40 example: Porto Alegre state: type: string description: State.
Required for the Anti-fraud maxLength: 20 example: RS country: type: string description: Country.
Required for the Anti-fraud maxLength: 20 example: Brasil postal_code: type: string description: Postal Code, CEP in Brazil or ZIP in the United States - (without mask)
Required for the Anti-fraud maxLength: 8 example: '90230060' address_debit: type: object description: Set of data relating to the buyer's address properties: street: type: string description: Street.
Required for the Anti-fraud maxLength: 60 example: Av. Brasil number: type: string description: Street number.
Required for the Anti-fraud maxLength: 10 example: '1000' complement: type: string description: Street complement.
Required for the Anti-fraud maxLength: 60 example: Sala 1 district: type: string description: District. maxLength: 40 example: São Geraldo city: type: string description: City.
Required for the Anti-fraud maxLength: 40 example: Porto Alegre state: type: string description: State.
Required for the Anti-fraud maxLength: 20 example: RS country: type: string description: Country.
Required for the Anti-fraud maxLength: 20 example: Brasil postal_code: type: string description: Postal Code, CEP in Brazil or ZIP in the United States - (without mask)
Required for the Anti-fraud maxLength: 8 example: '90230060' address_boleto: type: object description: Dataset referring to the buyer’s address required: - street - number - district - city - state - postal_code properties: street: type: string description: Address. maxLength: 20 example: Av. Brasil number: type: string description: Address number. maxLength: 6 example: '1000' complement: type: string description: Additional address information. maxLength: 12 example: Sala 1 district: type: string description: Neighborhood. maxLength: 30 example: São Geraldo city: type: string description: City. maxLength: 20 example: Porto Alegre state: type: string description: State. maxLength: 2 example: RS postal_code: type: string description: Postal Code, CEP in Brazil, ZIP in the United States. (no mask) minLength: 8 maxLength: 8 example: '90230060' customer_credit: type: object description: Set of data relating to the buyer. required: - customer_id - billing_address properties: customer_id: type: string description: Customer identification. example: customer_21081826 maxLength: 100 first_name: type: string description: Customer first name.
Required for the Anti-fraud field maxLength: 40 example: João last_name: type: string description: Customer last name.
Required for the Anti-fraud field maxLength: 80 example: da Silva name: type: string description: Customer full name. Mandatory for bank slip. maxLength: 100 example: João da Silva email: type: string description: Customer e-mail address.
Required for the Anti-fraud field format: email example: customer@email.com.br document_type: type: string description: Type of customer identification document. Mandatory for bank slip.
Required for the Anti-fraud field maxLength: 26 example: CPF document_number: type: string description: Customer document number with no special characters. (without mask)
Required for the Anti-fraud field minLength: 11 maxLength: 15 example: '12345678912' phone_number: type: string description: Customer phone number. (without mask)
Required for the Anti-fraud field maxLength: 15 example: '5551999887766' billing_address: $ref: '#/definitions/address_credit' customer_debit: type: object description: Set of data relating to the buyer. required: - customer_id - billing_address properties: customer_id: type: string description: Customer identification. example: customer_21081826 maxLength: 100 first_name: type: string description: Customer first name.
Required for the Anti-fraud maxLength: 40 example: João last_name: type: string description: Customer last name.
Required for the Anti-fraud maxLength: 80 example: da Silva name: type: string description: Customer full name. Mandatory for bank slip. maxLength: 100 example: João da Silva email: type: string description: Customer e-mail address.
Required for the Anti-fraud format: email example: customer@email.com.br document_type: type: string description: Type of customer identification document. Mandatory for bank slip.
Required for the Anti-fraud maxLength: 26 example: CPF document_number: type: string description: Customer document number with no special characters. (without mask)
Required for the Anti-fraud minLength: 11 maxLength: 15 example: '12345678912' phone_number: type: string description: Customer phone number. (without mask)
Required for the Anti-fraud maxLength: 15 example: '5551999887766' billing_address: $ref: '#/definitions/address_debit' customer_boleto: type: object description: Set of data relating to the buyer. required: - name - document_type - document_number - billing_address properties: first_name: type: string description: Buyer's first name. maxLength: 40 example: João name: type: string description: Buyer’s full name. maxLength: 40 example: João da Silva document_type: type: string description: Type of identification document of the buyer enum: - CPF - CNPJ example: CPF document_number: type: string description: Buyer's document number without punctuation. (no mask) minLength: 11 maxLength: 15 example: '12345678912' billing_address: $ref: '#/definitions/address_boleto' device: type: object description: Set of data relating to the device used by the buyer. properties: ip_address: type: string description: IP address (IPv4) of the buyer's device. This attribute must be captured by your application from the buyer's device (mobile; browser; etc.) and sent in the payload in order to enrich our preventive analysis. format: IPv4 example: 127.0.0.1 device_id: type: string description: Identification Hash (Device Fingerprint) of the device. More information on Anti-Fraud. example: hash-device-id device_credit: type: object description: Set of data relating to the device used by the buyer. properties: ip_address: type: string description: IP address (IPv4) of the buyer's device. This attribute must be captured by your application from the buyer's device (mobile; browser; etc.) and sent in the payload in order to enrich our preventive analysis.
Required for the Anti-fraud field format: IPv4 example: 127.0.0.1 device_id: type: string description: Identification Hash (Device Fingerprint) of the device. More information on Anti-Fraud.
Required for the Anti-fraud field example: hash-device-id device_debit: type: object description: Set of data relating to the device used by the buyer. properties: ip_address: type: string description: IP address (IPv4) of the buyer's device. This attribute must be captured by your application from the buyer's device (mobile; browser; etc.) and sent in the payload in order to enrich our preventive analysis.
Required for the Anti-fraud field format: IPv4 example: 127.0.0.1 device_id: type: string description: Identification Hash (Device Fingerprint) of the device. More information on Anti-Fraud.
Required for the Anti-fraud field example: hash-device-id shipping_credit: type: object description: Set of data relating to the delivery address. properties: first_name: type: string description: Customer first name. maxLength: 40 example: João name: type: string description: Customer full name. maxLength: 100 example: João da Silva email: type: string description: Customer e-mail address. format: email example: customer@email.com.br phone_number: type: string description: Customer phone number. (without mask)
Required for the Anti-fraud maxLength: 15 example: '5551999887766' shipping_amount: type: number description: Shipping amount in cents. example: 3000 address: $ref: '#/definitions/address_credit' shipping_debit: type: object description: Set of data relating to the delivery address. properties: first_name: type: string description: Customer first name. maxLength: 40 example: João name: type: string description: Customer full name. maxLength: 100 example: João da Silva email: type: string description: Customer e-mail address. format: email example: customer@email.com.br phone_number: type: string description: Customer phone number. (without mask)
Required for the Anti-fraud maxLength: 15 example: '5551999887766' shipping_amount: type: number description: Shipping amount in cents. example: 3000 address: $ref: '#/definitions/address_debit' sub_merchant: type: object description: In order for Getnet to comply with the rules of the Brands and Arrangements, the Federal Laws and determinations of BACEN (Central Bank of Brazil) for the identification of the final entities (subtrades) that make the financial transactions, the Payment Facilities must send the identification data of their customers to 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: Subtrade ID. example: '9058344' maxLength: 15 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 description: Subtrade document type. enum: - CPF - CNPJ example: CNPJ minLength: 3 maxLength: 4 document_number: type: string description: Subtrade CNPJ or CPF. example: '20551625000159' minLength: 11 maxLength: 14 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: Subtrade Street. (Comma not allowed) example: Torre Negra 44 maxLength: 40 city: type: string description: Subtrade City. example: Cidade maxLength: 13 state: type: string description: Subtrade State. example: RS minLength: 2 maxLength: 2 postal_code: type: string description: Subtrade Zip Code. example: '90520000' minLength: 8 maxLength: 8 credit: type: object description: Set of data relating to the credit transaction. required: - delayed - save_card_data - transaction_type - number_installments - card properties: delayed: type: boolean description: Indicates if credit payment will be done with delayed confirmation. example: false pre_authorization: type: boolean description: Indicative if the transaction is a pre credit authorization. example: false save_card_data: type: boolean description: Indicates if the card must be saved for use in future orders. example: false transaction_type: type: string description: | Type of transaction. Full payment in one installment, payment in installments with no interest, payment in installments with interest. enum: - FULL - INSTALL_NO_INTEREST - INSTALL_WITH_INTEREST example: FULL gateway_id: type: string description: | Merchant Payment Gateway ID. example: '00000999998' number_installments: type: number description: Number of installments for one credit transaction installment. example: 1 soft_descriptor: $ref: '#/definitions/soft_descriptor_global_sub_merchant' dynamic_mcc: $ref: '#/definitions/dynamic_mcc_sub_merchant' card: $ref: '#/definitions/card_credit' tokenization: $ref: '#/definitions/tokenization' 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.

enum: - ONE_CLICK - ONE_CLICK_PAYMENT - RECURRING - RECURRING_PAYMENT example: ONE_CLICK_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' tokenization: title: Tokenization type: object description: Type of cryptogram used by the TSP (Token Service Provider). The values can be - TAVV For Visa and ELO cards; - UCAF For Mastercard cards. properties: type: type: string description: Type of tokenization example: TAVV enum: - UCAF - TAVV cryptogram: type: string description: Cryptogram value generated by the TSP (Token Service Provider) occurred example: AM1BmNLpj5+nADA4gol2AAABBB== eci: type: string description: ECI Indicator (Electronic Commerce Indicator) example: '05' requestor_id: type: string description: Token Requestor identifier code example: '1234567' 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 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)
enum: - '000' - '101' - '102' - '103' - '216' - '217' - '327' example: '000' maxLength: 5 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: 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: 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 filled in with 03. completion for Mastercard, Visa and ELO brands for Cash-in SDWO transactions, for other brands or padding 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 recipient of the transfer. Ex 12345678900000. Filling required for Mastercard, Visa and ELO brands for Cash-in SDWO transactions, for other brands or padding 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: '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 filled in with 03. completion for Mastercard, Visa and ELO brands for Cash-in SDWO transactions, for other brands or padding 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 sender of the transfer. Ex 12345678900000. Filling required for Mastercard, Visa and ELO brands for Cash-in SDWO transactions, for other brands or padding is optional.' example: '12345678900000' maxLength: 25 debit: type: object description: Set of data relating to the debit transaction. properties: cardholder_mobile: type: string description: Cardholder’s phone number. Mandatory for Visa. example: '5551999887766' soft_descriptor: $ref: '#/definitions/soft_descriptor_global_sub_merchant' dynamic_mcc: $ref: '#/definitions/dynamic_mcc_sub_merchant' card: $ref: '#/definitions/card_debit' tokenization: $ref: '#/definitions/tokenization' 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.

enum: - ONE_CLICK - ONE_CLICK_PAYMENT - RECURRING - RECURRING_PAYMENT example: ONE_CLICK_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' gateway_id: type: string description: ID do Merchant Payment Gateway (MPG). minLength: 11 maxLength: 11 example: '00000999998' vault_card: type: object description: Card dataset. required: - number_token - expiration_month - expiration_year - customer_id properties: number_token: type: string description: Tokenized card number. Generated through endpoint/v1/tokens/card. example: dfe05208b105578c070f806c80abd3af09e246827d29b866cf4ce16c205849977c9496cbf0d0234f42339937f327747075f68763537b90b31389e01231d4d13c minLength: 128 maxLength: 128 brand: type: string description: Card Brand. Automatically populated by API if not informed. maxLength: 50 enum: - Mastercard - Visa - Amex - Elo - Hipercard example: Mastercard cardholder_name: type: string description: Name of the buyer printed on the card. maxLength: 26 example: JOAO DA SILVA expiration_month: type: string description: Card expiration month with two digits. minLength: 2 maxLength: 2 example: '12' expiration_year: type: string description: Card expiration year with two digits. minLength: 2 maxLength: 2 example: '20' customer_id: type: string description: | Buyer's Identifier: Information defined by the application that consumes the Digital Platform API. In this field, it is only allowed alphanumeric data. The following special characters must never be used: % $ , . / & ( ) + = < > - * example: customer_21081826 maxLength: 100 cardholder_identification: type: string description: Identification of the buyer, such as CPF or RG. (without mask) example: '12345678912' verify_card: type: boolean description: Performs a transaction that checks if the card entered is not canceled, blocked or restricted. default: false example: false security_code: type: string description: Security code. CVV or CVC. minLength: 3 maxLength: 4 example: '123' vault_card_response: type: object description: Saved card data set. properties: card_id: type: string description: Card identifier saved in the vault. format: uuidv4 example: e8ad2ae4-9e3e-4532-998f-1a5a11e56e58 minLength: 36 maxLength: 36 last_four_digits: type: string description: Last four digits of the card. example: '1212' minLength: 4 maxLength: 4 first_six_digits: type: string description: First six digits of the card. example: '121212' minLength: 6 maxLength: 6 expiration_month: type: string description: Two-digit card expiration month. example: '12' minLength: 2 maxLength: 2 expiration_year: type: string description: Two-digit card expiration year. example: '20' minLength: 2 maxLength: 2 brand: type: string description: Brand. (Also used in anti-fraud) example: Mastercard enum: - Mastercard - Visa - Amex - Elo - Hipercard maxLength: 50 cardholder_name: type: string description: Name of the Buyer print in the Card. example: JOAO DA SILVA maxLength: 26 customer_id: type: string description: 'Buyer''s Identifier: It can be any information that identifies your consumer, such as identification, email or even an internal id of your system.' example: customer_21081826 maxLength: 100 number_token: type: string description: Tokenized card number. Generated via endpoint /v1/tokens/card. example: dfe05208b105578c070f806c80abd3af09e246827d29b866cf4ce16c205849977c9496cbf0d0234f42339937f327747075f68763537b90b31389e01231d4d13c minLength: 128 maxLength: 128 used_at: type: string description: Date of last use. example: '2017-04-19T16:30:30Z' format: YYYY-MM-DDTHH:MM:SSZ minLength: 24 maxLength: 24 created_at: type: string description: Date of creation. example: '2017-04-19T16:30:30Z' format: YYYY-MM-DDTHH:MM:SSZ minLength: 24 maxLength: 24 updated_at: type: string description: Date of update. example: '2017-04-19T16:30:30Z' format: YYYY-MM-DDTHH:MM:SSZ minLength: 24 maxLength: 24 status: type: string description: Card status in the vault. enum: - active - blocked - canceled - renewed example: active maxLength: 20 transaction_id: type: string description: A Transaction ID of the card. example: '1002217281190421' verification_card_body: type: object description: Card to be checked dataset. required: - number_token - expiration_month - expiration_year properties: number_token: type: string description: Tokenized card number. Generated through endpoint/v1/tokens/card. example: dfe05208b105578c070f806c80abd3af09e246827d29b866cf4ce16c205849977c9496cbf0d0234f42339937f327747075f68763537b90b31389e01231d4d13c minLength: 128 maxLength: 128 brand: type: string description: Card Brand. Automatically populated by API if not informed. maxLength: 50 example: Mastercard enum: - Mastercard - Visa - Amex - Elo - Hipercard cardholder_name: type: string description: Name of the buyer printed on the card. maxLength: 26 example: JOAO DA SILVA expiration_month: type: string description: Card expiration month with two digits. minLength: 2 maxLength: 2 example: '12' expiration_year: type: string description: Card expiration year with two digits. minLength: 2 maxLength: 2 example: '20' security_code: type: string description: Security code. CVV or CVC. minLength: 3 maxLength: 4 example: '123' gateway_id: type: string description: | Merchant Payment Gateway ID. example: '00000999998' card_credit: type: object description: Dataset for the card. required: - number_token - expiration_month - expiration_year properties: number_token: type: string description: Tokenized card number. This field can receive two types of content 1 - This field can receive a token generated by the [Getnet Tokenization] service (https://developers.getnet.com.br/api#tag/Tokenizacao%2Fpaths%2F~1v1~1tokens~1card%2Fpost) 2 - This field can also receive a card token generated through a TSP (Token Service Provider). example: dfe05208b105578c070f806c80abd3af09e246827d29b866cf4ce16c205849977c9496cbf0d0234f42339937f327747075f68763537b90b31389e01231d4d13c minLength: 128 maxLength: 128 cardholder_name: type: string description: Cardholder name as it appears on the card.
Required for the and if the number_token is generated through a TSP (Token Service Provider) Anti-fraud field maxLength: 26 example: JOAO DA SILVA security_code: type: string description: Security Code. CVV or CVC.
Required for the Anti-fraud field minLength: 3 maxLength: 4 example: '123' brand: type: string description: Card brand. Automatically populated by the API if not entered.
Required for the Anti-fraud field maxLength: 50 example: Mastercard enum: - Mastercard - Visa - Amex - Elo - Hipercard expiration_month: type: string description: Card expiration month with two digits. minLength: 2 maxLength: 2 example: '12' expiration_year: type: string description: Card expiration year with two digits. minLength: 2 maxLength: 2 example: '20' card_debit: type: object description: Dataset for the card. required: - number_token - expiration_month - expiration_year - security_code properties: number_token: type: string description: Tokenized card number. example: dfe05208b105578c070f806c80abd3af09e246827d29b866cf4ce16c205849977c9496cbf0d0234f42339937f327747075f68763537b90b31389e01231d4d13c minLength: 128 maxLength: 128 cardholder_name: type: string description: Cardholder name as it appears on the card.
Required for the Anti-fraud maxLength: 26 example: JOAO DA SILVA security_code: type: string description: Security Code. CVV or CVC.
Required for the Anti-fraud minLength: 3 maxLength: 4 example: '123' brand: type: string description: Card Brand. Automatically populated by API if not informed.
Required for the Anti-fraud maxLength: 50 example: Mastercard enum: - Mastercard - Visa - Amex - Elo - Hipercard expiration_month: type: string description: Card expiration month with two digits. minLength: 2 maxLength: 2 example: '12' expiration_year: type: string description: Card expiration year with two digits. minLength: 2 maxLength: 2 example: '20' subscription_card: type: object description: Card dataset. properties: number_token: type: string description: Tokenized card number. example: dfe05208b105578c070f806c80abd3af09e246827d29b866cf4ce16c205849977c9496cbf0d0234f42339937f327747075f68763537b90b31389e01231d4d13c minLength: 128 maxLength: 128 cardholder_name: type: string description: Name of the Buyer print in the Card. Required if card data was 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: Brand. (Also used in anti-fraud). Required if card data was not permanently stored with the token. maxLength: 50 example: Mastercard enum: - Mastercard - Visa - Amex - Elo - Hipercard expiration_month: type: string description: Brand. (Also used in anti-fraud). Required if card data was not permanently stored with the token. minLength: 2 maxLength: 2 example: '12' expiration_year: type: string description: Two-digit card expiration year. Required if card data was not permanently stored with the token. minLength: 2 maxLength: 2 example: '20' bin: type: string description: First six card numbers. minLength: 6 maxLength: 9 example: '123412' payment_credit_response: type: object description: Credit payment response dataset. properties: payment_id: type: string description: Payment identification code. format: uuidv4 example: 06f256c8-1bbf-42bf-93b4-ce2041bfb87e minLength: 36 maxLength: 36 seller_id: type: string description: E-commerce identification code. format: uuidv4 example: 6eb2412c-165a-41cd-b1d9-76c575d70a28 minLength: 36 maxLength: 36 amount: type: integer description: Order amount in cents. example: 100 currency: type: string description: Currency identification (Check code at "https://www.currency-iso.org/en/home/tables/table-a1.html"). example: BRL minLength: 3 maxLength: 3 order_id: type: string description: Order identification code used by the e-commerce example: 6d2e4380-d8a3-4ccb-9138-c289182818a3 maxLength: 36 status: type: string description: Transaction status. For more information on the response status, see Notifications 1.0 or Notifications 1.1. example: APPROVED enum: - CANCELED - APPROVED - DENIED - AUTHORIZED - CONFIRMED maxLength: 20 received_at: type: string description: Date and time the order was received. format: YYYY-MM-DDTHH:mm:ss.SSSZ example: '2017-03-19T16:30:30.764Z' maxLength: 24 credit: $ref: '#/definitions/payment_credit_detail' payment_credit_pre_response: type: object description: Credit payment response dataset. properties: payment_id: type: string description: Payment identification code. format: uuidv4 example: 06f256c8-1bbf-42bf-93b4-ce2041bfb87e minLength: 36 maxLength: 36 seller_id: type: string description: E-commerce identification code. format: uuidv4 example: 6eb2412c-165a-41cd-b1d9-76c575d70a28 minLength: 36 maxLength: 36 amount: type: integer description: Amount of the purchase in cents. example: 100 currency: type: string description: Currency identification (See code at "https://www.currency-iso.org/en/home/tables/table-a1.html"). example: BRL minLength: 3 maxLength: 3 order_id: type: string description: Purchase identification used by the e-commerce example: 6d2e4380-d8a3-4ccb-9138-c289182818a3 maxLength: 36 status: type: string description: Transaction status. For more information on the response status, see Notifications 1.0 or Notifications 1.1. example: AUTHORIZED enum: - PENDING - CANCELED - APPROVED - DENIED - AUTHORIZED - CONFIRMED - EXPIRED - UNPROCESSED maxLength: 20 received_at: type: string description: Payment registration date and time. format: YYYY-MM-DDTHH:mm:ss.SSSZ example: '2017-03-19T16:30:30.764Z' maxLength: 24 credit: $ref: '#/definitions/payment_credit_detail' payment_credit_detail: type: object description: Dataset referring to the transaction. properties: delayed: type: boolean description: Indicates if the credit payment will be done with delayed confirmation. example: false authorization_code: type: string description: Internal transaction code. example: '000000099999' maxLength: 20 authorized_at: type: number description: Date/time of the credit authorization. format: YYYY-MM-DDTHH:MM:SSZ example: '2017-03-19T16:30:30Z' maxLength: 24 reason_code: type: string description: Return code. example: '00' minLength: 1 maxLength: 5 reason_message: type: string description: Return message. example: transaction approved maxLength: 250 acquirer: type: string description: Name of the acquirer. example: GETNET maxLength: 30 soft_descriptor: type: string description: Description for the card statement. example: Descrição para fatura maxLength: 22 brand: type: string description: Card network responsible for processing the transaction. example: Mastercard maxLength: 50 enum: - Mastercard - Visa - Amex - Elo - Hipercard terminal_nsu: type: string description: Authorization Code generated by the Issuer when the transaction is successfully executed. example: '0099999' acquirer_transaction_id: type: string description: Acquirer transaction code. example: '10000024' maxLength: 20 transaction_id: type: string description: Transaction code. example: '1002217281190421' first_installment_amount: type: string description: First installment amount. example: '123' other_installment_amount: type: string description: Other installment amount. example: '123' total_installment_amount: type: string description: Total installment amount. example: '123' credit_delayed_confirm: type: object description: Dataset for the confirmation response of credit payments with delayed confirmation. properties: payment_id: type: string description: Payment identification code. minLength: 36 maxLength: 36 format: uuidv4 example: 331b0b07-6e37-4bd9-a37b-99156cb34104 seller_id: type: string description: E-commerce identification code. minLength: 36 maxLength: 36 format: uuidv4 example: 8f840ea0-b7d1-42f5-ad78-5a5521e3125f amount: type: integer description: Order amount in cents. example: 200000 currency: type: string description: Currency identification(Check code at "https://www.currency-iso.org/en/home/tables/table-a1.html"). minLength: 3 maxLength: 3 example: BRL order_id: type: string description: Order identification code used by the e-commerce example: order-3 maxLength: 36 status: type: string description: Transaction status. For more information on the response status, see Notifications 1.0 or Notifications 1.1. example: CONFIRMED enum: - CONFIRMED - ERROR - DENIED maxLength: 20 credit_confirm: $ref: '#/definitions/payment_credit_confirm_details' payment_credit_confirm_details: type: object description: Additional dataset for confirmation services. properties: confirm_date: type: string description: Date/time the transaction was received. format: YYYY-MM-DDTHH:mm:ss.SSSZ example: '2018-07-18T20:00:53.764Z' maxLength: 24 message: type: string description: Receipt notice and finalization pending confirmation. maxLength: 250 example: Postponed 331b0b07-6e37-4bd9-a37b-99156cb34104 confirmed credit_delayed_cancel: type: object description: Dataset for the cancellation response of credit payment or credit payment with delayed confirmation transactions. properties: payment_id: type: string description: Payment identification code. minLength: 36 maxLength: 36 format: uuidv4 example: f3b54da1-0753-4dcf-ac92-48721d2ff553 seller_id: type: string description: E-commerce identification code. minLength: 36 maxLength: 36 format: uuidv4 example: 8f840ea0-b7d1-42f5-ad78-5a5521e3125f amount: type: integer description: Order amount in cents. example: 500000 currency: type: string description: Currency identification (Check code at "https://www.currency-iso.org/en/home/tables/table-a1.html"). minLength: 3 maxLength: 3 example: BRL order_id: type: string description: Order identification code used by the e-commerce example: pre-auth-order-204 maxLength: 36 status: type: string description: Transaction status. For more information on the response status, see Notifications 1.0 or Notifications 1.1. example: CANCELED enum: - CANCELED - ERROR - DENIED maxLength: 20 credit_cancel: $ref: '#/definitions/payment_credit_cancel_details' payment_credit_cancel_details: type: object description: Additional set of cancellation service information. properties: canceled_at: type: string description: Date/time the transaction was received. format: YYYY-MM-DDTHH:mm:ss.SSSZ example: '2018-07-22T18:47:32.270Z' maxLength: 24 message: type: string description: Receipt notice and finalization pending confirmation. example: Credit transaction cancelled successfully maxLength: 250 debit_cancel: type: object description: Dataset for the cancellation response of debit payment or debit payment with delayed confirmation transactions. properties: payment_id: type: string description: Payment identification code. minLength: 36 maxLength: 36 format: uuidv4 example: f3b54da1-0753-4dcf-ac92-48721d2ff553 seller_id: type: string description: E-commerce identification code. minLength: 36 maxLength: 36 format: uuidv4 example: 8f840ea0-b7d1-42f5-ad78-5a5521e3125f amount: type: integer description: Order amount in cents. example: 500000 currency: type: string description: Currency identification (Check code at "https://www.currency-iso.org/en/home/tables/table-a1.html"). minLength: 3 maxLength: 3 example: BRL order_id: type: string description: Order identification code used by the e-commerce example: pre-auth-order-204 maxLength: 36 status: type: string description: Transaction status. For more information on the response status, see Notifications 1.0 or Notifications 1.1. example: CANCELED enum: - CANCELED - ERROR - DENIED maxLength: 20 debit_cancel: $ref: '#/definitions/payment_debit_cancel_details' payment_debit_cancel_details: type: object description: Additional set of cancellation service information. properties: canceled_at: type: string description: Date/time the transaction was received. format: YYYY-MM-DDTHH:mm:ss.SSSZ example: '2018-07-22T18:47:32.270Z' maxLength: 24 message: type: string description: Receipt notice and finalization pending confirmation. example: Debit transaction cancelled successfully maxLength: 250 payment_debit_response: type: object description: Debit payment response dataset. properties: payment_id: type: string description: Payment identification code. format: uuidv4 example: 06f256c8-1bbf-42bf-93b4-ce2041bfb87e minLength: 36 maxLength: 36 seller_id: type: string description: E-commerce identification code. format: uuidv4 example: 6eb2412c-165a-41cd-b1d9-76c575d70a28 minLength: 36 maxLength: 36 amount: type: integer description: Order amount in cents. example: 100 currency: type: string description: Currency identification (Check code at "https://www.currency-iso.org/en/home/tables/table-a1.html"). example: BRL minLength: 3 maxLength: 3 order_id: type: string description: Order identification code used by the e-commerce example: 6d2e4380-d8a3-4ccb-9138-c289182818a3 maxLength: 36 status: type: string description: Transaction status. For more information on the response status, see Notifications 1.0 or Notifications 1.1. example: APPROVED enum: - CANCELED - APPROVED - DENIED - AUTHORIZED - CONFIRMED maxLength: 20 received_at: type: string description: Date and time the order was received. format: YYYY-MM-DDTHH:mm:ss.SSSZ example: '2017-03-19T16:30:30.764Z' maxLength: 24 debit: $ref: '#/definitions/payment_debit_detail' payment_debit_detail: type: object description: Dataset referring to the transaction. properties: authorization_code: type: string description: Internal transaction code. example: '000000099999' maxLength: 20 authorized_at: type: number description: Date/time of the debit authorization. format: YYYY-MM-DDTHH:MM:SSZ example: '2017-03-19T16:30:30Z' maxLength: 24 reason_code: type: string description: Return code. example: '00' minLength: 1 maxLength: 5 reason_message: type: string description: Return message. example: transaction approved maxLength: 250 acquirer: type: string description: Name of the acquirer. example: GETNET maxLength: 30 soft_descriptor: type: string description: Description for the card statement. example: Descrição para fatura maxLength: 22 brand: type: string description: Card network responsible for processing the transaction. example: Maestro maxLength: 50 enum: - Maestro - Visa-electron - Elo-debit terminal_nsu: type: string description: Authorization Code generated by the Issuer when the transaction is successfully executed. example: '0099999' acquirer_transaction_id: type: string description: Acquirer transaction code. example: '10000024' maxLength: 20 transaction_id: type: string description: Transaction code. example: '1002217281190421' boleto: type: object properties: our_number: type: string description: Named “our number” by banks. It is the bank slip’s unique identification for the collection system. Its rules vary according to the bank and the collection service. For example, for Santander there are two ways for numbering it. 1) If the client is the one who numbers, they should inform the CD (Check Digit); 2) If the number is left blank, the Bank is responsible for generating a sequential number, without a CD. minLength: 12 maxLength: 12 example: '000001946598' document_number: type: string description: Your Number. Number controlled by the client, usually managed by the system generating the bank slip. minLength: 15 maxLength: 15 example: '170500000019763' expiration_date: type: string description: Bank slip due date. If not informed, the default number of days pre-registered for the due date will be considered. format: dd/mm/yyyy example: 16/11/2017 instructions: type: string description: 'Instructions to be printed on the bill. The line break can be performed in two ways. 1) Automatic word wrap: A word wrap will be done up to 100 characters without words being truncated; 2) Manual line break: line break using the escape character "\n". Example: "This is a line break test. \n The second line will now print. \n And finally, the third line.";' maxLength: 1000 example: Não receber após o vencimento provider: type: string description: Provider bank. enum: - santander maxLength: 40 default: santander example: santander payment_boleto_response: type: object description: Data set for the issuing response for a bank slip. properties: payment_id: type: string description: Payment identification code. example: 599ca35059028b001023b323 minLength: 24 maxLength: 24 seller_id: type: string description: E-commerce identification code. format: uuidv4 example: 6eb2412c-165a-41cd-b1d9-76c575d70a28 minLength: 36 maxLength: 36 amount: type: string description: Order amount in cents. example: '100' currency: type: string description: Currency identification (Check code at "https://www.currency-iso.org/en/home/tables/table-a1.html"). minLength: 3 maxLength: 3 example: BRL order_id: type: string description: Order identification code used by the e-commerce example: 6d2e4380-d8a3-4ccb-9138-c289182818a3 maxLength: 36 status: type: string description: Transaction status. For more information on the response status, see Notifications 1.0 or Notifications 1.1. example: PENDING enum: - PENDING maxLength: 20 boleto: $ref: '#/definitions/payment_boleto_detail' payment_boleto_response_v2: type: object description: Data set of the response of the ticket issuance. properties: payment_id: type: string description: Payment identification code. example: 599ca35059028b001023b323 minLength: 24 maxLength: 24 status: type: string description: Transaction status. For more information on return statuses, see Notifications 1.0 or Notifications 1.1 example: EM ABERTO enum: - EM ABERTO maxLength: 20 seller_id: description: E-commerce identification code. type: string format: uuidv4 minLength: 36 maxLength: 36 example: 6eb2412c-165a-41cd-b1d9-76c575d70a28 amount: type: string description: Purchase amount in cents. example: '100' currency: type: string description: Currency identification (See code at "https://www.currency-iso.org/en/home/tables/table-a1.html"). example: BRL minLength: 3 maxLength: 3 order_id: description: Purchase identification code used by e-commerce. type: string maxLength: 36 example: 6d2e4380-d8a3-4ccb-9138-c289182818a3 boleto: $ref: '#/definitions/payment_boleto_detail_pix' payment_boleto_detail: type: object description: Body with bill data. properties: boleto_id: type: string description: Bank slip identification. format: uuidv4 example: e587cefe-8832-4fc0-acff-acc83dd66e9e minLength: 36 maxLength: 36 bank: type: string description: EC bank number. example: '0033' minLength: 3 maxLength: 4 status_code: type: string description: Payment status code. example: '1' minLength: 1 maxLength: 1 status_label: type: string description: Payment status in text form. example: EM ABERTO maxLength: 20 typeful_line: type: string description: Bank slip line to be typed. example: 03399.58910 93000.000013 94659.801016 8 71670000030015 minLength: 54 maxLength: 54 bar_code: type: string description: Bank slip barcode. example: '03397999200000002309235515900000026629840101' minLength: 44 maxLength: 44 issue_date: type: string description: Date the bank slip was generated. example: 17/05/2017 minLength: 10 maxLength: 10 expiration_date: type: string description: Bank slip due date. example: 22/05/2017 minLength: 10 maxLength: 10 our_number: type: string description: EC’s “Our Number”. example: '0000001946598' minLength: 12 maxLength: 13 document_number: type: string description: Customer controlled document number. (no mask) example: '170500000019763' minLength: 15 maxLength: 15 _links: type: array items: type: object 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 payment_boleto_detail_pix: type: object description: Body with payment slip data. properties: boleto_id: type: string description: Bank slip identification. format: uuidv4 example: e587cefe-8832-4fc0-acff-acc83dd66e9e minLength: 36 maxLength: 36 bank: type: string description: EC bank number. example: '0033' minLength: 3 maxLength: 4 status_code: type: string description: Payment status code. example: '1' minLength: 1 maxLength: 1 status_label: type: string description: Payment status in text form. example: EM ABERTO maxLength: 20 typeful_line: type: string description: Bank slip line to be typed. example: 03399.58910 93000.000013 94659.801016 8 71670000030015 minLength: 54 maxLength: 54 bar_code: type: string description: Bank slip barcode. example: '03397999200000002309235515900000026629840101' minLength: 44 maxLength: 44 issue_date: type: string description: Date the bank slip was generated. example: 17/05/2017 minLength: 10 maxLength: 10 expiration_date: type: string description: Bank slip due date. example: 22/05/2017 minLength: 10 maxLength: 10 our_number: type: string description: EC’s “Our Number”. example: '0000001946598' minLength: 12 maxLength: 13 document_number: type: string description: Customer controlled document number. (no mask) example: '170500000019763' minLength: 15 maxLength: 15 _links: type: array items: type: object 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 pix: type: object description: Payment details via Pix. properties: cod_qrcode: type: string format: Base64 description: Base64 code for generating the QRCode image. 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 format: url description: QRCode preview URL. example: pix.santander.com.br/qr/v2/cobv/a796c937-80ee-483c-a8d5-72f95759fd99 customer_info: type: object description: Conjunto de dados do comprador. 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 ID. If not informed, the system will generate a 36-position uuidv4 format identifier. type: string example: customer_21081826 maxLength: 100 first_name: description: First name of buyer. type: string maxLength: 40 example: João last_name: description: Last name of buyer. type: string maxLength: 80 example: da Silva document_type: description: Buyer 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' celphone_number: description: Buyer's cell phone number. (without mask) type: string example: '5551999887766' maxLength: 15 email: description: Buyer email. type: string format: email example: customer@email.com.br observation: description: Notes. type: string example: O cliente tem interesse no plano x. address: $ref: '#/definitions/address' customer_info_response: description: Buyer's 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's Identifier. type: string example: customer_21081826 maxLength: 100 first_name: description: Buyer's first name. type: string example: João maxLength: 40 last_name: description: Buyer's last name. type: string example: da Silva maxLength: 80 document_type: description: Buyer document type. type: string enum: - CPF - CNPJ example: CPF document_number: description: Buyer's document number. (no 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. (no mask) type: string maxLength: 15 example: '5551999887766' celphone_number: description: Buyer's mobile phone number. (no mask) type: string example: '5551999887766' maxLength: 15 email: description: Buyer email. type: string format: email example: customer@email.com.br observation: description: Notes. type: string example: O cliente tem interesse no plano x. status: description: Buyer’s registration status. type: string example: success maxLength: 20 address: $ref: '#/definitions/address' customer_filter_response: type: object required: - page - limit - total properties: customers: description: Client 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 clients. type: number example: 1 customer_filter_info_response: type: object properties: customer_id: description: Customer's identifier. type: string example: customer_21081826 maxLength: 100 first_name: description: Customer's first name. type: string example: João maxLength: 40 last_name: description: Customer's last name. type: string example: da Silva maxLength: 80 document_type: description: Customer's document type. type: string enum: - CPF - CNPJ example: CPF document_number: description: Customer's document number. (no mask) type: string example: '12345678912' minLength: 11 maxLength: 15 phone_number: description: Customer's telephone number. (no mask) type: string example: '5551999887766' maxLength: 15 celphone_number: description: Customer's mobile phone number. (no mask) type: string example: '5551999887766' maxLength: 15 email: description: Customer’s email address. 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: Name of plan. type: string example: Plano flex description: description: Description of the plan. type: string example: Plano flex amount: description: Plan value. 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: Types of payments accepted. type: array enum: - - credit_card items: type: string example: - credit_card sales_tax: description: Taxes. type: integer default: 0 product_type: description: Identifier of the type of product sold from 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 parcels with zero value, an entrance fee or discounted parcels. The use of this functionality and its expected goal will depend on the activation of a specific product on Getnet. items: $ref: '#/definitions/plan_floating_data_with_details' period: type: object description: Period of the plan. 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: Plan duration based on the periodicity type. For example, for a 12-month plan where you will be charged monthly (type = monthly) the amount 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 periodicity type is specific (type = specific) the number of days the billing cycle will be performed should be assigned. For example, if the plan duration is 12 (billing_cycle = 12) and the specific cycle is 10 (specific_cycle_in_days = 10), then the billing will occur every 10 days for a total of 12 billings. type: number minimum: 1 maximum: 30 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: Name of the plan. type: string example: Plano flex description: description: Description of the plan. type: string example: Plano flex amount: description: Amount 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: Types of payments accepted. type: string enum: - credit_card items: type: string example: - credit_card sales_tax: description: Tax amounts. type: integer default: 0 product_type: description: Identifier of the type of product sold from the options. type: string enum: - cash_carry - digital_content - digital_goods - gift_card - physical_goods - renew_subs - shareware - service example: service create_date: description: Date of creation of the plan. 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 parcels with zero value, an entrance fee or discounted parcels. The use of this functionality and its expected goal will depend on the activation of a specific product on Getnet. items: $ref: '#/definitions/plan_floating_data_with_details' 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 of 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: Name of the plan. type: string example: Plano flex status: description: Status of the plan. type: string enum: - active - inactive example: active maxLength: 20 amount: description: Amount 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: Types of payments accepted. type: array enum: - - credit_card items: type: string example: - credit_card create_date: description: Date of creation of the plan. 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 parcels with zero value, an entrance fee or discounted parcels. The use of this functionality and its expected goal will depend on the activation of a specific product on Getnet. items: $ref: '#/definitions/plan_floating_data_with_details' plan_update: type: object required: - name - description properties: name: description: Name of plan. type: string example: Plano flex atualizado description: description: Description of the plan. type: string example: Plano flex atualizado 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 parcels with zero value, an entrance fee or discounted parcels. The use of this functionality and its expected goal will depend on the activation of 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: Número da parcela que a alteração será aplicada. minimum: 1 amount: type: integer example: 19990 description: New charge amount for specific plan installments. When a Subscription is created with this Plan, it will have this characteristic, for example for installment 2 to apply the amount of R$ 10.00. This amount can be zero, greater or less than the original value of the Plan.. minimum: 0 plan_migration_request: type: object required: - from - to properties: from: type: string format: uuid description: Identifier of the source Plan, that is, the original plan_id of the Subscription. to: type: string format: uuid description: Destination plan identifier, that is, the plan_id to which the Subscription is to be migrated. 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 ID. 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: Identification code of the purchase 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: Billing start date for the Subscription. Until that date the Subscription will be Scheduled, that is, with status created. The use of this field and its expected objective will depend on the activation of 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: Shipping address set. type: array items: $ref: '#/definitions/subscription_shippings' subscription_payment_type_credit: description: Information of the subscription payment type. 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: João last_name: description: Buyer's last name. type: string maxLength: 80 example: da Silva email: description: Buyer email. type: string format: email example: customer@email.com.br phone_number: description: Buyer’s Phone Number type: string maxLength: 15 example: '5551999887766' shipping_amount: description: Delivery amount. type: integer example: 3000 address: $ref: '#/definitions/address' subscription_credit: description: Credit transaction dataset. type: object required: - transaction_type - number_installments - card properties: transaction_type: description: Type of transaction. Full one off payment. type: string enum: - FULL example: FULL number_installments: description: Number of installments for one credit transaction installment. 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 used by the e-commerce. type: string example: 6d2e4380-d8a3-4ccb-9138-c289182818a3 maxLength: 36 create_date: description: Date of creation of recurrence subscription. type: string format: YYYY-MM-DDTHH:MM:SSZ example: '2017-04-19T16:30:30Z' maxLength: 24 end_date: description: Final date of recurrence subscription. type: string format: YYYY-MM-DDTHH:MM:SSZ example: '2018-04-19T16:30:30Z' maxLength: 24 payment_date: description: Date of payment of recurrence subscription. type: integer format: YYYY-MM-DDTHH:MM:SSZ example: '2017-04-19T16:30:30Z' maxLength: 24 next_scheduled_date: description: Next recurrence subscription schedule date. 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: Status of the recurrence subscription type: string enum: - processing - canceled - success - delayed - failed - expired example: success maxLength: 20 status_details: description: Recurrence subscription status details. type: string example: Assinatura Plano flex criada com sucesso maxLength: 500 payment: description: Subscription payment information type: object properties: error: $ref: '#/definitions/error_payment_subscription' installment_start_date: description: Billing start date for the Subscription. Until that date the Subscription will be Scheduled, that is, with status created. The use of this field and its expected objective will depend on the activation of a specific product on Getnet. type: string format: YYYY-MM-DD example: '2020-09-14' maxLength: 10 subscription_payment_type_shippings_response: description: Information on the signature. type: object properties: subscription_id: description: Identifier of the recurrence subscription 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: Shipping address set. type: array items: $ref: '#/definitions/subscription_shippings' subscription_payment_type_credit_response: description: Information of the subscription payment type. type: object properties: credit: $ref: '#/definitions/subscription_credit_response' subscription_credit_response: description: Credit transaction dataset. type: object properties: transaction_type: description: Type of transaction. Full one off payment. type: string enum: - FULL example: FULL number_installments: description: Number of installments for one credit transaction installment. type: integer example: 1 billing_address: $ref: '#/definitions/address' card: $ref: '#/definitions/subscription_card_response' subscription_card_response: type: object description: Card dataset. properties: cardholder_name: type: string description: Name of the Buyer print in the Card. Required if card data was not permanently stored with the token. example: JOAO DA SILVA maxLength: 26 brand: type: string description: Brand. (Also used in anti-fraud). Required if card data was not permanently stored with the token. example: Mastercard enum: - Mastercard - Visa - Amex - Elo - Hipercard maxLength: 50 expiration_month: type: string description: Two-digit card expiration month. Required if card data was not permanently stored with the token. example: '12' minLength: 2 maxLength: 2 expiration_year: type: string description: Two-digit card expiration year. Required if card data was not permanently stored with the token. example: '20' minLength: 2 maxLength: 2 bin: type: string description: First six card numbers. example: '123412' minLength: 6 maxLength: 9 subscription_customer_response: type: object description: Buyer's dataset. properties: customer_id: description: Buyer's Identifier. type: string example: customer_21081826 maxLength: 100 first_name: description: Buyer's first name. type: string example: João maxLength: 40 last_name: description: Buyer's last name. type: string example: da Silva maxLength: 80 document_type: description: Buyer document type. type: string enum: - CPF - CNPJ example: CPF document_number: description: Buyer's document number. (no 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. (no mask) type: string maxLength: 15 example: '5551999887766' celphone_number: description: Buyer's mobile phone number. (no mask) type: string example: '5551999887766' maxLength: 15 email: description: Buyer email. type: string format: email example: customer@email.com.br observation: description: Notes. type: string example: O cliente tem interesse no plano x. address: $ref: '#/definitions/address' subscription_plan_response: description: Information about the plan. type: object properties: plan_id: description: Plan identifier. type: string format: uuidv4v4 example: 51995e24-b1ae-4826-8e15-2a568a87abdd minLength: 36 maxLength: 36 name: description: Name of the plan. type: string example: Plano flex description: description: Description of the plan. type: string example: Plano flex amount: description: Amount 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: Types of payments accepted. type: string enum: - credit_card items: type: string example: - credit_card sales_tax: description: Tax amounts. type: integer default: 0 product_type: description: Identifier of the type of product sold from the options. type: string enum: - cash_carry - digital_content - digital_goods - gift_card - physical_goods - renew_subs - shareware - service example: service status: description: Status of the plan. type: string enum: - active - inactive example: active maxLength: 20 period: $ref: '#/definitions/period' subscription_filter_response: type: object properties: subscriptions: description: Set of recurrence subscription. 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 of 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: Recurrence subscription status details. type: string maxLength: 500 example: Cliente não tem mais interesse no serviço/produto subscription_projection_response: type: object required: - amount properties: amount: description: Total amount of the projection. type: number example: 199900 projection: description: Collection projections set. type: array items: properties: date: description: Date of billing projection. type: string format: YYYY-MM-DD example: '2017-05-19' minLength: 10 maxLength: 10 amount: description: Amount of billing projection. type: number example: 100000 installment: description: Number of installment. 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: Recurrence subscription status details. type: string maxLength: 500 example: Pagamento de assinatura confirmado charge_id: description: Billing ID. type: string minLength: 36 maxLength: 36 format: uuidv4v4 example: 52bc81b2-f079-4f7b-b63a-f653ff29d794 subscription_payment_date: type: object required: - day properties: day: description: New bill payment day. type: integer minimum: 1 maximum: 31 example: 25 subscription_update_payment_type: type: object description: Conjunto de dados do cartão. properties: number_token: type: string description: Tokenized card number. example: dfe05208b105578c070f806c80abd3af09e246827d29b866cf4ce16c205849977c9496cbf0d0234f42339937f327747075f68763537b90b31389e01231d4d13c minLength: 128 maxLength: 128 cardholder_name: type: string description: Name of the buyer printed on the card. Required if card data was not permanently stored with the token. maxLength: 26 example: JOAO DA SILVA brand: type: string description: Brand. (Also used in antifraud). Required if card data was not permanently stored with the token. example: Mastercard enum: - Mastercard - Visa - Amex - Elo - Hipercard maxLength: 50 expiration_month: type: string description: Card expiration month with two digits. Required if card data was not permanently stored with the token. minLength: 2 maxLength: 2 example: '12' expiration_year: type: string description: Card expiration year with two digits. Required if card data was not permanently stored with the token. minLength: 2 maxLength: 2 example: '20' bin: type: string description: Six first card numbers. minLength: 6 maxLength: 9 example: '123412' subscription_floating_data_response: type: object required: - subscription_id properties: subscription_id: type: string format: uuid description: Identifier of the recurrence subscription. 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 amount of charge. minimum: 0 new_scheduled_date: type: string format: YYYY-MM-DD description: New scheduled date of charge example: '2020-06-10' maxLength: 12 subscription_floating_data_remove_response: type: object required: - subscription_id properties: subscription_id: type: string format: uuid description: Identifier of the recurrence subscription. 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 amount of charge. minimum: 0 new_scheduled_date: type: string format: YYYY-MM-DD description: New date of charge. 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 amount of charge. minimum: 0 new_scheduled_date: type: string format: YYYY-MM-DD description: New scheduled date of charge example: '2020-06-10' maxLength: 12 original_scheduled_date: type: string format: YYYY-MM-DD description: | Date of original billing schedule, before being changed, from according to the plan associated with the subscription. example: '2020-06-10' maxLength: 12 original_amount: type: integer example: 19990 description: | Original charge amount, before being changed, according to the subscription-associated plan. 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 amount of charge minimum: 0 new_scheduled_date: type: string format: YYYY-MM-DD description: New date of charge example: '2020-06-10' maxLength: 12 original_scheduled_date: type: string format: YYYY-MM-DD description: | Date of original billing schedule, before being changed, from according to the plan associated with the subscription. example: '2020-06-10' maxLength: 12 original_amount: type: integer example: 19990 description: | Original charge amount, before being changed, according to the subscription-associated plan. minimum: 0 details: type: string description: | Reason why it was not possible to remove the charge change date and / or value. subscription_floating_data_projection: type: object description: This list will be presented if the parameter expan =floating_data is informed in the query parameters and will also depend on the contracting of the product Flexible Recurrence. 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_plan_migration: type: object required: - from - to properties: from: type: string format: uuid description: Origin Plan identifier. All Subscriptions with this Plan will be migrated to the destination Plan (key to) to: type: string format: uuid description: Identifier of the Plan to which the Subscriptions will be destined. subscriptions: $ref: '#/definitions/subscription_ids_array' subscription_ids_array: type: array description: List of Subscription identifiers that will be migrated to the destination Plan (key to). If this list is not informed then the service will migrate all Subscriptions from the source Plan (key from) to the destination Plan (key to). items: type: string format: uuid 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 billings registered. type: number example: 1 charge_filter: description: Information of the billings. 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: Billing Identifier. 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's 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: Payment identification code of the original transaction. type: string format: uuidv4 example: 06f256c8-1bbf-42bf-93b4-ce2041bfb87e minLength: 36 maxLength: 36 amount: description: Billing Amount. type: integer example: 19990 status: description: Collection 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: Date of creation of the billing. 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: Date of payment of recurrence subscription. type: integer format: YYYY-MM-DDTHH:MM:SSZ example: '2017-04-19T16:30:30Z' maxLength: 24 payment_type: description: Payment type type: string example: credit_card terminal_nsu: type: string description: Authorization Code generated by the Issuer when the transaction is successfully executed. example: '013978' 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: Code of the original transaction acquirer. example: '113880914' payment_link_request: type: object description: Request containing the data for GetPay. required: - label - order - payment properties: label: type: string description: GetPay identification tag. example: cart1 minLength: 6 maxLength: 36 expiration: type: string description: Expiration date of GetPay. format: date-time max_orders: type: integer description: Maximum number of sales that GetPay will allow. minimum: 1 order: $ref: '#/definitions/payment_link_order' payment: $ref: '#/definitions/payment_link_payment' payment_link_order: type: object description: Order information. required: - product_type - title - description - amount properties: product_type: type: string description: Type of product linked to purchase. enum: - cash_carry - digital_content - digital_goods - digital_physical - gift_card - physical_goods - renew_subs - shareware - service title: type: string description: Title of the order. maxLength: 128 description: type: string description: Description of the order. maxLength: 1024 order_prefix: type: string description: Order ID prefix. maxLength: 16 shipping_amount: type: integer description: Value in cents of the shipping. amount: type: integer description: Value in cents of the cart. payment_link_payment: type: object description: Configuration of the types of payment available on GetPay. required: - credit - debit properties: credit: $ref: '#/definitions/payment_link_credit' debit: $ref: '#/definitions/payment_link_debit' wallet: $ref: '#/definitions/payment_link_qrcode' pix: $ref: '#/definitions/payment_link_pix' payment_link_credit: type: object description: Configuration of the types of credit. required: - enable properties: enable: type: boolean description: Enables the payment type at the checkout of GetPay. max_installments: type: integer description: Maximum number of installments. minimum: 1 maximum: 12 example: 1 not_authenticated: type: boolean description: Enables the payment option with not-authentication for the means of payment. default: false authenticated: type: boolean description: Enables the payment option with authentication for the means of payment. default: true payment_link_debit: type: object description: Configuration of the types of debit. required: - enable properties: enable: type: boolean description: Enables the payment type at the checkout of GetPay. caixa_virtual_card: type: boolean description: Enables the Caixa virtual card option at the checkout of GetPay. default: false not_authenticated: type: boolean description: Enables the payment option with not-authentication for the means of payment. default: false authenticated: type: boolean description: Enables the payment option with authentication for the means of payment. default: true payment_link_qrcode: type: object description: Configuration of the method of QRCode. required: - enable properties: enable: type: boolean description: Enables the payment method at the checkout of GetPay. \n (payment.wallet.enabled can to be sended = true if payment.credit.enabled or payment.debit.enabled = true) payment_link_pix: type: object description: Configuration of payment type QR Code PIX. required: - enable properties: enable: type: boolean description: Enables the payment type QR Code PIX at the checkout of GetPay. payment_link_request_response: type: object properties: amount: type: integer description: Value in cents of the cart. minimum: 0 label: type: string description: GetPay identification tag. link_id: type: string description: Payment link ID. format: uuid created_at: type: string description: Date of creation of GetPay. format: date-time updated_at: type: string description: Date of the last update of GetPay. format: date-time max_orders: type: string description: Maximum number of sales that GetPay will allow. status: type: string description: GetPay status. enum: - ACTIVE - SUSPENDED - EXPIRED url: type: string description: GetPay url. format: uri expiration: type: string description: Expiration date of GetPay. format: date-time payment_link_filter_response: type: object properties: page_number: type: integer description: Current page number. minimum: 0 total_pages: type: integer description: Total number of pages. minimum: 0 result: type: array description: List of search results. items: $ref: '#/definitions/payment_link_result' total: type: integer description: Total number of results. minimum: 0 per_page: type: integer description: Number of results per page. minimum: 0 payment_link_filter_response_enabled_products: type: object properties: debit: type: object description: List of debit payment results. items: $ref: '#/definitions/payment_link_result_enabled_products' credit: type: object description: List of credit payment results. items: $ref: '#/definitions/payment_link_result_enabled_products' pix: type: object description: List of pix payment results. items: $ref: '#/definitions/payment_link_result_enabled_products_pix' qr-code: type: object description: List of qr-cde payment results. items: $ref: '#/definitions/payment_link_result_enabled_products_qrcode' payment_link_result_enabled_products: type: object description: Result list item. properties: enabled: type: boolean description: Identifies whether the product is enabled. example: true authenticated: type: boolean description: Identifies whether authenticated payment is enabled. example: true not_authenticated: type: boolean description: Identifies whether not-authenticated payment is enabled. example: true payment_link_result_enabled_products_pix: type: object description: Result list item. properties: enabled: type: boolean description: Identifies whether the pix is enabled. example: true activated: type: boolean description: Identifies whether the pix is active. example: true payment_link_result_enabled_products_qrcode: type: object description: Result list item. properties: enabled: type: boolean description: Identifies whether the qr-code is enabled. example: true payment_link_result: type: object description: Result list item. properties: link_id: type: string description: Payment link ID. format: uuid label: type: string description: Payment link identification tag. amount: type: integer description: Value in cents of the cart. links: type: array description: Links related to the result. items: $ref: '#/definitions/payment_link_links' created_at: type: string description: Date of creation of GetPay. format: date-time url: type: string description: GetPay url access_counter: type: integer description: | Access counter. Every time the link is accessed it is incremented. status: type: string description: GetPay status. enum: - SUSPENDED - ACTIVE - EXPIRED shipping_amount: type: integer description: Value in cents of the shipping. title: type: integer description: Cart title displayed on GetPay. expiration: type: string description: Expiration date in ISO format. format: uri max_orders: format: date-time description: Maximum number of sales on GetPay. type: integer payment_link_links: type: object description: Links related to the result. properties: rel: type: string description: Relationship of the url in relation to the result. href: type: string description: Resource url. format: uri payment_link_alteration: type: object properties: max_orders: description: Maximum number of sales that GetPay will allow. type: integer expiration: type: string description: Expiration date of GetPay. format: date-time status: type: string description: GetPay status. enum: - SUSPENDED - ACTIVE - EXPIRED payment_link_alteration_response: type: object properties: created_at: type: string description: GetPay creation date. format: date-time updated_at: type: string description: Date of the last update of GetPay. format: date-time link_id: type: string description: Payment link ID. format: uuidv4 order: $ref: '#/definitions/payment_link_order_response' payment: $ref: '#/definitions/payment_link_payment_response' status: type: string description: GetPay status. enum: - ACTIVE - SUSPENDED - EXPIRED - SOLD_OUT seller_id: type: string description: ID of the seller who created GetPay. format: uuid max_orders: type: integer description: Maximum number of GetPay sales. successfull_orders: type: integer description: Number of successful GetPay sales. access_counter: type: integer description: Access counter. Every time the link is accessed, it is incremented. expiration: type: string description: Expiration date of GetPay. format: date-time merchant: $ref: '#/definitions/payment_link_merchant_response' url: type: string description: GetPay url. payment_orders_created: type: integer description: Number of sales orders created. Orders are generated when a user completes the purchase form, even if they abandon the purchase. label: type: string description: GetPay identification tag. last_order_at: type: string description: Date of the last order created by GetPay. payment_link_order_response: type: object description: Order information properties: product_type: type: string description: Type of product linked to purchase. enum: - cash_carry - digital_content - digital_goods - digital_physical - gift_card - physical_goods - renew_subs - shareware - service title: type: string description: Title of the order. description: type: string description: Description of the order. amount: type: integer description: Value in cents of the cart. shipping_amount: type: integer description: Value in cents of the shipping. order_prefix: type: string description: Prefixo de ID de pedido. payment_link_payment_response: type: object description: Configuration of the types of payment available on GetPay. properties: credit: $ref: '#/definitions/payment_link_credit_response' debit: $ref: '#/definitions/payment_link_debit_response' wallet: $ref: '#/definitions/payment_link_qrcode_response' pix: $ref: '#/definitions/payment_link_pix_response' payment_link_credit_response: type: object description: Credit payment type settings. properties: enable: type: boolean description: Enables the payment type at the checkout of GetPay. max_installments: type: integer description: Maximum number of installments. minimum: 0 maximum: 24 payment_link_debit_response: type: object description: Debit payment type settings. properties: enable: type: boolean description: Enables the payment type at GetPay checkout authenticated: type: boolean default: true description: | Enables the payment option with authentication for the means of payment. not_authenticated: type: boolean default: false description: | Enables the option of payment without authentication for the means of payment. caixa_virtual_card: type: boolean default: false description: Enables the Caixa virtual card option at GetPay checkout. payment_link_qrcode_response: type: object description: QRCode payment method settings. properties: enable: type: boolean description: Enables the QRCode payment method at GetPay checkout payment_link_pix_response: type: object description: QR Code PIX payment type settings. properties: enable: type: boolean description: Enables the QR Code PIX option at GetPay checkout. payment_link_merchant_response: type: object description: Data from the EC that created GetPay. properties: name: type: string description: Name of the EC that created GetPay. document: type: string description: Document number of the EC that created GetPay. document_type: type: string description: Type of the EC document that generated GetPay. payment_link_consult_response: type: object properties: created_at: type: string description: Date of creation of GetPay. format: date-time updated_at: type: string description: Date of the last update of GetPay. format: date-time link_id: type: string description: Payment link ID. format: uuid order: $ref: '#/definitions/payment_link_order_response' payment: $ref: '#/definitions/payment_link_payment_response' status: type: string description: GetPay status. enum: - ACTIVE - SUSPENDED - EXPIRED - SOLD_OUT seller_id: type: string description: ID of the seller who created GetPay. format: uuid max_orders: type: integer description: Maximum number of GetPay sales. successfull_orders: type: integer description: Number of successful GetPay sales. access_counter: type: integer description: Access counter. Every time the link is accessed it is incremented. payment_orders_created: type: integer description: | Number of sales orders created. Orders are generated when a user completes the purchase form, even if he leaves purchase. expiration: type: string description: Expiration date of GetPay. format: date-time url: type: string description: GetPay url. merchant: $ref: '#/definitions/payment_link_merchant_response' label: type: string description: GetPay identification tag. last_order_at: type: string description: Date of the last order created by GetPay. payment_link_payment_consult_response: type: object properties: quantity: type: integer description: Number of carts sold on this payment order. minimum: 1 amount: type: integer description: Purchase order cent value. minimum: 1 status: type: string description: Order status made via the payment link. enum: - SUCCESSFULL - CREATED - FAILED payment_order_id: type: string description: Payment order ID. customer: $ref: '#/definitions/payment_link_customer' payments: $ref: '#/definitions/payment_link_payments_response' shippings: $ref: '#/definitions/payment_link_shippings' updated_at: type: string description: Date of update of the payment order. created_at: type: string description: Date of creation of the payment order. seller_id: type: string description: Seller ID linked to paymment order. link_id: type: string description: GetPay ID that originated the payment order. shipping_amount: description: Shipping in cents value. type: integer payment_link_customer: type: object description: Buyer data set. properties: first_name: type: string description: Buyer's first name. last_name: type: string description: Buyer's last name. email: type: string description: Buyer's email. document_number: type: string description: Buyer document number. document_type: type: string description: Type of buyer identification document. phone_number: type: string description: Buyer's phone. billing_address: $ref: '#/definitions/payment_link_billing_address' payment_link_billing_address: type: object description: Billing address. properties: postal_code: type: string description: Postal Code, CEP in Brazil or ZIP in the United States. street: type: string description: Public place. number: type: string description: Street number. complement: type: string description: Complement of the street. district: type: string description: Neighborhood. city: type: string description: City. state: type: string description: State (UF). country: type: string description: Country. payment_link_payments_response: type: array description: List of payment data linked to the order. items: type: object properties: payment_id: type: string description: Payment ID. registred_at: type: string description: Payment record date and time. status: type: string description: Transaction status. payment_type: type: string description: Type of payment. enum: - CREDIT - DEBIT amount: type: integer description: Purchase value in cents. transaction_type: type: string description: Type of transaction carried out. enum: - FULL - INSTALL_NO_INTEREST - INSTALL_WITH_INTEREST transaction: type: object description: Transaction return. number_installments: description: Number of installments for an installment credit transaction. type: integer payment_link_shippings: type: object description: Data set referring to the delivery address. properties: address: $ref: '#/definitions/address' same_as_billing_address: description: Delivery address flag equal to billing address. type: boolean payment_link_linked_response: type: array items: type: object properties: page_number: type: integer minimum: 0 description: Current page number. total_pages: type: integer minimum: 0 description: Total number of pages. result: $ref: '#/definitions/payment_link_result_response' per_page: type: integer minimum: 0 description: Total number of results. total: type: integer minimum: 0 description: Number of results per page. payment_link_result_response: type: array description: List of search results. items: type: object properties: status: type: string enum: - SUCCESSFULL - FAILED - CREATED description: Order status made via the payment link. quantity: type: integer minimum: 1 description: Number of carts sold on this payment order. amount: type: integer minimum: 1 description: Purchase order cent value. payment_order_id: type: string description: Payment order ID. links: $ref: '#/definitions/payment_link_links' created_at: type: string format: date-time description: Date of creation of the payment order. email: type: string description: Buyer's email. first_name: type: string description: Buyer's first name. last_name: type: string description: Buyer's last name. document_number: type: string description: Document number of the holder. document_type: type: string description: Type of document of the holder. payment_qrcode_request: type: object description: Data set for payment with QRCode. required: - amount - order - customer properties: amount: type: integer description: Purchase amount in cents. example: 100 currency: type: string description: Currency identification (See code at "https://www.currency-iso.org/en/home/tables/table-a1.html"). example: BRL minLength: 3 maxLength: 3 order: $ref: '#/definitions/order' customer: $ref: '#/definitions/customer_credit' device: $ref: '#/definitions/device_credit' shippings: type: array items: $ref: '#/definitions/shipping_credit' payments: type: array items: $ref: '#/definitions/qrcode_payments' payment_qrcode_pix_request: type: object description: Data set for payment with PIX QR Code. required: - amount - currency properties: amount: type: integer description: | Purchase amount in cents. To simulate a PIX payment successfully approved or denied in the approval environment, consider the value below:

amount Time Status Pulling Description Checkout Status

9000 10 s APPROVED The PIX paymen was made successfully.(00) Successfully completed transaction.

9088 - DENIED Unable to perform PIX transaction.(AF-88) Unable to make payment.

example: 100 currency: type: string description: Currency identification (See code at "https://www.currency-iso.org/en/home/tables/table-a1.html"). example: BRL minLength: 3 maxLength: 3 order_id: description: Purchase identification code used by e-commerce. If informed, it will be passed on in the PIX Payment Notification. type: string example: DEV-1608748980 customer_id: description: Buyer identifier used by e-commerce. If informed, it will be passed on in the PIX Payment Notification. type: string maxLength: 36 payment_qrcode_pix_response: type: object description: Data set response for payment with PIX QR Code. properties: payment_id: type: string description: Payment identification. example: 1a938e0d-26ab-4ac2-b263-ab46a99e4356 status: description: 'PIX Transaction status. All availabled transaction status for PIX are:
PENDING - The QR Code was not successfully generated because it was pending waiting for a response from the institution.
WAITING - The QR Code was not successfully generated because it was pending waiting for a response from the institution.
EXPIRED - The QR Code is expired and it is necessary to generate another.
ERROR - The QR Code was not generated because an error occurred.
APPROVED - The PIX transaction was successfully paid. This status is sent by PIX Transaction Notification.
DENIED - The PIX transaction was denied. This status is sent by PIX Transaction Notification.
' type: string enum: - PENDING - WAITING - EXPIRED - ERROR - APPROVED - DENIED example: WAITING description: type: string description: Text with a descriptive message of the requisition result. example: QR Code generated successfully and awaiting payment. additional_data: $ref: '#/definitions/additional_data_pix' additional_data_pix: type: object description: Group of additional information about the result of the request for QR Code or PIX transaction. properties: transaction_id: type: string description: Identifier of the transaction initiated after the generation of the QR Code PIX with the institution. example: '8289874875871543653292342' qr_code: type: string description: Payload of the generated QR Code PIX. With this text it will be possible to present it in graphic mode or the customer can pay it via the PIX "Copy and Paste" function. example: 00020101021226740014br.gov.bcb.pix210812345678220412342308123456782420001122334455 667788995204000053039865406123.455802BR5913FULANO DE TAL6008BRASILIA62190515RP12345678- 201980720014br.gov.bcb.pix2550bx.com.br/spi/U0VHUkVET1RPVEFMTUVOVEVBTEVBVE9SSU8=63 0434D1 creation_date_qrcode: type: string description: Date of creation of the generated QR Code. format: YYYY-MM-DDTHH:MM:SSZ example: '2021-02-14T17:50:12Z' expiration_date_qrcode: type: string format: YYYY-MM-DDTHH:MM:SSZ description: Expiration date of the generated QR Code. example: '2021-02-14T17:51:52Z' psp_code: type: string description: Receiver PSP code. PSP (Payment Service Provider, which is the financial institution responsible for paying or receiving amounts on Pix. example: '033' qrcode_payments: type: object description: Set of payment data. properties: type: type: string description: Payment type. enum: - CREDIT - DEBIT example: CREDIT authenticated: type: boolean description: Identifies whether the transaction will be done with authentication. example: false transaction_type: type: string description: | Transaction type. Full payment in cash, installments without interest, installment staked with interest.
Required when the type field = CREDIT. enum: - FULL - INSTALL_NO_INTEREST - INSTALL_WITH_INTEREST example: FULL number_installments: type: number description: | Number of installments for a installment credit transaction.
Required when the type field = CREDIT. example: 1 soft_descriptor: $ref: '#/definitions/soft_descriptor_global' dynamic_mcc: $ref: '#/definitions/dynamic_mcc' cardholder_mobile: type: string description: | Cardholder phone. Required for Visa.
Use only in authenticated debit transactions (authenticated = true) example: '5551999887766' payment_qrcode_response: type: object description: QRCode dataset. properties: qr_code: type: string description: QRCode example: 00020101021226580014br.com.padraoq011600000000005439920208E03862520304000252040000530398654041.995802BR5919EC Teste HUB PADRAO6012Porto Alegre62290525b55161ce07c030209c2fe8ef381720014br.com.padraoq01122212201824420204000203020104020105020350088c65d85|50088c65d85|6304B0C0 hash_qr_code: type: string description: Hash QRCode example: b55161ce07c030209c2fe8ef38c65d85 payment_id: type: string description: Payment Identifier. example: 1a938e0d-26ab-4ac2-b263-ab46a99e4356 qrcode_response: type: object description: QRCode data returned. properties: seller_id: type: string description: E-commerce identification code. example: 54218a4d-3a3b-48e2-82dc-58f7df8509b2 hash_qr_code: type: string description: Hash QRCode example: 151b8eb68ac61573f72a84c9ab2feca2 status: description: Transaction status. type: string enum: - PENDING - APPROVED - DENIED example: APPROVED order_id: description: Identification code of the purchase used by e-commerce type: string example: DEV-1608748980 amount: type: integer description: Purchase amount in cents. example: 100 payment_request: $ref: '#/definitions/qrcode_payment_request' payment_response: $ref: '#/definitions/qrcode_payment_response' qrcode_payment_request: type: object description: Set of payment data. properties: type: type: string description: Payment type. example: CREDIT delayed: type: boolean description: Identifies whether the credit will be made with late confirmation. example: false authenticated: type: boolean description: Identifies whether the transaction will be done with authentication. example: false pre_authorization: type: boolean description: Indicative of whether the transaction is a pre-credit authorization. example: false 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. Full payment in cash, installments without interest, installment staked with interest. example: FULL number_installments: type: number description: Number of installments for a installment credit transaction. example: 1 soft_descriptor: $ref: '#/definitions/soft_descriptor_global' dynamic_mcc: $ref: '#/definitions/dynamic_mcc' qrcode_payment_response: type: object description: Set of payment data. properties: payment_id: type: string description: Payment Identifier. example: 1a938e0d-26ab-4ac2-b263-ab46a99e4356 seller_id: type: string description: E-commerce identification code. example: 54218a4d-3a3b-48e2-82dc-58f7df8509b2 amount: type: integer description: Purchase amount in cents. example: 100 currency: type: string description: Currency identification (See code at "https://www.currency-iso.org/en/home/tables/table-a1.html"). example: BRL order_id: description: Identification code of the purchase used by e-commerce. type: string example: DEV-1608748980 status: description: Transaction status. type: string enum: - APPROVED - DENIED - ERROR example: APPROVED received_at: type: string description: Date and time of payment registration. format: YYYY-MM-DDTHH:mm:ss.SSSZ example: '2017-03-19T16:30:30.764Z' credit: $ref: '#/definitions/qrcode_payment_response_credit' debit: $ref: '#/definitions/qrcode_payment_response_debit' qrcode_payment_response_credit: type: object description: | Payment data set.
Exlcusivo return for Credit transactions. properties: delayed: type: boolean description: Identifies whether the credit will be made with late confirmation. example: false authorization_code: type: string description: Authorization number generated by the card verification system. example: '6964722471672911' authorized_at: type: number description: Date/time of credit authorization. format: YYYY-MM-DDTHH:MM:SSZ example: '2017-03-19T16:30:30Z' reason_code: type: string description: Return code. example: '00' reason_message: type: string description: Return message. example: transaction approved maxLength: 250 acquirer: type: string description: Name of the purchaser. example: GETNET maxLength: 30 soft_descriptor: $ref: '#/definitions/soft_descriptor_global' brand: type: string description: Brand. Required if the data were not permanently stored with the token. example: Mastercard enum: - Mastercard - Visa - Amex - Elo - Hipercard maxLength: 50 terminal_nsu: type: string description: Authorization Code generated by the Issuer when the transaction is carried out successfully. example: '013978' acquirer_transaction_id: type: string description: Original transaction purchaser code. example: '113880914' transaction_id: type: string description: Transaction code. example: '1002217281190421' qrcode_payment_response_debit: type: object description: | Payment data set.
Exlcusivo return for Debit transactions. properties: authorization_code: type: string description: Authorization number generated by the card verification system. example: '6964722471672911' authorized_at: type: number description: Date/time of credit authorization. format: YYYY-MM-DDTHH:MM:SSZ example: '2017-03-19T16:30:30Z' reason_code: type: string description: Return code. example: '00' reason_message: type: string description: Return message. example: transaction approved maxLength: 250 acquirer: type: string description: Name of the purchaser. example: GETNET maxLength: 30 soft_descriptor: $ref: '#/definitions/soft_descriptor_global' brand: type: string description: Brand. Required if the data were not permanently stored with the token. example: Mastercard enum: - Mastercard - Visa - Amex - Elo - Hipercard maxLength: 50 terminal_nsu: type: string description: Authorization Code generated by the Issuer when the transaction is carried out successfully. example: '013978' acquirer_transaction_id: type: string description: Original transaction purchaser code. example: '113880914' transaction_id: type: string description: Transaction code. example: '1002217281190421' cancel_request: type: object description: Dataset to request cancellation required: - payment_id - cancel_amount properties: payment_id: type: string description: Payment ID code of the original transaction. example: 06f256c8-1bbf-42bf-93b4-ce2041bfb87e minLength: 36 maxLength: 36 cancel_amount: description: Value of the cancellation request. May be equal to or less than the value of the original transaction. type: integer example: 19990 cancel_custom_key: description: Customer key used to identify a cancellation request. (Key must be unique per transaction). type: string example: 4ec33ee18f9e45bfb73c5c30667f9006 minLength: 3 maxLength: 32 cancel_request_response: type: object description: Cancel request dataset. properties: seller_id: description: E-commerce identification code. type: string format: uuidv4 minLength: 36 maxLength: 36 example: 6eb2412c-165a-41cd-b1d9-76c575d70a28 payment_id: type: string description: Payment identification code of the original transaction. example: 06f256c8-1bbf-42bf-93b4-ce2041bfb87e minLength: 36 maxLength: 36 cancel_request_at: type: string description: Cancel request data. format: YYYY-MM-DDTHH:MM:SSZ example: '2017-11-16T16:30:30Z' cancel_request_id: description: Cancellation request identifier. type: string example: '20171117084237501' minLength: 18 maxLength: 18 cancel_custom_key: description: Customer key used to identify a cancellation request. (Key must be unique per transaction). type: string example: 4ec33ee18f9e45bfb73c5c30667f9006 maxLength: 32 status: description: Transaction status. For more information on the response status, see Notifications 1.0 or Notifications 1.1. type: string enum: - ACCEPTED - DENIED example: ACCEPTED cancel_query_response: type: object description: Cancel request dataset. properties: seller_id: description: E-commerce identification code. type: string format: uuidv4 minLength: 36 maxLength: 36 example: 6eb2412c-165a-41cd-b1d9-76c575d70a28 payment_id: type: string description: Payment identification code of the original transaction. example: 06f256c8-1bbf-42bf-93b4-ce2041bfb87e minLength: 36 maxLength: 36 cancel_request_at: type: string description: Cancel request data. format: YYYY-MM-DDTHH:MM:SSZ example: '2017-11-16T16:30:30Z' cancel_request_id: description: Cancellation request identifier. type: string example: '20171117084237501' minLength: 18 maxLength: 18 cancel_custom_key: description: Customer key used to identify a cancellation request. (Key must be unique per transaction). type: string example: 4ec33ee18f9e45bfb73c5c30667f9006 maxLength: 32 terminal_nsu: type: string description: Authorization Code generated by the Issuer when the transaction is successfully executed. example: '013978' acquirer_transaction_id: type: string description: Code of the original transaction acquirer. example: '113880914' transaction_date: type: string description: Date of the original transaction. example: '17052017' format: DDMMAAAA minLength: 8 maxLength: 8 currency: description: Currency identification of the original transaction (See code at "https://www.currency-iso.org/en/home/tables/table-a1.html"). type: string minLength: 3 maxLength: 3 example: BRL transaction_type: description: Type of original transaction. V = à vista (FULL) e P = parcelado (INSTALLMENT). type: string enum: - V - P example: FULL number_installments: description: Number of installments of the original transaction. type: integer example: 1 amount: description: Amount of the original transaction. type: integer example: 19990 cancel_amount: description: Cancel request amount. type: integer example: 19990 status_processing_cancel_code: description: Cancel request status code. For more details see D+n Cancellation Return Code Table type: string example: '100' status_processing_cancel_message: description: Cancel request status message. type: string example: SOLICITACAO EM ANDAMENTO credit_confirm: type: object description: Dataset to confirm delayed and pre-authorized credit. properties: amount: description: Confirmation value. May be equal to or less than the original value of the transaction. If you are not informed, the original transaction value will be accepted. type: integer example: 19990 soft_descriptor_global: type: string maxLength: 22 description: 'Text shown in the buyer’s credit card statement. This field is optional, if nothing is inserted, it will be considered the registered trade name for the establishment. Only alphanumeric data and the following special characters are allowed in this field: % $ , . / & () + = <> - * Spaces will be replaced by the character ''*'' The transaction will not be denied if characters that are not allowed are sent. Any information that exceeds the maximum size will be disregarded.' example: LOJA*TESTE*COMPRA-123 soft_descriptor_global_sub_merchant: type: string maxLength: 22 description: | Text shown in the buyer’s credit card statement. This field is optional, if nothing is inserted, it will be considered the registered trade name for the establishment. Only alphanumeric data and the following special characters are allowed in this field: % $ , . / & () + = <> - * Spaces will be replaced by the character '*' The transaction will not be denied if characters that are not allowed are sent. Any information that exceeds the maximum size will be disregarded. Required for Payment Facilities. In addition to the described above, you must follow the following additional brand rules:

Payment Facilities ID, 3, 7 or 12 characters

Separation characters "*" (asterisk)

Subtrade identification

Example 1: FAC*SUCOMERCIO

Example 2: FACILIT*SUBCOMERCIO

Example 3: FACILITADOR1*SUBCOMERC

example: LOJA*TESTE*COMPRA-123 dynamic_mcc: type: number maxLength: 4 minLength: 4 description: Field used to flag the transaction with another Merchant Category Code other than the one registered. If an invalid MCC is submitted, the default will be used. Send only numeric data. example: 1799 dynamic_mcc_sub_merchant: type: number maxLength: 4 minLength: 4 description: | Field used to flag the transaction with another Merchant Category Code other than the one registered. If an invalid MCC is submitted, the default will be used. Send only numeric data.

Required for Payment Facilities and SDWO example: 1799 credit_preauthorized_adjustment: type: object required: - amount - currency description: Dataset to adjust Pre-authorized amount properties: amount: type: integer description: Pre-Authorization adjustment value. example: 19990 currency: type: string description: Identification of the currency of the original transaction (See code at "https://www.currency-iso.org/en/home/tables/table-a1.html"). minLength: 3 maxLength: 3 example: BRL soft_descriptor: $ref: '#/definitions/soft_descriptor_global' dynamic_mcc: $ref: '#/definitions/dynamic_mcc' credit_preauthorized_adjustment_response: type: object description: Pre-authorization value adjustment response dataset. properties: payment_id: type: string description: Payment identification code. format: uuidv4 example: 06f256c8-1bbf-42bf-93b4-ce2041bfb87e minLength: 36 maxLength: 36 seller_id: type: string description: E-commerce identification code. format: uuidv4 example: 6eb2412c-165a-41cd-b1d9-76c575d70a28 minLength: 36 maxLength: 36 amount: type: integer description: Adjusted amount in cents. example: 19990 currency: type: string description: Currency identification (See code at "https://www.currency-iso.org/en/home/tables/table-a1.html"). example: BRL minLength: 3 maxLength: 3 order_id: type: string description: Purchase identification used by the e-commerce example: 6d2e4380-d8a3-4ccb-9138-c289182818a3 maxLength: 36 status: type: string description: Transaction status. For more information on the response status, see Notifications 1.0 or Notifications 1.1. example: APPROVED enum: - APPROVED - DENIED maxLength: 20 authorization_code: type: string description: Credit Authorization Code example: '000000099999' maxLength: 20 authorized_at: type: number description: Date/time of the authorization of the credit. format: YYYY-MM-DDTHH:MM:SSZ example: '2017-03-19T16:30:30Z' maxLength: 24 reason_code: type: string description: Return code. example: '00' minLength: 1 maxLength: 5 reason_message: type: string description: Return message. example: transaction approved maxLength: 250 acquirer: type: string description: Acquirer's name. example: GETNET maxLength: 30 soft_descriptor: type: string description: Card statement description. example: Descrição para fatura maxLength: 22 terminal_nsu: type: string description: Authorization Code generated by the Issuer when the transaction is successfully executed. example: '0099999' acquirer_transaction_id: type: string description: Acquirer's transaction code. example: '160453221' maxLength: 20 adjustment_acquirer_transaction_id: type: string description: Acquirer's adjust transaction code. example: '160453231' maxLength: 20 payment_combined: type: object description: Data set for payment transaction. required: - amount - payments - order - customer properties: amount: type: integer description: Adjusted amount in cents. example: 19990 dynamic_mcc: $ref: '#/definitions/dynamic_mcc' order: $ref: '#/definitions/order' customer: $ref: '#/definitions/customer_credit' device: $ref: '#/definitions/device_credit' shippings: type: array items: $ref: '#/definitions/shipping_credit' payments: type: array items: $ref: '#/definitions/combined_payments' combined_payments: type: object description: Set of data for the combined payment. required: - type - amount - save_card_data - transaction_type - number_installments - card - payment_tag properties: type: type: string description: Payment type. enum: - CREDIT example: CREDIT amount: type: integer description: Adjusted amount in cents. example: 19990 currency: type: string description: Currency identification (See code at "https://www.currency-iso.org/en/home/tables/table-a1.html"). example: BRL minLength: 3 maxLength: 3 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. Full payment in cash, installments without interest, installment staked with interest. enum: - FULL - INSTALL_NO_INTEREST - INSTALL_WITH_INTEREST example: FULL number_installments: type: number description: Number of installments for a installment credit transaction. example: 1 payment_tag: description: Tag to identify payment portions of the item on more than one card. type: string example: pay-1 maxLength: 50 soft_descriptor: $ref: '#/definitions/soft_descriptor_global' card: $ref: '#/definitions/card_credit' credentials_on_file_type: type: string description: |
Tipo do COF (Credential On File).

ONE_CLICK: Usado quando é realizado a primeira transação (parcela) de um pagamento normal.

ONE_CLICK_PAYMENT: Usado quando é realizado transações para as demais parcelas restantes de um pagamento normal. Obs: Necessário informar o transaction_id da primeira transação realizada.

RECURRING: Usado quando é realizado a primeira transação (parcela) de um pagamento recorrente.

RECURRING_PAYMENT: Usado quando é realizado transações para as demais parcelas restantes de um pagamento recorrente. Obs: Necessário informar o transaction_id da primeira transação realizada.

enum: - ONE_CLICK - ONE_CLICK_PAYMENT - RECURRING - RECURRING_PAYMENT example: ONE_CLICK_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' payment_combined_response: type: object description: Combined payment response data set. properties: seller_id: type: string description: E-commerce identification code. format: uuidv4 example: 6eb2412c-165a-41cd-b1d9-76c575d70a28 minLength: 36 maxLength: 36 combined_id: type: string description: Identification code of the combined payment. format: uuidv4 example: 693635a4-54b5-457b-9e07-e03579d189f1 minLength: 36 maxLength: 36 order_id: type: string description: Identification code of the purchase used by e-commerce. example: 6d2e4380-d8a3-4ccb-9138-c289182818a3 maxLength: 36 amount: type: integer description: Total purchase amount in cents. example: 10000 currency: type: string description: Currency identification (See code at "https://www.currency-iso.org/en/home/tables/table-a1.html"). example: BRL minLength: 3 maxLength: 3 payments: type: array items: $ref: '#/definitions/combined_response' combined_response: type: object description: Data set for payment response. properties: payment_id: type: string description: Payment identification code. format: uuidv4 example: 06f256c8-1bbf-42bf-93b4-ce2041bfb87e minLength: 36 maxLength: 36 payment_tag: description: Tag to identify payment portions of the item on more than one card. type: string example: pay-1 amount: type: integer description: Purchase amount in cents. example: 10000 currency: type: string description: Currency identification (See code at "https://www.currency-iso.org/en/home/tables/table-a1.html"). example: BRL minLength: 3 maxLength: 3 status: type: string description: Payment transaction status. example: AUTHORIZED maxLength: 20 received_at: type: string description: Date and time of payment registration. format: YYYY-MM-DDTHH:mm:ss.SSSZ example: '2019-08-23T16:30:30.764Z' maxLength: 24 credit: $ref: '#/definitions/payment_combined_detail' payment_combined_detail: type: object description: Set of data for the transaction. properties: authorization_code: type: string description: Credit authorization code. example: '000000099999' maxLength: 20 authorized_at: type: number description: Date/time of credit authorization. format: YYYY-MM-DDTHH:MM:SSZ example: '2019-08-23T16:30:30.764Z' maxLength: 24 reason_code: type: string description: Return code. example: '00' minLength: 1 maxLength: 5 reason_message: type: string description: Return message. example: transaction approved maxLength: 250 acquirer: type: string description: Name of the acquirer. example: GETNET maxLength: 30 soft_descriptor: type: string description: Description for the card invoice. example: LOJA*TESTE*COMPRA-123 maxLength: 22 brand: type: string description: Brand responsible for processing the transaction. example: Mastercard maxLength: 50 enum: - Mastercard - Visa - Amex - Elo - Hipercard terminal_nsu: type: string description: Authorization Code generated by the Issuer when the transaction is carried out successfully. example: '0099999' acquirer_transaction_id: type: string description: Transaction code of the acquirer. example: '10000024' maxLength: 20 transaction_id: type: string description: Transaction code. example: '1002217281190421' combined_confirm: type: object description: Set of data for combined payment confirmation. required: - payments properties: payments: type: array items: $ref: '#/definitions/combined_confirm_detail' combined_confirm_detail: type: object description: Data set for payments to be confirmed. required: - payment_id - payment_tag properties: payment_id: type: string description: Payment identification code. format: uuidv4 example: 06f256c8-1bbf-42bf-93b4-ce2041bfb87e minLength: 36 maxLength: 36 payment_tag: description: Tag to identify payment portions of the item on more than one card. type: string example: pay-1 maxLength: 50 combined_confirm_response: type: object description: Combined payment confirmation response data set. properties: seller_id: type: string description: E-commerce identification code. format: uuidv4 example: 6eb2412c-165a-41cd-b1d9-76c575d70a28 minLength: 36 maxLength: 36 combined_id: type: string description: Identification code of the combined payment. format: uuidv4 example: 693635a4-54b5-457b-9e07-e03579d189f1 minLength: 36 maxLength: 36 order_id: type: string description: Identification code of the purchase used by e-commerce. example: 6d2e4380-d8a3-4ccb-9138-c289182818a3 maxLength: 36 amount: type: integer description: Total purchase amount in cents. example: 10000 currency: type: string description: Currency identification (See code at "https://www.currency-iso.org/en/home/tables/table-a1.html"). example: BRL minLength: 3 maxLength: 3 payments: type: array items: $ref: '#/definitions/combined_confirm_response_detail' combined_confirm_response_detail: type: object description: Payment confirmation response dataset. properties: payment_tag: description: Tag to identify payment portions of the item on more than one card. type: string example: pay-1 payment_id: type: string description: Payment identification code. minLength: 36 maxLength: 36 format: uuidv4 example: 331b0b07-6e37-4bd9-a37b-99156cb34104 amount: type: integer description: Purchase amount in cents. example: 10000 currency: type: string description: Currency identification (See code at "https://www.currency-iso.org/en/home/tables/table-a1.html"). example: BRL minLength: 3 maxLength: 3 status: type: string description: Payment status. example: CONFIRMED enum: - CONFIRMED - ERROR maxLength: 20 credit_confirm: $ref: '#/definitions/payment_credit_confirm_details' combined_cancel: type: object description: Set of data for cancellation of combined payment. required: - payments properties: payments: type: array items: $ref: '#/definitions/combined_cancel_detail' combined_cancel_detail: type: object description: Data set for payments to be cancelled. required: - payment_id - payment_tag properties: payment_id: type: string description: Payment identification code. format: uuidv4 example: 06f256c8-1bbf-42bf-93b4-ce2041bfb87e minLength: 36 maxLength: 36 payment_tag: description: Tag to identify payment portions of the item on more than one card. type: string example: pay-1 maxLength: 50 combined_cancel_response: type: object description: Combined payment cancellation response data set. properties: seller_id: type: string description: E-commerce identification code. format: uuidv4 example: 6eb2412c-165a-41cd-b1d9-76c575d70a28 minLength: 36 maxLength: 36 combined_id: type: string description: Identification code of the combined payment. format: uuidv4 example: 693635a4-54b5-457b-9e07-e03579d189f1 minLength: 36 maxLength: 36 order_id: type: string description: Identification code of the purchase used by e-commerce. example: 6d2e4380-d8a3-4ccb-9138-c289182818a3 maxLength: 36 payments: type: array items: $ref: '#/definitions/combined_cancel_response_detail' combined_cancel_response_detail: type: object description: Payment cancellation response dataset. properties: payment_tag: description: Tag to identify payment portions of the item on more than one card. type: string example: pay-1 payment_id: type: string description: Payment identification code. minLength: 36 maxLength: 36 format: uuidv4 example: 331b0b07-6e37-4bd9-a37b-99156cb34104 amount: type: integer description: Purchase amount in cents. example: 10000 currency: type: string description: Currency identification (See code at "https://www.currency-iso.org/en/home/tables/table-a1.html"). example: BRL minLength: 3 maxLength: 3 status: type: string description: Payment status. example: CANCELED enum: - CANCELED - ERROR maxLength: 20 credit_cancel: $ref: '#/definitions/payment_credit_cancel_details' 3ds_token: type: object required: - js_version - client_code - currency - override_payment_method - total_amount properties: client_code: description: | 3DS authentication session identifier code. The value must be a reference of the request generated by the ecommerce or number of Trace. We recommend that you send a unique value to each transaction. This value will be returned in the response of the requests in the endpoints /v1/3ds/authentications and /v1/3ds/authentications/results. The return will be in the client_reference_information.code field in the form of a string composed of [client_code] + [-] + [UUID] (Example: client_code-00000000-0000-0000-0000-000000000000000). type: string maxLength: 13 currency: description: | Currency identification (See code in "https://en.wikipedia.org/wiki/ISO_4217"). type: string minLength: 3 maxLength: 3 example: BRL default: BRL items: $ref: '#/definitions/3ds_item_array_ref' js_version: description: JavaScript library version ID getnet_3ds220.js. type: string maxLength: 10 example: 1.0.0 order_number: description: | Identification code of the purchase used by your e-commerce (order code or number). type: string example: 1234-2019 maxLength: 40 override_payment_method: description: | Indicates the type of account.
02 = Credit
03 = Debit type: string minLength: 2 maxLength: 2 example: '02' enum: - '02' - '03' total_amount: type: integer description: Purchase amount in cents. example: 100 additional_data: description: Additional Data type: object example: null additional_object: description: Additional Object. type: object example: null 3ds_authentication: type: object required: - override_payment_method properties: customer_card_alias: description: 'Alias that uniquely identifies the account and credit card of the registered customer.
Note: This field is required if the tokenization is enabled in the ecommerce profile settings.' type: string maxLength: 50 example: João da Silva override_payment_method: description: | Indicates the type of account.
02 = Credit
03 = Debit type: string minLength: 2 maxLength: 2 example: '02' enum: - '02' - '03' alternate_authentication_data: description: Data to document and support the authentication process Specific. type: string maxLength: 2048 alternate_authentication_method: description: | Mechanism used by the cardholder to authenticate on your Ecommerce.
Possible values:
01: No authentication occurred
02: Login using commercial system credentials
03: Login using federated ID
04: Login using FIDO Authenticator type: string minLength: 2 maxLength: 2 example: '02' enum: - '01' - '02' - '03' - '04' authentication: $ref: '#/definitions/3ds_authentication_ref' device: $ref: '#/definitions/3ds_device_ref' costumer_risk_information: $ref: '#/definitions/3ds_costumer_risk_information_ref' recurring: $ref: '#/definitions/3ds_recurring_ref' card: $ref: '#/definitions/3ds_card_ref' order: $ref: '#/definitions/3ds_order_ref' additional_data: description: Additional Data type: object example: null additional_object: description: Additional Object type: object example: null 3ds_item_array_ref: type: array description: List of order items. items: $ref: '#/definitions/3ds_item_ref' 3ds_ship_to_ref: type: object description: Delivery address dataset. properties: address1: description: | First line of delivery address ordered by carrier. type: string minLength: 0 maxLength: 60 example: Rua XXXX, XX address2: description: Second line of delivery address ordered by carrier. Additional address information. type: string minLength: 0 maxLength: 60 example: Apartamento XX administrative_area: description: | State (UF) of the delivery address ordered by the carrier. type: string minLength: 2 maxLength: 2 example: RS country: description: | Country of the delivery address ordered by the carrier (See code in "https://www.iso.org/iso-3166-country-codes.html"). type: string minLength: 2 maxLength: 2 example: BR destination_code: description: | Type of destination.
01 = Send to the billing address of the cardholder
02 = Send to another verified address by ecommerce
03 = Send to the address other than the billing address
04 = Send to the store (the address of the store must be completed upon request)
05 = Porduto digital
06 = Travel tickets and events, not sent
07 = Other type: string minLength: 2 maxLength: 2 example: '01' enum: - '01' - '02' - '03' - '04' - '05' - '06' - '07' first_name: description: | First name of the recipient. type: string minLength: 0 maxLength: 60 example: João last_name: description: | Last name of the recipient. type: string minLength: 0 maxLength: 60 example: da Silva locality: description: | City of delivery address ordered by carrier. type: string minLength: 0 maxLength: 50 example: Porto Alegre method: description: | Shipping method for the product. Possible values:
lowcost = lowest cost service
sameday = mail service or same day
oneday = next day service or overnight
twoday = two-day service
threeday = three-day service
pickup = store pickup
other = another sending method
none = no shipping method because the product is a service or Signature. Required for American Express SafeKey (US). type: string maxLength: 8 example: lowcost enum: - lowcost - sameday - oneday - twoday - threeday - pickup - other - none phone_number: description: | Phone number of the delivery address ordered by the carrier. (without mask) Country code: 1–3 characters type: string minLength: 0 maxLength: 15 example: 555199988776 postal_code: description: Zip code of the delivery address ordered by the carrier. type: string minLength: 5 maxLength: 10 example: '686593' 3ds_item_ref: type: object properties: description: description: Item description. type: string maxLength: 255 example: Descricao do item name: description: Item name. type: string maxLength: 255 example: Nome do item sku: description: Stock Keeping Unit (SKU). type: string maxLength: 255 example: XXX-00-XXX-00 quantity: description: Number of items of this product. type: integer example: 1 total_amount: description: Total value of item/product in cents. type: integer example: 100 unit_price: description: Unit value of the item/product in cents. type: integer example: 100 3ds_authentication_ref: type: object description: Authentication process dataset. required: - token properties: token: description: Access token for 3DS authentication session. example: eyJhbGciOiJIUzI1NiJ9.eyJqdGkiOiIzZjczZGQ3MS03NjkyLTQyYTItYjU2Ni1jYmUzMzJkYzU3OTQiLCJpYXQiOjE1NzY2NzI3NDUsImlzcyI6IjVkNzVhYzYxNmZlM2QxMmYxODhmZmQ3YyIsIk9yZ1VuaXRJZCI6IjVkNzRlZDczZTA5MTlmMTk1ODNjMzE5MyIsIlBheWxvYWQiOiJ7XCJvcmRlck51bWJlclwiOlwic3RyaW5nXCIsXCJwYXltZW50SWRcIjpcImRhMGU4ZDkwLTQ0OGMtNGJhMC1iZGUyLTQxN2Q2YTdmZjliOVwiLFwibWVyY2hhbnRJZFwiOlwiMDU0Mzk5MlwiLFwibWVyY2hhbnROYW1lXCI6XCJFQyBUZXN0ZSBIVUIg4oCTIFBBRFJBT1wiLFwiY3VycmVuY3lcIjpcImJybFwiLFwidG90YWxBbW91bnRcIjpcIjEwMDBcIixcImpzVmVyc2lvblwiOlwic3RyaW5nXCIsXCJjbGllbnRDb2RlXCI6XCJzdHJpbmctM2Y3M2RkNzEtNzY5Mi00MmEyLWI1NjYtY2JlMzMyZGM1Nzk0XCIsXCJvdmVycmlkZVBheW1lbnRNZXRob2RcIjpcIjAyXCIsXCJpdGVtc1wiOlt7XCJ0b3RhbEFtb3VudFwiOlwiOTAwXCIsXCJ1bml0UHJpY2VcIjpcIjg5OVwiLFwicXVhbnRpdHlcIjowLFwic2t1XCI6XCJzdHJpbmdcIixcImRlc2NyaXB0aW9uXCI6XCJzdHJpbmdcIixcIm5hbWVcIjpcInN0cmluZ1wifSx7XCJ0b3RhbEFtb3VudFwiOlwiOTAwXCIsXCJ1bml0UHJpY2VcIjpcIjgwMFwiLFwicXVhbnRpdHlcIjowLFwic2t1XCI6XCJzdHJpbmdcIixcImRlc2NyaXB0aW9uXCI6XCJzdHJpbmdcIixcIm5hbWVcIjpcInN0cmluZ1wifV19IiwiT2JqZWN0aWZ5UGF5bG9hZCI6ZmFsc2UsIlJlZmVyZW5jZUlkIjoiM2Y3M2RkNzEtNzY5Mi00MmEyLWI1NjYtY2JlMzMyZGM1Nzk0IiwiZXhwIjoxNTc2NjcyODY1fQ.jrPvIjtvSY6HukI-PjBE0ACWo68whA2FhCCfKeEfB4g type: string maxLength: 2000 npa_code: description: | NPA code.
01 = Add card
02 = Keep card information
03 = Cardholder verification for the EMV token type: string minLength: 2 maxLength: 2 example: '01' enum: - '01' - '02' - '03' challenge_code: description: | Indicates whether a challenge is required by the applicant for this transaction.
01 = No preference.
02 = Asked not to challenge
03 = Challenge requested (3DS preference Requestor).
04 = Challenge requested (mandate)
Note: If this element is not provided, the value 01 is used. type: string minLength: 2 maxLength: 2 example: '01' enum: - '01' - '02' - '03' - '04' installment_total_count: description: | Indicates the maximum number of installments allowed for a payment installment.
Value must be greater than 1 for purchases only installments.
Note: It is necessary if the ecommerce and the agree to the installment payments. type: integer minimum: 2 maximum: 9999 example: 3 message_category: type: string maxLength: 2 minLength: 2 description: | Message category for a specific use case.
Values possible:
01: PA payment authentication
02: NPA payment-not paid authentication
80: to indicate mastercard dataonly. example: '01' enum: - '01' - '02' - '80' transaction_mode: description: | Transaction mode identifier.
Identifies the channel from which the transaction originates.
Possible values:
M = Request by email or phone
P = Mobile Device
R = Retail (Store Physics)
S = Computer
T = Tablet type: string example: M minLength: 1 maxLength: 1 enum: - M - P - R - S - T device_channel: description: Device Channel type: string example: Browser maxLength: 10 acs_window_size: description: | Indication of the desired size (pixels) of the challenge screen, when it is the case.
Possible values:
01: (250x400)
02: (390x400)
03: (500x600)
04: (600x400)
05: (Full page) type: string example: '02' enum: - '01' - '02' - '03' - '04' - '05' maxLength: 2 3ds_device_ref: type: object description: Set of data for the device used by the buyer. properties: http_accept_browser_value: description: | Accept header value sent by the web browser of the customer.
Note: If the client's browser provides a value, you must include it in your request. type: string example: text/html,application/xhtml+xml,application/xml maxLength: 255 http_accept_content: description: The exact contents of the HTTP accepter header. type: string example: text/html maxLength: 255 user_agent_browser_value: description: | User-Agent header value of user submitted by web browser customer.
Note: If the client's browser provides a value, you must include it in your request. type: string maxLength: 255 example: Mozilla/5.0 (Windows NT 6.1; Win64; x64; rv:47.0) http_browser_color_depth: description: The value represents the bit depth of the color palette for display images, in bits per pixel. type: string example: '24' maxLength: 2 http_browser_java_enabled: description: Value representing the cardholder's browser ability to run Java. type: string example: 'N' enum: - 'Y' - 'N' maxLength: 1 http_browser_java_script_enabled: description: Value representing the cardholder's browser ability to run JavaScript. type: string example: 'Y' enum: - 'Y' - 'N' maxLength: 1 http_browser_language: description: The value represents the browser language as defined in IETF BCP47. type: string example: pt-BR maxLength: 8 http_browser_screen_height: description: Total screen height of the cardholder in pixels. type: string example: '260' maxLength: 6 http_browser_screen_width: description: Full width of the cardholder's screen in pixels. type: string example: '1366' maxLength: 6 http_browser_time_difference: description: Time difference between UTC time and local time of the card, in minutes. type: string example: '180' maxLength: 5 ip_address: description: Ip address customer's account. type: string example: 127.0.0.1 maxLength: 45 3ds_costumer_risk_information_ref: type: object description: Customer risk data set. properties: transaction_count_year: description: | Number of successful and abandoned transactions from this account cardholder with your ecommerce in the last year. type: integer minimum: 0 maximum: 999 example: 12 transaction_count_day: description: | Number of successful and abandoned transactions from this account cardholder with your ecommerce in the last 24 hours. type: integer minimum: 0 maximum: 999 example: 1 add_card_attempts: description: | Number of attempts to add card in the last 24 hours. type: integer minimum: 0 maximum: 999 example: 1 customer_id: description: | Identification document number (NATIONAL, CPF, CPNJ, CURP, SSN, DRIVER_LICENSE). type: string maxLength: 26 example: '12345678912' customer_type_id: description: | Type of ID. type: string maxLength: 14 enum: - NATIONAL - CPF - CPNJ - CURP - SSN - DRIVER_LICENSE example: CPF payment_account_history: description: | Indicates the type of payment account. This applies only to NEWACCOUNT and EXISTINGACCOUNT in the creation_history. type: string maxLength: 23 enum: - PAYMENTACCOUNTEXISTS - PAYMENTACCOUNTADDED_NOW payment_account_date: description: | Date of creation of the payment account. This applies only to PAYMENTACCOUNTEXISTS in the payment_account_history. type: string minLength: 8 maxLength: 8 format: YYYYMMDD example: '20191125' prior_suspicious_activity: description: | Indicates whether ecommerce has had suspicious activity (including fraud previous) in the account. type: boolean example: false account: $ref: '#/definitions/3ds_account_ref' 3ds_recurring_ref: type: object description: Data set for recorente payment. properties: end_date: description: | Date after which no additional recurring authorisation should be Held.
Note: This field is required for recurring transactions. type: string minLength: 8 maxLength: 8 format: YYYYMMDD example: '20191201' frequency: description: | Indicates the minimum number of days between applications for authorisation of recurring transactions. A monthly frequency is indicated by the 28. Multiples of 28 days will be used to indicate months.
Example: 6 months = 168
Note: This field is required for recurring transactions. type: integer minimum: 0 maximum: 999 example: 4 original_purchase_date: description: | Date of original purchase. Required for recurring transactions.
Note: If this field is empty, the current date will be Used. type: string minLength: 17 maxLength: 17 format: YYYYMMDD:HH:MM:SS example: '20191201:13:40:23' 3ds_card_ref: type: object description: Card data set. required: - number_token - expiration_month - expiration_year - type_card properties: number_token: type: string description: Tokenized card number. example: dfe05208b105578c070f806c80abd3af09e246827d29b866cf4ce16c205849977c9496cbf0d0234f42339937f327747075f68763537b90b31389e01231d4d13c minLength: 128 maxLength: 128 expiration_month: type: string description: | Two-digit card expiration month. Required if card data was not permanently stored with the token. minLength: 2 maxLength: 2 example: '12' expiration_year: type: string description: | Two-digit card expiration year. Required if card data was not permanently stored with the token. minLength: 4 maxLength: 4 example: '2019' type_card: type: string description: | Indicates the flag type code.
001 = Visa
002 = Mastercard
003 = Amex
054 = ELO minLength: 3 maxLength: 3 enum: - '001' - '002' - '003' - '054' example: '001' default_card: description: | Indicates that the card in use is the one designated as the payment card main for purchase. type: boolean example: false 3ds_order_ref: type: object description: Set of data to identify the purchase. required: - currency - product_code properties: product_code: 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 = Transaction almost cash
28 = Prepaid activation and account financing type: string default: '01' maxLength: 2 example: '01' enum: - '01' - '03' - '10' - '11' - '28' currency: type: string description: | Currency identification (See code in "https://www.currency-iso.org/en/home/tables/table-a1.html"). example: BRL minLength: 3 maxLength: 3 default: BRL total_amount: description: Total value of the item/product in cents of the order. type: integer example: 1000 bill_to: $ref: '#/definitions/3ds_bill_to_ref' items: $ref: '#/definitions/3ds_item_array_ref' ship_to: $ref: '#/definitions/3ds_ship_to_ref' 3ds_bill_to_ref: type: object description: Collection address dataset. required: - mobile_phone properties: address1: description: | First line of the cardholder's billing address associated with the card used in the purchase. type: string minLength: 0 maxLength: 60 example: Rua XXXX, XX address2: description: | Second line of the carrier's billing address associated with the card used in the purchase. Additional address information. type: string minLength: 0 maxLength: 60 example: Apartamento XX administrative_area: description: | State (UF) of the carrier's billing address associated with the card used in the purchase. type: string minLength: 2 maxLength: 2 example: RS country: description: | Country of the billing address of the cardholder associated with the card used on purchase (See code in "https://www.iso.org/iso-3166-country-codes.html"). type: string minLength: 2 maxLength: 2 example: BR email: description: | Email address associated with the account that was informed by the carrier or was already stored in prior registration by 3DS Requestor. type: string minLength: 0 maxLength: 255 example: customer@email.com first_name: description: Customer's first name. This name must be the same as the name on the Card. type: string minLength: 0 maxLength: 60 example: João last_name: description: Customer's last name. This last name must be the same as the last name on the card. type: string minLength: 0 maxLength: 60 example: da Silva locality: description: | City of the billing address of the cardholder associated with the card used in the purchase. type: string minLength: 0 maxLength: 50 example: Porto Alegre mobile_phone: description: | Carrier-provided mobile number. (without mask) Code of country: 1–3 characters type: string minLength: 0 maxLength: 15 example: '5551999887766' phone_number: description: | Phone number provided by the carrier. (without mask) Code of country: 1–3 characters type: string minLength: 0 maxLength: 15 example: '555199988776' postal_code: description: | Zip code of the carrier's billing address associated with the card used in the purchase. type: string minLength: 5 maxLength: 10 example: '90230060' 3ds_account_ref: type: object description: Customer account dataset. properties: modification_history: description: | Account change history. This field is applicable only in the case of EXISTING_ACCOUNT in the creation_history. type: string maxLength: 18 example: ACCOUNTUPDATEDNOW enum: - ACCOUNTUPDATEDNOW - ACCOUNTUPDATEDPAST account_purchases: description: | Number of purchases with this cardholder's account during the last six months in your ecommerce. type: integer minimum: 0 maximum: 9999 example: 4 shipping_address_usage_date: description: | Date the delivery address for this transaction was used by the first time. If first_use_of_shipping_address is false and is not a guest account, that date will be entered. type: string minLength: 10 maxLength: 10 format: YYYY-MM-DD example: '2019-11-25' first_use_of_shipping_address: description: | First use of the delivery address ordered by the carrier. Applicable when the account is not a GUEST account. type: boolean example: false last_change_date: description: | Date of the last change of the cardholder's account details in the your ecommerce, including billing or delivery address, new account or new added users. type: string minLength: 10 maxLength: 10 format: YYYY-MM-DD example: '2019-11-25' created_date: description: | Date the cardholder opened the account. This applies only to EXISTING_ACCOUNT in creation_history. type: string minLength: 10 maxLength: 10 format: YYYY-MM-DD example: '2019-11-25' creation_history: description: | Type of account that the cardholder has with his ecommerce. type: string maxLength: 16 example: NEW_ACCOUNT enum: - GUEST - NEW_ACCOUNT - EXISTING_ACCOUNT password_changed_date: description: | Date on which the cardholder's account with his ecommerce had password change or account reset. This applies only to PASSWORDCHANGEDPAST in the password_history. type: string minLength: 10 maxLength: 10 format: YYYY-MM-DD example: '2019-11-25T00:00:00.000Z' password_history: description: | Indicates whether the cardholder's account with your ecommerce has had a password change or account password reset. This applies to just the EXISTING_ACCOUNT np field creation_history. type: string maxLength: 19 example: PASSWORDCHANGEDNOW enum: - PASSWORDCHANGEDNOW - PASSWORDCHANGEDPAST 3ds_authentications_resp_card_ref: type: object description: Card data set. properties: number_token: type: string description: | Token card that will be used in transactions. If the answer HTTP contains the header "Content-Encoding:gzip" ( RFC 2616 topic 14.11 Content-Encoding ) the response must go through a process of decompression, depending on the technology used for integration use of a third-party library will be required. example: dfe05208b105578c070f806c80abd3af09e246827d29b866cf4ce16c205849977c9496cbf0d0234f42339937f327747075f68763537b90b31389e01231d4d13c minLength: 128 maxLength: 128 3ds_authentications_resp_client_reference_information_ref: type: object description: Customer reference data set. properties: code: type: string description: | 3DS authentication session identifier code. The returned value follows the form of a string composed of [client_code] + [-] + [UUID] (Example: client_code-00000000-0000-0000-0000-0000000000000). The value client_code to the value sent in the endpoint resquest /v1/3ds/tokens. maxLength: 13 3ds_authentications_resp_consumer_authentication_information_ref: type: object description: Consumer authentication dataset. properties: acs_url: type: string description: | URL to the authentication form of the issuing bank of the card that you receive when the card is enrolled. example: https://merchantacsstag.cardinalcommerce.com/MerchantACSWeb/pareq.jsp?vaa=b&gold=AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA maxLength: 2048 authentication_path: example: ADS description: | Indicates what is displayed to the client during the Authentication. This field can contain one of these values:
ADS = customer (not enrolled card) asked to activate the card during the checkout process.
ATTEMPTS = (attempt processing) the processing is displayed briefly before the checkout process is completed.
ENROLLED = (Enrolled Card) window authentication of the card issuer is displayed.
UNKNOWN = status of enrollment of the card cannot be determined.
NOREDIRECT = (not enrolled card, unavailable authentication or error) nothing is displayed to the customer.
The following values can be returned if you are using rules-based payer authentication.
RIBA = the card issuing bank supports authentication based on but it is not possible to determine whether the cardholder is liable to of challenge.
RIBA_PASS = card issuing bank supports risk-based authentication and it is likely that the cardholder will not challenged to provide credentials, also known as silent authentication. maxLength: 12 enum: - ADS - ATTEMPTS - ENROLLED - UNKNOWN - NOREDIRECT - RIBA - RIBA_PASS authentication_transaction_id: type: string description: | The identifier of the last payer authentication transaction for link the verification enrollment and validate the verification messages Authentication. example: gz3aQ1z6YBS8kK4B0A40 maxLength: 20 pareq: type: string description: | Payer authentication request (PAReq) message that needs to be forwarded to the CHA. 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 the elements VEReq and VERes. 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 the payer's authentication request. example: 3291969 specification_version: type: string description: | This field contains the 3D Secure version that was used to process the Transaction. example: 2.0.0 maxLength: 10 veres_enrolled: example: 'Y' minLength: 1 maxLength: 1 description: | Enrollment check result.
This field may contain one of these values:
Y = enrolled card or can be enrolled; you must authenticate yourself. Change of responsibility.
N = not enrolled card; continue with the authorisation. Change of Responsibility.
U = cannot authenticate regardless of the reason. No change of responsibility. enum: - 'Y' - 'N' - U xid: description: | Field available from version 2.0. MPI identifier for each authenticated transaction. The contents of the field can be a HEXA value or Base64, according to the MPI used. type: string maxLength: 255 example: ODZ3MlMyZFpMZG5DRmJPUnM1ODA= token: type: string description: | Token example: AxjzbwSTOJ/N1W2cYUdd/+YBUaf/qJNr7RTZSQkiIZNJMvRiueI7APAAqRQK 3ds_authentications_resp_error_information_ref: type: object description: Error information. properties: reason: type: string description: The reason for the status. 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 example: Este campo não está sendo devolvido pela API cybersource. description: The message describing the reason for the status. 3ds_results_ref: type: object required: - currency - override_payment_method - total_amount properties: currency: type: string description: | Currency identification (See code in "https://www.currency-iso.org/en/home/tables/table-a1.html"). example: BRL minLength: 3 maxLength: 3 default: BRL override_payment_method: description: | Indicates the type of account.
02 = Credit
03 = Debit type: string minLength: 2 maxLength: 2 example: '02' enum: - '02' - '03' token: description: Token type: string token_challenge: description: Token returned in the challenge. type: string total_amount: description: Total value of the item/product in cents of the order. type: integer example: 1000 card: $ref: '#/definitions/3ds_card_ref' additional_data: description: Additional Data type: object example: null additional_object: description: Additional Objetc type: object example: null 3ds_authentication_results_resp_consumer_authentication_information_ref: type: object description: Consumer authentication dataset. properties: authentication_result: type: string description: 'Primary authentication field that indicates whether authentication went well and whether the change of responsibility occurred.
This field contains one of these values:
-1: Invalid PARes,
0: Successful validation,
1: Cardholder is not authentication attempt was recorded,
6: Issuer unable to perform authentication,
9: Cardholder has not completed authentication.' example: 0 maxLength: 1 enum: - '-1' - '0' - '1' - '6' - '9' authentication_status_msg: type: string description: | Message that explains the authenticationresult of the response field. example: Success indicator: type: string example: spa maxLength: 1 description: Indicator used to differentiate Internet transactions from others types.
The value of this field is automatically passed on to the authorization service if you request the services together.
enum: - aesk - aesk_attempted - dipb - dipb_attempted - internet - js - js_attempted - moto - pb_attempted - recurring - spa - spa_failure - vbv - vbv_attempted - vbv_failure eci: description: | Field available from version 2.0. Transaction ECI Code Authenticated 3D Secure. Generated by an external MPI. type: string minLength: 2 maxLength: 2 pares_status: type: string example: 'Y' minLength: 1 maxLength: 1 description: 'Result of authentication verification.
This field may contain one of these values:
A: Proof of attempt to authentication.
B: Authentication circumvented.
N: The customer failed or canceled authentication. Transaction denied.
R: Authentication rejected (used only for 3D Secure 2.0 transactions)
U: Authentication not completed regardless of the reason.
Y: The client has been successfully authenticated.' enum: - A - B - 'N' - R - U - 'Y' specification_version: type: string description: 'This field contains the 3D Secure version that was used to process the Transaction. ' xid: description: | Field available from version 2.0. MPI identifier for each authenticated transaction. The contents of the field can be a HEXA value or Base64, according to the MPI used. type: string minLength: 40 maxLength: 40 token: type: string description: Token cavv_algorithm: type: string example: 2 maxLength: 1 description: 'Field that is returned only when cavv is generated, which occurs when pairsStatus contains the Y (successful authentication) or A (authentication attempt).
This field contains one of these values:
2: Visa, American Express, JCB, Diners Club and Discover
3: Mastercard' enum: - '2' - '3' ucaf: description: | Field available from version 2.0. Authentication code encrypted by the Flag. The contents of the field can be a value HEXA or Base64, according to the MPI used. type: string minLength: 40 maxLength: 40 ucaf_authentication_data: type: string example: jELUbgG+Tfj0AREACMLdCae+oIs= description: AAV is a unique identifier generated by the card bank for Mastercard SecureCode transactions after the client is authenticated. ucaf_collection_indicator: type: string example: 2 minLength: 1 maxLength: 1 description: 'For registration, returned only for mastercard.
Indicates that authentication is not required because the client is not registered.
This field contains one of these values:
0: Data authentication not collected, and client authentication was not Completed.
1: Authentication data not collected because the authentication of the client has not completed.
2: Data from authentication collected because the client has completed authentication.' enum: - '0' - '1' - '2' cavv: type: string description: 'Unique identifier generated by the issuing bank after the customer is authenticated. ' example: AAABAWFlmQAAAABjRWWZEEFgFz+= maxLength: 255 3ds_payments_authenticated_ref: type: object required: - order_id - amount - payment_method - transaction_type - dynamic_mcc properties: order_id: type: string description: | Identification code of the purchase used by e-commerce (code or order number). example: 6d2e4380-d8a3-4ccb-9138-c289182818a3 maxLength: 36 amount: description: Transaction amount in cents. type: integer example: 19990 currency: type: string description: | Currency identification (See code in "https://www.currency-iso.org/en/home/tables/table-a1.html"). example: BRL minLength: 3 maxLength: 3 default: BRL transaction_type: description: | Transaction type. Full payment in cash, installments without interest, installment staked with interest. type: string enum: - FULL - INSTALL_NO_INTEREST - INSTALL_WITH_INTEREST example: FULL number_installments: type: number description: Number of installments for a installment credit transaction. example: 1 xid: description: | Field available from version 2.0. MPI identifier for each authenticated transaction. The contents of the field can be a HEXA value or Base64, according to the MPI used. type: string minLength: 40 maxLength: 40 ucaf: description: | Field available from version 2.0. Authentication code encrypted by the Flag. The contents of the field can be a value HEXA or Base64, according to the MPI used. type: string minLength: 40 maxLength: 40 eci: description: | Field available from version 2.0. Transaction ECI Code Authenticated 3D Secure. Generated by an external MPI. type: string minLength: 2 maxLength: 2 tdsdsxid: description: Transaction identifier of the 3DS server version 2. type: string example: dbdcb82d-63c5-496f-ae27-1ecfc3a8dbec tdsver: description: Indicates the 3DS version used in authentication type: string example: 2.1.0 payment_method: description: Type of credit or debit transaction type: string enum: - CREDIT - DEBIT - CREDIT_PRE_AUTHORIZATION - CREDIT_AUTHORIZATION dynamic_mcc: type: number maxLength: 4 minLength: 4 description: | Field used to flag transaction with another Merchant Category Code (Establishment Category Code) different from the registered one. If an invalid MCC is sent, the default will be used. Send only numerical data. example: 1799 soft_descriptor: type: string description: Description for the card invoice. example: Descrição para fatura maxLength: 22 customer_id: description: Buyer's identifier. type: string maxLength: 36 card: $ref: '#/definitions/3ds_payments_authenticated_card_ref' credentials_on_file_type: type: string description: |
Tipo do COF (Credential On File).

ONE_CLICK: Usado quando é realizado a primeira transação (parcela) de um pagamento normal.

ONE_CLICK_PAYMENT: Usado quando é realizado transações para as demais parcelas restantes de um pagamento normal. Obs: Necessário informar o transaction_id da primeira transação realizada.

RECURRING: Usado quando é realizado a primeira transação (parcela) de um pagamento recorrente.

RECURRING_PAYMENT: Usado quando é realizado transações para as demais parcelas restantes de um pagamento recorrente. Obs: Necessário informar o transaction_id da primeira transação realizada.

enum: - ONE_CLICK - ONE_CLICK_PAYMENT - RECURRING - RECURRING_PAYMENT example: ONE_CLICK_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' gateway_id: type: string description: | Merchant Payment Gateway ID. example: '00000999998' 3ds_payments_authenticated_card_ref: type: object description: Card data set. required: - number_token - brand - expiration_month - expiration_year properties: number_token: type: string description: | Tokenized card number. Generated through the endpoint /v1/tokens/card. example: dfe05208b105578c070f806c80abd3af09e246827d29b866cf4ce16c205849977c9496cbf0d0234f42339937f327747075f68763537b90b31389e01231d4d13c minLength: 128 maxLength: 128 security_code: type: string description: Security code. CVV or CVC. minLength: 3 maxLength: 4 example: '123' expiration_month: type: string description: Two-digit card expiration month. minLength: 2 maxLength: 2 example: '12' expiration_year: type: string description: Four-digit card expiration year. minLength: 4 maxLength: 4 example: '2019' cardholder_name: type: string description: Buyer's name printed on card maxLength: 26 example: JOAO DA SILVA 3ds_payments_authenticated_res_ref: type: object description: Credit payment response data set. properties: payment_id: type: string description: Payment identification code. format: uuidv4 example: 06f256c8-1bbf-42bf-93b4-ce2041bfb87e minLength: 36 maxLength: 36 seller_id: type: string description: E-commerce identification code. format: uuidv4 example: 6eb2412c-165a-41cd-b1d9-76c575d70a28 minLength: 36 maxLength: 36 amount: type: integer description: Purchase amount in cents. example: 100 currency: type: string description: | Currency identification (See code in "https://www.currency-iso.org/en/home/tables/table-a1.html"). example: BRL minLength: 3 maxLength: 3 default: BRL order_id: type: string description: | Identification code of the purchase used by e-commerce (code or order number). example: 6d2e4380-d8a3-4ccb-9138-c289182818a3 maxLength: 36 status: type: string description: | Transaction status. For more information on return status, see at Notifications 1.0 or Notifications 1.1. example: APPROVED enum: - CANCELED - APPROVED - DENIED - AUTHORIZED - CONFIRMED maxLength: 20 payment_method: type: string description: Transaction type. received_at: type: string description: Date and time of payment registration. format: YYYY-MM-DDTHH:mm:ss.SSSZ example: '2017-03-19T16:30:30.764Z' maxLength: 24 transaction_id: type: string description: Confirmation transaction code. original_transaction_id: type: string description: Authorization transaction code. authorized_at: type: string description: Date/time of credit authorization. format: YYYY-MM-DDTHH:MM:SSZ example: '2017-03-19T16:30:30Z' reason_code: type: string description: Return code of the sender or capture system of the getnet. example: '00' minLength: 1 maxLength: 5 reason_message: type: string description: Return message from the sender or getnet capture system. example: transaction approved maxLength: 250 acquirer: type: string description: Name of the purchaser. example: GETNET maxLength: 30 soft_descriptor: type: string description: Description for the card invoice. example: Descrição para fatura maxLength: 22 brand: type: string description: Flag responsible for processing the transaction. example: Mastercard maxLength: 50 enum: - Mastercard - Visa - Amex - Elo - Hipercard authorization_code: type: string description: Authorization code. example: '6964722471672911' minLength: 1 maxLength: 18 acquirer_transaction_id: type: string description: Transaction code of the acquirer. example: '160453221' maxLength: 20 eci: description: | Field available from version 2.0. Transaction ECI Code Authenticated 3D Secure. Generated by an external MPI. type: string minLength: 2 maxLength: 2 ucaf: description: | Field available from version 2.0. Authentication code encrypted by the Flag. The contents of the field can be a value HEXA or Base64, according to the MPI used. type: string minLength: 40 maxLength: 40 xid: description: | Field available from version 2.0. MPI identifier for each authenticated transaction. The contents of the field can be a HEXA value or Base64, according to the MPI used. type: string minLength: 40 maxLength: 40 total_installment_amount: type: number description: Total installment value. example: 50 first_installment_amount: type: number description: Value of the first installment. example: 50 other_installment_amount: type: number description: Value of other installments. example: 50 3ds_payments_authenticated_pre_res_ref: type: object description: Credit payment response data set. properties: payment_id: type: string description: Payment identification code. format: uuidv4 example: 06f256c8-1bbf-42bf-93b4-ce2041bfb87e minLength: 36 maxLength: 36 seller_id: type: string description: E-commerce identification code. format: uuidv4 example: 6eb2412c-165a-41cd-b1d9-76c575d70a28 minLength: 36 maxLength: 36 amount: type: integer description: Purchase amount in cents. example: 100 currency: type: string description: | Currency identification (See code in "https://www.currency-iso.org/en/home/tables/table-a1.html"). example: BRL minLength: 3 maxLength: 3 default: BRL order_id: type: string description: | Identification code of the purchase used by e-commerce (code or order number). example: 6d2e4380-d8a3-4ccb-9138-c289182818a3 maxLength: 36 status: type: string description: | Transaction status. For more information on return status, see at Notifications 1.0 or Notifications 1.1. example: AUTHORIZED enum: - PENDING - CANCELED - APPROVED - DENIED - AUTHORIZED - CONFIRMED - EXPIRED - UNPROCESSED maxLength: 20 payment_method: type: string description: Transaction type. received_at: type: string description: Date and time of payment registration. format: YYYY-MM-DDTHH:mm:ss.SSSZ example: '2017-03-19T16:30:30.764Z' maxLength: 24 transaction_id: type: string description: Confirmation transaction code. authorized_at: type: string description: Date/time of credit authorization. format: YYYY-MM-DDTHH:MM:SSZ example: '2017-03-19T16:30:30Z' reason_code: type: string description: Return code of the sender or capture system of the getnet. example: '00' minLength: 1 maxLength: 5 reason_message: type: string description: Return message from the sender or getnet capture system. example: transaction approved maxLength: 250 acquirer: type: string description: Name of the purchaser. example: GETNET maxLength: 30 soft_descriptor: type: string description: Description for the card invoice. example: Descrição para fatura maxLength: 22 brand: type: string description: Flag responsible for processing the transaction. example: Mastercard maxLength: 50 enum: - Mastercard - Visa - Amex - Elo - Hipercard authorization_code: type: string description: | Authorization code. example: '6964722471672911' minLength: 1 maxLength: 18 acquirer_transaction_id: type: string description: Transaction code of the acquirer. example: '160453221' maxLength: 20 eci: description: | Field available from version 2.0. Transaction ECI Code Authenticated 3D Secure. Generated by an external MPI. type: string minLength: 2 maxLength: 2 ucaf: description: | Field available from version 2.0. Authentication code encrypted by the Flag. The contents of the field can be a value HEXA or Base64, according to the MPI used. type: string minLength: 40 maxLength: 40 xid: description: | Field available from version 2.0. MPI identifier for each authenticated transaction. The contents of the field can be a HEXA value or Base64, according to the MPI used. type: string minLength: 40 maxLength: 40 total_installment_amount: type: number description: Total installment value. example: 50 first_installment_amount: type: number description: Value of the first installment. example: 50 other_installment_amount: type: number description: Value of other installments. example: 50 3ds_payments_authenticated_confirm_ref: type: object required: - payment_method properties: payment_method: description: Transaction type. type: string enum: - CREDIT_PRE_AUTHORIZATION - CREDIT_AUTHORIZATION amount: description: Transaction amount in cents. type: integer example: 19990 3ds_payments_authenticated_confirm_res_ref: type: object description: | Credit payment confirmation response data set Late. properties: payment_id: type: string description: Payment identification code. minLength: 36 maxLength: 36 format: uuidv4 example: 331b0b07-6e37-4bd9-a37b-99156cb34104 seller_id: type: string description: E-commerce identification code. minLength: 36 maxLength: 36 format: uuidv4 example: 8f840ea0-b7d1-42f5-ad78-5a5521e3125f amount: type: integer description: Purchase amount in cents. example: 200000 currency: type: string description: | Currency identification (See code in "https://www.currency-iso.org/en/home/tables/table-a1.html"). minLength: 3 maxLength: 3 example: BRL default: BRL order_id: type: string description: | Identification code of the purchase used by e-commerce (code or order number). example: 6d2e4380-d8a3-4ccb-9138-c289182818a3 maxLength: 36 status: type: string description: | Transaction status. For more information on return status, see at Notifications 1.0 or Notifications 1.1. example: CONFIRMED enum: - CONFIRMED - ERROR - DENIED maxLength: 20 confirmed_at: type: string description: Date/time of credit confirmation. reason_code: type: string description: Return code. example: '00' minLength: 1 maxLength: 5 reason_message: type: string description: Return message. example: transaction approved maxLength: 250 3ds_payments_authenticated_adjustment_ref: type: object required: - amount - payment_method properties: amount: description: Transaction amount in cents. type: integer example: 19990 payment_method: description: Transaction type. type: string enum: - CREDIT_PRE_AUTHORIZATION 3ds_payments_authenticated_adjustment_res_ref: type: object description: Pre-authorization value adjustment response dataset. properties: payment_id: type: string description: Payment identification code. format: uuidv4 example: 06f256c8-1bbf-42bf-93b4-ce2041bfb87e minLength: 36 maxLength: 36 seller_id: type: string description: E-commerce identification code. format: uuidv4 example: 6eb2412c-165a-41cd-b1d9-76c575d70a28 minLength: 36 maxLength: 36 amount: type: integer description: Adjusted value in cents. example: 19990 currency: type: string description: | Currency identification (See code in "https://www.currency-iso.org/en/home/tables/table-a1.html"). example: BRL minLength: 3 maxLength: 3 default: BRL order_id: type: string description: | Identification code of the purchase used by e-commerce (code or order number). example: 6d2e4380-d8a3-4ccb-9138-c289182818a3 maxLength: 36 status: type: string description: | Transaction status. For more information on return status, see at Notifications 1.0 or Notifications 1.1. example: APPROVED enum: - APPROVED - DENIED maxLength: 20 adjustment_transaction_id: type: string description: Adjustment transaction code. original_transaction_id: type: string description: Authorization transaction code. authorization_code: type: string description: Credit authorization code. example: '000000099999' maxLength: 20 authorized_at: type: number description: Date/time of credit authorization. format: YYYY-MM-DDTHH:MM:SSZ example: '2017-03-19T16:30:30Z' maxLength: 24 received_at: type: string description: Date and time of payment registration. format: YYYY-MM-DDTHH:mm:ss.SSSZ example: '2017-03-19T16:30:30.764Z' maxLength: 24 brand: type: string description: Flag responsible for processing the transaction. example: Mastercard maxLength: 50 enum: - Mastercard - Visa - Amex - Elo - Hipercard reason_code: type: string description: Return code. example: 0 minLength: 1 maxLength: 5 reason_message: type: string description: Return message. example: transaction approved maxLength: 250 acquirer: type: string description: Name of the purchaser. example: GETNET maxLength: 30 soft_descriptor: type: string description: Description for the card invoice. example: Descrição para fatura maxLength: 22 acquirer_transaction_id: type: string description: Transaction code of the acquirer. example: '160453221' maxLength: 20 adjustment_acquirer_transaction_id: type: string description: You purchaser's adjustment transaction code. example: '160453231' maxLength: 20 total_installment_amount: type: number description: Total installment value. example: 50 first_installment_amount: type: number description: Value of the first installment. example: 50 other_installment_amount: type: number description: Value of other installments. example: 50 3ds_payments_authenticated_cancel_ref: type: object required: - payment_method properties: payment_method: description: Transaction type. type: string enum: - CREDIT - DEBIT - CREDIT_PRE_AUTHORIZATION - CREDIT_AUTHORIZATION 3ds_payments_authenticated_cancel_res_ref: type: object description: | Credit cancellation response data set complete or with late confirmation. properties: payment_id: type: string description: Payment identification code. minLength: 36 maxLength: 36 format: uuidv4 example: f3b54da1-0753-4dcf-ac92-48721d2ff553 seller_id: type: string description: E-commerce identification code. minLength: 36 maxLength: 36 format: uuidv4 example: 8f840ea0-b7d1-42f5-ad78-5a5521e3125f amount: type: integer description: Purchase amount in cents. example: 500000 currency: type: string description: | Currency identification (See code in "https://www.currency-iso.org/en/home/tables/table-a1.html"). minLength: 3 maxLength: 3 example: BRL default: BRL order_id: type: string description: | Identification code of the purchase used by e-commerce (code or order number). example: 6d2e4380-d8a3-4ccb-9138-c289182818a3 maxLength: 36 status: type: string description: | Transaction status. For more information on return status, see at Notifications 1.0 or Notifications 1.1. example: CANCELED enum: - CANCELED - ERROR - DENIED maxLength: 20 canceled_at: type: string description: Date/time of receipt of the transaction. format: YYYY-MM-DDTHH:mm:ss.SSSZ example: '2018-07-22T18:47:32.270Z' maxLength: 24 reason_code: type: string description: Return code. example: '00' minLength: 1 maxLength: 5 reason_message: type: string description: Return message. example: transaction approved maxLength: 250 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' errorgetpay401: type: object properties: message: type: string description: Detailed error message. maxLength: 250 example: Unauthorized name: type: string description: Name of the module or system where the error occurred. maxLength: 250 example: GatewayAuthenticationOAuth2ServiceError status_code: type: number description: HTTP Status code. example: 401 details: type: array description: Error details. items: $ref: '#/definitions/array' array: type: object properties: status: type: string description: Detailed error message. maxLength: 250 example: DENIED error_code: type: string description: Name of the module or system where the error occurred. maxLength: 250 example: AUTHENTICATION-401 description: type: number description: HTTP Status code. example: UnAuthorized description_detai: type: string description: Error details. example: Invalid cliente credentials error_table: type: object properties: message: type: string description: Detailed error message. maxLength: 250 name: type: string description: Name of the module or system where the error occurred. maxLength: 250 status_code: type: number description: HTTP Status code. details: type: array description: For more details, check the Error Table. items: $ref: '#/definitions/empty' error_authentication: type: object properties: error: type: string description: Error message. error_description: type: string description: Error description. error_payment_subscription_detail: type: object properties: acquirer_transaction_id: type: string description: Transaction code. maxLength: 36 description: type: string description: characters Transaction description. maxLength: 250 description_detail: type: string description: details on transaction description. 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: Transaction Status. maxLength: 36 terminal_nsu: type: string description: NSU (Unique Sequential Number) Terminal Code. maxLength: 36 error_payment_subscription: type: object description: Payment return error details in case of failure status in the creation of the Signature. properties: message: type: string description: Detailed message on the error in the event the subscription status is the same as 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, check the Errors Table. items: $ref: '#/definitions/error_payment_subscription_detail' consulta_bin_response: type: object properties: results: type: array items: $ref: '#/definitions/results' status: type: string description: BIN Status return message. title: consulta_bin_response xml: name: consulta_bin_response attribute: false wrapped: false results: type: object description: List of BIN information. properties: bin: type: integer description: Searched BIN. minLength: 6 maxLength: 9 brand: type: string description: Brand name. brand_code: type: integer description: Brand conde. brazilian_issued: type: string description: Informs if the issuer is from Brazil. country: type: string description: Country name. country_code: type: string description: Numeric country code. country_code_iso: type: string description: Country ISO_3166-1 code. issuer: type: string description: Issuer name. product: type: string description: Product linked to BIN. type: type: string description: BIN type. enum: - credit - debit - both - prepaid title: results xml: name: results attribute: false wrapped: false empty: type: object properties: {}

amount	Time	Status	Pulling Description	Checkout Status
9000	10 s	APPROVED	The PIX paymen was made successfully.(00)	Successfully completed transaction.
9088	-	DENIED	Unable to perform PIX transaction.(AF-88)	Unable to make payment.

Payment Link | Digital Platform