Payouts

Create payouts. Payouts disburse funds from your merchant balance to an external bank account or card.

export FRAME_API_KEY='sk_sandbox_...'

Create payout

Initiate a payout to a payment method owned by an account. frameOS supports payouts to debit cards via the card_receive capability and to bank accounts via the bank_account_receive capability — each must be active on the account before funds can be disbursed. Both payout types require a verified KYC record on the account; identity verification is the foundation of payout eligibility.

Body parameters
payment_methodstringrequired

ID of the payment method to pay out to. Must belong to an account with the relevant payout capability active.

amountintegerrequired

Amount in cents. Must be greater than 0.

currencystringrequired

Three-letter ISO currency code. Must be USD.

speedenumoptional

Payout speed. Required for ACH bank account payouts; must be one of asap, same_day, or standard. Not accepted for card (push_to_card) payouts.

Returns

Payout object for the newly initiated disbursement

POST/v1/payouts
curl --request POST \
  --url https://api.framepayments.com/v1/payouts \
  --header 'Authorization: Bearer API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
  "payment_method": null,
  "amount": 1000,
  "currency": "USD"
}'
RESPONSE
{
  "id": "00000000-0000-4000-8000-000000000001",
  "status": "pending",
  "speed": "asap",
  "amount": 1000,
  "currency": "USD",
  "payment_method": "00000000-0000-4000-8000-000000000002",
  "object": "payout",
  "livemode": false,
  "processor_fee": null,
  "merchant_fee": null,
  "customer_fee": null,
  "created": 1745107200,
  "updated": 1745107200,
  "succeeded": null,
  "failed": null
}