Check Status of Payout

This API is used to inquire about the current status of the requested payout based on the payout id.

Endpoint

Environment	Method	URL
Sandbox	GET	https://payout.codapayments-staging.com/payouts/<payout_id>
Production	GET	https://payout.codapayments.com/payouts/<payout_id>

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

curl --location 'https://payout.codapayments.com/payouts/<payout_id>' \
--header 'X-API-Key: [Test_API_Key]' \
--header 'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJwYXJ0bmVyX2lkIjoicGFyX3NnMTg3MzI2ZjA4ZjB3cmtyMTA2IiwiaWF0IjoxNjgzMTA0MTc3fQ.JLm21T7EE-papCtiAvDeU1SftBlDuwvI4VtAf2WcOKY'

Check Status Response

Success

{
    "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
}

Failed

{
    "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."
    }
}