Skip to main content
Send payouts directly to your subaccounts from your platform balance. Subaccounts must complete identity verification and add a payout method before they can receive funds.
1

Complete KYC verification

Before a user can receive payouts, they must complete identity verification (KYC). Use the hosted account onboarding flow to guide users through this process:
Redirect the user to the url returned in the response. After completing verification, they will be redirected back to your return_url.
2

Add a payout method

Before creating a payout, the account needs a payout method. Mount the Withdraw element with an access token for the subaccount. It lists the account’s payout methods and collects a new one when none exists:
Mint the accessToken on your server for the subaccount, as shown in Enable Subaccount Payouts. You can also send the user to the hosted payout portal instead. To accept a PayPal account only after its holder logs in to prove they own it, connect a PayPal payout method.
3

Get the default payout method

List the subaccount’s payout methods and find the one with is_default: true:
4

Create a payout

API version 2026-11-03 and later requires a quote. First call POST /payouts/quotes with the account, payout method, amount, currency, and speed you will submit:
Replace QUOTE_TOKEN_FROM_RESPONSE below with the returned quote_token and submit before expires_at. If a payout request times out, retry with the same payout Idempotency-Key and original token. Use a different key for the quote request.
In this example:
  • account_id is the subaccount to pay out
  • amount is the payout amount (100.00 USD) - fees will be deducted from this amount
  • currency is the ISO currency code
  • payout_method_id is the ID of the payout method to use (from step 3)
The request will return an error if the amount exceeds the available balance.

Cover payout fees for your subaccounts

By default, payout fees are deducted from the subaccount’s balance. You can choose to cover these fees from your platform balance instead by setting platform_covers_fees to true on both the quote request and the payout request:
When platform_covers_fees is true, the subaccount receives the full payout amount and the fee is debited from your platform’s balance instead. This requires your platform’s fee coverage policy to cover the payout method, or an API key authorized to manage your subaccounts’ fees.

API reference

Create Payout API

See the full API reference for creating payouts

Pay subaccounts

Transfer funds to your subaccounts

Render payout portal

Let your users withdraw their funds