Payouts
This resource is deprecated. Every operation on this resource will be removed in a future API version. Existing integrations continue to work — the API is wire-compatible — but new integrations should use the canonical replacement.
Create payouts. Payouts disburse funds from your merchant balance to an external bank account or card.
Create payout
Deprecated. This operation is deprecated and will be removed in a future API version. New integrations should use the canonical replacement; see the related concept page for guidance.
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
ID of the payment method to pay out to. Must belong to an account with the relevant payout capability active.
Amount in cents. Must be greater than 0.
Three-letter ISO currency code. Must be USD.
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
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"
}'
{
"id": "661da9f0-a545-4648-918d-290486513a75",
"status": "pending",
"speed": "asap",
"amount": 1000,
"currency": "USD",
"payment_method": "3f0ff60d-2a42-4bf9-9f47-cdf8d9a7ef3a",
"object": "payout",
"livemode": false,
"processor_fee": null,
"merchant_fee": null,
"customer_fee": null,
"created": 1781115883,
"updated": 1781115883,
"succeeded": null,
"failed": null
}