Query

Overview

This endpoint is used to query the current balance and associated customer information for a specific prepaid (loyalty/gift) card.

Environments

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

---

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.
loyaltyChannel	String	Yes	The prepaid channel provider. See Prepaid Channels for valid values.
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.

Entry Type Codes

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

Request Example

{
    "clientId": "825429536610058240",
    "loyaltyChannel": "FACTOR4",
    "accountId": "914639258868515",
    "entryType": "K"
}

---

Response Body

The response returns the card's current balance information and any associated customer data.

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.accountId	String	The unique identifier for the prepaid card.
data.balances	Array	An array of Balances Object detailing the card's value.
data.customerInfo	Object	The CustomerInfo Object associated with the card.

CustomerInfo Object

Parameter	Type	Description
customerType	String	1: Primary account holder, 2: Alternate, 3: Giver of card.
firstName	String	Customer's first name.
middleName	String	Customer's middle name.
lastName	String	Customer's last name.
address1	String	Primary address line.
address2	String	Secondary address line.
city	String	City name.
state	String	State or province.
postal	String	Postal code.
country	String	2-character ISO 3166-1 country code.
mailPref	String	Mail preference. O: Opt-out, I: Opt-in.
phone	String	Phone number in the format +CCC AAA LLL LLL xEEEE.
isMobile	String	Y: Yes, N: No.
phonePref	String	Phone contact preference. O: Opt-out, I: Opt-in.
email	String	Customer's email address.
emailPref	String	Email contact preference. O: Opt-out, I: Opt-in.
birthday	String	Customer's birthday in YYYYMMDD format.
anniversary	String	Customer's anniversary in YYYYMMDD format.
gender	String	M: Male, F: Female.

Balances Object

This object represents a single type of value held on the card, such as currency or points.

Parameter	Type	Description
valueCode	String	The currency code (e.g., "USD") or "Points".
amount	Decimal	The total amount of the specified valueCode.
difference	Decimal	The difference in amount from the previous transaction.

Success Response Example

{
    "code": 200,
    "msg": "success",
    "timestamp": "2025-07-24 13:16:29",
    "data": {
        "accountId": "914639258868515",
        "balances": [
            {
                "valueCode": "USD",
                "amount": 1534.10,
                "difference": 0
            },
            {
                "valueCode": "Points",
                "amount": 53.00,
                "difference": 0
            }
        ],
        "customerInfo": {
            "customerType": "1",
            "firstName": "Jon1",
            "middleName": "Mid2",
            "lastName": "Doe3",
            "address1": "295R+VM Settat, Morocco",
            "address2": "Settat,Morocco",
            "city": "Morocco",
            "state": "Settat",
            "postal": "",
            "country": "US",
            "mailPref": "O",
            "phone": "[phone]",
            "isMobile": "N",
            "phonePref": "O",
            "email": "[e-mail]",
            "emailPref": "O",
            "birthday": "20000101",
            "anniversary": "",
            "gender": ""
        }
    }
}