Sign in

v1

latestOpenAPI 3.0.02026-07-242035712.0 MB
Account V2

Account Balance List

<ul> <li class="docBullet">Allows for retrieval of a list of all child accounts of an account or list all account of provided customer id.</li> <li class="docBullet">A simple list of all child account id’s and their names, descriptions and billing currencies are returned.</li> </ul>
post/pws/v2/pws_get_balances/

Request body

ac_idinteger required

Parent account number

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

user_idstring

User Id of the Customer who triggered the API request.

remarksstring

Remarks for API request

optioninteger
<ul> <li>1 : Show aggregrate balances for ac_id passed and its child accounts</li> <li>2 : Show aggregate balance for ac_id passed only and its details</li> <li>3 : Show aggregate balance for ac_id and its child accounts and details of all accounts<br /><br /><br /></li> </ul>If value for this field is not passed then action behaves as option 1 by default

Example request

{
  "ac_id": 285287818,
  "api_call_unique_identifier": "438574845790657485",
  "client_id": 760131,
  "option": 2
}

Response

Successful Response

blk_amt_aggregatenumber

Aggregate blocked amount of account list

act_amt_aggregatenumber

Aggregate actual amount of account list

Example response

{
  "header": {
    "error_desc": "success"
  },
  "blk_amt_aggregate": 5500.001,
  "act_amt_aggregate": 1200.101,
  "body": [
    {
      "ac_id": 732021388,
      "ac_name": "Akhsay Patel",
      "ac_parent": 122222,
      "client_id": 123456,
      "bill_ccy": "826",
      "bal_blk_amt": 100,
      "bal_act_amt": 10000,
      "cre_dt": "2019-12-03T08:03:12Z"
    }
  ]
}