# Process Payout by ID 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 - **`apikey`** (`string`) (required): API Key provided by BlockBee's [Dashboard](https://dash.blockbee.io/). Unsure how to get yours? [Check this tutorial](https://support.blockbee.io/support/solutions/articles/204000013926-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`. - **`payout_id`** (`string`) (required) - Example: `{payout_id: 7f839bdd-5acd-4ce3-984d-1be8357b642d}`: The ID of the payout you want to process. --- ## 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. - **`status`** (`string`): Status of the request. - **`payout_info`** (`object`): Contains detailed information about the payout request. - **`id`** (`string`): Unique identifier for the payout request. - **`status`** (`string`): Current status of the payout request. - **`display_status`** (`string`): Current verbose status of the payout request. - **`from`** (`string`): Source address for the payout, if applicable. - **`requests`** (`object`): A mapping of destination addresses to the amount requested for each. - **`total_requested`** (`string`): Total cryptocurrency amount requested. - **`total_with_fee`** (`string`): Total cryptocurrency amount including the fee. - **`error`** (`string`): The error message given in case the payout status is error. - **`blockchain_fee`** (`string`): The fee paid to the blockchain for the transaction. - **`fee`** (`string`): Fee associated with the transaction. - **`coin`** (`string`): Cryptocurrency ticker for the transaction. - **`txid`** (`string`): Transaction ID, available once the payout is fulfilled. - **`timestamp`** (`string`): Timestamp when the payout was created. - **`queued`** (`boolean`): Indicates whether the payout is queued for processing. ## Example Response ```json { "status": "success", "queued": true, "payout_info": { "id": "ddcbab52-3fbc-478c-a103-ecdc2f0ed58c", "status": "processing", "display_status": "Pending Payment", "from": "0x18B211A1Ba5880C7d62C250B6441C2400d588589", "requests": { "0xA6B78B56ee062185E405a1DDDD18cE8fcBC4395d": "0.2" }, "total_requested": "0.2", "total_with_fee": "0.201", "error": null, "blockchain_fee": "0E-18", "fee": "0.001", "coin": "bep20_usdt", "txid": "", "timestamp": "10/07/2025 17:01:27" } } ```