1. Datos bancarios
| Campo | Descripción | Usos |
|---|---|---|
| branch | Código de sucursal bancaria | CRM, Pix |
| account | Número de cuenta | CRM |
| bankAccount | Número de cuenta bancaria (hasta 20 dígitos) | Pix |
| bankAccountType | Tipo de cuenta | Pix |
| accountNumber | Número de cuenta genérico | Pix |
| accountDigit | Dígito verificador | Pix |
| agency | Agencia bancaria | Pix |
| accountType | Tipo de cuenta | CRM, Pix |
| iban | Número de cuenta bancaria internacional | CRM |
| bankId | Identificador bancario | CRM, Pix |
| openingDate | Fecha de apertura de cuenta | CRM |
2. Claves Pix
| Campo | Descripción | Usos |
|---|---|---|
| key | Valor de clave Pix | Pix |
| keyType | Tipo de clave (email, teléfono, ID fiscal, aleatorio) | Pix |
| requiresConfirmation | Requiere confirmación con token | Pix |
| confirmationToken | Token para confirmación de clave | Pix |
| claimId | Identificador de reclamo | Pix |
| claimReason | Razón de reclamo | Pix |
| claimType | Tipo de reclamo | Pix |
| authorizationCode | Código de autorización | Pix |
| checked | Bandera de verificación de clave | Pix |
3. Transacciones financieras
| Campo | Descripción | Usos |
|---|---|---|
| amount | Monto monetario | Midaz, Pix, Fee |
| value | Valor numérico | Fee, Pix |
| totalAmount | Monto total de la operación | Pix |
| minimumAmount | Monto mínimo permitido | Fee |
| maximumAmount | Monto máximo permitido | Fee |
| originalAmount | Monto antes de tarifas | Fee |
| afterFeesAmount | Monto después de aplicar tarifa | Fee |
| description | Descripción de transacción | Midaz, Pix, Flowker |
| asset | Código de activo (BRL, USD) | Midaz, Fee |
| code | Código de transacción o autorización | Midaz, Flowker |
| route | Ruta de operación | Midaz |
| pending | Estado pendiente | Midaz |
| priority | Prioridad (alta/media/baja) | Pix, Flowker |
| flow | Flujo de transacción (entrada/salida) | Pix |
| isPixSaque | Bandera de retiro Pix | Pix |
| isPixTroco | Bandera de cambio Pix | Pix |
| isReversal | Bandera de reversión | Pix |
| isInternal | Bandera de transacción interna | Pix |
| reversalType | Tipo de reversión | Pix |
| refundId | Identificador de reembolso | Pix |
| returnId | Identificador de devolución | Pix |
| returnReason | Razón de devolución | Pix |
| returnedAt | Marca de tiempo de devolución | Pix |
| failureReason | Razón de fallo | Pix |
4. Códigos QR Pix
| Campo | Descripción | Usos |
|---|---|---|
| qrCode | Cadena de código QR Pix | Pix |
| qrCodeImage | Imagen QR en Base64 | Pix |
| qrCodeType | Tipo de QR (estático/dinámico) | Pix |
| txId | ID de transacción (hasta 25 caracteres) | Pix |
| recipientName | Nombre del destinatario | Pix |
| expirationTime | Tiempo de expiración en segundos | Pix |
| isValid | Si el QR es válido | Pix |
| validationMessage | Mensaje de validación | Pix |
| additionalData | Datos adicionales del QR | Pix |
5. Límites y controles
| Campo | Descripción | Usos |
|---|---|---|
| limitType | Tipo de límite | Pix |
| periodType | Tipo de período | Pix |
| period | Período (contexto de métricas) | Flowker |
| used | Monto utilizado en el período | Pix |
| remaining | Monto restante | Pix |
| resetDate | Fecha de reinicio de período | Pix |
| waivedAccounts | Cuentas exentas de tarifas | Fee |

