Skip to main content

​
Overview

You can send a paymentDetails object inside originDetails and/or destinationDetails when creating a transaction. This page describes suggested structures by payment method so the client knows what can be sent. Nothing is enforced: the API accepts any shape and any extra fields; use these as a reference only.
  • Where: originDetails.paymentDetails, destinationDetails.paymentDetails
  • Optional: Yes. Omit if you don’t need payment-level details.
  • Custom fields: Any additional keys are stored as-is. You are not restricted to the fields below.

​
Unknown party (graph visualization)

When origin or destination is not an entity in gu1 (you do not send originEntityId/originExternalId or destinationEntityId/destinationExternalId), you can still send identifying data so that network graphs show a single “pseudo” node per unknown party instead of hiding the flow:
FieldTypeNotes
taxIdstringTax ID (e.g. CPF, CNPJ). Used to group the same unknown party across transactions; same taxId = one node in the graph. Digits only for grouping.
accountNumberstringAccount number. Used when no taxId; grouped with optional bankCode.
bankCodestringOptional; improves grouping with accountNumber.
These fields are optional and for internal use only (graph visualization). They are not required for creating the transaction.

​
Card (CARD)

Suggested fields when paymentMethod is CARD (or for card-related context):
FieldTypeNotes
cardholderNamestringName on card
cardLast4stringLast 4 digits (4 chars)
cardBrandstringe.g. Visa, Mastercard, Amex, Discover, Other
cardTypestringcredit, debit, prepaid
expiryMonthstringMM (01-12)
expiryYearstringYYYY
bankNamestringIssuer bank
bankCodestringBank code
accountTypestringpersonal, business, merchant
issuerCountrystringISO 2-letter country
binstringFirst 6 digits (BIN)
timestampstringWhen the payment occurred
transactionIdstringYour transaction reference
referencestringAdditional reference
countrystringISO 2-letter

​
PIX (Brasil)

Suggested fields for PIX:
FieldTypeNotes
pixKeystringPIX key (email, phone, CPF, CNPJ, or random)
pixTypestringemail, phone, cpf, cnpj, random
bankNamestringBank name
bankCodestringBank code
endToEndIdstringPIX end-to-end ID
returnIdentificationstringReturn identification
timestampstring
transactionIdstring
referencestring
countrystringISO 2-letter

​
Bank transfer (ACH, wire, SEPA, TED)

Generic bank transfer suggested fields:
FieldTypeNotes
accountNumberstringAccount number
routingNumberstringUS routing number
swiftCodestringSWIFT/BIC
ibanstringIBAN
bankNamestringBank name
bankCodestringBank code
accountTypestringchecking, savings, business
transferTypestringwire, ach, sepa, ted, other
timestampstring
transactionIdstring
referencestring
countrystringISO 2-letter

​
CBU / CVU (Argentina)

Suggested fields for Argentine CBU/CVU:
FieldTypeNotes
cbustringCBU (22 digits)
cvustringCVU (22 digits)
aliasstringAlias
bankNamestringBank name
bankCodestringBank code
accountTypestringcaja_ahorro, cuenta_corriente
timestampstring
transactionIdstring
referencestring
countrystringISO 2-letter

​
SPEI (México)

Suggested fields for SPEI:
FieldTypeNotes
clabestringCLABE (18 digits)
bankNamestringBank name
bankCodestringBank code
trackingKeystringTracking key
timestampstring
transactionIdstring
referencestring
countrystringISO 2-letter

​
PSE (Colombia)

Suggested fields for PSE:
FieldTypeNotes
bankNamestringBank name
bankCodestringBank code
transactionReferencestringPSE transaction reference
pseTransactionIdstringPSE transaction ID
timestampstring
transactionIdstring
referencestring
countrystringISO 2-letter

​
DEBIN (Argentina)

Suggested fields for DEBIN:
FieldTypeNotes
debinIdstringDEBIN ID
bankNamestringBank name
bankCodestringBank code
cbustringCBU (22 digits)
timestampstring
transactionIdstring
referencestring
countrystringISO 2-letter

​
Cryptocurrency

Suggested fields for crypto payments:
FieldTypeNotes
walletAddressstringWallet address
cryptoTypestringbitcoin, ethereum, usdt, usdc, stablecoin, other
networkstringBlockchain network
txHashstringTransaction hash
confirmationsnumberNumber of confirmations
gasFeestringGas fee
timestampstring
transactionIdstring
referencestring
countrystringISO 2-letter

​
Cash

Suggested fields for cash:
FieldTypeNotes
locationstringWhere the payment was made
receiptNumberstringReceipt number
cashierNamestringCashier name
timestampstring
transactionIdstring
referencestring
countrystringISO 2-letter

​
Check

Suggested fields for check payments:
FieldTypeNotes
checkNumberstringCheck number
bankNamestringBank name
routingNumberstringRouting number
accountNumberstringAccount number
timestampstring
transactionIdstring
referencestring
countrystringISO 2-letter

​
Money order

Suggested fields:
FieldTypeNotes
moneyOrderNumberstringMoney order number
issuerstringIssuer
timestampstring
transactionIdstring
referencestring

​
E-Wallet / digital wallet

Suggested fields for wallets (PayPal, Mercado Pago, etc.):
FieldTypeNotes
walletProviderstringe.g. PayPal, Venmo, Mercado Pago
walletIdstringWallet identifier
accountEmailstringEmail linked to wallet
accountPhonestringPhone linked to wallet
walletTypestringdigital, mobile, crypto
timestampstring
transactionIdstring
referencestring
countrystringISO 2-letter

​
Other / generic

For any other method you can send:
FieldTypeNotes
timestampstring
transactionIdstring
referencestring
countrystringISO 2-letter
Plus any custom keys you need.

​
Examples

Origin with card paymentDetails: 
{
  "originDetails": {
    "deviceType": "mobile",
    "ipAddress": "189.123.45.67",
    "country": "BR",
    "paymentDetails": {
      "cardLast4": "4242",
      "cardBrand": "Visa",
      "cardType": "credit",
      "issuerCountry": "BR",
      "bin": "123456"
    }
  }
}
Destination with PIX paymentDetails: 
{
  "destinationDetails": {
    "merchantName": "Loja XYZ",
    "mcc": "5411",
    "paymentDetails": {
      "pixKey": "loja@email.com",
      "pixType": "email",
      "bankName": "Banco do Brasil",
      "endToEndId": "E12345678202101011200abc123"
    }
  }
}
Mixing suggested + custom fields: 
{
  "originDetails": {
    "paymentDetails": {
      "cardLast4": "1234",
      "cardBrand": "Mastercard",
      "myCustomField": "any value",
      "internalRef": "ABC-999"
    }
  }
}
All of the above are accepted. The API does not restrict keys inside paymentDetails.

​
See also