Retrieve Payout
Retrieves a payout by its wdrl_ ID, or by the cofr_ conversion request ID a payout carries as payout_request_id. Authentication is optional: anyone with the ID can view tracking details, including notes, trace code, exchange rate, and payout request ID, while accounting fields require payout:withdrawal:read on the account or user that owns the payout. A supplied invalid credential returns 401.
Autorisaties
An Account API key, an App API key, an account access token, an account-scoped user token, or a user OAuth token. Prepend the key or token with Bearer, for example Bearer ***************************. See Auth & API keys for how to get each one.
Padparameters
Queryparameters
Respons
payout found
Currency the funds are delivered in, taken from the payout method when the payout is created. On a payout funded by a conversion request it follows the settlement payout minted alongside it — the GET /payouts row carrying this payout's id as payout_request_id — and is null only when no settlement payout exists.
"eur"
The planned net for the destination, in the payout currency: amount minus fee_amount minus markup_fee when fee_paid_by is self; equal to amount when the platform covers the fees. A payout that ends denied, canceled, or failed delivered nothing — most keep the planned figure and failure says where the funds are, but a canceled payout funded by a conversion request can report the settled outcome instead: amount carries what stayed in the balance, fees are zero because none were charged, and net_amount is 0 because nothing was delivered.
"49.75"
The finest machine phase under status — for example awaiting_provider_acceptance vs in_transit under processing, or the conversion phase under requested. Informational vocabulary: values can be added without a version bump; status is the versioned contract.
"awaiting_provider_acceptance"
Whether POST /payouts/{id}/cancel would act on this payout right now: true while it is in_review, while it is processing with nothing yet submitted to the payout provider, or while a submitted payout can still be asked to cancel at the provider. false once the money has arrived or the payout has already ended. Only returned to callers with payout:withdrawal:read on the owning ledger.
true

