Skip to content

Query Collection Order

Best practices

  1. Treat as successful when status==200 && orderStatus="SUCCESS"
  2. If timeout occurs or orderStatus is unavailable, do not change or conclude the order status

Endpoint

POST /cashin/vn/order/query

Request Headers

NameRequiredExampleDescription
Content-TypeYesapplication/json

Request Parameters

FieldTypeRequiredDescription
signstringYesVerified name
mchOrderNostringYesMerchant order number
mchIdintegerYesMerchant ID
timestampintegerYesCurrent timestamp — Unix timestamp in seconds

Request Example

json
{
  "mchId": 399204155797661,
  "timestamp": 16624500121,
  "mchOrderNo": "order_1662450069",
  "sign": "xxxxxxxxxxxxx"
}

Response Parameters

FieldTypeRequiredDescription
statusintegerYesStatus
msgstringYesMessage
dataobjectYesData
data.orderStatusstring enumYesOrder status — PENDING, SUCCESS, FAILED, REFUND, PART_SUC
data.amountnumberYesActual paid amount
data.timeEndintegerNoCompletion time — Timestamp unit: seconds
data.feenumberYesFee amount
data.mchOrderNostringYesMerchant order number
data.platOrderNostringYesPlatform order number

Response Example

json
{
  "status": 200,
  "msg": null,
  "data": {
    "mchOrderNo": "order_1662112944",
    "platOrderNo": "P5nosqyWAQsQZNtYa5OW",
    "orderStatus": "PENDING",
    "amount": "1200.00",
    "fee": "14.00"
  }
}

Transafe Developer Documentation