Create or update a new payout for team members. For teams with balance enforcement enabled (the default), pre-approved payouts (`preApproved: true`) are rejected with HTTP 422 and error code `INSUFFICIENT_BALANCE` when the total of all open (approved but not yet paid out) payouts would exceed the team wallet balance. The error `data` contains `walletBalance`, `totalOpenAmount`, and `currency`.
/payoutCreate or update a new payout for team members.
For teams with balance enforcement enabled (the default), pre-approved payouts (preApproved: true) are rejected with HTTP 422 and error code INSUFFICIENT_BALANCE when the total of all open (approved but not yet paid out) payouts would exceed the team wallet balance. The error data contains walletBalance, totalOpenAmount, and currency.
Team API key generated from team settings. Sent as Authorization: Bearer <api_key>.
In: header
application/json
TypeScript Definitions
Use the request body type in TypeScript.
application/json
curl -X POST "https://example.com/payout" \ -H "Content-Type: application/json" \ -d '{ "description": "string", "payoutAmount": "string", "currency": "USD" }'{ "id": "0e4ba886-0bfe-4b6a-ae2e-d6d9d135dd1e", "uuid": "0e4ba886-0bfe-4b6a-ae2e-d6d9d135dd1e", "customId": "campaign-42", "description": "Payment for YouTube channel campaign", "amount": "100.00", "currency": "EUR", "createdAt": "2026-06-20T10:00:00.000Z", "updatedAt": "2026-06-20T10:00:00.000Z", "creatorHandle": "@mrbeast", "verificationMethod": "youtube-channel", "tags": [], "payoutType": "manual", "status": "created", "notifications": "allowed", "action": "created"}Breaking changes
Scheduled removals and deprecated fields.
Get GET
Retrieve a specific payout by ID or custom ID. By default, the endpoint expects an ID. To query by custom ID instead, add the query parameter `id_type=custom_id`. Examples: - Get by ID: `GET /payout/{id}` - Get by custom ID: `GET /payout/{custom_id}?id_type=custom_id`
Description or reason for the payout
1 <= lengthSocial media handle of the creator (must start with @)
Verification method for the payout recipient
Value in
Wallet address for wallet_address verification method (user ID)
@deprecated Use verificationMethod instead. Type of social media platform for the creator handle
Value in
Email address of the creator. Can be set for any verification method, but required when verification method is 'email'
Phone number of the creator
Amount to be paid out (minimum 0.1)
1 <= lengthCurrency for the payout
Value in
Optional tags for categorizing the payout
Optional custom identifier for the payout
Type of payout - manual or manual-immutable (source-of-truth fields cannot be updated after creation)
"manual"Value in
Whether notifications can be sent for this payout. If not allowed, you should implement your own notification system.
"allowed"Value in
UTC calendar date (YYYY-MM-DD) from which the payout can be claimed (at 00:00 UTC). Omit or null for immediately claimable.
Optional payout ID for updates
Whether the payout should be pre-approved. Requires the 'payouts:approve' scope on the access token — granted only to admin-provisioned OAuth clients and to API keys for teams with the 'payout.api_approve' permission.
false