Detail of fields for the transaction process in Brazil.

AttributeData TypeMandatory
order_idString [max_length:40]Yes
credit_noteString [max_length:40]Yes
account_idInteger [max_length:20]

The first value of the account number before the hyphen, with no additional dots or hyphens. Example: if the account number is 000123456789-1 the value to be sent to this field will be 000123456789
Yes
account_typeString [max_length:9]

(savings or checking) + The second value of the account number before the hyphen, with no additional dots or hyphens. Example: if the account number is 000123456789-1 and the account type is savings, the value to be sent to this field will be savings-1
Yes
vat_idInteger [max_length:20]Yes
vat_id_typeString [max_length:4]

Allow values:
- cpf
- cnpj
- rne
Yes
nameString [max_length:100]Yes
amountdecimalYes
subjectString [max_length:100]
Example: Withdrawal request
Yes
bank_detailString [max_length:100]
Example: User withdrawal request
Yes
channelString [max_length:100]
Example: Transfer request
Yes
user_emailString [max_length:100]
Example: [email protected]
Yes
phone_numberString [max_length:30]
Example: +5511111111111
Yes
bankId value according to bank from /api/banks/?country=BR&fields=id,nameYes
currencyId value from /api/currencies/

Allowed currencies:
- BRL
No