Getnet DocsGetnet Docs

Create - Authorize

POST/dpm/payments-gwproxy/v2/payments

__Create a Payment Transaction__<br><br>This endpoint creates a payment with a credit card, a debit card, or an alternative payment method. The response carries the status of the transaction, and the operation also supports installment payments.<br><br>**Usage Scenarios:**<br>- Charging a customer for an online purchase with a credit or debit card.<br>- Charging a customer at a terminal with a card-present method.<br>- Splitting a purchase into installments.<br>- Letting the cardholder withdraw cash during a card-present purchase, with Cashout.<br><br>**Notes:**<br>- Set the transaction type in `data.payment.payment_method`.<br>- Send a unique `idempotency_key` on every request to prevent duplicate transactions.<br>- Check `status` in the response to confirm the outcome of the transaction.<br>- Some payments need an extra step before authorization, such as [3DS - Init Authentication](#tag/payments/post/dpm/security-gwproxy/v2/enrolments-initial) or [Generate Token](#tag/cards/post/dpm/cofre-gw-proxy/v1/tokens/card).<br>- **For payment facilitators:** send the `data.sub_merchant` object on every card authorization, to identify the sub-merchant behind the transaction.<br>- **For transactions in Uruguay (UY):** send `data.additional_data.rates` as an array of `key`/`value` items. Set `key` to lowercase `iva` and `value` to the rate as a percentage.<br>- Standard rate — send `22`.<br>- Reduced rate — send `10`.<br>- Exempt transaction — omit the item.<br>- **For a Uruguay tax benefit:** send `data.additional_data.regional_regulation_code` only when the transaction qualifies. Use `17934` for credit and debit cards, or `19210` for debit cards only. Send one item, as an object carrying `code`. Add `invoice` when you have a fiscal document of your own to tie to the transaction.<br>- **For Cashout in Argentina (AR):** send the `data.cashout` object to let the cardholder withdraw cash during the purchase. Set `cashout_amount` to the withdrawal amount, and let the root `data.amount` carry the total of the operation. Cashout accepts only card-present `DIRECT_DEBIT` transactions. The card must be a domestic debit or domestic prepaid card, read by chip or contactless chip.

Header Parameters

x-transaction-channel-entrystring

Field used to identify the platform that will be sending the transaction<br><br>(The code to be informed must be previously requested from GetNet)

Body application/json

idempotency_keystring<(a-Z | 0-9 | .-_)>required

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

request_idstring<uuid>

Request identifier. Unique for each request.

order_idstringrequired

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

dataobjectrequired

Data to carry out an authorization.

Show data properties
amountinteger<int32>required

Purchase amount in cents. See more <a href="https://docs.globalgetnet.com/es/articles/currency-codes">here.</a><br><br>For a Cashout transaction, send the total amount of the operation<span>:</span> purchase + `cashout.cashout_amount`.

cashoutobject

Cash withdrawal dataset. Send it when the cardholder withdraws cash at the point of sale during a purchase (Cashout). Getnet Argentina (AR) only. Omit the object for purchases without cash withdrawal.<br><br>Cashout applies only to card-present transactions where `payment_method` is `DIRECT_DEBIT` and the card is a domestic debit or domestic prepaid card. The terminal must read the card by chip or contactless chip, so `data.payment.card.entry_mode` must be `chip` or `chip_contactless`.<br><br>The purchase and the withdrawal produce a single authorization record.

Show cashout properties
cashout_amountinteger<int32>required

Cash withdrawal amount in cents. Required when the `cashout` object is sent.

currency"BRL" | "ARS" | "CLP" | "USD" | "UYU" | "EUR" | "MXN"

Currency identification (See code in <a href="https://docs.globalgetnet.com/es/articles/currency-codes">this</a> section).</br><b><i>Mandatory field for <a href="https://developers.getnet.com.br/api#section/Antifraude/Dados-obrigatorios-para-analise-do-Antifraude"> Antifraud</a></i></b>

customer_idstring

Buyer identifier. Information defined by the application that consumes the Digital Platform api. </br><b><i>Mandatory field for <a href="https://developers.getnet.com.br/api#section/Antifraude/Dados-obrigatorios-para-analise-do-Antifraude"> Antifraud</a></i></b>

paymentobjectrequired

Dataset containing order items.

Show payment properties
payment_idstring

Payment identification code. If not send in the request the api will generate one in the response. Important to reconciliation process.

payment_methodstringrequired

Transaction type.<br>**Card not present methods:**<br>- CREDIT (immediate capture)<br>- DEBIT<br>- CREDIT_AUTHORIZATION (two-step, capture later)<br>- CREDIT_PRE_AUTHORIZATION<br>- VOUCHER (BR Only - Open-loop voucher payment scheme)<BR>**Card present methods:**<br>- DIRECT_CREDIT<br>- DIRECT_CREDIT_AUTHORIZATION<br>- DIRECT_CREDIT_PRE_AUTHORIZATION<br>- DIRECT_DEBIT<br>**Alternative payment methods:**<br>- INSTANT_TRANSFER<br>- INSTANT_TRANSFER_PREAUTH

save_card_databoolean

Identifies whether the card should be saved for future purchases.

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

Transaction type. Payment in full, in installments without interest, paid in installments with interest.

credentials_on_file_type"ONE_CLICK" | "ONE_CLICK_PAYMENT" | "RECURRING" | "RECURRING_PAYMENT"

Identifies a Card on File (COF) transaction and its role in a cardholder-initiated (One Click) or merchant-initiated recurring payment sequence. Use `ONE_CLICK` or `RECURRING` for the first transaction in the sequence, and `ONE_CLICK_PAYMENT` or `RECURRING_PAYMENT` for subsequent transactions. When using a `_PAYMENT` value, you must also send `transaction_id` with the value returned in the first transaction's response.

transaction_idstring

The transaction_id generated by the card brand for the original payment of a Card on File (COF) or Recurring transaction. Send it in subsequent COF transactions: one-click purchases and recurring payments. Applies to Visa, Mastercard, and Elo.

number_installmentsintegerrequired

Number of installments for an installment credit transaction.

soft_descriptorstring

<p>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.</p> <p>The card schemes require this format for Payment and SDWO facilitators. For cross-border sellers, Getnet truncates the value to 18 characters and adds a platform prefix, which overrides the facilitator format. In addition to the above, the following additional rules of the Flags must be followed:</p> <ul> <li>Identification of the Payment Facilitator, with 3, 7 or 12 characters</li> <li>Separator characters "*" (asterisk)</li> <li>Sub-trade identification</li> <li>Example 1<span>:</span> FAC*SUCOMERCIO</li> <li>Example 2<span>:</span> FACILIT*SUBCOMERCIO</li> <li>Example 3<span>:</span> FACILITADOR1*SUBCOMERC</li> <li>Example 4<span>:</span> for SDWO back-to-back<span>:</span> Carteira*Subcomercio</li> <li>Exemple 5<span>:</span> for SDWO cash-in just fill in the wallet name<span>:</span> Digital Wallet</li> </ul>

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.<br><br> <b>The card schemes require this field for Payment Facilitators and SDWO.</b>

cardobjectrequired

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 <b>Store Card in Vault</b> 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).<br><br>For **Card Present**, send Card number. Send it when `entry_mode` is `manual` or `manual_with_pass`.<br><br>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.<br>You can find test cards <a href="https://docs.globalgetnet.com/es/articles/test-cards">here.</a>

