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

Request

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

Response

string
The payout id, echoed back.
string
One of pending, converting, sent, settled, rejected, returned. See Statuses.
string
What was paid out, once known.
string
The currency fiatAmount is in.
string
The rail the transfer actually went out on.
string
The reference carried on the transfer, for reconciling against the beneficiary’s statement.
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.
A returned payout is not a failed one. A receiving bank can bounce a transfer days after it was sent - wrong beneficiary name, closed account, its own checks. The status becomes returned and the value comes back as stablecoin to the sending wallet, minus the rail’s own cost. Treat settled as final and nothing before it.

Errors