Get Payment account balance

This operation returns balance of Wallet or PB Bank (GFS payment method) accounts.

SecuritybearerAuth
Request
query Parameters
accountType
required
string

An identifier to get balance of Wallet or PB Bank. It accepts WALLET for fetching postage balance and PBBANK for fetching GFS balance.

Enum: "WALLET" "PBBANK"
carrierAccountId
string

A unique identifier assigned to the specific carrier account. Its value can be referred from the response of Get Carrier Accounts API. It is required when accountType is WALLET

locationId
string

It specifies the Location Id on which GFS payment method is associated. Its value can be refered from response of Get Location Details API. It is required when accountType is PBBANK.

header Parameters
X-PB-Developer-Partner-ID
string

This is the Developer Partner ID. When the developer is the only partner, this field is not required.

Responses
200

Returns account balance

400

Invalid request.

401

The request could not be authorized.

500

The request could not be completed due to an internal error.

get/api/v1/payments/accounts/balance
Request samples 
Response samples 
application/json
{
  • "walletAccount": {
    },
  • "trustAccount": {
    },
  • "purchasePowerAccount": {
    },
  • "reserveAccount": {
    }
}