Query a transaction

Query up to 100 orders in a single request.
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.

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='

{ "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

Merchant Code or Merchant ID or Merchant Number

<= 7 characters

Example:

account_id

string

required

Subaccount ID or Gateway Number

<= 10 characters

Example:

orders

string

optional

Merchat Order Number
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

Transaction ID
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

Digital signature information:
encryption_data=sha256(merchant_id + account_id + sign_key);

All encryption parameters need to remove spaces before encryption.

<= 64 characters

Responses

🟢200Success

application/json

Body

account_id

string

required

return_status

string

required

return_message

string

required

orders_list

array [object {9}]

required

amount

string

optional

currency

string

optional

order_no

string

optional

payment_status

string

optional

query_result

string

optional

reference_no

string

optional

transaction_date

string

optional

transaction_id

string

optional

website

string

optional

merchant_id

string

required

antifraud_provider

string

required

<= 10 characters

fraud_check_result

array [object {2}]

required

check_items

string

required

<= 50 characters

status

string

required

<= 10 characters

is3ds

string

required

<= 1 characters