ServicesGatewayViiGift Card

Gift Card redemption with vii

placeholder description

Redeem Gift Cards with Vii and add them to your payment flow.

Prerequisites

Requirements are as follows:

  1. Obtain the following Vii data:
  • A Vii username
  • A Vii password
  • A Vii URL
  • A Store Id
  • A Store Group Id
  • An AIIC (Acquiring institution identification code)
  • A CATI (Card acceptor terminal identification)
  • A CAIC Card acceptor identification code
  1. Ensure that you have your Paydock access token. To generate the token, check the following guide().

Setup the service

and generate your Gateway ID

  1. Navigate to your Paydock Dashboard.
  2. Select ‘Services’ on the left navigation panel.
  3. Click on the ‘Add New’ tab.
  4. Go to the ‘Service Group’ dropdown list and select ‘Gateway Services’.
  5. Complete all of the required fields: ▪ Username ▪ Password ▪ URL API ▪ Store Id ▪ Store Group Id
  6. Select the environment.
  7. Click connect.
  8. Ensure the Vii service is defined on the Paydock dashboard.
  9. Select ‘Services’ on the left navigation panel.
  10. Click on ‘Connected Services’ tab.
  11. Go to ‘Service Group’ drop down list and select ‘Gateway Services’.
  12. Note the ‘Gateway ID’ as this is a requirement for API calls.

Integrate your flows

Before you integrate any of these flows, ensure that you have your Vii data, Paydock access token and Gateway ID. Instructions to generate these are contained earlier in this section.

The following Integration flows are compatible with this service.

  • Check Balance: Check the existing balance on your Gift Card.
  • Gift Card Redemption: Redeem value from the Gift Card.
  • Gift Card Cancellation: Cancel the Gift Card.
  • Gift Card Refund: Refund the Gift Card.