查看Payout可用余额

可用payout余额是以当地货币显示的，可用于请求payout的总金额。

接口

环境	方法	URL
沙盒 (Sandbox)	GET	https://payout.codapayments-staging.com/balance
生产 (Production)	GET	https://payout.codapayments.com/balance

Headers

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

请求参数

仅限读操作。请求不需要任何参数。

响应参数

参数	描述
balance	Payout可用总金额
currency	币种
credit_limit	若商户启用了信用额度功能，此字段显示剩余可用信用额度。
credit_currency	Credit_limit 的货币 信用额度对应的货币类型（仅当启用信用额度功能时返回）。
gst	如果发布者符合 GST 税收条件，此处显示将应用于Payout请求的 GST 金额。例如：0.01（1%）
fees.bank_transfer	应用于payout请求的银行转账费用的价值。 例如：0.01（1%）
fees.wallet	应用于payout请求的电子钱包费用的价值。 例如：0.01（1%）
last_updated	余额信息的上次更新日期和时间。 日期和时间采用 UTC 时区。

可用余额的详细信息将每日更新。截止时间为下午 5 点（UTC+8）。

请求和响应示例

查询余额请求

未设置

curl -L -X GET 'https://payout.codapayments-staging.com/balance' \
-H 'X-API-Key: Test_API_Key' \
-H 'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJwYXJ0bmVyX2lkIjoicGFyX3NnMTg3MzI2ZjA4ZjB3cmtyMTA2IiwiaWF0IjoxNjgyNDg1MjYwfQ.ao1-YJBbkAEj1hWmK8vTydK1LyaQh2es9kc51VeJix4' \
-H 'Content-Type: application/json'

查询余额响应（信用额度）

信用流动

{
    "balance": "10000.00",
    "currency": "USD",
    "credit_limit": "10000.00",
    "credit_currency": "USD",
    "gst": "0.08",
    "fees": {
        "wallet": "0.01",
        "bank_transfer": "0.02"
    },
    "last_updated": "2023-06-09T07:27:05.346867915Z"
}

非信用流动

{
    "balance": "10000.00",
    "currency": "USD",
    "gst": "0.08",
    "fees": {
        "wallet": "0.01",
        "bank_transfer": "0.02"
    },
    "last_updated": "2023-06-09T07:27:05.346867915Z"
}