Getnet DocsGetnet Docs

Authorize

View as MarkdownView this page as plain textOpen in ChatGPTAsk questions about this pageOpen in ClaudeAsk questions about this pageOpen in PerplexityAsk questions about this page
Connect to CursorUse these docs in CursorConnect to VS CodeUse these docs in VS Code
POST/dpm/payments-gwproxy/v2/payments/combined

Splitting a Transaction Across Multiple Cards

This endpoint allows you to authorize a combined payment using multiple cards. It is typically used when a buyer wishes to split the total amount across two or more payment methods.

Usage Scenarios:
- Offering flexibility to the customer in payment options.
- Handling split transactions for marketplaces or platforms.

Notes:
- Only card-based payments are allowed. APMs like PIX and Boleto are not supported.
- This flow is valid only for card-not-present (e-commerce) scenarios.
- The field combined_id in the response is used to track the overall transaction.
- Each card must be represented as an object inside the payments array.

Header Parameters

x-transaction-channel-entrystring

Field used to identify the platform that will be sending the transaction

(The code to be informed must be previously requested from GetNet)

Body application/json

request_idstring<uuid>

Request identifier. Unique for each request

order_idstring

Purchase identification code used by e-commerce (code or order number).

dataobject

Data set to be encrypted

Show data properties
amountinteger

Purchase value in cents. It must be an integer.

currencystring

Currency identification (See code in this section).

customer_idstring

Buyer identifier used by e-commerce. Case be informed it will be passed on in the PIX Payment Notification.

paymentsobject[]required
Show payments properties
idempotency_keystring<(a-Z | 0-9 | .-_)>

Idempotency key, used to control requests, must be unique per request, because if it is repeated, it will always be returned the same data.

payment_idstring<uuid>

Payment identifier

amountinteger

Purchase value in cents. It must be an integer.

payment_method"CREDIT" | "DEBIT" | "CREDIT_AUTHORIZATION" | "CREDIT_PRE_AUTHORIZATION" | "INSTANT_TRANSFER" | "INSTANT_TRANSFER_PREAUTH"

Payment method type for the transaction:

  • CREDIT: Credit card payment (single-step, immediate capture)
  • DEBIT: Debit card payment
  • CREDIT_AUTHORIZATION: Credit card authorization (two-step, capture later)
  • CREDIT_PRE_AUTHORIZATION: Credit card pre-authorization
  • INSTANT_TRANSFER: Instant payment (single-step, immediate capture)
  • INSTANT_TRANSFER_PREAUTH: Instant payment pre-authorization (two-step, capture within 30 days)
save_card_databoolean

Determine whether the card should be saved for future purchases. Only for customers using the GetNet vault.

transaction_type"FULL" | "INSTALL_NO_INTEREST" | "INSTALL_WITH_INTEREST"

Transaction type. Payment in cash or in installments to the retailer or in installments to the issuer.

number_installmentsnumber

Number of installments.

soft_descriptorstring

Text displayed on the buyer’s card invoice. The field is optional. When you leave it empty, Getnet uses the trade name registered for the establishment. Getnet keeps letters, digits, spaces, and the asterisk. Accented characters are converted to their unaccented equivalent, so AÇÃO becomes ACAO. Every other character is removed. Values longer than 22 characters are truncated rather than rejected.

dynamic_mccstring

Merchant Category Code used to signal the transaction with an MCC different from the one registered for the merchant. Send digits only. Getnet left-pads values shorter than four digits with zeros, so “799” is processed as “0799”. If you send an invalid MCC, Getnet uses the registered one.

The card schemes require this field for Payment Facilitators and SDWO.

cardobject

Card data set.

Show card properties
card_idstring

Identifier of a card stored in the Getnet vault. Send only this field to reuse a stored card. Getnet retrieves the card data (number_token, cardholder_name, expiration_month, expiration_year, and brand) from the vault and populates it transparently, so you do not need to send number, number_token, or the other card fields. Obtain the card_id from the Store Card in Vault response or from a previous payment.

numberstring

For Card not Present, send Card number (send only when the number_token and card_id fields are not sent).

For Card Present, send Card number. Send it when entry_mode is manual or manual_with_pass.

Getnet requires this element for CREDIT transactions and rejects the request when it is missing. The DIRECT_* card-present methods accept a request without it.
You can find test cards here.

expiration_monthstring

Two-digit card expiry month.

expiration_yearstring

Two-digit card expiry year.

cardholder_namestring

Buyer’s name printed on the card.
Mandatory field for Antifraude

security_codestring

Security code. CVV or CVC.
Mandatory field for Antifraude

brand"MASTERCARD" | "VISA" | "AMEX" | "ELO" | "HIPERCARD"

Card flag. Automatically populated by the API if not informed.
Mandatory field for Antifraude

number_tokenstring

Tokenized card number (send only when the number and card_id fields are not sent).

entry_modestring

For Card Present Card entry mode.

The values card_on_file and recurring apply only when the value of transaction_channel_type is recurring.

seq_numberstring

For Card Present

pin_blockstring

For Card Present: PIN block. A PIN block consists of the PIN entered by the cardholder which has been encrypted by a PIN-pad.

Countries where online PIN validation is mandatory for card payments require this element. Send it in those countries. The value is stored in the Hardware Secure Module (HSM).

pin_key_idstring

For Card Present

ksnstring

For Card Present: KSN (Key Serial Number). The value is the DUKPT (Derived Unique Key Per Transaction) process key concatenated with the transaction counter.

Countries where online PIN validation is mandatory for card payments require this element. Send it in those countries.

The value must be in ASCII format with 20 hexadecimal digits where the left is aligned with trailing spaces.

emvstring

For Card Present: EMV tag data collected from the ICC (Integrated Circuit Card). This element is required if the value of entry_mode is chip or chip_contactless.

The data must be in TLV format.

For a list of all EMV tags and whether they are required, see the EMV tags document.

aidstring

For Card Present

cardholder_verification_method"offline_pin" | "online_pin" | "signature" | "no_cvm" | "fail_cvm_processing"

For Card Present

aggregator"siscard"

For Card Present

service_codeobject

For Card Present: card service code data set.

