API Docs
ReferencePayouts

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`

DELETE/payout/:id

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

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 DELETE "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"}

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`

List GET

Retrieve a list of payouts for the authenticated team.