Partner Account

As a Gifting Partner, you would have been set up with an SVA as part of your Account Settings.

Each time a digital gift card is ordered or a physical gift card is activated, your SVA balance will be deducted and your outstanding balance will be updated to reflect the same.

You can use the SVA Balance API to check the balance on your account at any time.

📘
Note
Talk to your Account Manager if you are interested in this feature

curl --location --request GET 'https://pt-api.wpay.com.au/v1/partner/giftcards/sva/balance' \
--header 'content-type: application/json' \
--header 'X-Api-Key: ****************************'

Where:

X-Api-Key is your Partner integration key.

A successful response will have the HTTP status code of 200 and contains a list of fields associated with your SVA.

{
  "balance": "95368.25",
  "expiry": null,
  "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
currency contains information about your account currency

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

📘Note

📘
Note