Show service_code properties
interchange"international" | "national_only" | "not_available"

Where the card is accepted for interchange.

chipboolean

Indicates whether the card is chip-capable.

authorization_process"normal_rules" | "by_issuer_online"

How the issuer expects the authorization to be processed.

pin_required"required" | "not_required" | "when_feasible"

Indicates whether the transaction requires a PIN.

range_of_services"no_restrictions" | "goods_services" | "atm" | "cash"

Which services the card is allowed to perform.

track_1string

For Card Present: Track 1 data, as defined in ISO 7813.

Send it when you omit track_2 and entry_mode is not manual or manual_with_pass.

This element is ignored by the system if the value of transaction_channel_type is digital, mail_order or telephone_order.

track_2string

For Card Present: Track 2 data, as defined in ISO 7813.

Send it when you omit track_1 and entry_mode is not manual or manual_with_pass.

This element is ignored by the system if the value of transaction_channel_type is digital, mail_order or telephone_order.

tokenizationobject

Type of cryptogram used by the TSP (Token Service Provider). Values ​​can be - TAVV For Visa and ELO cards; - UCAF For Mastercard brand cards.

Show tokenization properties
type"UCAF" | "TAVV"required

tokenization type

cryptogramstringrequired

Value of the cryptogram generated by the TSP (Token Service Provider)

ecistring

ECI Indicator (Electronic Commerce Indicator)

requestor_idstring

Indicates the identifier of the Token requester.

walletobject

The wallet object covers three types of wallet transactions, distinguished by wallet.type:

  • SDWO (Staged Digital Wallet Operator): wallet.type = 55. This is a payment framework for digital wallets that act as intermediaries between the cardholder and the final recipient. For every SDWO transaction, also send dynamic_mcc and soft_descriptor on the payment object.
  • Generic Wallets (Apple Pay, Google Pay, and other NFC/tokenized wallets): wallet.type = 10. The wallet only replaces the physical card and does not participate in settlement.
  • QR Code: use capture_type, ticket_number, capture_channel, identification, plans, and sub_plan.
Show wallet properties
type"01" | "02" | "10" | "55"

Wallet Type:

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

id"000" | "101" | "102" | "103" | "216" | "217" | "327" | "BRL"

Wallet Identification.

000 = Unspecified
101 = Wallet Remote
102 = Wallet Remote NFC Payment
103 = Apple Pay
216 = Google Pay
217 = Samsung Pay
327 = MDES for merchants (M4M)
BRL = Wallet identifier. Always required for SDWO transactions in Brazil.

merchant_idstring

Identification number of the Digital Wallet registered with the card brand. Required for Visa, Mastercard, and Elo; not applicable for Amex.

Visa = MVV (Merchant Value Verification) with 6 positions
Mastercard = WID (Wallet ID) with 3 positions
Elo = WID (Wallet ID) with 11 positions
Amex = Not applicable

authorization_tokenstring

Used in the Authorization Token flow, where the merchant sends the wallet’s encrypted payment token to Getnet instead of separate card data fields (card.number, card.expiration_month, card.expiration_year, tokenization.cryptogram, tokenization.eci). Send the token content exactly as returned by the wallet provider, without decrypting, changing, trimming, or removing any field.

Google Pay = Base64-encoded value of paymentMethodData.tokenizationData.token.
Apple Pay = Hexadecimal-encoded value of pkPaymentToken. See Handling the Apple Pay payload for the full extraction and encoding steps.

For SDWO Authorization Token transactions, also set wallet.id to BRL, wallet.type to 55, and wallet.tag to GP (Google Pay) or AP (Apple Pay).

tag"GP" | "AP"

Wallet tag. Required only for SDWO Authorization Token transactions (wallet.id = BRL, wallet.type = 55, and authorization_token set).

fund_transferobject

Data for SDWO (Staged Digital Wallet Operator) array transactions.

Show fund_transfer properties
pay_action"FT" | "FP" | "PP" | "BP"

Financing type for the SDWO transaction.

FT Funding Transfer: Cash-in transactions, for all brands.
FP Funding and Purchase: Back-to-back transactions, for all brands.
PP Peer-to-Peer: transfer between different users/different ownership, for Mastercard, Visa, and Amex.
BP Bill Payment: bill payment marking in the Visa and Amex.

receiverobject

Data identifying the recipient of an SDWO fund transfer. Used for Cash-in (FT), Peer-to-peer (PP), and Bill Payment Provider (BP) transactions; not used for Back-to-back (FP).

Show receiver properties
account_numberstring

Receiver’s account number. Use “#NA” or “9999999999999995”; for road toll wallet transactions, provide the user’s unique toll wallet account ID instead. Required for the Mastercard brand on Cash-in (pay_action FT) and Peer-to-peer (pay_action PP) transactions; optional for other brands. Not used for Bill Payment Provider (pay_action BP).

account_type"00" | "01" | "02" | "03" | "04" | "05" | "06" | "07" | "08"

Account type.

- 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

Required for the Mastercard brand on Cash-in (pay_action FT) and Peer-to-peer (pay_action PP) transactions; optional for other brands. Not used for Bill Payment Provider (pay_action BP).

first_namestring

Receiver’s first name. Required for the Mastercard brand on Cash-in (pay_action FT) and Peer-to-peer (pay_action PP) transactions; optional for other brands. Required for Bill Payment Provider (pay_action BP) transactions for the Amex brand: for a legal entity, provide the full registered company name; for an individual, provide the name of the bill issuer (beneficiary).

middle_namestring

Abbreviation of the receiver’s middle name. Optional for all brands on Cash-in (pay_action FT) and Peer-to-peer (pay_action PP) transactions. For Bill Payment Provider (pay_action BP) transactions for the Amex brand, use this field the same way as first_name and last_name.

last_namestring

Receiver’s last name. Required for the Mastercard brand on Cash-in (pay_action FT) and Peer-to-peer (pay_action PP) transactions; optional for other brands. Required for Bill Payment Provider (pay_action BP) transactions for the Amex brand: for a legal entity, provide the full registered company name; for an individual, provide the name of the bill issuer (beneficiary).

addr_streetstring

