Process Payout by ID

View as Markdown

Use this endpoint to process a specific Payout using its ID.

Notes:

  • Will throw an error if the Payout status is already Done.

Method: POST

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

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

payout_idstring•Required

The ID of the payout you want to process.

Example:{payout_id: 7f839bdd-5acd-4ce3-984d-1be8357b642d}

Returns

Returns a success message with payout information. Returns an error if the payout has already been processed or if the payout_id is invalid.

statusstring

Status of the request.

payout_infoobject

Contains detailed information about the payout request.

idstring

Unique identifier for the payout request.

statusstring

Current status of the payout request.

display_statusstring

Current verbose status of the payout request.

fromstring

Source address for the payout, if applicable.

requestsobject

A mapping of destination addresses to the amount requested for each.

total_requestedstring

Total cryptocurrency amount requested.

total_with_feestring

Total cryptocurrency amount including the fee.

errorstring

The error message given in case the payout status is error.

blockchain_feestring

The fee paid to the blockchain for the transaction.

feestring

Fee associated with the transaction.

coinstring

Cryptocurrency ticker for the transaction.

txidstring

Transaction ID, available once the payout is fulfilled.

timestampstring

Timestamp when the payout was created.

queuedboolean

Indicates whether the payout is queued for processing.