1. Dados bancários
| Campo | Descrição | Usado em |
|---|---|---|
| branch | Código da agência bancária | CRM, PIX |
| account | Número da conta | CRM |
| bankAccount | Número da conta bancária (até 20 dígitos) | PIX |
| bankAccountType | Tipo de conta | PIX |
| accountNumber | Número de conta genérico | PIX |
| accountDigit | Dígito verificador | PIX |
| agency | Agência bancária | PIX |
| accountType | Tipo de conta | CRM, PIX |
| iban | International Bank Account Number | CRM |
| bankId | Identificador do banco | CRM, PIX |
| openingDate | Data de abertura da conta | CRM |
2. Chaves PIX
| Campo | Descrição | Usado em |
|---|---|---|
| key | Valor da chave PIX | PIX |
| keyType | Tipo de chave (e-mail, telefone, CPF/CNPJ, aleatória) | PIX |
| requiresConfirmation | Requer confirmação por token | PIX |
| confirmationToken | Token para confirmação da chave | PIX |
| claimId | Identificador de reivindicação | PIX |
| claimReason | Motivo da reivindicação | PIX |
| claimType | Tipo de reivindicação | PIX |
| authorizationCode | Código de autorização | PIX |
| checked | Flag de verificação da chave | PIX |
3. Transações financeiras
| Campo | Descrição | Usado em |
|---|---|---|
| amount | Valor monetário | Midaz, PIX, Fee |
| value | Valor numérico | Fee, PIX |
| totalAmount | Valor total da operação | PIX |
| minimumAmount | Valor mínimo permitido | Fee |
| maximumAmount | Valor máximo permitido | Fee |
| originalAmount | Valor antes das tarifas | Fee |
| afterFeesAmount | Valor após aplicação de tarifas | Fee |
| description | Descrição da transação | Midaz, PIX, Flowker |
| asset | Código do ativo (BRL, USD) | Midaz, Fee |
| code | Código de transação ou autorização | Midaz, Flowker |
| route | Rota da operação | Midaz |
| pending | Status pendente | Midaz |
| priority | Prioridade (alta/média/baixa) | PIX, Flowker |
| flow | Fluxo da transação (cash-in/cash-out) | PIX |
| isPixSaque | Flag de PIX Saque | PIX |
| isPixTroco | Flag de PIX Troco | PIX |
| isReversal | Flag de estorno | PIX |
| isInternal | Flag de transação interna | PIX |
| reversalType | Tipo de estorno | PIX |
| refundId | Identificador de reembolso | PIX |
| returnId | Identificador de devolução | PIX |
| returnReason | Motivo da devolução | PIX |
| returnedAt | Timestamp da devolução | PIX |
| failureReason | Motivo da falha | PIX |
4. QR Codes PIX
| Campo | Descrição | Usado em |
|---|---|---|
| qrCode | String do QR Code PIX | PIX |
| qrCodeImage | Imagem QR em Base64 | PIX |
| qrCodeType | Tipo de QR (estático/dinâmico) | PIX |
| txId | ID da transação (até 25 caracteres) | PIX |
| recipientName | Nome do recebedor | PIX |
| expirationTime | Tempo de expiração em segundos | PIX |
| isValid | Se o QR é válido | PIX |
| validationMessage | Mensagem de validação | PIX |
| additionalData | Dados adicionais do QR | PIX |
5. Limites e controles
| Campo | Descrição | Usado em |
|---|---|---|
| limitType | Tipo de limite | PIX |
| periodType | Tipo de período | PIX |
| period | Período (contexto de métricas) | Flowker |
| used | Valor usado no período | PIX |
| remaining | Valor restante | PIX |
| resetDate | Data de reset do período | PIX |
| waivedAccounts | Contas isentas de tarifas | Fee |