Receiver’s street address, including street name and number. Optional for all brands on Cash-in (pay_action FT) and Peer-to-peer (pay_action PP) transactions. Required for Bill Payment Provider (pay_action BP) transactions for the Amex brand.

addr_citystring

Receiver’s city. Optional for all brands on Cash-in (pay_action FT) and Peer-to-peer (pay_action PP) transactions. Required for Bill Payment Provider (pay_action BP) transactions for the Amex brand.

addr_statestring

Receiver’s state. Optional for all brands on Cash-in (pay_action FT) and Peer-to-peer (pay_action PP) transactions. Required for Bill Payment Provider (pay_action BP) transactions for the Amex brand.

addr_countrystring

Receiver’s country, following the ISO 3166-1 alpha-3 standard. Required for Cash-in (pay_action FT) and Peer-to-peer (pay_action PP) transactions, for all brands. Required for Bill Payment Provider (pay_action BP) transactions only for the Amex brand.

addr_postal_codestring

Receiver’s postal code (ZIP code). Optional for all brands on Cash-in (pay_action FT) and Peer-to-peer (pay_action PP) transactions. Not used for Bill Payment Provider (pay_action BP).

nationalitystring

Receiver’s nationality, following the ISO 3166-1 alpha-3 standard. Optional for all brands on Cash-in (pay_action FT) and Peer-to-peer (pay_action PP) transactions. Not used for Bill Payment Provider (pay_action BP).

phonestring

Receiver’s phone number, including the country code. Optional for all brands on Cash-in (pay_action FT) and Peer-to-peer (pay_action PP) transactions. Not used for Bill Payment Provider (pay_action BP).

date_of_birthstring

Receiver’s date of birth, in YYYYMMDD format. Optional for all brands on Cash-in (pay_action FT) and Peer-to-peer (pay_action PP) transactions. Not used for Bill Payment Provider (pay_action BP).

id_type"00" | "01" | "02" | "03" | "04"

Receiver’s document type. Use 03 for CPF or CNPJ. Required for Cash-in (pay_action FT) and Peer-to-peer (pay_action PP) transactions, for all brands. Required for Bill Payment Provider (pay_action BP) transactions only for the Amex brand.
- 00 = Passport
- 01 = National Identification Card
- 02 = Driver’s License
- 03 = Issued by the Government
- 04 = Other

id_numstring

Receiver’s document number (CPF or CNPJ). Required for Cash-in (pay_action FT) and Peer-to-peer (pay_action PP) transactions, for all brands. Required for Bill Payment Provider (pay_action BP) transactions only for the Amex brand.

capture_type"0" | "1" | "2" | "3" | "4"

Numeric field of fixed length with 1 positions.
Denotes the capture type and must be sent in all the Sale and Cancellation/Refunds transactions:
0 - POS
1 - TEF
2 - Ecommerce
3 - Recurring Payment
4 - Mobile POS

ticket_numberstring

Only QRCode transactions
Numeric field of fixed length with 10 digits justified to the right and completed by zeros. The ticket number which is disposed by some countries is entered in the terminals in case the ticket is valid as an invoice.

capture_channelstring

Only QRCode transactions
Numeric field of fixed length with 2 digits justified to the right and completed by zeros. Channel capture type indicator

identificationstring

Only QRCode transactions

plans"01" | "02"

Only QRCode transactions
Type of sales plan Mandatory string Fixed length numeric field with 2 positions: 01 or 02

sub_plan"01" | "02"

Only QRCode transactions
Sales plan subtype Mandatory string Fixed length numeric field with 2 positions: 01 or 02

xidstring

Field available from version 2.0 onwards. MPI identifier for each authenticated transaction. The field content can be a HEXA or Base64 value, according to the MPI used.

ucafstring

Field available from version 2.0 onwards. Authentication code encrypted by the Flag. The field content can be a HEXA or Base64 value, according to the MPI used.

ecistring

Field available from version 2.0 onwards. ECI code of the 3D Secure Authenticated transaction. Generated by an External MPI.

tdsdsxidstring

A transaction identifier generated by 3DS 2.x protocol (equivalent to ds_trans_id).

tdsverstring

Indicates the 3DS protocol version used in the authentication (e.g., “1.0.2” or “2.2.0”).

is_pre_paidboolean
network_tokenstring

Card token that will be used to generate the cryptogram.

payment_tagstring

Required for split

billing_addressobject
Show billing_address properties
streetstring

Street.
Mandatory field for Antifraud

numberstring

Street number.
Mandatory field for Antifraud

districtstring

District.
Mandatory field for Antifraud

citystring

City.
Mandatory field for Antifraud

statestring

State (UF).
Mandatory field for Antifraud

countrystring

Country.
Report in the ISO 3166-1 alpha-3 standard
Example “BRA”, “USA” and “ARG”
Mandatory field for Antifraud

postal_codestring

Postal Code, CEP in Brazil or ZIP in the United States. (without mask)
Mandatory field for Antifraud

complementstring

Address complement.
Mandatory field for Antifraud

type"RESIDENCIAL" | "INSTALACAO" | "CORRESPONDENCIA" | "FISCAL" | "COBRANCA"
installmentobject

See the documentation for installments.

Show installment properties
quote_idstring

Quote ID to be used in the query.
Required for AR and CL

schemastringrequired

Code that groups credits by category.

typestring

Identifier that represents the type of credit. Required for UY

codestring

Unique code associated with the specific credit.
Required for UY

numbernumber

Number of installments available for the credit. Required for UY

cross_border_dataobject

Required for FX (cross border)

Show cross_border_data properties
first_namestring

Customer’s first name. Required when type = INDIVIDUAL.

last_namestring

Customer’s last name. Required when type = INDIVIDUAL.

legal_namestring

Customer’s legal name. Required when type = COMPANY.

type"INDIVIDUAL" | "COMPANY"

Field that informs the type of buyer, being “INDIVIDUAL” for a natural person and “COMPANY” for a legal entity.

document_numberstring

Customer’s document number.

emailstring

Email address that will be used to send the cross-border transaction receipt.

sub_merchantobject

Identification data of the sub-merchant that makes the transaction. Card scheme rules, laws, and regulations require Getnet to identify this final entity.

