Query a transaction
POST
/v1/retrievalTrans
Merchant may use this interface to synchronise order status on merchant’s internal systems to our gateway system.
Please note, due to security concern, merchant needs to provide the IP addresses to our gateway system for registration before using this interface.
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://test.your-api-server.com/v1/retrievalTrans' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--data-urlencode 'merchant_id={{merchant_id}}' \
--data-urlencode 'account_id={{account_id}}' \
--data-urlencode 'encryption_data='Response Response Example
{
"account_id": "701001021",
"return_status": "1",
"return_message": "OK",
"orders_list": [
{
"amount": "10.36",
"currency": "USD",
"order_no": "1726542011891",
"payment_status": "3000",
"query_result": "1",
"reference_no": "Ca655969070295",
"transaction_date": "20240917065443",
"transaction_id": "Ca655969070295",
"website": "website.com"
}
],
"antifraud_provider": "Forter",
"fraud_check_result": [
{
"check_items": "Approved By Forter",
"status": "ACCEPT"
},
{
"check_items": "PaymentToken is incorreet".
"status": "REJECT"
}
],
"is3ds": "0",
"merchant_id": "701001"
}Request
Header Params
Content-Type
string
required
Example:
application/x-www-form-urlencoded
Body Params application/x-www-form-urlencoded
merchant_id
string
required
<= 7 characters
Example:
{{merchant_id}}
account_id
string
required
<= 10 characters
Example:
{{account_id}}
orders
string
optional
Order number defined by merchant
Up to 100 orders can be queried in a single request, divided by “,”
At least one of the three parameters is not empty
<= 1000 characters
Example:
1726890189565
trades
string
optional
Up to 100 transactions can be queried in a single request, divided by “,”
At least one of the three parameters is not empty
<= 1000 characters
encryption_data
string
required
encryption_data=sha256(merchant_id + account_id + sign_key);
<= 64 characters