For AI agents: visit https://openbanking-oxpay.readme.io/llms.txt for an index of all pages formatted in Markdown and endpoints in OpenAPI.
| Chave | Tipo | Descrição |
|---|
| description | String | Deve conter um texto descrevendo essa transação. |
| additional_data | String | Campo adicional em texto que pode ser utilizado como uma descrição extra da transação. |
| amount | Number | Utilizado para informar o valor da transação. |
| date | Date | Todos os registros de data e hora são retornados no formato completo ISO 8601 em UTC ( AAAA-MM-DDTHH:MM:SS). |
| expiration_date | Date | Todos os registros de data e hora são retornados no formato completo ISO 8601 em UTC ( AAAA-MM-DDTHH:MM:SS). |
| bank_code | String | Código do banco para essa transação se necessário, sendo ele o ISPB ou o próprio código fornecido pelo banco. |
| document | String | Campo destinado ao CPF ou CNPJ da conta. |
| branch | String | Agência da conta |
| branch_digit | String | Dígito da agência da conta |
| account | String | Número da conta bancária |
| account_digit | String | Dígito do número da conta bancária |
| account_type | String | Tipo da conta para essa transação se necessário. Consulte os tipos de contas aqui . |
| name | String | Nome do destinatário, se necessário apenas. |
| email | String | Email do destinatário, se necessário apenas. |
| pix_key | String | Chave pix. |
| pix_transaction_id | String | Id da transação pix. |
| pix_qrcode | String | Valor do QrCode pix. |
| bank_slip | String | Código de barras do boleto bancário. |
| is_salary | Boolean | Campo destinado a informar se for um pagamento equivalente a salário. |
| message | String | Mensagem ao destinatário |
| Chave | Valor | Tipo de Conta |
|---|
| Checking | CC | Conta Corrente |
| Deposit | CD | Conta de Depósito |
| Granted | CG | Conta Garantia |
| Payment | PG | Conta de Pagamento |
| Saving | PP | Conta Poupança |
| Chave | Valor | Status da movimentação |
|---|
| Created | 01 | Criado |
| AwaitingProcessing | 02 | Aguardando Processamento |
| AwaitingApproval | 03 | Aguardando Aprovação |
| Processing | 04 | Processando |
| Cancelled | 05 | Cancelado |
| Done | 06 | Finalizado |
| Error | 07 | Erro |
| AwaitingBalance | 08 | Aguardando Saldo |
| AwaitingBilling | 09 | Aguardando Fatura |
| AwaitingAnalysis | 10 | Aguardando Análise |
| LoadingPreview | 11 | Carregando Prévia |
| Chave | Valor | Status da Ordem |
|---|
| Created | 01 | Criado |
| AwaitingProcessing | 02 | Aguardando Processamento |
| AwaitingApproval | 03 | Aguardando Aprovação |
| Processing | 04 | Processando |
| Cancelled | 05 | Cancelado |
| Done | 06 | Finalizado |
| AwaitingBalance | 07 | Aguardando Saldo |
| AwaitingBilling | 08 | Aguardando Cobrança |
| LoadingPreview | 09 | Carregando Prévia |
| Chave | Valor | Tipo da Chave |
|---|
| Transfer | 1 | Transferência |
| Bill | 2 | Cobrança |
| Validation | 3 | Validação |
| CashIn | 4 | Depósito |
| BrCodeBilling | 5 | Cobrança QrCode |
| Consignable | 6 | Consignação |
| Chave | Valor | Método de Pagamento |
|---|
| TedOut | 01 | Ted |
| PixIn | 02 | Pix |
| PixOut | 03 | Pix |
| TedIn | 05 | Ted |
| InternalOut | 06 | Ox |
| InternalIn | 07 | Ox |
| BankSlip | 08 | Boleto |
| ConsignationRelease | 09 | Antecipação |
| ConsignableBalanceOut | 10 | Aporte de Antecipação |
| PixRefund | 11 | Estorno |
| ConsignationIn | 12 | Antecipação |
| Card | 13 | Cartão |