The following scenarios are examples of the use cases we'll run through during your live test session. This is not an exhaustive list, as our certification process will also include negative tests to validate the error handling of your API integration.
Our technical team will monitor your API responses closely to ensure that all parameters are correctly returned and populated for downstream reporting and reconciliation purposes.
- When you call the
Get Categories API
- Then you should be able to validate that all returned categories include the following parameters: categoryId, name, and description.
- When you call the
Get Category by Id API
- Then the response should return an HTTP status of 200 Success and validate the parameters for the requested category.
| Parameter | Value |
|---|
| http status code | 200 success |
| categoryId | Unique identifier of the Category |
| name | Name of the Category |
| description | Description of the Category |
- When you call the
Get Programs API
- Then you should be able to validate that the response returns all programs you are eligible for, including the programId, name, descriptions, and designs.
- When you call the
Get Programs by Id API
- Then the response should return an HTTP status of 200 Success and validate the parameters for the specific program requested.
| Parameter | Value |
|---|
| http status code | 200 success |
| programId | Unique Identifier of the Program |
| name | Name of the Program |
| descriptions | Range of descriptions available for the Program |
| designs | Hero design assets for the Program |
- When you call the
Get Products API
- Then you should be able to validate that the response returns a list of all products you are eligible for, including productId, programId, name, designs, validityInYears, termsAndConditions, redemptionInfo, and denomination.
- When you call the
Get Products by Id API
- Then the response should return an HTTP status of 200 Success and validate the parameters for the specific product requested.
| Parameter | Value |
|---|
| http status code | 200 success |
| productId | Unique Identifier of the Product |
| descriptions | Range of descriptions available for the Product |
| programId | Program Identifier the Product belongs to |
| name | Name of the Product |
| designs | Range of design assets available for the Product |
| validityInYears | The number of years the Product is redeemable for where expiry applies |
| termsAndConditions | Terms and conditions associated with the ProductorderId |
| redemptionInfo | Redemption information for the Product, |
| denomination | Denomination information for the Product, e.g. type of denomination and range |
- When you successfully call the
Submit Order API
- Then the response should return an HTTP status of 200 Success and contain the following parameters:
| Parameter | Value |
|---|
| http status code | 200 success |
| orderId | System-generated order identifier |
| giftId | System-generated gift card identifier |
| cardNumber | Activated gift card number |
| pin | Relevant gift card pin |
| activatedBalance | Dollar amount loaded onto the gift card |
| activationDateTime | Timestamp of the gift card activation |
Note: pin is only provided if you do not use our Fulfillment Service
- Given you have a successfully placed order
- When you invoke the
Get Order Summary API
- Then you should be able to validate the following parameters in the response:
| Parameter | Value |
|---|
| http status code | 200 success |
| orderId | System-generated order identifier |
| giftId | System-generated gift card identifier |
| activatedBalance | Dollar amount loaded onto the gift card |
| activationDateTime | Timestamp of the gift card activation |
- Given you have a successfully placed order
- When you invoke the
Get Order Status API
- Then you should be able to validate the following parameters in the response:
| Parameter | Value |
|---|
| http status code | 200 success |
| orderId | System-generated order identifier |
| giftId | System-generated gift card identifier |
| giftCardStatus | ACTIVATED |
| deliveryStatus | COMPLETED |
- Given you have a successfully placed order
- When you invoke the Update
Order Fulfillment Info API
- Then you should be able to validate the following parameters in the response:
| Parameter | Value |
|---|
| http status code | 200 success |
| orderId | System-generated order identifier |
| giftId | System-generated gift card identifier |
| email | Email address the gift card will be delivered to |
| mobile | Mobile number the gift card will be delivered to |
| firstName | First name of the gift card recipient |
- Given you have a successfully placed order
- When you invoke the
Update Gift Status API
- Then you should be able to validate the following parameters in the response:
| Parameter | Value |
|---|
| http status code | 200 success |
| orderId | System-generated order identifier |
| giftId | System-generated gift card identifier |
| giftCardStatus | Status of the gift card, i.e. ACTIVATED CANCELLED BLOCKED EXPIRED or ACTIVATION PENDING
Note: you can only manually update the status to BLOCKED or CANCELLED as part of the request |
