Merchant Wallet API

Revision & Version

• Version: 1.0
• Last Updated: 2025-03-14

Endpoint

• URL: /api/v2/merchant/wallet
• Method: GET
• Authentication: Required (refer to Global Authentication Guidelines)

Request Parameters

Parameter	Type	Required	Description
-	-	-	This API does not require additional parameters

Response Parameters

APIMerchantWalletResponse Fields

Parameter	Type	Description
totalBalance	BigDecimal	Total balance of the merchant account
availableBalance	BigDecimal	Available balance
frozenBalance	BigDecimal	Frozen balance
withdrawal	WithdrawInfo	Withdrawal details

WithdrawInfo Fields

Parameter	Type	Description
withdrawableBalance	BigDecimal	Balance available for withdrawal
withdrawalRestriction	WithdrawRestriction	Withdrawal restriction details

WithdrawRestriction Fields

Parameter	Type	Description
depositFreezeDuration	Int	Deposit freeze duration (in minutes)
depositTransactionCount	Int	Number of deposit transactions
depositTransactionAmount	BigDecimal	Total deposit transaction amount

Request Example

curl -X GET https://{YOUR_ENDPOINT}/api/v2/merchant/wallet \
  -H "Content-Type: application/json;charset=UTF-8" \
  -H "access_key: {YOUR_ACCESS_KEY}" \
  -H "signature: {GENERATED_BY_Hmac256}" \
  -H "timestamp: {TIMESTAMP_IN_MILLISECONDS}"

Response Example

{
  "data": {
    "totalBalance": 1000.50,
    "availableBalance": 800.00,
    "frozenBalance": 200.50,
    "withdrawal": {
      "withdrawableBalance": 500.00,
      "withdrawalRestriction": {
        "depositFreezeDuration": 86400,
        "depositTransactionCount": 5,
        "depositTransactionAmount": 1000.00
      }
    }
  },
  "isSuccess": true,
  "statusCode": "SUCCESS",
  "message": "Request successful",
  "version": "2.0"
}