Individual Gift Card

As a Gifting Partner offering the sale of digital and/or physical gift cards, we offer balance checks on individual gift cards via our Gift Card Balance API.

This API is available to you as a Partner and can be made accessible to your customers via your platform to retrieve the real time balance on a gift card they have purchased.

You can invoke the Get Balance API by passing in the the individual card number and pin.

📘
Note
This API has a rate limit of 50 requests per minute. Talk to your Account Manager if you are interested in customising this limit to suit your system requirements.

curl --location --request POST 'https://pt-api.wpay.com.au/v1/partner/giftcards/balance' \
--header 'content-type: application/json' \
--header 'X-Api-Key: *************************' \
--data-raw '{
    "pin": "****",
    "cardNumber": "***********************"
}'

Where:

cardNumber is the gift card number
pin is the gift card PIN

A successful response will have the HTTP status code of 200 and gift card balance details.

{
  "cardNumber": "6280006516407352328",
  "balance": "5.00",
  "expiry": "2023-05-05T05:43:07+00:00",
  "status": "ACTIVATED",
  "currency": {
    "code": "AUD",
    "numericCode": "036",
    "symbol": "$",
    "countryName": "AUSTRALIA",
    "currencyName": "Australian Dollar"
  },
  "additionalTxnFields": {
    "extendedParameters": null,
    "responseCode": "0"
  }
}

Where:

balance is the remaining balance available for use on the gift card
expiry is the date on which the card is scheduled to expire
currency contains information about the gift card currency

Refer to the Get Gift Card Balance API specification for descriptions of all fields in the request and response.

📘Note

📘
Note