Sign in

v1

latestOpenAPI 3.0.02026-07-242035712.0 MB
Account

Load Balance

This API is for Debit and Prepaid products only. It allows users to load or unload an amount onto an account. A token or account ID can be passed in. In the event that a token is passed, the default action is to credit the account linked to the token. Note: It is normal to load/unload funds in the billing currency of the account. However, this web service offers the option for FX conversion during the load/unload process.

Conversion rates are live within the platform and can be controlled by the user on various bases. A load/unload fee can also be accommodated. It is important to note that the user has control over how this fee affects the account/card balance. Please refer to the description in the "load_fee_type" tag to determine whether the load fee will be charged or not.

Using this API does not disrupt the continuity of the ledger and should be used for all day-to-day financial operations required at the account level. However, please note that this API is NOT suitable for STIP updates of account balance. For STIP functions, please use the Update Account Balance API.

post/pws/pws_load_balance/

Request body

act_blk_pndstring required
<p>Amount Status:</p> <ul> <li class="docBullet">a ==&gt; update actual amount</li> <li class="docBullet">b ==&gt; update blocked amount</li> </ul>
amountnumber required

Amount to load or unload.

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

cr_drstring required
<ul> <li class="docBullet">Credit [c/C]= add balance in the account/token.</li> <li class="docBullet">Debit [d/D] = deduct balance in the account/token.</li> </ul>
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

amt_ccystring

Amount currency (Three digit ISO-4217 standard currency code . i.e. : 048 → BHD, 060 → BMD, 036 → AUD).

load_feenumber

Fee amount while load/unload balance.

load_ccystring

Load Currency (Three digit ISO-4217 standard currency code . i.e. : 048 → BHD, 060 → BMD, 036 → AUD).

sourcestring

Specify a note about source of load.

unload_optionstring
<p>Unload option :</p> <ul> <li class="docBullet">1 ==&gt; Decline unload if balance is insufficient.</li> <li class="docBullet">2 ==&gt; Balance reduces to negative if insufficient.</li> <li class="docBullet">3 ==&gt; Balance reduces to zero if insufficient balance. DEFAULT if not passed unload_option.</li> </ul>
notestring

Something about load/unload note.

load_fee_typeinteger
<p>Load Fee Type.Possible values are</p> <ul> <li class="docBullet">:0 ==&gt; Load fee not applicable.</li> <li class="docBullet">1 ==&gt; Load fee applicable.</li> </ul> <p>If not passed then default as 0</p>

Example request

{
  "act_blk_pnd": "a",
  "amount": 100.1,
  "api_call_unique_identifier": "438574845790657485",
  "client_id": 760131,
  "cr_dr": "c",
  "input_id": 520872406,
  "input_type": "t",
  "amt_ccy": "826",
  "load_fee": 12.12,
  "load_ccy": "826",
  "source": "paymentology",
  "unload_option": "3",
  "note": "Balance load from Paymentology"
}

Response

Successful Response

Example response

{
  "header": {
    "error_desc": "success"
  },
  "body": {
    "load_amt": 1200.1244,
    "bill_blk_amt": 100.1,
    "bill_act_amt": 100.1,
    "bill_pnd_amt": 100.1,
    "bal_ccy": "826",
    "txn_id": "164793651353181"
  }
}