查看Payout订单状态

该API用于根据payout ID查询请求payout的当前状态。

接口

环境	模式	URL
沙盒 (Sandbox)	GET	https://payout.codapayments-staging.com/payouts/<payout_id>
生产 (Production)	GET	https://payout.codapayments.com/payouts/<payout_id>

Headers

您可以参考身份验证章节。

请求参数

参数	类型	必填项	描述	验证
payout_id	string	是	由Coda创建的Payout唯一ID。	-

响应参数

参数	描述
payout_id	由Coda生成的付款唯一标认符。
request_id	商户创建并附加至付款请求的唯一请求标认符。
request_amount	付款请求的总金额
target_amount	支付给收款人的最终金额（已扣除费用、商品级服务税等，具体扣除项根据与Coda的商业合同而定）。 注意：request_amount 和 target_amount 可以是不同的货币
payout_status	付款状态（如“处理中” “已完成” 等，具体状态请参考下表）。
error	错误信息（若交易失败，此处显示具体错误详情）。

Payout状态

Payout状态	描述
Initiated	付款请求已接收，待审核。
Rejected	付款请求已被Coda拒绝（详情请查看错误信息），此状态不可逆转。
OnHold	付款请求正在进行内部复核， Coda 将联系商户补充相关资料，审核完成后将继续处理。
Processing	付款请求处理中。
Success	付款成功，此状态不可更改。
Failed	付款失败（详情请查看错误信息），此状态不可逆转。若需了解失败交易的费用问题，请联系Coda。

请求和响应示例

查看状态请求

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

查看状态响应

成功

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

失败

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