Pay

Overview

This endpoint is used to process a payment using the available balance on a customer's prepaid (loyalty/gift) card.

Environments

Environment	Protocol	HTTP Method	URL
Sandbox	HTTPS	POST	https://uat.paywizard.biz/ovstrade/openLoyaltyPay/giftTransaction
Production	HTTPS	POST	https://portal.paywizard.biz/ovstrade/openLoyaltyPay/giftTransaction

Headers

Key	Type	Required	Description
Content-Type	String	Yes	Must be application/json.
jwt-token	String	Yes	The transaction token obtained using your developer credentials.
sign	String	Yes	The request signature. See Signature Generation Guide.

Request Body Parameters

Parameter	Type	Required	Description
clientId	String	Yes	Your unique developer ID.
tranOrderNo	String	Yes	The unique order ID for this payment transaction, generated by your system.
loyaltyChannel	String	Yes	The prepaid channel provider. See Prepaid Channels for valid values.
amount	String	Yes	The total transaction amount. Example: "10.50".
tranCurrency	String	Yes	The 3-letter ISO currency code for the transaction. Example: "USD".
accountId	String	Yes	The unique identifier for the prepaid card.
entryType	String	Yes	The method used to input the accountId. See Entry Type Codes below.
nsfAllowed	Boolean	No	Non-Sufficient Funds Allowed. Set to true to permit the transaction to proceed even if the card balance is insufficient to cover the full amount.

Entry Type Codes

Code	Description
B	Barcode
K	Keyed (manually entered)
M	Magnetic Stripe
P	Proximity (NFC/Contactless)

Request Example

{
    "clientId": "825429536610058240",
    "tranOrderNo": "20250401123534801",
    "loyaltyChannel": "FACTOR4",
    "amount": "10.50",
    "tranCurrency": "USD",
    "accountId": "914639258868515",
    "entryType": "K"
}

---

Response Body

The response object contains the status of the payment transaction request.

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. Format: YYYY-MM-DD HH:mm:ss.
data	Object	A container for the successful response data. Null on error.
data.mid	String	The merchant ID.
data.paywizardId	String	The unique platform ID for the transaction.
data.checkoutId	String	The unique transaction ID generated by the payment platform.
data.transIndexCode	String	A unique transaction reference code.
data.amount	String	The transaction amount.
data.result	Integer	An integer code representing the status of the transaction. See Transaction Status Codes below.

Transaction Status Codes

The result field indicates the immediate outcome of the payment request.

Result Code	Description
0	Success
1	Failure
2	Pending / In Progress

Success Response Example

{
    "code": 200,
    "msg": "success",
    "timestamp": "2025-07-24 13:06:10",
    "data": {
        "mid": "202507081058",
        "paywizardId": "10020000080",
        "checkoutId": "933392815902294016",
        "transIndexCode": "100200000807293844967",
        "amount": "10000",
        "result": 0
    }
}