API Docs
ReferencePayouts

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`

GET/payout/:id

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

Authorization

AuthorizationBearer <token>

Team API key generated from team settings. Sent as Authorization: Bearer <api_key>.

In: header

Path Parameters

id*string

ID or custom ID of the payout

Query Parameters

id_type?string

Type of ID provided: 'id' (default) or 'custom_id'

Default"id"

Value in

  • "id"
  • "custom_id"

Response Body

application/json

curl -X GET "https://example.com/payout/:id"
{  "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"}

Create POST

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`.

Delete DELETE

Delete a payout that has not been requested yet. Only payouts with status `created`, `approved` or `expired` can be deleted. Once the recipient has requested the payout (status `requested`) or it is `completed`, the request fails with HTTP 409. Deleting an already deleted payout succeeds and returns it unchanged. A deleted payout emits a webhook event with status `deleted`. By default, the endpoint expects an ID. To delete by custom ID instead, add the query parameter `id_type=custom_id`. Examples: - Delete by ID: `DELETE /payout/{id}` - Delete by custom ID: `DELETE /payout/{custom_id}?id_type=custom_id`