Skip to content

Query Merchant Balance (/payout/balance)

Description

Merchants invoke this endpoint to query their real-time account balances on the platform (available balance, frozen balance, unavailable/in-transit funds).


Request Information

  • Endpoint: /payout/balance
  • Method: POST
  • Content-Type: application/json; charset=utf-8

HTTP Headers

HeaderRequiredTypeDescription
merchantNoYesStringMerchant ID
signYesStringBase64-encoded RSA digital signature of request body

Request Body Parameters

ParameterRequiredTypeExampleDescription
timestampYesLong1772880600000Epoch timestamp in milliseconds

Request Payload Example

json
{
  "timestamp": 1772880600000
}

Response Parameters

Success Response

json
{
  "code": 1,
  "msg": "ok",
  "data": {
    "merchantNo": "M1652264659533",
    "availableBalance": "971.40",
    "frozenBalance": "0.00",
    "unavailableBalance": "100.00"
  }
}

Failure Response

json
{
  "code": 0,
  "msg": "invalid merchant"
}

Response Fields Description

FieldTypeDescription
codeInteger / StringStatus code: 1 success, 0 failure
msgStringMessage description
dataObjectAccount balance details
data.merchantNoStringMerchant ID
data.availableBalanceStringAvailable Balance (Funds readily available for payouts or withdrawals)
data.frozenBalanceStringFrozen Balance (Funds withheld due to security, disputes, or reserves)
data.unavailableBalanceStringUnavailable / In-transit Balance (Funds pending settlement or in clearing)

Bangladesh Payment Gateway API Specifications