Api Inquiry Balance

Request

API capability allowing systems, software, or applications to programmatically check and retrieve the current balance of an account.

Request Path:

{Base URL}/v2.0/inquiry-balance

Header Parameters

Field	Attribute	Type	Description
Content-Type	M	String	application/json
X-TIMESTAMP	M	String	yyyy-MM-ddTHH:mm:ss[zoneOffset] eg: 2020-12-17T10:55:00+07:00
X-SIGNATURE	M	String	Focus：How to signature
X-PARTNER-ID	M	String	merchant ID

Body Parameters

Field	Attribute	Type	Description
accountNo	M	String(128)	the account of merchant
balanceTypes	M	List(String)	default BALANCE

Info

1. accountNo in sandbox random string,
2. accountNo in prod you can find in merchant backend. click how to get account no
3. The payin account used to collect the amount of all pay-in business
4. The payout account is used to indicate the account used for pay-out.
5. The balance between accounts can be transferred. how to transfer

Example Header – Balance Inquiry Request:

POST {Base URL}/v2.0/inquiry-balance HTTP/1.2

Content-type: application/json
X-TIMESTAMP: 2020-12-18T15:06:00+07:00
X-SIGNATURE: 85be817c55b2c135157c7e89f52499bf0c25ad6eeebe04a986e8c862561b19a5
X-PARTNER-ID: 20001

{
  "accountNo": "21120030202403071031",
  "balanceTypes": [
    "BALANCE"
  ]
}

Response

API header format structure:

Field	Attribute	Type	Description
Content-Type	M	String	application/json
X-TIMESTAMP	M	String	yyyy-MM-ddTHH:mm:ss[zoneOffset] eg: 2020-12-17T10:55:00+07:00

Response Body

Field	Attribute	Type	Description
code	M	String	success = "00"
message	M	String	Response message
accountInfos	M	BalanceAccounts	BalanceAccounts
accountNo	O	String	The account of merchant
balanceTypes	O	List	balanceTypes
name	O	String	account name
accountNo	O	String	The account of merchant
additionalInfo	O	JsonString	Additional Information

Example Body – Balance Inquiry Response:

Content-type: application/json 
X-TIMESTAMP: 2020-12-17T10:55:00+07:00

{
  "code": "00",
  "message": "Successful",
  "accountNo": "21120030202403071031",
  "name": "Sandbox Test",
  "balanceTypes": [
    "balance"
  ],
  "accountInfos": {
    "balanceType": "BALANCE",
    "amount": {
      "currency": "THB",
      "value": "250000"
    },
    "availableBalance": {
      "currency": "THB",
      "value": "250000"
    }
  }
}