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.
your_api_key_hereRequest Body
This endpoint requires a request body with the payout_id.
Note: The request Content-Type header must be set to application/x-www-form-urlencoded.
payout_idstring•Required
The ID of the payout you want to check.
{payout_id: 7f839bdd-5acd-4ce3-984d-1be8357b642d}Returns
Returns the status information of the payout.
payout_infoobject
Contains detailed information about the payout.
The ID of the Payout.
The status of the Payout. Can be created, processing, done, rejected, expired, or error.
The status of the Payout. Can be Created, Pending Payment, Done, Rejected, Expired, or Error.
The source wallet address the payout is sent from. Set once processing starts.
A map of payout request addresses to their respective amounts.
The total cryptocurrency amount requested for the payout.
The total amount requested including the fee.
The error message. This field is always present in the response, but is empty unless the payout status is error or expired. For an expired payout it is one of Payout expired: transaction not found on any node, please retry or issue a new payout or Payout expired: transaction unconfirmed after 72 hours, please retry or issue a new payout, meaning the settlement transaction was dropped before confirming. The payout is recoverable: retry it with the same payout_id, or create a new payout.
The network fee paid by the settlement transaction. Set when the payout completes.
The fee associated with the payout.
The cryptocurrency for the payout.
The settlement transaction ID. Always set when status is done; empty for expired until a retry succeeds.
The timestamp when the Payout was created.
Delivery log of your payout webhook for this payout. Empty if no webhook URL is configured.
For an expired payout, requests, total_requested, and total_with_fee still report the full batch, which is intact and recoverable via retry. txid is empty until a retry succeeds, and no funds have left your wallet.
Payout statuses
The status field is machine-readable; display_status is its human-readable label.
status | display_status | Meaning |
|---|---|---|
created | Created | Payout created and queued for processing. |
processing | Pending Payment | Being processed on the blockchain. |
done | Done | Completed and confirmed on-chain. txid is populated. |
rejected | Rejected | You rejected the payout in your dashboard, or it had no valid outputs; it will not be processed. |
expired | Expired | The settlement transaction was dropped before confirming. No funds left your wallet and the batch is intact; retry with the same payout_id, or create a new payout. |
error | Error | The payout failed. Check the error field; you can retry with the same payout_id. |
Responses
200
The Payout was created successfully.
Content Types:
application/json
400
Your request couldn't be processed. Retry after a short delay.