Query Order Details

This endpoint is designed to provide you with the ability to retrieve details for all transaction types associated with your OPay Business account. By doing so, you can seamlessly integrate this data into your system, enabling efficient management and oversight of your orders from a single, centralized location.

Query Order Details

URL: https://payapi.opayweb.com/openApi/order/queryDetail

Request Parameters

ParameterTypeRequiredDescription
headMerchantIdStringYesYour Business ID
merchantIdStringYesYour Branch ID
orderTypeStringYesPAY
orderNoStringYesEnter your OPay order number

POST
{
  "headMerchantId":"256622040884147",
  "merchantId":"256622040884147",
  "orderType":"PAY",
  "orderNo":"2334345345345245"
}
1
2
3
4
5
6

Response

ParameterTypeDescription
codeStringsuccessful
messageString
signString
timestampString
dataObject
outOrderNoStringYour business order number
orderNoStringOPay payment order number
payNoStringOPay payment serial number
headMerchantIdStringYour Business ID
merchantIdStringYour Branch ID
Show more parameters

POST
{
  "code":"00000",
  "message":"SUCCESSFUL",
  "sign":"yUJrerHr9GqKP7y......",
  "timestamp":"1283203360637",
  "data":{
    "outOrderNo":"2334345345345211",
    "orderNo":"20220704741380171865833472",
    "payNo":"2334345345345245",
    "headMerchantId":"256622022480363",
    "merchantId":"256622022480364",
    "status":"Not sufficient funds",
    "errorMsg":"SUCCESS",
    "senderName":"John",
    "senderAccount":"23234324*****23423",
    "senderBank":"",
    "recipientName":"Michael",
    "recipientAccount":"+2345656567878",
    "recipientBank":"",
    "amount":"100.00",
    "fee":"10.00",
    "feePattern":"OUT_DEDUCT",
    "payMethod":"BalancePayment",
    "settlementAmount":"100.00",
    "settlementFee":"10.00",
    "settlementFeePattern":"OUT_DEDUCT",
    "currency":"NGN",
    "isSplit":"Y",
    "splitInfo":[
      {
        "splitMerchantId":"25623232423432",
        "splitAmount":"20.00"
      }
    ],
    "productInfo":"",
    "sn":"XXXX",
    "remark":null,
    "transactionTime":"1692773950143",
    "completedTime":"1692773950143"
  }
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
Last Updated: 11/7/2024, 3:43:34 AM