expiration_monthstring

Two-digit card expiry month.

expiration_yearstring

Two-digit card expiry year.

cardholder_namestring

Buyer's name printed on the card.</br><b><i>Mandatory field for <a href="https://developers.getnet.com.br/api#section/Antifraude/Dados-obrigatorios-para-analise-do-Antifraude">Antifraude</a></i></b >

security_codestring

Security code. CVV or CVC.</br><b><i>Mandatory field for <a href="https://developers.getnet.com.br/api#section/Antifraude/Dados-obrigatorios-para-analise-do-Antifraude">Antifraude</a></i></b >

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

Card flag. Automatically populated by the API if not informed.</br><b><i>Mandatory field for <a href="https://developers.getnet.com.br/api#section/Antifraude/Dados-obrigatorios-para-analise-do-Antifraude">Antifraude</a></i></b >

number_tokenstring

Tokenized card number (send only when the <b>number</b> and <b>card_id</b> 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)

ecistringrequired

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: <ul> <li><b>SDWO (Staged Digital Wallet Operator)<span>:</span></b> 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.</li> <li><b>Generic Wallets (Apple Pay, Google Pay, and other NFC/tokenized wallets)<span>:</span></b> wallet.type = 10. The wallet only replaces the physical card and does not participate in settlement.</li> <li><b>QR Code<span>:</span></b> use capture_type, ticket_number, capture_channel, identification, plans, and sub_plan.</li> </ul>

