Financial data

This page brings together all financial information fields used across Midaz, CRM, Pix, and Fees Engine.

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

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

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
asset	Asset code (BRL, USD)	Midaz, Fee
code	Transaction or authorization code	Midaz
route	Operation route	Midaz
pending	Pending status	Midaz
priority	Priority (high/medium/low)	Pix
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

Field	Description	Used in
limitType	Limit type	Pix
periodType	Period type	Pix