Skip to main content

Merchant Balance Inquiry

Check your available balance, total balance, and any amount on hold before initiating a remittance. The response includes the total balance, the balance available for remittances, the security deposit hold, and the maximum amount allowed per transaction (if a limit is set).

Applies to: Both

Endpoint​

MethodGET
Path/remittance/{merchantId}/balance-data
Sandboxhttps://sandbox.simpaisa.com

Request Parameters​

ParameterRequiredTypeLengthDescription
merchantIdYesString10The unique ID of a merchant provided by Simpaisa

Response Parameters​

ParameterTypeLengthDescription
iso-currency-codeString3The currency code as per international standard
balance-in-totalInt15The total balance of the merchant
available-balanceInt15The balance that can be used for remittances
balance-on-holdInt15The balance kept as a security deposit
max-amount-limitInt15The maximum amount per remittance, if enabled

Sample​

{
  "response": {
    "iso-currency-code": "PKR",
    "balance-in-total": 100.0,
    "available-balance": 100.0,
    "balance-on-hold": 0.0,
    "max-amount-limit": 100.0
  }
}