](https://payout.codapayments.com/payouts/%3Cpayout_id%3E) |
## **Request parameters**
| Parameter | Type | Required | Description | Validation |
| ---------- | ------ | -------- | ------------------------------------------ | ---------- |
| payout\_id | string | Yes | A unique ID of the payout, created by Coda | - |
## **Response parameters**
| Parameter | Description |
| --------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| payout\_id | A unique ID of the payout, created by Coda |
| request\_id | A unique request ID that is attached to the payout request, created by Merchant |
| request\_amount | Total requested payout amount |
| target\_amount | Total final amount paid out to beneficiary (after deducting fees, gst, various taxes depending on Merchant contract with Coda)
Note: request\_amount and target\_amount can be in different currencies
|
| payout\_status | The status of the payout. Refer to the table below for the different statuses. |
| error | This will show the error message if there is an error. |
## **Payout Statuses**
| Payout Status | Description |
| ------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Initiated | Payout request has been received and will be reviewed. |
| Rejected | Payout request has been rejected by Coda, refer to the error message for more details. This status is the final status. |
| Processing | Payout request is being processed.
This status is the in progress status.
|
| Success | Payout is successful.
This status is the final status.
|
| Failed | Payout has failed, refer to the error message for more details.
This status is the final status.
For information on transaction fees for Failed status, please contact Coda Payments.
|
## Request and response samples
### Check Status Request
```javascript
curl --location 'https://payout.codapayments.com/payouts/' \
--header 'X-API-Key: [Test_API_Key]' \
--header 'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJwYXJ0bmVyX2lkIjoicGFyX3NnMTg3MzI2ZjA4ZjB3cmtyMTA2IiwiaWF0IjoxNjgzMTA0MTc3fQ.JLm21T7EE-papCtiAvDeU1SftBlDuwvI4VtAf2WcOKY'
```
### Check Status Response
{% tabs %}
{% tab title="Success" %}
```javascript
{
"payout_id": "MDAwLjAuMTY4MDAxMjM3MC4xMw==",
"request_id": "request_id",
"request_amount": {
"value": 10.0,
"currency_code": "USD"
},
"target_amount": {
"value": 10.0,
"currency_code": "PHP"
},
"payout_status": {
"code": "Success",
"message": "Payout is successful"
},
"error": null
}
```
{% endtab %}
{% tab title="Failed" %}
```javascript
{
"payout_id": "e0929c27-a229-4d83-b2a1-ab227157dc23",
"request_id": "koongpayout79_request11_id_4July2023BBB",
"request_amount": {
"value": 5555.00,
"currency_code": "EGP"
},
"target_amount": {
"value": 5555.00,
"currency_code": "EGP"
},
"payout_status": {
"code": "Failed",
"message": "Payout has failed, refer to the error message for more details."
},
"error": {
"code": "INCOMPLETE_DATA",
"message": "Data sent are incomplete and the request cannot be completed."
}
}
```
{% endtab %}
{% endtabs %}
---
# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.
## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.
Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:
```
GET https://docs.coda.co/payout/integration-guides/api-reference/initiate-a-payout-request/check-status-of-payout.md?ask=&goal=
```
`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.
Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.