Skip to content

Query Payout Order (/payout/query) ​

Description ​

Merchants can query the real-time status and details of a payout order.


Request Information ​

  • Endpoint: /payout/query
  • 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
timestampYesLong1772880500000Epoch timestamp in milliseconds
merchantOrderNoYesStringPO202603070001Merchant payout order reference

Request Payload Example ​

json
{
  "timestamp": 1772880500000,
  "merchantOrderNo": "PO202603070001"
}

Response Parameters ​

Success Response ​

json
{
  "code": 1,
  "msg": "ok",
  "data": {
    "merchantNo": "M1639466186292",
    "merchantOrderNo": "PO202603070001",
    "platOrderNo": "876324486452871168",
    "amount": "220.00",
    "fee": "5.00",
    "status": "3",
    "payTime": "2026-09-09 22:22:22",
    "payAccountNo": "01666777888",
    "trxId": "SDIIFKISDL"
  }
}

Failure Response ​

json
{
  "code": 0,
  "msg": "order not found"
}

Field Specifications ​

FieldRequiredTypeDescription
codeYesInteger / StringStatus code: 1 indicates success, 0 indicates failure
msgYesStringMessage description
dataYesObjectDetailed payout data object
data.merchantNoYesStringMerchant ID
data.merchantOrderNoYesStringMerchant order reference number
data.platOrderNoYesStringPlatform transaction number
data.amountYesStringDisbursed amount
data.feeYesStringPayout fee
data.statusYesStringPayout status:
0: Created
1: Processing (sent to bank/wallet)
2: Failed
3: Succeeded
data.payTimeNoStringPayment completion timestamp (format: yyyy-MM-dd HH:mm:ss)
data.payAccountNoNoStringDisbursing account number
data.trxIdNoStringUnique transaction ID generated by the e-wallet system to identify this transaction

Bangladesh Payment Gateway API Specifications