API: Get Merchant Transaction

API that gets a merchant's transaction list

Overview

This endpoint retrieves a paginated list of transaction logs. You can filter the results using various parameters such as a date range, merchant ID, or transaction type.

Test Enviroment:

POST https://uat.paywizard.biz/ovstrade/open/queryTranLogList

Production Enviroment:

POST https://portal.paywizard.biz/ovstrade/open/queryTranLogList

HTTP Header Information

Name	Value
Content-Type	application/json
jwt-token	Merchant Token provided by Paywizard
sign	PayWizard Open Platform API Signature Guide V3

Request Body Parameters

Parameter	Type	Required	Description
clientId	String	Yes	Your unique developer ID.
mid	String	No	The merchant ID to filter results.
transactionId	String	No	The specific transaction log ID to retrieve.
transType	String	No	The transaction type to filter by (e.g., "Purchase").
startTime	String	No	The start of the date range for the query. Format: YYYY-MM-DD HH:mm:ss.
endTime	String	No	The end of the date range for the query. Format: YYYY-MM-DD HH:mm:ss.
pageNo	Integer	No	The page number to retrieve.
pageSize	Integer	No	The number of records to return per page. Defaults to 100.

Request Example

{
    "clientId": "825429536610058240",
    "mid": "10800000003",
    "transactionId": "894650047914967040",
    "transType": "Purchase",
    "startTime": "2025-04-08 00:00:00",
    "endTime": "2025-04-08 23:59:29",
    "pageNo": 1,
    "pageSize": 100
}

---

Response Body

The response is a JSON object containing the list of transaction records and pagination details.

Parameter	Type	Description
code	Integer	The HTTP status code. 200 indicates a successful request.
msg	String	A human-readable message. success on successful requests.
timestamp	String	The UTC timestamp of the response.
data	Object	A container for the successful response data.
data.records	Array	An array of Transaction Record Objects.
data.total	Integer	See Pagination Metadata.
data.pages	Integer	See Pagination Metadata.
data.size	Integer	See Pagination Metadata.
data.current	Integer	See Pagination Metadata.

Transaction Record Object

This object represents a single transaction log within the records array.

Parameter	Type	Description
transactionId	String	The unique ID for the transaction log entry.
mid	String	The merchant ID associated with the transaction.
amount	Long	The transaction amount represented as an integer in 1/10000th units of the currency. See note below.
currencyCode	String	The numeric ISO 4217 currency code.
tranTime	String	The timestamp of the transaction.
tranType	String	The type of transaction (e.g., "Purchase").
checkoutId	String	The unique transaction ID generated by the payment platform.
thirdOrderId	String	The unique order ID generated by the third-party (your) system.

Note on amount format: The amount is provided in ten-thousandths of the major currency unit. For example, for a currency like the US Dollar, a value of 1436200 represents $143.62.

Pagination Metadata

These fields provide information about the paginated result set.

Parameter	Type	Description
total	String	The total number of records matching the query.
pages	String	The total number of pages available.
size	String	The number of records per page.
current	String	The current page number.

Success Response Example

{
    "code": 200,
    "msg": "success",
    "timestamp": "2025-04-08 16:07:36",
    "data": {
        "records": [
            {
                "transactionId": "894650047914967040",
                "mid": "10800000003",
                "amount": 1436200,
                "currencyCode": "973",
                "tranTime": "2025-04-08 07:16:10",
                "tranType": "Purchase",
                "checkoutId": "894649806197227520",
                "thirdOrderId": "1744096512092"
            }
        ],
        "total": 1,
        "size": 100,
        "current": 1,
        "pages": 1
    }
}