Skip to main content
Returns where a card payout stands. Poll it, or take the webhook - see Webhooks.
Needs the card-payouts permission on your API key.

Request

string
required
The payout id from POST /v1/card/payout.

Response

string
The payout id, echoed back.
string
One of pending, converting, sent, settled, rejected, returned. Read the vocabulary in Statuses rather than matching strings you saw once.
string
What actually landed, once known. Equals the quoted figure unless the user sent a different amount than quoted.
string
The currency fiatAmount is in.
string
The transaction that funded the payout, once seen on chain.
string
Present on rejected and returned: why, in the partner’s words.
string
ISO 8601 of the last change.
sent is not settled. sent means the payout left the partner; card schemes take from minutes to several working days to post it to the cardholder. Telling a user the money has arrived at sent produces support tickets.
A payout the user underfunded does not fail - it converts what arrived and pays that out, so fiatAmount comes back lower than quoted. Compare it against your own record rather than assuming the quote held.

Errors