Get Payout Status

View as Markdown

Check the status of your Payout by providing its ID.

Method: POST

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

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.

Example:your_api_key_here

Request Body

This endpoint requires a request body with the payout_id.

payout_idstring•Required

The ID of the payout you want to check.

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

Returns

Returns the status information of the payout.

statusstring

Status of the request. Should be success if the request didn't fail.

payout_infoobject

Contains detailed information about the payout.

idstring

The ID of the Payout.

statusstring

The status of the Payout. Can be created, processing, done, or error.

display_statusstring

The status of the Payout. Can be Created, Pending Payment, Done, or Error.

fromstring

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

requestsobject

A map of payout request addresses to their respective 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 given in case the payout status is error.

Important Note: This parameter will only be returned if there was an error with the Payout.

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.

Responses

200

The Payout was created successfully.

Content Types:

  • application/json

400

Your request couldn't be processed, please try again later.