API 5: POS System Query Transaction Results

Through this API interface, you will be able to query or poll the result of payment terminal transaction.

If a callback URL was provided when initiating the transaction, there is no need to use this query interface. The system will automatically send the transaction result to the specified URL. This API can serve as a compensation mechanism.

Please Refer To : Transaction Result Callback Interface

Query Transaction Result

Test Enviroment:

POST https://oversea.paywizard.biz/ovstrade/semiOpen/getCashierAgentResult

Production Enviroment:

POST https://portal.paywizard.biz/ovstrade/semiOpen/getCashierAgentResult

Headers

Name
Value

Content-Type

application/json

jwt-token

The token responesed from Get Access Token

Request Body

Name
Type
Mandatory
Description

clientId

string

merchantId

String

tradeNo

String

transType

String

Request Sample

{
    "clientId": "client12345",
    "merchantId": "10800000003",
    "tradeNo": "2024081210800000003001",
    "transType": "Purchase"
}

Response Body

Name
Type
Mandatory
Description

code

int

Response Code

(200 Success,

Non-200 Failed)

msg

String

Response Message

timestamp

String

Date/Time(UTC)

data

Object

-transResult

Integer

Transaction result:

  • 0: Success

  • 1: Failed

  • 2: In Progress

-transIndexCode

String

System Trans Index

-transId

String

Payment Transaction ID

-invoiceNum

String

Payment Invoice Number

-rrn

String

Payment Reference Number

Response Sample

{
    "code": 200,
    "msg": "success",
    "data": {
        "transResult": 0,
        "transIndexCode": "848981718949036032",
        "transId": "1733208430104",
        "invoiceNum": "120324144634",
        "rrn": ""
    },
    "timestamp": "2024-08-12 15:47:59"
}

Last updated