Test Scenarios

The following scenarios are meant to serve as an example of the use cases we will run through as part of the Live Test session. This is not an exhaustive list as the certification process will also involve negative tests that will validate the Error handling of your API integration.

Our technical team will ensure that your account has been correctly configured as a partner while paying close attention to the fields that you get back in your API responses since these parameters will get populated in downstream reports for reconciliation purposes.

Test Scenario : Order a Digital Gift Card

📘

This test only applies if you are selling digital gift cards on your platform.

  • Given you have a valid sku and program details set up in UAT
  • When you invoke the Order Digital Gift Cardi API
  • Then you should be able to validate the following parameters in the response
ParameterValue
http status code 201 created
statusCOMPLETE
orderIdSystem generated order identifier
cardNumberActivated gift card number
cardPinRelevant gift card pin

Test Scenario : Activate a Physical Gift Card

📘

This test only applies if you are selling physical gift cards on your platform.

  • Given you you have a valid sku and card number for a physical gift card in UAT
  • When you invoke Activate Physical Gift Card API,
  • Then you should be able to validate in Response :
ParameterValue
http status code 201 OK
statusCOMPLETE
orderIdSystem generated order identifier

Test Scenario : Order Digital Gift Cards in Bulk

📘

These tests only apply if your platform requires you to order of more than 10 digital gift cards at a time

Step-1 : Place order

  • Given you have been setup for batch orders with valid sku and program details in UAT
  • When you invoke the Order Digital Gift Cards API for more than 10 cards
  • Then you should be able to validate the following parameters in the response
ParameterValue
http status code 202 OK
statusPROCESSING
orderIdSystem generated order identifier

Step-2 : Check order status periodically

  • Given you have already placed a bulk order for more than 10 gift cards [Step-1]
  • When you invoke Get Order Status API and the order is still not completed
  • Then you should be able to validate in Response :
ParameterValue
http status code 200 OK
statusPROCESSING

Step-3 : Confirm order has been processed

  • Given your bulk order is in PROCESSING state
  • When you invoke Get Order Status API and the order is completed
  • Then you should be able to validate in Response :
ParameterValue
http status code 200 OK
statusCOMPLETE

Step 3 : Retrieve gift cards

  • Given your order for bulk cards has been processed successfully
  • When you invoke Get Activated Cards API with orderId
  • Then you should be able to validate in Response :
ParameterValue
http status code 200 OK
cardNumberActivated gift card number for each gift card created
cardPinGift card pin for each gift card created
amountBalance on each gift card created