Sign in

v1

latestOpenAPI 3.0.02026-07-242035712.0 MB
Account

Get Balance

Token or account number can be passed in. In the case where token is passed, the balance of the account to which the token is related to by default, is returned.
Provision is made for four balances to be returned :

  1. Total blocked amount (bal_blk_amt)
  2. Total Settled amount (bal_act_amt)
  3. Total pending amount (bal_pnd_amt)
  4. Total Available amount (bal_avail_amt)

Note: Pending amounts are amounts that may be ‘in progress’ to the account but not cleared for use (eg a chaps transfer, or chargeback refund).

post/pws/pws_get_balance/

Request body

api_call_unique_identifierstring required

Unique number that must be passed at each API request. Identifier to make each API request unique

client_idinteger required

Unique identifier for the client which Paymentology will provide at outset

input_idinteger required

Public token / account number.Pass public token when input type is t./Pass account number when input type is a.

input_typestring required
<p>Input Type :</p> <ul> <li class="docBullet">a ==&gt; account</li> <li class="docBullet">t ==&gt; Token</li> </ul>
user_idstring

User Id of the Customer who triggered the API request.

remarksstring

Remarks for API request

Example request

{
  "api_call_unique_identifier": "438574845790657485",
  "client_id": 760131,
  "input_id": 520872406,
  "input_type": "t"
}

Response

Successful Response

Example response

{
  "header": {
    "error_desc": "success"
  },
  "body": {
    "bal_pnd_amt": 100,
    "bal_blk_amt": 100,
    "bal_act_amt": 10000,
    "bal_ccy": "826",
    "bal_avail_amt": 9900
  }
}