Glossário

Tabela de campos para corpo de transação

ChaveTipoDescrição
descriptionStringDeve conter um texto descrevendo essa transação.
additional_dataStringCampo adicional em texto que pode ser utilizado como uma descrição extra da transação.
amountNumberUtilizado para informar o valor da transação.
dateDateTodos os registros de data e hora são retornados no formato completo ISO 8601 em UTC ( AAAA-MM-DDTHH:MM:SS).
expiration_dateDateTodos os registros de data e hora são retornados no formato completo ISO 8601 em UTC ( AAAA-MM-DDTHH:MM:SS).
bank_codeStringCódigo do banco para essa transação se necessário, sendo ele o ISPB ou o próprio código fornecido pelo banco.
documentStringCampo destinado ao CPF ou CNPJ da conta.
branchStringAgência da conta
branch_digitStringDígito da agência da conta
accountStringNúmero da conta bancária
account_digitStringDígito do número da conta bancária
account_typeStringTipo da conta para essa transação se necessário. Consulte os tipos de contas aqui .
nameStringNome do destinatário, se necessário apenas.
emailStringEmail do destinatário, se necessário apenas.
pix_keyStringChave pix.
pix_transaction_idStringId da transação pix.
pix_qrcodeStringValor do QrCode pix.
bank_slipStringCódigo de barras do boleto bancário.
is_salaryBooleanCampo destinado a informar se for um pagamento equivalente a salário.
messageStringMensagem ao destinatário

Tipos de Contas

ChaveValorTipo de Conta
CheckingCCConta Corrente
DepositCDConta de Depósito
GrantedCGConta Garantia
PaymentPGConta de Pagamento
SavingPPConta Poupança

Status de Movimentações

ChaveValorStatus da movimentação
Created01Criado
AwaitingProcessing02Aguardando Processamento
AwaitingApproval03Aguardando Aprovação
Processing04Processando
Cancelled05Cancelado
Done06Finalizado
Error07Erro
AwaitingBalance08Aguardando Saldo
AwaitingBilling09Aguardando Fatura
AwaitingAnalysis10Aguardando Análise
LoadingPreview11Carregando Prévia

Status da Ordem

ChaveValorStatus da Ordem
Created01Criado
AwaitingProcessing02Aguardando Processamento
AwaitingApproval03Aguardando Aprovação
Processing04Processando
Cancelled05Cancelado
Done06Finalizado
AwaitingBalance07Aguardando Saldo
AwaitingBilling08Aguardando Cobrança
LoadingPreview09Carregando Prévia

Tipos da Ordem

ChaveValorTipo da Chave
Transfer1Transferência
Bill2Cobrança
Validation3Validação
CashIn4Depósito
BrCodeBilling5Cobrança QrCode
Consignable6Consignação

Métodos de Pagamento

ChaveValorMétodo de Pagamento
TedOut01Ted
PixIn02Pix
PixOut03Pix
TedIn05Ted
InternalOut06Ox
InternalIn07Ox
BankSlip08Boleto
ConsignationRelease09Antecipação
ConsignableBalanceOut10Aporte de Antecipação
PixRefund11Estorno
ConsignationIn12Antecipação
Card13Cartão