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"
  }
}

Failure Response

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

Field Specifications

FieldTypeDescription
codeInteger / String1 indicates success, 0 indicates failure
msgStringMessage description
dataObjectDetailed payout data object
data.merchantNoStringMerchant ID
data.merchantOrderNoStringMerchant order reference number
data.platOrderNoStringPlatform transaction number
data.amountStringDisbursed amount
data.feeStringPayout fee
data.statusStringPayout status:
0: Created
1: Processing (sent to bank/wallet)
2: Failed
3: Succeeded

Bangladesh Payment Gateway API Specifications