Inquiry Payment
1.Overview
Use this API to inquire about the transaction status and other information about a previously submitted payment request.
2.Request Info
Key |
Value |
Content-Type |
application/json |
version |
1.0 |
2.2 Request Data
Name |
Description |
Type |
Required |
appId |
Unique identifier assigned to a third-party application platform |
string |
true |
merchantId |
Unique identifier assigned to a thired-party merchant |
string |
true |
timestamp |
Request timestamp |
timestamp |
true |
sign |
Data signature |
string |
true |
orderNo |
Order number |
string |
true |
2.3 Response Data
Name |
Description |
Type |
success |
Success flag: true/false |
boolean |
message |
Response message |
string |
code |
Reponse code |
string |
timestamp |
Response timestamp |
long |
data |
Result |
object |
> appId |
Unique identifier assigned to a third-party application platform |
string |
> sign |
Data signature |
string |
> tranAbbr |
Transaction Type |
string |
> tranNo |
Transaction Number |
string |
> transStatus |
Transaction status: 1.success; 0.failure; 2.in processing |
int |
> transInfo |
The reason for failure |
string |
> payMethod |
Payment method: 1.NewPay; 4.MasterCard; |
int |
> extra |
Third party order supplementary fields |
string |
> orderNo |
Order number |
string |
> newpayOrderNo |
NewPay order number |
string |
> currency |
Payment currency, LAK/USD |
string |
> orderAmt |
Payment amount |
string |
> subject |
Commodity title |
string |
> settlementStatus |
Settlement status: 1-No settlement; 2-have already settled |
int |
3. Example Data
3.1 Request
{
"appId": "3514d69403bc4ce1a8fafb6415a31018",
"timestamp": {{current_timestamp}},
"sign": "{{sign}}",
"merchantId": "876266cdc7154dd08a022fd1f2eace55",
"orderNo": "ORDERNO000000000A104"
}
3.2 Response
{
"success": true,
"message": "success",
"data": {
"appId": "3514d69403bc4ce1a8fafb6415a31018",
"sign": "OUUz/cvUfo4m3IcndGByEKjT/pUOSyf0qhMV+lbKdilMxZgErjmTrB6xYmvMvhJpQFcRbGJFsn9B1WxNi330K1gY5ANXD2ttEIqV0IROm3M/o43rMu1tjVLk5ZBMP2D2l28zsYh9tyX8Zd8CzIxw10YT8Hkgvbh3bTP/vsRv1xov/YzOhpWsvSgDIJb6eKg02BePfR8N6wLkE9FV+91JDxFvFIMCc6qR7GXEFCnrilTeas95SGcSADS2KBFSXHdP6IOjnQbQEgVoAzyLhq4pjh6DrNupduknOKagB9CEKB1yEnb/zs+/WRFfP3VgBj0MIUideXEAvVJzp4CoZ5q7cA==",
"tranAbbr": "FP1003",
"tranNo": "00012022090700000033",
"transStatus": 0,
"transInfo": "Transaction Success",
"payMethod": 1,
"extra": "",
"orderNo": "ORDERNO000000000A104",
"newpayOrderNo": "202209076000000321",
"currency": "LAK",
"orderAmt": "50000",
"subject": "name002",
"settlementStatus": 1
},
"code": "0",
"timestamp": "1662528566437"
}
4. Response Code
Code |
Description |
0 |
success |
E9008 |
order information is not existed |
E9999 |
unknow error |
B11095 |
Illegal request |
Z00046 |
whitelist authentication failed |
Z00003 |
appid field wrong |
Z00044 |
merchantId field wrong |
Z00007 |
sign field verification failed |
Z00001 |
appid field illegal |
Z00004 |
timestamp field illegal |
Z00005 |
sign field illegal |
Z00021 |
merchantId field illegal |
Z00023 |
orderNo field illegal |
Z01012 |
appId or merchantId is not valid |