Terminal API: Subscribe Transaction Results

Through this API interface, you will be able to let the payment terminal to send transaction result to the Paywizard platform.

This API is for payment terminal use. Not for Point of Sale system.

Most intergration process will not use this API.

Subscribe Transaction Results

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

Headers

Name	Value
Content-Type	application/json
jwt-token	The token responesed from Get Access Token

Request Body

Name	Type	Mandatory	Description
clientId	string		Developer ID
merchantId	String		Merchant ID
terminalId	String		Terminal ID
tradeNo	String		hird-party POS systems order numbers, must be unique under the same ISO/ISV.
transType	String		See support transaction type
transScheme	String		{Credit,Debit,EBT,ECS}
CallerName	String		Merchant Name
transIndexCode	String		Paywizard trans id
transResult	boolean		{true,false} true: Transaction approved false: Transaction denied
respCode	String		Payment host response code.
respDesc	String		Payment host response message.
cardNum	String		Card Number
entryMode	Integer		Card entry mode: 0x01: Manual entry card number 0x02: Magnetic stripe 0x05: Contact 0x07: Contactless
expiryDate	String		Card expiration date.
cardBrand	String
transAmount	Long		Mandatory if it is a financial transaction. The number of decimal places is determined by the CurrencyCode.
otherAmount	Long		Cashback amount
tipAmount	Long		Tip amount
balance	Long		Balance
currencyCode	String
dccOriCurrencyCode	String		Original currency code in DCC transaction.
dccOriAmount	Long		Original amount in DCC transaction.
dccFee	Long		DCC transaction commission.
dccExchangeRate	String		DCC transaction exchange rate
dccMarkUp	String		DCC transaction fee rate
dccFooterText	String		DCC trans content on the receipt.
transDate	String		YYYYMMDD
transTime	String		hhmmss
countryCode	String
posId	String		Point of Sale system ID
merchantName	String
merchantAddress	String
transID	String
invoiceNum	String
rrn	String		Reference Number
authCode	String		Auth Code
oriTransIndexCode	String
oriInvoiceNum	String
oriTransId	String
oriRrn	String
emvAid	String
emvAppName	String
emvCryptogram	String
emvTVR	String

Request Sample

{
    "merchantId": "10800000003",
    "tradeNo": "2024081210800000003001",
    "transType": "Purchase",
    "transScheme": "Credit",
    "callerName": "caller001",
    "transIndexCode": "202408120001",
    "transResult": true,
    "respCode": "001",
    "respDesc": "",
    "cardNum": "77339***21234",
    "entryMode": 1,
    "expiryDate": "0608",
    "cardBrand": "001",
    "transAmount": 10000,
    "otherAmount": 0,
    "tipAmount": 0,
    "balance": 100000,
    "currencyCode": "156",
    "dccOriCurrencyCode": "156",
    "dccOriAmount": 10000,
    "dccFee": 10,
    "dccExchangeRate": "0.1",
    "dccMarkUp": "0.1",
    "dccFooterText": "",
    "transDate": "20240812",
    "transTime": "154400",
    "CountryCode": "001",
    "merchantId": "10800000003",
    "tId": "T123456789",
    "merchantName": "TEST",
    "merchantAddress": "TEST",
    "transID": "202408121545001",
    "invoiceNum": "001",
    "rrn": ""
}

Response Body

Name	Type	Mandatory	Description
code	int		Response Code (200 Success, Non-200 Failed)
msg	String		Response Message
timestamp	String		Date/Time(UTC)

Response Sample

200

{
    "code": 200,
    "msg": "200",
    "timestamp": "2024-08-12 14:45:54"
}