Who sends it:
- Payment facilitators, on every card authorization. Your Getnet credential determines whether you send it, so confirm your coverage with Integration Support.

Where the values come from:
- The sub-merchant’s onboarding record that you hold as facilitator, never the cardholder, the buyer, or the order. Only foreign_amount changes per transaction. Every other value stays the same for that sub-merchant.

Which operations use it:
- Create - Authorize and Combined Payments - Authorize act on the object. In a combined payment, Getnet applies it to every payment in the payments array.
- Create an Invoice/Boleto rejects it with a validation error.
- Cancel accepts it and ignores it.

Market-specific requirements:
- In Argentina, Mastercard requires iva_category. It is the only property here whose obligation depends on the market.

Show sub_merchant properties
identification_codestringrequired

Identifier the facilitator assigns to the sub-merchant. Visa and Mastercard limit the value to 15 characters. American Express does not apply that limit.

gateway_idstring

Gateway identifier of the sub-merchant. Optional in every market. Contact Integration Support to find out whether your integration uses this field.

document_type"CPF" | "CNPJ" | "PASSPORT_BR" | "DNI" | "CUIL" | "CUIT" | "PASSPORT_AR" | "RUT" | "CI" | "CURP" | "RFC"required

Legal document type of the sub-merchant, from the country where it is registered. Every value is accepted in every market. Send it exactly as listed, and make sure document_type and document_number describe the same document, in the format that document uses.

document_numberstringrequired

Number of the document named in document_type. Send it without punctuation or mask, so a CNPJ goes as 77415914000148 rather than 77.415.914/0001-48. This is the sub-merchant’s own document, not the cardholder’s. It is separate from acceptor.tax_id.

addressstringrequired

Street or public-place name from the sub-merchant’s registered address. Send it as a plain string, never a nested object. The remaining parts of the address go in address_number, address_complement, district, city, state, postal_code, and country_code. Before processing, Getnet converts accented characters to their unaccented equivalent. It then removes everything that is not a letter, a digit, or a space, so Av. São João is processed as Av Sao Joao. This is the only property in the object that Getnet rewrites.

citystringrequired

City where the sub-merchant is registered, not where the purchase happens. It must match the onboarding record.

statestringrequired

State or region of the sub-merchant, as the local abbreviation. Send SP, not the full ISO 3166-2 subdivision code, which does not fit in three characters.

postal_codestring

Postal code of the sub-merchant’s registered address, not the buyer’s shipping code. Send digits only, without a separator, so a Brazilian CEP goes as 90520000 rather than 90520-000.

districtstring

District or neighborhood of the sub-merchant’s registered address.

country_codestring

Country code of the sub-merchant. Send ISO 3166-1 alpha-2 (BR) or alpha-3 (BRA).

address_numberstring

Building or street number of the sub-merchant’s registered address. Send it here instead of appending it to address.

address_complementstring

Additional detail of the sub-merchant’s registered address, such as a floor, room, or block. This is the only complement field the API accepts.

business_namestring

Trading or company name of the sub-merchant, as registered with the facilitator. Send it whenever you have it, because Getnet includes it in fraud analysis. For a sub-merchant registered without a trading name, send an empty string or null.

This value does not control what the cardholder sees on the card statement. That text comes from soft_descriptor.

foreign_type"F" | "P" | "D"

Composition of the sub-merchants in the transaction. The value is case-insensitive. This object is not a list, so a transaction identifies one sub-merchant only. P describes the composition of the cart, not multiple sub-merchant entries.

foreign_amountinteger<int32>

Transaction amount in the sub-merchant’s foreign currency, in cents. You do not send the currency. It comes from the sub-merchant configuration. Zero and null are accepted. A negative value fails validation.

iva_categorystring

IVA (VAT) tax category of the sub-merchant. Mastercard requires it for transactions in Argentina. Send it for those transactions, because the acquirer or the issuer can decline a transaction without it.

additional_dataobject
additional_dataobject

Response

Transaction executed successfully.

seller_idstring<uuid>

ECommerce identification code

request_idstring<uuid>

Request identifier. Unique for each request.

order_idstring

Purchase identification code used by e-commerce (code or order number).

amountinteger

Purchase value in cents. It must be an integer.

combined_idstring

Combined payment identification code.

paymentsobject[]
Show payments properties
idempotency_keystring<(a-Z | 0-9 | .-_)>

Idempotency key, used to control requests, must be unique per request, because if it is repeated, it will always be returned the same data.

payment_idstring<uuid>

Payment identifier

status"AUTHORIZED" | "APPROVED" | "DENIED" | "ERROR"

Authorization Status

payment_method"CREDIT" | "DEBIT" | "CREDIT_AUTHORIZATION" | "CREDIT_PRE_AUTHORIZATION" | "INSTANT_TRANSFER" | "INSTANT_TRANSFER_PREAUTH"

Payment method type for the transaction:

  • CREDIT: Credit card payment (single-step, immediate capture)
  • DEBIT: Debit card payment
  • CREDIT_AUTHORIZATION: Credit card authorization (two-step, capture later)
  • CREDIT_PRE_AUTHORIZATION: Credit card pre-authorization
  • INSTANT_TRANSFER: Instant payment (single-step, immediate capture)
  • INSTANT_TRANSFER_PREAUTH: Instant payment pre-authorization (two-step, capture within 30 days)
received_atstring

Transaction date

transaction_idstring

Transaction identifier generated by the eCommerce platform

original_transaction_idstring

Original transaction identifier

authorized_atstring

Transaction authorization date

reason_codestring

Return code from the sender or the getnet capture system.

reason_messagestring

Return message from the sender or the getnet capture system.

acquirerstring

Acquirer.

soft_descriptorstring

Text displayed on the buyer’s card invoice. The field is optional. When you leave it empty, Getnet uses the trade name registered for the establishment. Getnet keeps letters, digits, spaces, and the asterisk. Accented characters are converted to their unaccented equivalent, so AÇÃO becomes ACAO. Every other character is removed. Values longer than 22 characters are truncated rather than rejected.

