Sign in
Payouts

Create Payout Quote

Creates a short-lived, provider-backed quote for a payout. No funds move until the returned quote_token is submitted to POST /payouts. An Idempotency-Key header is required.

post/payouts/quotes

Headers

Idempotency-Keystring
Example:d9105228-4a08-46b1-8b91-42fed586d383

A unique key that makes this request safe to retry. See Idempotent requests.

Request body

account_idstring

Account to pay out from, prefixed biz_. Provide exactly one of account_id or user_id.

amountnumber float required

The amount to pay out in the specified currency.

currencystring

The balance currency to pay out.

payout_method_idstring required

The saved payout method to quote (a potk_ identifier).

platform_covers_feesboolean

Whether the parent platform covers the payout fee instead of the account being paid out.

speed'standard' | 'instant'

How fast the funds should arrive.

user_idstring

User to pay out from, prefixed user_. Provide exactly one of account_id or user_id.

Example request

{
  "account_id": "biz_xxxxxxxxxxxxxx",
  "amount": 6762.41,
  "currency": "eur",
  "payout_method_id": "potk_xxxxxxxxxxxxxx",
  "speed": "standard"
}

Response

payout quote created

exchange_ratenumber float required

Quoted exchange rate from the source currency to the destination currency.

expires_atstring date-time required

When the quote expires.

idstring required

Provider-backed payout quote ID, prefixed pout_.

object'payout_quote' required
quote_tokenstring required

Server-signed quote token to submit to POST /payouts.

Example response

{
  "amount": {
    "amount": "-2.50",
    "currency": "usd",
    "decimals": 2,
    "display_decimals": 2
  },
  "destination_amount": {
    "amount": "-2.50",
    "currency": "usd",
    "decimals": 2,
    "display_decimals": 2
  },
  "exchange_rate": 4.13978443,
  "expires_at": "2026-01-01T12:00:00.000Z",
  "fee": {
    "amount": "-2.50",
    "currency": "usd",
    "decimals": 2,
    "display_decimals": 2
  },
  "id": "pout_aed_quote",
  "net_amount": {
    "amount": "-2.50",
    "currency": "usd",
    "decimals": 2,
    "display_decimals": 2
  },
  "object": "payout_quote",
  "quote_token": "signed-payout-quote"
}

Changes

Changed in 1 of the 41 revisions of this API.1