Get Brazil payout data by idepotency key
GET /order/v1/payout/brazil/idempotency/{idempotencyKey}
NOTE: Please, to authenticate use the scope: “api://app-order-hml”
Authorizations
Section titled “Authorizations ”Parameters
Section titled “ Parameters ”Path Parameters
Section titled “Path Parameters ”Responses
Section titled “ Responses ”The resource was returned successfully
object
Payout id, unique identification
Example
f2b2721d-fc6c-46c1-a60b-ed2d9eb0216dPayout idempotency key
Example
4a5450eb-ab0f-4dc1-85c3-a2f097c59785Payout description
Example
Customer withdrawPayout amout
Example
100.00Payout status
Example
PAIDPayout error message
Example
An unexpected error occurredPayout creation date
Example
2026-10-07T00:31:00.686ZThe crypto
object
The crypto wallet address
Example
0x1234567890123456789012345678901234567890The memo
Example
12345678901Batch information when this payout was split into a batch
object
Id of the batch
Example
5160c73e-8b9b-4f1f-8c64-0edcbb97c335Total number of child transactions in the batch
Example
3Number of child transactions already paid
Example
2Number of child transactions that failed
Example
1Number of child transactions still pending
Amount already paid across all child transactions
Example
30000.00Amount still pending across all child transactions
Example
15000.00Child transactions the batch was split into
object
Id of this child transaction
Example
a4cf980e-f66d-4321-b0f2-95c7eecca7ceIdempotency key of this child transaction - the first child reuses the batch idempotencyKey verbatim, later ones suffix it
Example
bf8b0b1f-f444-40c5-b657-d236ee03e6ba-01Ordering position of this child transaction within the batch
Example
1Amount of this child transaction
Example
15000.00Status of this child transaction
Example
PAIDEnd-to-end id of this child transaction
Example
E69467793202607101200Je8IkFT5JQSDate this child transaction was paid
Example
2026-07-10T12:01:03.000ZError message when this child transaction failed
Example
An unexpected error occurredPayout payment method
Example
PIXPayout bank information
object
Pix information data
object
The type of pix
Example
CPFThe key of pix
Example
1234567890Bank account information data
object
The ispb number
Example
12345678The bank number
Example
341The bank branch number
Example
6770The bank account number
Example
12345-2Payout Customer data
object
Customer fullName
Example
John Doe MartinsCustomer email
Example
john@domain.comCustomer phone
Example
51999999The date of birth or foundation, in ISO-8601 YYYY-MM-DD format.
Example
1984-03-16Document
Required for TED and manual bank account payouts. Optional for pix key and QR Code payouts, where it is resolved from the DICT key or the decoded QR Code; when provided, the receiver document is compared against the key/QR Code owner.
object
The document type
Example
CPFThe document number
Example
123.456.789-01The owner information.
PS: This field is optional, not all payment methods have this information.object
The name of the owner.
Example
John DoeThe document of the owner.
Example
12345678901The bank information of owner.
object
The bank name.
Example
Financial BankThe bank ISPB code.
Example
00123876The bank code, like COMPE.
Example
123The account number.
Example
12345-2The branch account number.
Example
0001The pix.
object
The type of pix
Example
CPFThe key of pix
Example
1234567890The payout E2E ID
Example
E1823612020260819143000123456789The Receiver
object
The receiver name.
Example
John DoeThe document of the receiver.
object
Document type
Example
CPFDocument number
Example
12345678910Account bank data
object
The bank name
Example
Jhon Doe Bank S.AThe bank code
Example
101The bank ispb
Example
12345678The pix key
object
The type of pix
Example
CPFThe key of pix
Example
1234567890The bank account
object
The type of pix
Example
CPFThe key of pix
Example
1234567890Fee
object
Fixed fee amount
object
Example
1.00Variable fee amount
object
Example
1.00Addictional fee amount
object
Example
1.00The request is not valid
Unauthorized Request
Resource not found
An unexpected error occurred inside the server