API: Get Transaction Result

Cashier System Obtaining Order Transaction Results

Description

Used for third-party cashier systems to obtain order transaction results.

Enviroment:

POST https://uat.paywizard.biz/ovstrade/semiOpen/v3/getCashierAgentResult

Production Enviroment:

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

HTTP Header Information

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

Transaction Request Parameters

Name	Description	Required	Type	Remark
clientId	Developer ID		String
merchantId	Acquiring Merchant ID		String
tradeNo	Transaction Order Number		String	External third-party system order number

Request Example

{
    "clientId": "client12345",
    "merchantId": "10800000003",
    "tradeNo": "202404231080000000789"
}

Return Parameters

Name	Description	Mandatory	Type	Example Value	Remark
code	Return Code		Int	200	Return code (200 indicates normal transaction; non-200 indicates an exception)
msg	Return Message		String	success	Return prompt message
timestamp	Return Information		String	2024-07-23 17:57:00	Timestamp (UTC)
data	Return Information		Object		Return content
checkoutId	Transaction Number		String
transIndexCode	External Third-Party System Order Number		String
paywizardId	PayWizard Number		String
mid	Acquiring Merchant Number		String
amount	Transaction Amount		String
state	Transaction Status		Integer		Transaction status 1: Pending Transaction 2: Transaction Completed 3: Void 4: Refund 5: Order Closed 6: Partial Refund 7: Pre-Authorization Completed 8: Pre-Authorization Void 9: Partial Resersal
currencyCode	Currency Code		String	840
transType	Transaction Type		String
tranTime	Transaction Time		LocalDateTime		yyyy-MM-dd HH:mm:ss
cardNo	Masked Card Number		String
cardToken	Card Token		String
transResult	Terminal Transaction Result		Integer		Terminal transaction result 0: Success 1: Failure 2: In Progress
transId	Terminal Acquiring Channel Transaction Serial Number		String		Returned when terminal transaction result is successful
invoiceNum	Terminal Transaction Invoice Number		String		Returned when terminal transaction result is successful
traceNum	Terminal Transaction Number		String		Returned when terminal transaction result is successful
rrn	Terminal Transaction Reference Number		String		Returned when terminal transaction result is successful
respCode	Terminal Transaction Response Code		String		Returned when terminal transaction is completed
respDesc	Terminal Transaction Response Description		String		Returned when terminal transaction is completed

Return Example

{
    "code": 200,
    "msg": "success",
    "data": {
        "transResult": 0,
        "mid": "10800000003",
        "paywizardId": "10000000011",
        "transIndexCode": "202404231080000000789",
        "transId": "250423162541",
        "invoiceNum": "250423162541",
        "checkoutId": "900103342380941312",
        "cardNo": "622908********3688",
        "respCode": "001",
        "respDesc": "Approved",
        "transType": "AuthCompletion",
        "tranTime": "2025-04-23 16:25:41",
        "amount": "1000",
        "state": 2,
        "currencyCode": "840"
    },
    "timestamp": "2024-08-12 15:47:59"
}