Transaction Inquiry API

Endpoint
POST {BASE_URL}/api/v2.0/payments/transactions

Query all transaction records of a specified date, this includes payments and refunds(not including settlement) from all payment channels (including the Non-gateway transaction).

Note: One payment or refund order may correspond to multiple transaction records.

Request Body
datestringREQUIRED

Date to be queried, e.g.：20230516
The value must comply with the regular expression: ((19|20)\d{2}(0[1-9]|1[0-2])(0[1-9]|[12]\d|3[01]))

pageintegerREQUIRED

Page number >= 1

pageLimitintegerREQUIRED

Specify the number of records per page >= 10且<= 100

transactionTypestringREQUIRED

Transaction type：All, Credit(payment), Debit(refund) Allowed values: All Credit Debit

Transaction Inquiry Request Body
{
    "date": "string",
    "page": 1,
    "pageLimit": 10,
    "transactionType": "All"
}
Response (200 OK)
transactionsarray [object]

Transaction details

Hide child parameters
transactions.requestIdstring

Merchant order ID

transactions.transactionIdstring

AlphaPay transaction ID

transactions.amountstring

The total amount of the transaction

transactions.currencystring

Currency code, allowed values: CAD/USD CNY

transactions.transactionTypestring

Transaction types：Credit(payment), Debit(refund) Allowed values: Credit Debit

transactions.settleAmountstring

The amount of the transaction that will be settled

transactions.settleCurrencystring

Currency of the settlement, the current currency of the platform.

transactions.exchangeRatestring

Transaction exchange rate

transactions.paymentMethodstring

Payment methods，allowed values: Alipay Wechat UnionPay

transactions.createTimestring <date-time>

Transaction creation time
Follow the ISO8601 standard, e.g. 2019-05-28T12:12:12+08:00

transactions.transactionTimestring <date-time>

Transaction completion time
Follow the ISO8601 standard, e.g. 2019-05-28T12:12:12+08:00

paginationobject

Pagination Information

Hide child parameters
pagination.pageinteger

Current page number

pagination.pageLimitinteger

Specify the number of records per page

pagination.totalPageinteger

Total pages

pagination.totalinteger

Totals number of transaction records

resultobject

Process result

Hide child parameters
result.resultCodestring

Process result code, please refer to resultCode

result.resultMessagestring

Process result message

result.resultStatusstring

The status of an API call, please refer to resultStatus

  • S: API call succeeded.
  • F: API call failed, the resultMessage field will provide a detailed description of the error, which could be caused by either the merchant or the platform, when an error occurs during API invocation.
  • U: In cases where the handling result is unknown or in an intermediate state. Such as receiving a PAYMENT_IN_PROCESS status after submitting a payment order, the query interface can be used to confirm the status of the payment result.
Transaction Inquiry Response
{
    "transactions": [
        {
            "requestId": "string",
            "transactionId": "string",
            "amount": "string",
            "currency": "CAD",
            "transactionType": "Credit",
            "settleAmount": "string",
            "settleCurrency": "CAD",
            "exchangeRate": "string",
            "paymentMethod": "Alipay",
            "createTime": "2019-08-24T14:15:22Z",
            "transactionTime": "2019-08-24T14:15:22Z"
        }
    ],
    "pagination": {
        "page": 0,
        "pageLimit": 0,
        "totalPage": 0,
        "total": 0
    },
    "result": {
        "resultCode": "string",
        "resultMessage": "string",
        "resultStatus": "S"
    }
}