NEXPAY
  1. Acquiring
NEXPAY
  • Guides
    • Welcome
    • Interface
  • API Reference
    • Introduction
    • Endpoints
    • Data Types
    • Signing
    • Errors
    • Webhooks
    • Items Information
    • Changelog
    • Acquiring
      • Create a direct payment
        POST
      • Create a redirect (iFrame) payment
        POST
      • Query a transaction
        POST
      • Optimise payment methods
        POST
      • Search a refund transaction
        POST
      • Refund a transaction
        POST
      • Review a transaction
        POST
      • Cancel a transaction
        POST
      • Cancel a subscription
        POST
      • Capture a transaction
        POST
      • Create a payout
        POST
  • Appendix
    • Test Cards
    • Bank Code
    • Country Code
    • Currency Code
    • Payment Methods
  • Schemas
    • Sample Schemas
      • Review
      • Chargeback
      • Payment
      • Refund
  1. Acquiring

Query a transaction

POST
/v1/retrievalTrans
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.

Request

Header Params

Body Params application/x-www-form-urlencoded

Request Code Samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST '/v1/retrievalTrans' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--data-urlencode 'merchant_id={{merchant_id}}' \
--data-urlencode 'account_id={{account_id}}' \
--data-urlencode 'orders=1726890189565' \
--data-urlencode 'trades=' \
--data-urlencode 'encryption_data='

Responses

🟢200Success
application/json
Body

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"
        }
    ],
    "merchant_id": "701001"
}
Modified at 2025-02-12 07:34:36
Previous
Create a redirect (iFrame) payment
Next
Optimise payment methods