brand"MASTERCARD" | "VISA" | "AMEX" | "ELO" | "HIPERCARD"

Bcard walker. Automatically populated by the API if not informed. Mandatory field for using Anti-Fraud

authorization_codestring

Authorization Code generated by the Issuer when the transaction is carried out successfully

acquirer_transaction_idstring

NSU of the GetNet transaction (Acquirer)

ecistring

Code indicating whether the transaction was processed with Bearer Authentication. 00, 01 and 02 for Mastercard and 05, 06 and 07 for Visa and other brands

payment_received_timestampstring<date-time>
card_idstring

Card identifier saved in the safe, can be used to retrieve a valid number_token for future purchases, as well as can be used to remove saved cards.

merchant_advice_codestring

merchant_advice_code.

amountinteger

Purchase value in cents. It must be an integer.

currencystring

Currency identification (See code in this section).

Invalid Requisition

messagestring

Detailed error message.

namestring

Name of the module or system in which the error occurred.

status_codeinteger<int32>

HTTP status code of the error.

detailsobject[]

Error details.

Show details properties
statusstring

Error situation.

error_codestring

Error code.

descriptionstring

Description of the error.

description_detailstring

Detailed description of the error.

brandstring

Brand.

payment_idstring

payment_id.

seller_idstring

seller_id.

amountstring

amount.

currencystring

currency.

order_idstring

order_id.

credit_cancelobject

credit_cancel.

Show credit_cancel properties
canceled_atstring

canceledAt.

messagestring

message.

payment_tagstring

payment_tag.

status_codestring

statusCode.

messagestring

message.

namestring

name.

acquirer_transaction_idstring

acquirer_transaction_id.

authorization_codestring

authorization_code.

transaction_idstring

transaction_id.

reason_codestring

reason_code.

reason_messagestring

reason_message.

merchant_advice_codestring

merchant_advice_code.

paymentsobject[]

Error details.

Show payments properties
statusstring

Error situation.

error_codestring

Error code.

descriptionstring

Description of the error.

description_detailstring

Detailed description of the error.

brandstring

Brand.

payment_idstring

payment_id.

seller_idstring

seller_id.

amountstring

amount.

currencystring

currency.

order_idstring

order_id.

credit_cancelobject

credit_cancel.

Show credit_cancel properties
canceled_atstring

canceledAt.

messagestring

message.

payment_tagstring

payment_tag.

status_codestring

statusCode.

messagestring

message.

namestring

name.

acquirer_transaction_idstring

acquirer_transaction_id.

authorization_codestring

authorization_code.

transaction_idstring

transaction_id.

reason_codestring

reason_code.

reason_messagestring

reason_message.

merchant_advice_codestring

merchant_advice_code.

combined_idstring

combinedId.

order_idstring

orderId.

seller_idstring

sellerId.

Invalid Authentication

messagestring

Detailed error message.

namestring

Name of the module or system in which the error occurred.

status_codeinteger<int32>

HTTP status code of the error.

detailsobject[]

Error details.

Show details properties
statusstring

Error situation.

error_codestring

Error code.

descriptionstring

Description of the error.

description_detailstring

Detailed description of the error.

brandstring

Brand.

payment_idstring

payment_id.

seller_idstring

seller_id.

amountstring

amount.

currencystring

currency.

order_idstring

order_id.

credit_cancelobject

credit_cancel.

Show credit_cancel properties
canceled_atstring

canceledAt.

messagestring

message.

payment_tagstring

payment_tag.

status_codestring

statusCode.

messagestring

message.

namestring

name.

acquirer_transaction_idstring

acquirer_transaction_id.

authorization_codestring

authorization_code.

transaction_idstring

transaction_id.

reason_codestring

reason_code.

reason_messagestring

reason_message.

merchant_advice_codestring

merchant_advice_code.

paymentsobject[]

Error details.

Show payments properties
statusstring

Error situation.

error_codestring

Error code.

descriptionstring

Description of the error.

description_detailstring

Detailed description of the error.

brandstring

Brand.

payment_idstring

payment_id.

seller_idstring

seller_id.

amountstring

amount.

currencystring

currency.

order_idstring

order_id.

credit_cancelobject

credit_cancel.

Show credit_cancel properties
canceled_atstring

canceledAt.

messagestring

message.

payment_tagstring

payment_tag.

status_codestring

statusCode.

messagestring

message.

namestring

name.

acquirer_transaction_idstring

acquirer_transaction_id.

authorization_codestring

authorization_code.

transaction_idstring

transaction_id.

reason_codestring

reason_code.

reason_messagestring

reason_message.

merchant_advice_codestring

merchant_advice_code.

combined_idstring

combinedId.

order_idstring

orderId.

seller_idstring

sellerId.

Product not Enable

messagestring

Detailed error message.

namestring

Name of the module or system in which the error occurred.

status_codeinteger<int32>

HTTP status code of the error.

detailsobject[]

Error details.

Show details properties
statusstring

Error situation.

error_codestring

Error code.

descriptionstring

Description of the error.

description_detailstring

Detailed description of the error.

brandstring

Brand.

payment_idstring

payment_id.

seller_idstring

seller_id.

amountstring

amount.

currencystring

currency.

order_idstring

order_id.

credit_cancelobject

credit_cancel.

Show credit_cancel properties
canceled_atstring

canceledAt.

messagestring

message.

payment_tagstring

payment_tag.

status_codestring

statusCode.

messagestring

message.

namestring

name.

acquirer_transaction_idstring

acquirer_transaction_id.

authorization_codestring

authorization_code.

transaction_idstring

transaction_id.

reason_codestring

reason_code.

reason_messagestring

reason_message.

merchant_advice_codestring

merchant_advice_code.

paymentsobject[]

Error details.

Show payments properties
statusstring

Error situation.

error_codestring

Error code.

descriptionstring

Description of the error.

description_detailstring

Detailed description of the error.

brandstring

Brand.

payment_idstring

payment_id.

seller_idstring

seller_id.

amountstring

amount.

currencystring

currency.

order_idstring

order_id.

credit_cancelobject

credit_cancel.

Show credit_cancel properties
canceled_atstring

canceledAt.

messagestring

message.

payment_tagstring

