Skip to main content

​
Resumo

Você pode enviar um objeto paymentDetails dentro de originDetails e/ou destinationDetails ao criar uma transação. Esta página descreve estruturas sugeridas por método de pagamento. Nada é exigido: a API aceita qualquer formato e campos extras; use apenas como referência.
  • Onde: originDetails.paymentDetails, destinationDetails.paymentDetails
  • Opcional: Sim. Omita se não precisar de detalhes de pagamento.
  • Campos custom: Qualquer chave adicional é armazenada como está. Você não está restrito aos campos abaixo.

​
Parte desconhecida (visualização em grafos)

Quando a origem ou o destino não é uma entidade no gu1 (você não envia originEntityId/originExternalId ou destinationEntityId/destinationExternalId), pode enviar dados identificadores para que os grafos de rede mostrem um único nó “pseudo” por parte desconhecida:
CampoTipoNotas
taxIdstringEx.: CPF, CNPJ. Usado para agrupar a mesma parte em várias transações; mesmo taxId = um nó no grafo.
accountNumberstringNúmero da conta. Usado quando não há taxId; agrupado com bankCode opcional.
bankCodestringOpcional; melhora o agrupamento com accountNumber.
Estes campos são opcionais e de uso interno (visualização em grafos). Não são obrigatórios para criar a transação.

​
Cartão (CARD)

Campos sugeridos quando paymentMethod é CARD:
CampoTipoNotas
cardholderNamestringNome no cartão
cardLast4stringÚltimos 4 dígitos (4 caracteres)
cardBrandstringex.: Visa, Mastercard, Amex, Discover, Other
cardTypestringcredit, debit, prepaid
expiryMonthstringMM (01-12)
expiryYearstringYYYY
bankNamestringBanco emissor
bankCodestringCódigo do banco
accountTypestringpersonal, business, merchant
issuerCountrystringPaís emissor (ISO 2 letras)
binstringPrimeiros 6 dígitos (BIN)
timestampstringQuando o pagamento ocorreu
transactionIdstringSua referência de transação
referencestringReferência adicional
countrystringISO 2 letras

​
PIX (Brasil)

Campos sugeridos para PIX:
CampoTipoNotas
pixKeystringChave PIX (email, telefone, CPF, CNPJ ou aleatória)
pixTypestringemail, phone, cpf, cnpj, random
bankNamestringNome do banco
bankCodestringCódigo do banco
endToEndIdstringID end-to-end PIX
returnIdentificationstringIdentificação de retorno
timestampstring
transactionIdstring
referencestring
countrystringISO 2 letras

​
Transferência bancária (ACH, wire, SEPA, TED)

Campos sugeridos genéricos:
CampoTipoNotas
accountNumberstringNúmero da conta
routingNumberstringRouting number (EUA)
swiftCodestringSWIFT/BIC
ibanstringIBAN
bankNamestringNome do banco
bankCodestringCódigo do banco
accountTypestringchecking, savings, business
transferTypestringwire, ach, sepa, ted, other
timestampstring
transactionIdstring
referencestring
countrystringISO 2 letras

​
CBU / CVU (Argentina)

Campos sugeridos para CBU/CVU:
CampoTipoNotas
cbustringCBU (22 dígitos)
cvustringCVU (22 dígitos)
aliasstringAlias
bankNamestringNome do banco
bankCodestringCódigo do banco
accountTypestringcaja_ahorro, cuenta_corriente
timestampstring
transactionIdstring
referencestring
countrystringISO 2 letras

​
SPEI (México)

Campos sugeridos: clabe (18 dígitos), bankName, bankCode, trackingKey, timestamp, transactionId, reference, country.

​
PSE (Colômbia)

Campos sugeridos: bankName, bankCode, transactionReference, pseTransactionId, timestamp, transactionId, reference, country.

​
DEBIN (Argentina)

Campos sugeridos: debinId, bankName, bankCode, cbu (22 dígitos), timestamp, transactionId, reference, country.

​
Criptomoedas

Campos sugeridos: walletAddress, cryptoType (bitcoin, ethereum, usdt, usdc, stablecoin, other), network, txHash, confirmations, gasFee, timestamp, transactionId, reference, country.

​
Dinheiro

Campos sugeridos: location, receiptNumber, cashierName, timestamp, transactionId, reference, country.

​
Cheque

Campos sugeridos: checkNumber, bankName, routingNumber, accountNumber, timestamp, transactionId, reference, country.

​
E-Wallet / carteira digital

Campos sugeridos: walletProvider (ex.: PayPal, Mercado Pago), walletId, accountEmail, accountPhone, walletType (digital, mobile, crypto), timestamp, transactionId, reference, country.

​
Outro / genérico

Para qualquer outro método: timestamp, transactionId, reference, country e qualquer chave custom que precisar.

​
Exemplos

Origem com paymentDetails de cartão: 
{
  "originDetails": {
    "deviceType": "mobile",
    "ipAddress": "189.123.45.67",
    "country": "BR",
    "paymentDetails": {
      "cardLast4": "4242",
      "cardBrand": "Visa",
      "cardType": "credit",
      "issuerCountry": "BR",
      "bin": "123456"
    }
  }
}
Destino com paymentDetails PIX: 
{
  "destinationDetails": {
    "merchantName": "Loja XYZ",
    "mcc": "5411",
    "paymentDetails": {
      "pixKey": "loja@email.com",
      "pixType": "email",
      "bankName": "Banco do Brasil",
      "endToEndId": "E12345678202101011200abc123"
    }
  }
}
Campos sugeridos + custom: Você pode misturar qualquer campo acima com chaves próprias; a API não restringe as chaves dentro de paymentDetails.

​
Ver também