Skip to main content
GET
Get a withdrawal by ID

Path Parameters

account-id
string<uuid>
required
id
string<uuid>
required

Response

Withdrawal retrieved successfully

BRL PIX withdrawal

id
string<uuid>
required
Example:

"660e8400-e29b-41d4-a716-446655440001"

asset
enum<string>
required
Available options:
fiat/brl
Example:

"fiat/brl"

amount
string<decimal>
required
Example:

"100.50"

method
enum<string>
required
Available options:
pix
Example:

"pix"

state
enum<string>
required

Current state of the order. pending-payment is a brcode order waiting for its PIX. pending-delivery has been paid and its target asset is on its way. rolling-back is being undone. completed is the happy end. rolled-back means the order was undone for a reason other than funding. expired is a brcode order whose funding window closed with no payment: nothing was charged and nothing is owed. payment-returned is a brcode order whose PIX arrived after the window: the payment is being returned to the account it came from. rejected means the order could not go ahead.

Available options:
pending-payment,
pending-delivery,
rolling-back,
completed,
rolled-back,
expired,
payment-returned,
rejected
Example:

"pending-payment"

created-at
string<date-time>
required
Example:

"2025-03-06T10:30:00Z"

state-updated-at
string<date-time>
required
Example:

"2025-03-06T10:30:00Z"