Get Withdrawal
Reads one payout by id.
/api/withdrawals/{id}Auth: RequiredResponse
The withdrawal.
idnumberRequiredThe withdrawal id.
client_withdrawal_idstring | nullRequiredThe id you sent on creation, echoed back. null if you sent none.
uuidstring | nullRequiredReference 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_idnumberRequiredThe member the funds are debited from.
asset_idstringRequiredAsset code.
dchain_idstringRequiredNetwork code.
amountstringRequiredThe amount sent to destination. The fee is charged on top — see Create Withdrawal.
feestringRequiredTotal 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.
statusstringRequiredSee Statuses.
tx_idstring | nullRequiredChain transaction hash. Filled in once the payout is broadcast; null before that and on an off-chain payout.
destinationstringRequiredThe address the funds were sent to.
destination_tagstring | nullRequiredDestination memo, on networks that use one.
operation_typestring | nullRequiredON_CHAIN or OFF_CHAIN. null on older records.
updated_atstringRequiredWhen the record last changed.
created_atstringRequiredWhen the record was created.