payment_tag.

status_codestring

statusCode.

messagestring

message.

namestring

name.

acquirer_transaction_idstring

acquirer_transaction_id.

authorization_codestring

authorization_code.

transaction_idstring

transaction_id.

reason_codestring

reason_code.

reason_messagestring

reason_message.

merchant_advice_codestring

merchant_advice_code.

combined_idstring

combinedId.

order_idstring

orderId.

seller_idstring

sellerId.

Not Found

messagestring

Detailed error message.

namestring

Name of the module or system in which the error occurred.

status_codeinteger<int32>

HTTP status code of the error.

detailsobject[]

Error details.

Show details properties
statusstring

Error situation.

error_codestring

Error code.

descriptionstring

Description of the error.

description_detailstring

Detailed description of the error.

brandstring

Brand.

payment_idstring

payment_id.

seller_idstring

seller_id.

amountstring

amount.

currencystring

currency.

order_idstring

order_id.

credit_cancelobject

credit_cancel.

Show credit_cancel properties
canceled_atstring

canceledAt.

messagestring

message.

payment_tagstring

payment_tag.

status_codestring

statusCode.

messagestring

message.

namestring

name.

acquirer_transaction_idstring

acquirer_transaction_id.

authorization_codestring

authorization_code.

transaction_idstring

transaction_id.

reason_codestring

reason_code.

reason_messagestring

reason_message.

merchant_advice_codestring

merchant_advice_code.

paymentsobject[]

Error details.

Show payments properties
statusstring

Error situation.

error_codestring

Error code.

descriptionstring

Description of the error.

description_detailstring

Detailed description of the error.

brandstring

Brand.

payment_idstring

payment_id.

seller_idstring

seller_id.

amountstring

amount.

currencystring

currency.

order_idstring

order_id.

credit_cancelobject

credit_cancel.

Show credit_cancel properties
canceled_atstring

canceledAt.

messagestring

message.

payment_tagstring

payment_tag.

status_codestring

statusCode.

messagestring

message.

namestring

name.

acquirer_transaction_idstring

acquirer_transaction_id.

authorization_codestring

authorization_code.

transaction_idstring

transaction_id.

reason_codestring

reason_code.

reason_messagestring

reason_message.

merchant_advice_codestring

merchant_advice_code.

combined_idstring

combinedId.

order_idstring

orderId.

seller_idstring

sellerId.

Unprocessable Entity

messagestring

Detailed error message.

namestring

Name of the module or system in which the error occurred.

status_codeinteger<int32>

HTTP status code of the error.

detailsobject[]

Error details.

Show details properties
statusstring

Error situation.

error_codestring

Error code.

descriptionstring

Description of the error.

description_detailstring

Detailed description of the error.

brandstring

Brand.

payment_idstring

payment_id.

seller_idstring

seller_id.

amountstring

amount.

currencystring

currency.

order_idstring

order_id.

credit_cancelobject

credit_cancel.

Show credit_cancel properties
canceled_atstring

canceledAt.

messagestring

message.

payment_tagstring

payment_tag.

status_codestring

statusCode.

messagestring

message.

namestring

name.

acquirer_transaction_idstring

acquirer_transaction_id.

authorization_codestring

authorization_code.

transaction_idstring

transaction_id.

reason_codestring

reason_code.

reason_messagestring

reason_message.

merchant_advice_codestring

merchant_advice_code.

paymentsobject[]

Error details.

Show payments properties
statusstring

Error situation.

error_codestring

Error code.

descriptionstring

Description of the error.

description_detailstring

Detailed description of the error.

brandstring

Brand.

payment_idstring

payment_id.

seller_idstring

seller_id.

amountstring

amount.

currencystring

currency.

order_idstring

order_id.

credit_cancelobject

credit_cancel.

Show credit_cancel properties
canceled_atstring

canceledAt.

messagestring

message.

payment_tagstring

payment_tag.

status_codestring

statusCode.

messagestring

message.

namestring

name.

acquirer_transaction_idstring

acquirer_transaction_id.

authorization_codestring

authorization_code.

transaction_idstring

transaction_id.

reason_codestring

reason_code.

reason_messagestring

reason_message.

merchant_advice_codestring

merchant_advice_code.

combined_idstring

combinedId.

order_idstring

orderId.

seller_idstring

sellerId.

Unprocessable Entity

messagestring

Detailed error message.

namestring

Name of the module or system in which the error occurred.

status_codeinteger<int32>

HTTP status code of the error.

detailsobject[]

Error details.

Show details properties
statusstring

Error situation.

error_codestring

Error code.

descriptionstring

Description of the error.

description_detailstring

Detailed description of the error.

brandstring

Brand.

payment_idstring

payment_id.

seller_idstring

seller_id.

amountstring

amount.

currencystring

currency.

order_idstring

order_id.

credit_cancelobject

credit_cancel.

Show credit_cancel properties
canceled_atstring

canceledAt.

messagestring

message.

payment_tagstring

payment_tag.

status_codestring

statusCode.

messagestring

message.

namestring

name.

acquirer_transaction_idstring

acquirer_transaction_id.

authorization_codestring

authorization_code.

transaction_idstring

transaction_id.

reason_codestring

reason_code.

reason_messagestring

reason_message.

merchant_advice_codestring

merchant_advice_code.

paymentsobject[]

Error details.

Show payments properties
statusstring

Error situation.

error_codestring

Error code.

descriptionstring

Description of the error.

description_detailstring

Detailed description of the error.

brandstring

Brand.

payment_idstring

payment_id.

seller_idstring

seller_id.

amountstring

amount.

currencystring

currency.

order_idstring

order_id.

credit_cancelobject

credit_cancel.

Show credit_cancel properties
canceled_atstring

canceledAt.

messagestring

message.

payment_tagstring

payment_tag.

status_codestring

statusCode.

messagestring

message.

namestring

name.

acquirer_transaction_idstring

acquirer_transaction_id.

authorization_codestring

authorization_code.

transaction_idstring

transaction_id.

reason_codestring

reason_code.

reason_messagestring

reason_message.

merchant_advice_codestring

merchant_advice_code.

combined_idstring

combinedId.

