Skip to main content
Creates the payout and answers with the address the user sends stablecoins to. Nothing moves until they send. See Payouts for the whole order, and POST /v1/card/payout/quote for the price.
Needs the card-payouts permission on your API key. See Authentication.

​
Request

​
string
required
From the quote. Expired quotes are refused rather than silently repriced.
​
string
required
The user being paid out. Same id as the incoming direction - see Rheon ID. A user onboarded for deposits does not onboard again.
​
object
required
Where the money lands. Send token when you hold a tokenised card from the hosted collection page, or cardId when the user’s card is already on file from a previous payout. Raw card numbers are never accepted here.
​
string
Your own idempotency key, up to 64 characters. Repeating a request with the same reference returns the original payout instead of creating a second one. Send one - a network timeout is otherwise indistinguishable from a failure.

​
Response

​
string
The payout id. Poll it with POST /v1/card/payout/status.
​
string
Where the user sends the stablecoins. Single-use and tied to this payout.
​
string
The exact amount to send, as a decimal string.
​
number
The chain depositAddress lives on. Sending on any other chain loses the funds.
​
string
pending on creation. See Statuses.
​
string
ISO 8601. Stablecoins arriving after this are converted at the rate current on arrival, not the quoted one.
The address is single-use. A second payout gets its own address. Money sent to a spent address has no order to attribute it to and has to be recovered by hand.
Some cards cannot receive a payout even when the country and currency are open - issuer policy decides, not us. That surfaces as a rejected status carrying the issuer’s reason, and the stablecoins are returned to the sending wallet.

​
Errors