Search documentation

Search across BlockBee docs, API endpoints, webhooks and guides.

Create Payout

View as Markdown

Create a Payout by providing the Payout Request ID.

Notes:

  • You can provide multiple IDs eg: 7f839bdd-5acd-4ce3-984d-1be8357b642d,7f839bdd-5asd-4ce3-984d-1be8357b646d.

Method: POST

Path: https://api.blockbee.io/payout/create/

Parameters

Query Parameters

apikeystring•Required

API Key provided by BlockBee's Dashboard. Unsure how to get yours? Check this tutorial.

Note: The API key can also be sent as a header named apikey.

Request Body

This endpoint requires a request body with the payout_request_ids.

Note: The request Content-Type header must be set to application/x-www-form-urlencoded.

request_idsstring•Required

The ID or a list of IDs of the Payout Requests you want to include in the Payout.

All requests must be for the same coin, in pending status, and not already attached to another payout, or the call fails with Error creating the payout. A payout bundles at most 100 requests (50 on Solana); any extra request IDs are left pending for a future payout.

Example:{request_ids=7f839bdd-5acd-4ce3-984d-1be8357b642d,7f839bdd-5asd-4ce3-914d-1be8357b646d}

Returns

Returns information about the newly created payout.

statusstring

Status of the request. Indicates success if the request has been accepted.

payout_infoobject

Contains detailed information about the created payout.

idstring

The ID of the created payout.

statusstring

The status of the created payout. Can be created, processing, done, rejected, expired, or error.

display_statusstring

The verbose status of the created payout. Can be Created, Pending Payment, Done, Rejected, Expired, or Error.

fromstring

The source from which the payout was created, if applicable.

requestsobject

A map of payout request addresses to their respective amounts. The keys are dynamic wallet addresses, and the values are the string amounts.

total_requestedstring

The total cryptocurrency amount requested for the payout.

total_with_feestring

The total amount requested including the fee.

errorstring

The error message. This field is always present but is empty unless the payout status is error or expired.

blockchain_feestring

The fee paid to the blockchain for the transaction.

feestring

The fee associated with the payout.

coinstring

The cryptocurrency for the payout.

txidstring

The transaction ID of the payout, if it has been processed.

timestampstring

The timestamp when the payout was created.

Errors

HTTP 400 with { "status": "error", "error": "<message>" }:

ErrorCause
No requests sentrequest_ids is missing or empty.
Error creating the payoutNo usable requests (unknown IDs, wrong status, already attached, or mixed coins).