order_idstring

orderId.

seller_idstring

sellerId.

Internal server or service error

messagestring

Detailed error message.

namestring

Name of the module or system in which the error occurred.

status_codeinteger<int32>

HTTP status code of the error.

detailsobject[]

Error details.

Show details properties
statusstring

Error situation.

error_codestring

Error code.

descriptionstring

Description of the error.

description_detailstring

Detailed description of the error.

brandstring

Brand.

payment_idstring

payment_id.

seller_idstring

seller_id.

amountstring

amount.

currencystring

currency.

order_idstring

order_id.

credit_cancelobject

credit_cancel.

Show credit_cancel properties
canceled_atstring

canceledAt.

messagestring

message.

payment_tagstring

payment_tag.

status_codestring

statusCode.

messagestring

message.

namestring

name.

acquirer_transaction_idstring

acquirer_transaction_id.

authorization_codestring

authorization_code.

transaction_idstring

transaction_id.

reason_codestring

reason_code.

reason_messagestring

reason_message.

merchant_advice_codestring

merchant_advice_code.

paymentsobject[]

Error details.

Show payments properties
statusstring

Error situation.

error_codestring

Error code.

descriptionstring

Description of the error.

description_detailstring

Detailed description of the error.

brandstring

Brand.

payment_idstring

payment_id.

seller_idstring

seller_id.

amountstring

amount.

currencystring

currency.

order_idstring

order_id.

credit_cancelobject

credit_cancel.

Show credit_cancel properties
canceled_atstring

canceledAt.

messagestring

message.

payment_tagstring

payment_tag.

status_codestring

statusCode.

messagestring

message.

namestring

name.

acquirer_transaction_idstring

acquirer_transaction_id.

authorization_codestring

authorization_code.

transaction_idstring

transaction_id.

reason_codestring

reason_code.

reason_messagestring

reason_message.

merchant_advice_codestring

merchant_advice_code.

combined_idstring

combinedId.

order_idstring

orderId.

seller_idstring

sellerId.

Internal server or service error

messagestring

Detailed error message.

namestring

Name of the module or system in which the error occurred.

status_codeinteger<int32>

HTTP status code of the error.

detailsobject[]

Error details.

Show details properties
statusstring

Error situation.

error_codestring

Error code.

descriptionstring

Description of the error.

description_detailstring

Detailed description of the error.

brandstring

Brand.

payment_idstring

payment_id.

seller_idstring

seller_id.

amountstring

amount.

currencystring

currency.

order_idstring

order_id.

credit_cancelobject

credit_cancel.

Show credit_cancel properties
canceled_atstring

canceledAt.

messagestring

message.

payment_tagstring

payment_tag.

status_codestring

statusCode.

messagestring

message.

namestring

name.

acquirer_transaction_idstring

acquirer_transaction_id.

authorization_codestring

authorization_code.

transaction_idstring

transaction_id.

reason_codestring

reason_code.

reason_messagestring

reason_message.

merchant_advice_codestring

merchant_advice_code.

paymentsobject[]

Error details.

Show payments properties
statusstring

Error situation.

error_codestring

Error code.

descriptionstring

Description of the error.

description_detailstring

Detailed description of the error.

brandstring

Brand.

payment_idstring

payment_id.

seller_idstring

seller_id.

amountstring

amount.

currencystring

currency.

order_idstring

order_id.

credit_cancelobject

credit_cancel.

Show credit_cancel properties
canceled_atstring

canceledAt.

messagestring

message.

payment_tagstring

payment_tag.

status_codestring

statusCode.

messagestring

message.

namestring

name.

acquirer_transaction_idstring

acquirer_transaction_id.

authorization_codestring

authorization_code.

transaction_idstring

transaction_id.

reason_codestring

reason_code.

reason_messagestring

reason_message.

merchant_advice_codestring

merchant_advice_code.

combined_idstring

combinedId.

order_idstring

orderId.

seller_idstring

sellerId.

Gateway Timeout

messagestring

Detailed error message.

namestring

Name of the module or system in which the error occurred.

status_codeinteger<int32>

HTTP status code of the error.

detailsobject[]

Error details.

Show details properties
statusstring

Error situation.

error_codestring

Error code.

descriptionstring

Description of the error.

description_detailstring

Detailed description of the error.

brandstring

Brand.

payment_idstring

payment_id.

seller_idstring

seller_id.

amountstring

amount.

currencystring

currency.

order_idstring

order_id.

credit_cancelobject

credit_cancel.

Show credit_cancel properties
canceled_atstring

canceledAt.

messagestring

message.

payment_tagstring

payment_tag.

status_codestring

statusCode.

messagestring

message.

namestring

name.

acquirer_transaction_idstring

acquirer_transaction_id.

authorization_codestring

authorization_code.

transaction_idstring

transaction_id.

reason_codestring

reason_code.

reason_messagestring

reason_message.

merchant_advice_codestring

merchant_advice_code.

paymentsobject[]

Error details.

Show payments properties
statusstring

Error situation.

error_codestring

Error code.

descriptionstring

Description of the error.

description_detailstring

Detailed description of the error.

brandstring

Brand.

payment_idstring

payment_id.

seller_idstring

seller_id.

amountstring

amount.

currencystring

currency.

order_idstring

order_id.

credit_cancelobject

credit_cancel.

Show credit_cancel properties
canceled_atstring

canceledAt.

messagestring

message.

payment_tagstring

payment_tag.

status_codestring

statusCode.

messagestring

message.

namestring

name.

acquirer_transaction_idstring

acquirer_transaction_id.

authorization_codestring

authorization_code.

transaction_idstring

transaction_id.

reason_codestring

reason_code.

reason_messagestring

reason_message.

merchant_advice_codestring

merchant_advice_code.

combined_idstring

combinedId.

order_idstring

orderId.

seller_idstring

sellerId.

