Skip to main content

Get Withdrawal

Reads one payout by id.

GET/api/withdrawals/{id}Auth: Required

Response​

The withdrawal.

idnumberRequired

The withdrawal id.

client_withdrawal_idstring | nullRequired

The id you sent on creation, echoed back. null if you sent none.

uuidstring | nullRequired

Reference to the payout in the core, assigned when the core accepts it — so it is present from aml_processing onwards, and null on a payout that failed before the core registered it. It is an opaque reference string, not a standard UUID — it is shaped 12-4-4-12, so store and compare it as plain text. You do not need it to address a payout: use id or your own client_withdrawal_id.

member_idnumberRequired

The member the funds are debited from.

asset_idstringRequired

Asset code.

dchain_idstringRequired

Network code.

amountstringRequired

The amount sent to destination. The fee is charged on top — see Create Withdrawal.

feestringRequired

Total fee calculated for the payout: network, percentage and AML together. It is set when the payout is created and stays on the record whatever the outcome, so a refused payout still carries it. "0.0" means the fee itself is zero on that network, not that nothing was charged yet. What returns to the balance after a refusal is in Statuses.

statusstringRequired
tx_idstring | nullRequired

Chain transaction hash. Filled in once the payout is broadcast; null before that and on an off-chain payout.

destinationstringRequired

The address the funds were sent to.

destination_tagstring | nullRequired

Destination memo, on networks that use one.

operation_typestring | nullRequired

ON_CHAIN or OFF_CHAIN. null on older records.

updated_atstringRequired

When the record last changed.

created_atstringRequired

When the record was created.