# Check Payout Status Check the status of your Payout by providing its `ID`. **Method:** `POST` **Path:** ``` https://api.blockbee.io/payout/status/ ``` --- ## Parameters ### Query Parameters - **`apikey`** (`string`) (required) - Example: `your_api_key_here`: API Key provided by BlockBee's [Dashboard](https://dash.blockbee.io/). Unsure how to get yours? [Check this tutorial](/kb/tutorials/dashboard/how-to-generate-a-new-api-key). **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`. **Note**: The request `Content-Type` header must be set to `application/x-www-form-urlencoded`. - **`payout_id`** (`string`) (required) - Example: `{payout_id: 7f839bdd-5acd-4ce3-984d-1be8357b642d}`: The ID of the payout you want to check. --- ## Returns Returns the status information of the payout. - **`status`** (`string`): Status of the request. Should be `success` if the request didn't fail. - **`payout_info`** (`object`): Contains detailed information about the payout. - **`id`** (`string`): The ID of the Payout. - **`status`** (`string`): The status of the Payout. Can be created, processing, done, rejected, or error. - **`display_status`** (`string`): The status of the Payout. Can be Created, Pending Payment, Done, Rejected, or Error. - **`from`** (`string`): The source from which the Payout was created, if applicable. - **`requests`** (`object`): A map of payout request addresses to their respective amounts. - **`total_requested`** (`string`): The total cryptocurrency amount requested for the payout. - **`total_with_fee`** (`string`): The total amount requested including the fee. - **`error`** (`string`): 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_fee`** (`string`): The fee paid to the blockchain for the transaction. - **`fee`** (`string`): The fee associated with the payout. - **`coin`** (`string`): The cryptocurrency for the payout. - **`txid`** (`string`): The transaction ID of the Payout, if it has been processed. - **`timestamp`** (`string`): 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. ## Example Response ```json { "status": "success", "payout_info": { "id": "ddcbab52-3fbc-478c-a103-ecdc2f0ed58c", "status": "done", "display_status": "Done", "from": "0x18B211A1Ba5880C7d62C250B6441C2400d588589", "requests": { "0xA6B78B56ee062185E405a1DDDD18cE8fcBC4395d": "0.2" }, "total_requested": "0.2", "total_with_fee": "0.201", "error": null, "blockchain_fee": "0.000024738630000000", "fee": "0.001", "coin": "bep20_usdt", "txid": "0xcc522d6b94e3f284f3f00d43729167f792419c70ec4f9143fc1bddeb04c91912", "timestamp": "10/07/2025 17:01:27" } } ```