Check Available Balance for Payout

Available payout balance is the total amount shown in local currency that can be used for requesting payout.

Endpoint

Environment	Method	URL
Sandbox	GET	https://payout.codapayments-staging.com/balance
Production	GET	https://payout.codapayments.com/balance

Request Parameters

Read operation only. No parameter needed for the request.

Response Parameters

Parameter	Description
balance	Total amount available for payout
currency	Currency for balance
credit_limit	If a publisher applies the Credit Flow, the publisher will be eligible for a specific credit limit amount. This is to show the total amount of the credit limit that are still available for payout request If publisher doesn’t applying the Credit Flow, this parameter won’t be shown in the response
credit_currency	Currency for credit_limit If publisher doesn’t applying the Credit Flow, this parameter won’t be shown in the response
gst	If publisher is eligible for GST tax, this is to show the value of GST that will be applied for payout request. e.g. 0.01 (1%)
fees.bank_transfer	The value of Bank Transfer fee that will be applied for payout request. e.g. 0.01 (1%)
fees.wallet	The value of Wallet fee that will be applied for payout request. e.g. 0.01 (1%)
last_updated	Last updated date and time for the balance information. Date and time is in UTC timezone.

The detailed information of available balance will be updated daily. The cut-off time is 5PM UTC+8.

Request and response samples

Check balance request

Unset

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'

Check balance response (Credit flow)

Credit flow

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

Non-Credit flow

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