Request
curl -X POST "https://api.pre.globalgetnet.com/dpm/payments-gwproxy/v2/payments/combined" \
  -H "Content-Type: application/json" \
  -H "x-transaction-channel-entry: <x-transaction-channel-entry>" \
  -d '{
  "request_id": "daac03dc-73db-453f-9bea-b1391669d5d3",
  "order_id": "ORDER-10187383",
  "data": {
    "amount": 8900,
    "currency": "BRL",
    "customer_id": "string",
    "payments": [
      {
        "idempotency_key": "63c7f8ee-51a6-470d-bb76-ef762b62bfb7",
        "payment_id": "2c341d28-491b-4cf8-aec7-eeb60136b7a5",
        "amount": 8900,
        "payment_method": "CREDIT",
        "save_card_data": false,
        "transaction_type": "FULL",
        "number_installments": 1,
        "soft_descriptor": "MEUECOMM*ORDER10187383",
        "dynamic_mcc": "1799",
        "card": {
          "card_id": "e8ad2ae4-9e3e-4532-998f-1a5a11e56e58",
          "number": "4013790001234569",
          "expiration_month": "09",
          "expiration_year": 30,
          "cardholder_name": "Roland Deschain",
          "security_code": 517,
          "brand": "Visa",
          "number_token": "e71084449bc70e344f77d4c382704ea2868b5e9775dced7ffcd40b3f66b167f51e352a2f289b518a11180c81478dfbdbeffd8a41f0b34564f2f0e41be8a88e11",
          "entry_mode": "string",
          "seq_number": "string",
          "pin_block": "A0B6BA8D53C8D3C3",
          "pin_key_id": "string",
          "ksn": "BC756011020000400001",
          "emv": "6F1A840E315041592E5359532E4444463031A5088801025F2D02656E",
          "aid": "string",
          "cardholder_verification_method": "offline_pin",
          "aggregator": "siscard",
          "service_code": {
            "interchange": "international",
            "chip": true,
            "authorization_process": "normal_rules",
            "pin_required": "required",
            "range_of_services": "no_restrictions"
          },
          "track_1": "%B1234567890123445^PADILLA/L. ^99011X100000*000000000XXX000000?*",
          "track_2": "4013790001234569=301220111379456001"
        },
        "tokenization": {
          "type": "TAVV",
          "cryptogram": "0006010865799300000620111679930000000000",
          "eci": "00",
          "requestor_id": 1234567
        },
        "wallet": {
          "type": "55",
          "id": "000",
          "merchant_id": "327",
          "authorization_token": "<BASE64_OR_HEX_ENCODED_WALLET_PAYMENT_TOKEN>",
          "tag": "GP",
          "fund_transfer": {
            "pay_action": "FT",
            "receiver": {
              "account_number": "9999999999999995",
              "account_type": "00",
              "first_name": "Jane",
              "middle_name": "T",
              "last_name": "Smith",
              "addr_street": "1 Main ST",
              "addr_city": "SAO PAULO",
              "addr_state": "SP",
              "addr_country": "BRA",
              "addr_postal_code": "1408000",
              "nationality": "BRA",
              "phone": "5511977778888",
              "date_of_birth": "19901230",
              "id_type": "03",
              "id_num": "12345678900000"
            }
          },
          "capture_type": "0",
          "ticket_number": "0",
          "capture_channel": "pos",
          "identification": "Santander",
          "plans": "02",
          "sub_plan": "02"
        },
        "xid": "test",
        "ucaf": "string",
        "eci": "00",
        "tdsdsxid": "string",
        "tdsver": "2.1.0",
        "is_pre_paid": true,
        "network_token": "1b110aaa71934ae492bff48baab9af81",
        "payment_tag": "string",
        "billing_address": {
          "street": "string",
          "number": "string",
          "district": "string",
          "city": "string",
          "state": "string",
          "country": "string",
          "postal_code": "string",
          "complement": "string",
          "type": "RESIDENCIAL"
        },
        "installment": {
          "quote_id": "06f256c8-1bbf-42bf-93b4-ce2041bfb87e",
          "schema": "plan_ahora",
          "type": "00",
          "code": "00",
          "number": 2
        },
        "cross_border_data": {
          "first_name": "John",
          "last_name": "da Silva",
          "legal_name": "string",
          "type": "INDIVIDUAL",
          "document_number": "string",
          "email": "string"
        }
      }
    ],
    "sub_merchant": {
      "identification_code": "9058345",
      "gateway_id": "GW123456",
      "document_type": "CNPJ",
      "document_number": "77415914000148",
      "address": "Dark Tower 207",
      "city": "Sao Paulo",
      "state": "SP",
      "postal_code": "90520000",
      "district": "Centro",
      "country_code": "BR",
      "address_number": "207",
      "address_complement": "Floor 2",
      "business_name": "Company Ltd",
      "foreign_type": "F",
      "foreign_amount": 0,
      "iva_category": "1"
    },
    "additional_data": {}
  },
  "additional_data": {}
}'
Response
{
  "seller_id": "9406df6c-3100-49ba-b4df-d81c1ad8a62b",
  "request_id": "daac03dc-73db-453f-9bea-b1391669d5d3",
  "order_id": "ORDER-10187383",
  "amount": 8900,
  "combined_id": "66f36211-3a61-41fa-8747-052c451e89ad",
  "payments": [
    {
      "idempotency_key": "63c7f8ee-51a6-470d-bb76-ef762b62bfb7",
      "payment_id": "2c341d28-491b-4cf8-aec7-eeb60136b7a5",
      "status": "APPROVED",
      "payment_method": "CREDIT",
      "received_at": "2020-06-30T18:32:51.222Z",
      "transaction_id": "3729756321501820",
      "original_transaction_id": "6534812321501821",
      "authorized_at": "2020-06-30T18:32:51.815Z",
      "reason_code": "00",
      "reason_message": "TRANSACTION EXECUTED SUCCESSFULLY",
      "acquirer": "GETNET",
      "soft_descriptor": "MEUECOMM*ORDER10187383",
      "brand": "VISA",
      "authorization_code": "017060",
      "acquirer_transaction_id": "000152147981",
      "eci": "07",
      "payment_received_timestamp": "1970-01-01T00:00:00.000Z",
      "card_id": "e8ad2ae4-9e3e-4532-998f-1a5a11e56e58",
      "merchant_advice_code": "string",
      "amount": 8900,
      "currency": "BRL"
    }
  ]
}