Show wallet properties
type"01" | "02" | "10" | "55"

Wallet Type<span>:</span> <ul> <li>01<span>:</span> MasterPass Wallet</li> <li>02<span>:</span> Visa Checkout</li> <li>10<span>:</span> Generic Tokenized Wallet</li> <li>55<span>:</span> SDWO (Local Brazil Wallet)</li> </ul>

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

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

merchant_idstring

Identification number of the Digital Wallet registered with the card brand. Required for Visa, Mastercard, and Elo; not applicable for Amex.<br><br> <b>Visa</b> = MVV (Merchant Value Verification) with 6 positions<br> <b>Mastercard</b> = WID (Wallet ID) with 3 positions<br> <b>Elo</b> = WID (Wallet ID) with 11 positions<br> <b>Amex</b> = Not applicable<br>

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. <br><br><b>Google Pay</b> = Base64-encoded value of paymentMethodData.tokenizationData.token. <br><b>Apple Pay</b> = Hexadecimal-encoded value of pkPaymentToken. See <a href="https://docs.globalgetnet.com/en/products/online-payments/regional-api?doc=apple-pay">Handling the Apple Pay payload</a> for the full extraction and encoding steps. <br><br>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.<br><br> <b>FT</b> Funding Transfer: Cash-in transactions, for all brands.<br> <b>FP</b> Funding and Purchase: Back-to-back transactions, for all brands.<br> <b>PP</b> Peer-to-Peer: transfer between different users/different ownership, for Mastercard, Visa, and Amex.<br> <b>BP</b> 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.<br><br> - <b>00 — Other (Default, currently the only allowed value)</b><br> - 01 — RTN + Bank Account<br> - 02 — IBAN<br> - 03 — Card Account (for getnet currently only available type)<br> - 04 — <span>E-mail</span><br> - 05 — Phone Number<br> - 06 — Bank account number (BAN) + Code Bank Identification (BIC)<br> - 07 — Wallet ID<br> - 08 — Social Network ID<br><br> 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.<br> - 00 = Passport<br> - 01 = National Identification Card<br> - 02 = Driver's License<br> - 03 = Issued by the Government<br> - 04 = Other<br>

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.<br>Denotes the capture type and must be sent in all the Sale and Cancellation/Refunds transactions:<br>0 - POS<br>1 - TEF<br>2 - Ecommerce<br>3 - Recurring Payment<br>4 - Mobile POS

ticket_numberstring

**Only QRCode transactions**<br>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**<br>Numeric field of fixed length with 2 digits justified to the right and completed by zeros. Channel capture type indicator

identificationstring

**Only QRCode transactions**<br>

plans"01" | "02"

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

sub_plan"01" | "02"

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

xidstring

3-D Secure authentication transaction identifier. **Required for 3DS 1.x** transactions. For **3DS 2.x and later**, this field is optional and may be populated for backward compatibility.

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").

terminalobject

Terminal dataset **is a Mandatory object for Card Present**.

Show terminal properties
terminal_numberstringrequired

Terminal number identification **is a Mandatory field for Card Present**.

logical_codestringrequired

Logical code of the terminal **is a Mandatory field for Card Present**.

serial_numberstringrequired

