Brazil payout - V1
PUT /order/v1/payout/brazil
Request a payout for Brazil country
NOTE: Please, to authenticate use the scope: “api://app-order-hml”
Authorizations
Section titled “Authorizations ”Parameters
Section titled “ Parameters ”Header Parameters
Section titled “Header Parameters ”A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).
Request Body required
Section titled “Request Body required ”object
The payout amount
object
The currency of the transaction.
The amount of the transaction, in minor units.
Minor Units Format
All amount values must be formatted in that currency’s smallest unit. Two-decimal currency (for example Brazilian Real): R$ 10.95 BRL, amount will be “10.95”.
Click in the link bellow to see the latest official ISO 4217 Currency Table, with Minor Units (number of decimal places) per currency.
https://en.wikipedia.org/wiki/ISO_4217#List_of_ISO_4217_currency_codes
Payment Method
The payout customer
object
Customer fullName
Customer email
Customer phone
The date of birth or foundation, in ISO-8601 YYYY-MM-DD format.
Document
object
The document type
The document number
The payout bank information
OBS: If you send this pix data, you don’t need to send the account data or vice-versa
object
Pix information data
OBS: If you send this data, you don’t need to send the account data
object
The type of pix
The key of pix
Bank account information data
OBS: If you send this data, you don’t need to send the pix data
object
The bank number accept the ISPB or COMPE number.
ISPB number is composed by 8 numerical digits like “12345678”. If you decide to use the IPSB, you can find it in the bank list in the following link: https://www.bcb.gov.br/estabilidadefinanceira/participantespix
COMPE number is composed by 3 numerical digits like “123”. If you decide to use the COMPE, you can find it in the bank list in the following link: https://www.bcb.gov.br/content/estabilidadefinanceira/str1/ParticipantesSTR.pdf
The bank branch number (Agência)
The bank account number, if it has a digit, it must be separated by a hyphen Examples: - 12345-2 - 123452 - 12345 67890 09876 54321 - 12345678900987654321
Crypto
object
The crypto wallet address
The memo
The payout description.
The webhook url to receive the payout status
Order id in your system.
Responses
Section titled “ Responses ”The resource was returned successfully
object
Payout id, unique identification
Payout amout
Payout status
Fee
object
Fixed fee amount
object
Variable fee amount
object
Addictional fee amount
object
Payout error message
Payout creation date
Batch information when this payout was split into a batch
object
Id of the batch
Total number of child transactions in the batch
Number of child transactions already paid
Number of child transactions that failed
Number of child transactions still pending
Amount already paid across all child transactions
Amount still pending across all child transactions
Child transactions the batch was split into
object
Id of this child transaction
Idempotency key of this child transaction - the first child reuses the batch idempotencyKey verbatim, later ones suffix it
Ordering position of this child transaction within the batch
Amount of this child transaction
Status of this child transaction
End-to-end id of this child transaction
Date this child transaction was paid
Error message when this child transaction failed
The request is not valid
Unauthorized Request
An unexpected error occurred inside the server