Query Account Balance

Retrieves the total, available, and blocked balances of a merchant account by currency.

Endpoint

POST /remittance/account/query-balance

Sandbox base URL: https://rem-api-sandbox.pagsmile.com Content-Type: application/json; charset=UTF-8

The request uses the standard Remittance API request envelope. The fields below describe the decrypted biz_data object.

Requirement: M = Mandatory, O = Optional, and C = Conditional. A conditional field is mandatory only when the condition stated in its description applies.

Encrypt biz_data, encrypt the AES key into random_key, and sign the request according to the Common request specification.

Request body

Decrypted biz_data fields

Field	Type	Requirement	Description
merchant_id	string	M	Pagsmile-assigned unique identifier of the merchant.
currency	string	O	Three-letter ISO 4217 code of the currency in which the merchant account balance values are denominated.

Plaintext biz_data example

This example includes mandatory fields and representative optional or conditional fields. Submit fields marked C only when the condition in the field description applies.

{
  "merchant_id": "100398",
  "currency": "USD"
}

Request example

curl --request POST \
  --url https://rem-api-sandbox.pagsmile.com/remittance/account/query-balance \
  --header 'Content-Type: application/json; charset=UTF-8' \
  --data '{
    "partner_id": "<your_partner_id>",
    "app_id": "<your_app_id>",
    "timestamp": "2026-07-20 10:30:00",
    "version": "2.0",
    "language": "en",
    "random_key": "<RSA-encrypted AES key>",
    "request_id": "<globally_unique_request_id>",
    "sign_type": "RSA",
    "biz_data": "<AES-encrypted biz_data>"
  }'

Use the partner_id and app_id assigned to your integration. The values above are placeholders.

Response

Success

The data field in the response envelope is AES-encrypted. Decrypt random_key with your RSA private key, then use the resulting AES key to decrypt data. See Security for implementation details.

Encrypted response example

{
  "code": "10000",
  "msg": "Success",
  "data": "<AES-encrypted response data>",
  "random_key": "<RSA-encrypted AES key>",
  "sign_type": "RSA",
  "app_id": "2017051914172236111"
}

Decrypted data example

[
  {
    "account_name": "Example Merchant Account",
    "account_no": "2001000000000057",
    "currency": "USD",
    "balance": "1000.00",
    "available_balance": "950.00",
    "block_amount": "50.00"
  }
]

Invalid signature

{
  "code": "40002",
  "msg": "Business Failed",
  "sub_code": "invalid-signature",
  "sub_msg": "invalid signature"
}

Response data fields

Field	Type	Requirement	Description
account_name	string	M	Name registered on the account.
account_no	string	M	Merchant account number whose balance is returned.
currency	string	M	Three-letter ISO 4217 code of the currency in which the merchant account balance values are denominated.
balance	string	M	Total account balance, including available and blocked funds.
available_balance	string	M	Amount currently available for new transactions.
block_amount	string	M	Amount currently blocked or reserved and therefore unavailable for use.

Related APIs

• Query Account Transactions