Serial number of the terminal **is a Mandatory field for Card Present**.

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.<br><br> **Who sends it:**<br>- **Payment facilitators**, on every card authorization. Your Getnet credential determines whether you send it, so confirm your coverage with Integration Support.<br><br> **Where the values come from:**<br>- 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.<br><br> **Which operations use it:**<br>- [Create - Authorize](#tag/payments/post/dpm/payments-gwproxy/v2/payments) and [Combined Payments - Authorize](#tag/combined-payments/post/dpm/payments-gwproxy/v2/payments/combined) act on the object. In a combined payment, Getnet applies it to every payment in the `payments` array.<br>- [Create an Invoice/Boleto](#tag/payments/post/dpm/payments-gwproxy/v2/payments/boleto) rejects it with a validation error.<br>- [Cancel](#tag/payments/post/dpm/payments-gwproxy/v2/payments/cancel) accepts it and ignores it.<br><br> **Market-specific requirements:**<br>- 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`.<br><br>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 authorization data. Required field for payment split.

Show additional_data properties
splitobject

Data for split payment. Required field for payment split.

Show split properties
subseller_list_paymentobject[]required

List of Stores and their due amounts for payment.

Show subseller_list_payment properties
subseller_idstringrequired

Subseller ID registered on the marketplace platform (MGM).

document_type"CPF" | "CNPJ"

Sub-trade document type.

document_numberstringrequired

Sub-trade document number without punctuation. (without mask)

subseller_sale_amountintegerrequired

Part of the Store Value in relation to the Order (in cents).

itemsobject[]required

List of Subtrade items.

Show items properties
idstringrequired

Item/Product Identifier.

descriptionstringrequired

Item/Product Description.

currencystring

Currency identification code for the item.

amountintegerrequired

Item/Product value (in cents).

transaction_rate_percentnumber

Fee to be charged on the item in percentage if not send the rate will be set the same as the registration. <br />If <b>transaction_rate_percent</b> is informed, the <b>transaction_rate_amount</b> should not be sent. <br />Note: If <b>transaction_rate_percent</b> and <b>transaction_rate_amount</b> are sent for the same item the values ​​will be added together.

transaction_rate_amountinteger

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. <br />If <b>transaction_rate_amount</b> is informed, the <b>transaction_rate_percent</b> must not be sent. <br />Note: If <b>transaction_rate_percent</b> and <b>transaction_rate_amount</b> are sent to the same item the values ​​will be added.

payment_planinteger

Subseller Payment Plan.

urlstring<uri>

URL of the seller's website (BR only). This field carries the seller's own URL, not sub-merchant data. Send the sub-merchant's website in <b>data.sub_merchant.acceptor.url_address</b>.

deviceobject

Set of data referring to the device used by the buyer.</br><b><i>Required fields for <a href="https://docs.globalgetnet.com/es/products/online-payments/regional-api?doc=api-ref-antifraud">Antifraud</a></i></b>

Show device properties
ip_addressstringrequired

string <IPv4> IP address (IPv4) of the buyer's device. This attribute must be captured by your application, from the device of the buyer (mobile; browser; etc.) and sent in the payload, in order to enrich our preventive analyses.

device_idstringrequired

Device unique Id.

finger_printstringrequired

Identification hash (Device Fingerprint) of the device.

customerobjectrequired
Show customer properties
document_typestring

Type of the buyer's identification document. Mandatory for billet. </br> Suggested Values <b>CPF</b>, <b>CNPJ</b>, <b>RNE</b>, <b>RG</b>, <b>CNAE</b>, <b>UYCI</b>, <b>PASSPORT</b> ou <b>Document in accordance with current legislation in the country of origin<br><br>See all the accepted types <a href="https://docs.globalgetnet.com/es/articles/document-types">here.</a><br><br><b><i>Mandatory field for <a href="https://developers.getnet.com.br/idempotency#section/Antifraude/Dados-obrigatorios-para-analise-do-Antifraude">Antifraude</a></i></b></b>

document_numberstring

Purchaser's document number without punctuation. (without mask) </br><b><i>Mandatory field for <a href="https://developers.getnet.com.br/api#section/Antifraude/Dados-obrigatorios-para-analise-do-Antifraude"> Antifraud</a></i></b>

emailstring

Purchaser's email. </br><b><i>Mandatory field for <a href="https://developers.getnet.com.br/api#section/Antifraude/Dados-obrigatorios-para-analise-do-Antifraude"> Antifraud</a></i></b>

namestring

Purchaser's name. </br><b><i>Mandatory field for <a href="https://developers.getnet.com.br/api#section/Antifraude/Dados-obrigatorios-para-analise-do-Antifraude"> Antifraud</a></i></b>

phone_numberstring

Purchaser's phone number. </br><b><i>Mandatory field for <a href="https://developers.getnet.com.br/api#section/Antifraude/Dados-obrigatorios-para-analise-do-Antifraude"> Antifraud</a></i></b>

billing_addressobject
Show billing_address properties
streetstring

Street. </br><b><i>Mandatory field for <a href="https://developers.getnet.com.br/api#section/Antifraude/Dados-obrigatorios-para-analise-do-Antifraude"> Antifraud</a></i></b>

numberstring

Street number. </br><b><i>Mandatory field for <a href="https://developers.getnet.com.br/api#section/Antifraude/Dados-obrigatorios-para-analise-do-Antifraude"> Antifraud</a></i></b>

districtstring

District. </br><b><i>Mandatory field for <a href="https://developers.getnet.com.br/api#section/Antifraude/Dados-obrigatorios-para-analise-do-Antifraude"> Antifraud</a></i></b>

citystring

City. </br><b><i>Mandatory field for <a href="https://developers.getnet.com.br/api#section/Antifraude/Dados-obrigatorios-para-analise-do-Antifraude"> Antifraud</a></i></b>

statestring

State (UF). </br><b><i>Mandatory field for <a href="https://developers.getnet.com.br/api#section/Antifraude/Dados-obrigatorios-para-analise-do-Antifraude"> Antifraud</a></i></b>

countrystring

Country. </br> Report in the ISO 3166-1 alpha-3 standard </br> Example "BRA", "USA" and "ARG" </br><b><i>Mandatory field for <a href="https://developers.getnet.com.br/api#section/Antifraude/Dados-obrigatorios-para-analise-do-Antifraude"> Antifraud</a></i></b>

postal_codestring

Postal Code, CEP in Brazil or ZIP in the United States. (without mask) </br><b><i>Mandatory field for <a href="https://developers.getnet.com.br/api#section/Antifraude/Dados-obrigatorios-para-analise-do-Antifraude"> Antifraud</a></i></b>

complementstring

Address complement. </br><b><i>Mandatory field for <a href="https://developers.getnet.com.br/api#section/Antifraude/Dados-obrigatorios-para-analise-do-Antifraude"> Antifraud</a></i></b>

type"RESIDENCIAL" | "INSTALACAO" | "CORRESPONDENCIA" | "FISCAL" | "COBRANCA"
shippingsobject
Show shippings properties
addressstring

Set of data referring to the buyer's address

streetstring
numberstring
districtstring
citystring
countrystring
postal_codestring
complementstring
typestring
orderobject

Set of line items in the shopping cart, sent as additional data for the authorization.

Show order properties
itemsobject[]

List of items included in the order.

Show items properties
namestring

Name of the product or item.

quantitystring

Quantity of the item purchased.

skustring

Unique identifier (SKU) of the item.

pricestring

Unit price of the item.

installmentobject

See the <a href="https://docs.globalgetnet.com/es/products/online-payments/regional-api?doc=handlingpayments-intallments">documentation</a> for installments.

Show installment properties
quote_idstring

Quote ID to be used in the query.<br> <b>Required for AR and CL</b>

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.<br> <b>Required for UY</b>

numbernumber

Number of installments available for the credit. Required for UY

airlineobject

Data structure containing airline details. Applies only for airline transactions.

Show airline properties
boarding_feestring

Allows a different amount to be charged for the first installment related to the boarding fee. (BR Only)

passenger_codestring

File key of the Passenger Name Record (PNR). This field is required for transactions using an AirPlus UATP card.

company_idstring
airline_codestring

3-digit IATA (International Air Transport Association) code used to identify the carrier

travel_agency_codestring

IATA number or ARC (Airlines Reporting Corporation) number of the travel agency that issued the ticket

ticket_numberstring[]
ratesobject[]

List of rates.

Show rates properties
keystringrequired

Rate identifier.

valuenumberrequired

Value in percent.

dynamic_currency_conversionobject

Data structure containing dynamic currency conversion details.

Show dynamic_currency_conversion properties
currencystring
amountnumber<double>
conversion_ratenumber<double>
datestring
markupnumber<double>
sourceobject
Show source properties
idstring

fx_rate_id field received in CrossBorder resource

namestring
regional_regulation_codeobject[]

(Uruguay only). Send when the transaction must be evaluated under a supported regional regulation or tax benefit code. Supported codes are "17934" (credit and debit cards) and "19210" (debit cards only). Omit the field when the transaction is not eligible for a regional tax benefit or does not require special regulatory treatment. Unrecognized codes are ignored and no discount is applied.

Show regional_regulation_code properties
codestringrequired

Regional regulation or tax benefit law code. Use "17934" for credit and debit cards, or "19210" for debit cards only.

invoicestring

Optional. Invoice, receipt, or internal fiscal document identifier linked to the transaction, used for traceability only. Up to 9 characters, alphanumeric; numbers recommended. If omitted, SEP fills the field with the first 9 digits of order_id. Automatically generated values are informational and have no fiscal validity.

cross_border_dataobject

Data structure containing data about cross-border (FX) transactions.

Show cross_border_data properties
consumer_dataobjectrequired

Customer data

Show consumer_data properties
emailstringrequired

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

first_namestringrequired

Customer first name. Required when type = INDIVIDUAL.

last_namestringrequired

Customer last name. Required when type = INDIVIDUAL.

legal_namestringrequired

Company name. Required when type = COMPANY.

document_numberstringrequired

Customer document number.

type"INDIVIDUAL" | "COMPANY"required

Type of customer.

Response

Transaction executed successfully.

idempotency_keystring

Same sent in the request.

seller_idstring
request_idstring
payment_idstring
order_idstring
amountstring
cashoutobject

Cash withdrawal data. Returned when the transaction carried a `data.cashout` object. Getnet Argentina (AR) only.

Show cashout properties
cashout_amountinteger<int32>

Cash withdrawal amount, in cents.

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

Authorization Status

payment_methodstring
received_atstring
transaction_idstring
original_transaction_idstring
authorized_atstring
reason_codestring
reason_messagestring
acquirerstring
soft_descriptorstring
brandstring
authorization_codestring
acquirer_transaction_idstring
ecistring
payment_received_timestampstring
card_idstring
boletoobject
Show boleto properties
boleto_idstring
bankstring
status_codestring
status_labelstring
typeful_linestring
bar_codestring
issue_datestring
expiration_datestring
our_numberstring
document_numberstring
pixobject
Show pix properties
cod_qrcodestring
cod_url_qrcodestring
_linksobject[]
Show _links properties
hrefstring
relstring
typestring
merchant_advice_codestring
additional_dataobject

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" \
  -H "Content-Type: application/json" \
  -H "x-transaction-channel-entry: <x-transaction-channel-entry>" \
  -d '{
  "idempotency_key": "63c7f8ee-51a6-470d-bb76-ef762b62bfb7",
  "request_id": "daac03dc-73db-453f-9bea-b1391669d5d3",
  "order_id": "ORDER-10187383",
  "data": {
    "amount": 118708,
    "cashout": {
      "cashout_amount": 10000
    },
    "currency": "BRL",
    "customer_id": "test",
    "payment": {
      "payment_id": "173f9e8d-4e0b-4503-8016-5cdafba89bee",
      "payment_method": "CREDIT",
      "save_card_data": false,
      "transaction_type": "FULL",
      "credentials_on_file_type": "ONE_CLICK_PAYMENT",
      "transaction_id": "MCC00DTEJ0714",
      "number_installments": 1,
      "soft_descriptor": "LOJA*TESTE*COMPRA-123",
      "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",
      "terminal": {
        "terminal_number": "TF009560",
        "logical_code": "TF009560",
        "serial_number": "TF7551190428"
      }
    },
    "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": {
      "split": {
        "subseller_list_payment": [
          {
            "subseller_id": "700104158",
            "document_type": "CNPJ",
            "document_number": "12345678912",
            "subseller_sale_amount": 118708,
            "items": [
              null
            ]
          }
        ]
      },
      "url": "https://site.getnet.com.br",
      "device": {
        "ip_address": "10.0.0.1",
        "device_id": "ae44e06c-3e85-44af-8542-bcaccd54ef2e",
        "finger_print": "aGVsbG8td29ybGQtZGV2aWNlLWlkCg=="
      },
      "customer": {
        "document_type": "CPF",
        "document_number": 2441356709,
        "email": "aceiti@getnet.com.br",
        "name": "Jose da Silva",
        "phone_number": 11999999999,
        "billing_address": {
          "street": "string",
          "number": "string",
          "district": "string",
          "city": "string",
          "state": "string",
          "country": "string",
          "postal_code": "string",
          "complement": "string",
          "type": "RESIDENCIAL"
        },
        "shippings": {
          "address": "string",
          "street": "string",
          "number": "string",
          "district": "string",
          "city": "string",
          "country": "string",
          "postal_code": "string",
          "complement": "string",
          "type": "string"
        }
      },
      "order": {
        "items": [
          {
            "name": "Product name",
            "quantity": 1,
            "sku": "Product identifier",
            "price": 412
          }
        ]
      },
      "installment": {
        "quote_id": "06f256c8-1bbf-42bf-93b4-ce2041bfb87e",
        "schema": "plan_ahora",
        "type": "00",
        "code": "00",
        "number": 2
      },
      "airline": {
        "boarding_fee": "1000",
        "passenger_code": "1234567890",
        "company_id": "1220",
        "airline_code": "022",
        "travel_agency_code": "s517",
        "ticket_number": [
          [
            "125769"
          ]
        ]
      },
      "rates": [
        {
          "key": "iva",
          "value": 8
        }
      ],
      "dynamic_currency_conversion": {
        "currency": "string",
        "amount": 0,
        "conversion_rate": 0,
        "date": "string",
        "markup": 0,
        "source": {
          "id": "string",
          "name": "tradefx"
        }
      },
      "regional_regulation_code": [
        {
          "code": "17934",
          "invoice": "846352"
        }
      ],
      "cross_border_data": {
        "consumer_data": {
          "email": "customer@email.com",
          "first_name": "John",
          "last_name": "Doe",
          "legal_name": "ABC Corporation",
          "document_number": "80026928027",
          "type": "INDIVIDUAL"
        }
      }
    }
  }
}'
Response
{
  "idempotency_key": "string",
  "seller_id": "string",
  "request_id": "string",
  "payment_id": "string",
  "order_id": "string",
  "amount": "string",
  "cashout": {
    "cashout_amount": 10000
  },
  "currency": "string",
  "status": "APPROVED",
  "payment_method": "string",
  "received_at": "string",
  "transaction_id": "string",
  "original_transaction_id": "string",
  "authorized_at": "string",
  "reason_code": "string",
  "reason_message": "string",
  "acquirer": "string",
  "soft_descriptor": "string",
  "brand": "string",
  "authorization_code": "string",
  "acquirer_transaction_id": "string",
  "eci": "string",
  "payment_received_timestamp": "string",
  "card_id": "string",
  "boleto": {
    "boleto_id": "string",
    "bank": "string",
    "status_code": "string",
    "status_label": "string",
    "typeful_line": "string",
    "bar_code": "string",
    "issue_date": "string",
    "expiration_date": "string",
    "our_number": "string",
    "document_number": "string",
    "pix": {
      "cod_qrcode": "string",
      "cod_url_qrcode": "string"
    },
    "_links": [
      {
        "href": "string",
        "rel": "string",
        "type": "string"
      }
    ]
  },
  "merchant_advice_code": "string",
  "additional_data": {}
}