Skip to content

Query Pay-in Order (/payin/query)

Description

Merchants can query the real-time status and details of an existing pay-in order. This endpoint is typically used when the asynchronous callback notification is delayed or for periodic reconciliation.


Request Information

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

HTTP Headers

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

Request Body Parameters

ParameterRequiredTypeExampleDescription
timestampYesLong1772880200000Epoch timestamp in milliseconds
merchantOrderNoYesString202603070001Merchant unique order number

Request Payload Example

json
{
  "timestamp": 1772880200000,
  "merchantOrderNo": "202603070001"
}

Response Parameters

Success Response

json
{
  "code": 1,
  "msg": "success",
  "data": {
    "merchantNo": "M1639466186292",
    "merchantOrderNo": "202603070001",
    "platOrderNo": "876324486452871168",
    "amount": "220.00",
    "fee": "2.20",
    "payUrl": "https://gateway.example.com/checkout/876324486452871168",
    "expireTime": "2026-05-05 11:11:11",
    "status": "3"
  }
}

Failure Response

json
{
  "code": 0,
  "msg": "param merchant error"
}

Field Specifications

FieldTypeDescription
codeInteger / String1 for success, 0 for failure
msgStringStatus or error description
dataObjectDetailed order data object
data.merchantNoStringMerchant ID
data.merchantOrderNoStringMerchant order reference number
data.platOrderNoStringPlatform transaction number
data.amountStringTransaction amount
data.feeStringProcessing fee
data.expireTimeStringExpiration time of the checkout URL
data.payUrlStringCashier checkout page redirect URL
data.statusStringOrder status:
0: Created
1: Expired
2: Failed
3: Succeeded

Bangladesh Payment Gateway API Specifications