1. Banking data
| Field | Description | Used in |
|---|---|---|
| branch | Bank branch code | CRM, PIX |
| account | Account number | CRM |
| bankAccount | Bank account number (up to 20 digits) | PIX |
| bankAccountType | Account type | PIX |
| accountNumber | Generic account number | PIX |
| accountDigit | Check digit | PIX |
| agency | Bank agency | PIX |
| accountType | Account type | CRM, PIX |
| iban | International Bank Account Number | CRM |
| bankId | Bank identifier | CRM, PIX |
| openingDate | Account opening date | CRM |
2. PIX keys
| Field | Description | Used in |
|---|---|---|
| key | PIX key value | PIX |
| keyType | Key type (email, phone, tax ID, random) | PIX |
| requiresConfirmation | Requires token confirmation | PIX |
| confirmationToken | Token for key confirmation | PIX |
| claimId | Claim identifier | PIX |
| claimReason | Claim reason | PIX |
| claimType | Claim type | PIX |
| authorizationCode | Authorization code | PIX |
| checked | Key verification flag | PIX |
3. Financial transactions
| Field | Description | Used in |
|---|---|---|
| amount | Monetary amount | Midaz, PIX, Fee |
| value | Numeric value | Fee, PIX |
| totalAmount | Total amount of the operation | PIX |
| minimumAmount | Minimum allowed amount | Fee |
| maximumAmount | Maximum allowed amount | Fee |
| originalAmount | Amount before fees | Fee |
| afterFeesAmount | Amount after fee application | Fee |
| description | Transaction description | Midaz, PIX, Flowker |
| asset | Asset code (BRL, USD) | Midaz, Fee |
| code | Transaction or authorization code | Midaz, Flowker |
| route | Operation route | Midaz |
| pending | Pending status | Midaz |
| priority | Priority (high/medium/low) | PIX, Flowker |
| flow | Transaction flow (cash-in/cash-out) | PIX |
| isPixSaque | PIX withdrawal flag | PIX |
| isPixTroco | PIX cashback flag | PIX |
| isReversal | Reversal flag | PIX |
| isInternal | Internal transaction flag | PIX |
| reversalType | Type of reversal | PIX |
| refundId | Refund identifier | PIX |
| returnId | Return identifier | PIX |
| returnReason | Reason for return | PIX |
| returnedAt | Return timestamp | PIX |
| failureReason | Failure reason | PIX |
4. PIX QR codes
| Field | Description | Used in |
|---|---|---|
| qrCode | PIX QR Code string | PIX |
| qrCodeImage | Base64 QR image | PIX |
| qrCodeType | QR type (static/dynamic) | PIX |
| txId | Transaction ID (up to 25 chars) | PIX |
| recipientName | Recipient name | PIX |
| expirationTime | Expiration time in seconds | PIX |
| isValid | Whether QR is valid | PIX |
| validationMessage | Validation message | PIX |
| additionalData | Additional QR data | PIX |
5. Limits and controls
| Field | Description | Used in |
|---|---|---|
| limitType | Limit type | PIX |
| periodType | Period type | PIX |
| period | Period (metrics context) | Flowker |
| used | Amount used in the period | PIX |
| remaining | Remaining amount | PIX |
| resetDate | Period reset date | PIX |
| waivedAccounts | Accounts exempt from fees | Fee |