Skip to content

Get Account Balance

An endpoint to get the available balance of the integrator's account with the payment processor of a payout option.

To get the account balance, send the following request header and body parameters via POST.

POST/disbursement/account-balance

HEADER PARAMETERS

Authorization required
string
Unique identifier of the integrator.

REQUEST BODY SCHEMA: application/json

transaction_id required
string
Payment transaction reference ID.
notify_user required
string
True or false value. Directs function whether to notify the customer via email.

RESPONSE BODY PARAMETERS

option
string
Generated code of the payout option from Get Disbursement Options endpoint response.

Request Samples

curl
    -X POST "https://test-api.tlpe.io/disbursement/account-balance" \
    -H "Content-Type: application/json" \
    -H "Authorization: {integratorToken}" \
    -d "{
        "option":"{generatedOptionKey}"
    }"

Response Samples

{
    "timestamp":"2020-07-14T09:29:49.843+0000",
    "status":200,
    "message":"Request processed successfully",
    "path":"/disbursement/account-balance",
    "data":{
        "balance":"{availableBalance}",
        "currency":"PHP"
    }
}