---
title: "Get Balance"
method: POST
path: "/pws/pws_get_balance/"
tags: ["Account"]
---

# Get Balance

`POST /pws/pws_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).

## Request body

- GetBalanceModel — -- This web service retrieves the card balance available for a specific card/token or account. -- It returns current (actual) balance, available (pending) balance and blocked balance.
  - `api_call_unique_identifier` string, required — Unique number that must be passed at each API request. Identifier to make each API request unique
  - `client_id` integer, required — Unique identifier for the client which Paymentology will provide at outset
  - `input_id` integer, required — Public token / account number.Pass public token when input type is t./Pass account number when input type is a.
  - `input_type` string, required — <p>Input Type :</p> <ul> <li class="docBullet">a ==&gt; account</li> <li class="docBullet">t ==&gt; Token</li> </ul>
  - `user_id` string — User Id of the Customer who triggered the API request.
  - `remarks` string — Remarks for API request

## Response `200`

Successful Response

- GetBalanceResponse — This model contains the information of get balance api
  - `header` GetBalanceHeader
    - `error_id` integer — error id
    - `error_desc` string — error message
  - `body` GetBalanceBody
    - `bal_pnd_amt` number — Pending Balance Amount
    - `bal_blk_amt` number — Blocked Balance Amount
    - `bal_act_amt` number — Actual Balance Amount
    - `bal_ccy` string — Billing currency (Three digit ISO-4217 standard currency code . i.e. : 048 → BHD, 060 → BMD, 036 → AUD)
    - `bal_avail_amt` number — Available Balance Amount

## Other responses

- `404` — Webservices does not exist
- `500` — Internal Server error

---

[API](https://skmtc.net/paymentology/apis/payapi-docs.md) · [All operations](https://skmtc.net/paymentology/apis/payapi-docs/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/paymentology/payapi-docs/revisions/a675891b0365/schema)