Operations
activate
Request a gift card activation.
POST /giftcard/v3/activations/{activationId}
The Activations endpoint allows a gift card to be activated. Optionally, an amount can be included to indicate initial funds which should be credited to the card. An activation is not considered complete until an activation confirmation or activation reversal has been sent and acknowledged. An activation request should only be sent once.
Security
- httpBasic
Request
Content-Type: application/json
Parameters
| Name | Located in | Required | Description | Default | Schema |
|---|---|---|---|---|---|
| activationId | path | yes | The randomly generated UUID identifying this activation, as defined for a variant 4 UUID in RFC 4122. | string | |
| body | body | yes | The activation information. | ActivationRequest |
Response
Content-Type: application/json
| Status Code | Reason | Response Model |
|---|---|---|
| 201 | Created | ActivationResponse |
| 400 | Bad Request | ErrorDetail |
| 500 | Internal Server Error | ErrorDetail |
| 503 | Service Unavailable | ErrorDetail |
| 504 | Gateway Timeout | ErrorDetail |
confirmActivation
Confirm a gift card activation.
POST /giftcard/v3/activations/{activationId}/confirmations/{confirmationId}
The Activation Confirmations endpoint registers the confirmation of a prior activation of a giftcard. Activation confirmations are advice type messages and should continue to be sent at suitable intervals until a response has been received. Multiple confirmation advices may be sent which refer to the same activation. The net result is that the activation is confirmed once.
Security
- httpBasic
Request
Content-Type: application/json
Parameters
| Name | Located in | Required | Description | Default | Schema |
|---|---|---|---|---|---|
| activationId | path | yes | The randomly generated activationId UUID as sent in the original activation. | string | |
| confirmationId | path | yes | The randomly generated UUID identifying this confirmation, as defined for a variant 4 UUID in RFC 4122. | string | |
| body | body | yes | The activation confirmation information. | ActivationConfirmation |
Response
Content-Type: application/json
| Status Code | Reason | Response Model |
|---|---|---|
| 202 | Accepted | BasicAdviceResponse |
| 400 | Bad Request | ErrorDetail |
| 404 | Not Found | ErrorDetail |
| 500 | Internal Server Error | ErrorDetail |
| 503 | Service Unavailable | ErrorDetail |
| 504 | Gateway Timeout | ErrorDetail |
reverseActivation
Simplistically, an activation reversal undoes an activation if the activation was successfully processed.
POST /giftcard/v3/activations/{activationId}/reversals/{reversalId}
The Activation Reversals endpoint allows an activation of a giftcard to be reversed. If the sender of an activation request is uncertain of the state of an activation request then the sender must send an activation reversal. Activation reversals are advice type messages and should continue to be sent at suitable intervals until a response has been received. Multiple reversals advices may be sent which refer to the same activation. The net result is that the activation is reversed once.
Security
- httpBasic
Request
Content-Type: application/json
Parameters
| Name | Located in | Required | Description | Default | Schema |
|---|---|---|---|---|---|
| activationId | path | yes | The randomly generated activationId UUID as sent in the original activation. | string | |
| reversalId | path | yes | The randomly generated UUID identifying this reversal, as defined for a variant 4 UUID in RFC 4122. | string | |
| body | body | yes | The activation reversal information. | ActivationReversal |
Response
Content-Type: application/json
| Status Code | Reason | Response Model |
|---|---|---|
| 202 | Accepted | BasicAdviceResponse |
| 400 | Bad Request | ErrorDetail |
| 404 | Not Found | ErrorDetail |
| 500 | Internal Server Error | ErrorDetail |
| 503 | Service Unavailable | ErrorDetail |
| 504 | Gateway Timeout | ErrorDetail |
load
Request funds to be loaded on a gift card.
POST /giftcard/v3/loads/{loadId}
The Loads endpoint allows loading of funds on a gift card to be authorized. A load is not considered complete until a load confirmation or load reversal has been sent and acknowledged. A load request should only be sent once otherwise multiple loads may occur erroneously.
Security
- httpBasic
Request
Content-Type: application/json
Parameters
| Name | Located in | Required | Description | Default | Schema |
|---|---|---|---|---|---|
| loadId | path | yes | The randomly generated UUID identifying this load, as defined for a variant 4 UUID in RFC 4122. | string | |
| body | body | yes | The load information. | LoadRequest |
Response
Content-Type: application/json
| Status Code | Reason | Response Model |
|---|---|---|
| 201 | Created | LoadResponse |
| 400 | Bad Request | ErrorDetail |
| 500 | Internal Server Error | ErrorDetail |
| 503 | Service Unavailable | ErrorDetail |
| 504 | Gateway Timeout | ErrorDetail |
confirmLoad
Confirm a load of funds on a gift card.
POST /giftcard/v3/loads/{loadId}/confirmations/{confirmationId}
The Load Confirmations endpoint registers the confirmation of a prior load on a gift card. Load confirmations are advice type messages and should continue to be sent at suitable intervals until a response has been received. Multiple confirmation advices may be sent which refer to the same load. The net result is that the load is confirmed once.
Security
- httpBasic
Request
Content-Type: application/json
Parameters
| Name | Located in | Required | Description | Default | Schema |
|---|---|---|---|---|---|
| loadId | path | yes | The randomly generated loadId UUID as sent in the original load. | string | |
| confirmationId | path | yes | The randomly generated UUID identifying this confirmation, as defined for a variant 4 UUID in RFC 4122. | string | |
| body | body | yes | The load confirmation information. | LoadConfirmation |
Response
Content-Type: application/json
| Status Code | Reason | Response Model |
|---|---|---|
| 202 | Accepted | BasicAdviceResponse |
| 400 | Bad Request | ErrorDetail |
| 404 | Not Found | ErrorDetail |
| 500 | Internal Server Error | ErrorDetail |
| 503 | Service Unavailable | ErrorDetail |
| 504 | Gateway Timeout | ErrorDetail |
reverseLoad
Simplistically, a load reversal undoes a load if the load was successfully processed.
POST /giftcard/v3/loads/{loadId}/reversals/{reversalId}
The Load Reversals endpoint allows loads on a gift card to be reversed. If the sender of a load request is uncertain of the state of a load request then the sender must send a load reversal. Reversals should continue to be sent at suitable intervals until a response has been received. Multiple reversals may be sent which refer to the same load. The net result is that the load is reversed once. Note that a load reversal does not equate to a redemption.
Security
- httpBasic
Request
Content-Type: application/json
Parameters
| Name | Located in | Required | Description | Default | Schema |
|---|---|---|---|---|---|
| loadId | path | yes | The randomly generated loadId UUID as sent in the original load. | string | |
| reversalId | path | yes | The randomly generated UUID identifying this reversal, as defined for a variant 4 UUID in RFC 4122. | string | |
| body | body | yes | The redemption reversal information. | LoadReversal |
Response
Content-Type: application/json
| Status Code | Reason | Response Model |
|---|---|---|
| 202 | Accepted | BasicAdviceResponse |
| 400 | Bad Request | ErrorDetail |
| 404 | Not Found | ErrorDetail |
| 500 | Internal Server Error | ErrorDetail |
| 503 | Service Unavailable | ErrorDetail |
| 504 | Gateway Timeout | ErrorDetail |
lookupGiftcard
Request gift card information.
POST /giftcard/v3/lookupGiftcard/{lookupId}
The Lookup Gift Cards endpoint allows information about a gift card to be retrieved. This operation has no financial impact and may be submitted repeatedly without financial consequece. Thus there is no confirmation or reversal process for gift card lookup requests.
Security
- httpBasic
Request
Content-Type: application/json
Parameters
| Name | Located in | Required | Description | Default | Schema |
|---|---|---|---|---|---|
| lookupId | path | yes | The randomly generated UUID identifying this lookup request, as defined for a variant 4 UUID in RFC 4122. | string | |
| body | body | yes | Information describing the gift card lookup to be performed. | LookupRequest |
Response
Content-Type: application/json
| Status Code | Reason | Response Model |
|---|---|---|
| 201 | Created | LookupResponse |
| 400 | Bad Request | ErrorDetail |
| 404 | Not Found | ErrorDetail |
| 500 | Internal Server Error | ErrorDetail |
| 503 | Service Unavailable | ErrorDetail |
| 504 | Gateway Timeout | ErrorDetail |
redeem
Request a redemption of a gift card.
POST /giftcard/v3/redemptions/{redemptionId}
The Redemptions endpoint allows gift cards to be redeemed as a form of tender. A redemption is not considered complete until a redemption confirmation or redemption reversal has been sent and acknowledged. A redemption request should only be sent once otherwise multiple redemptions may occur erroneously.
Security
- httpBasic
Request
Content-Type: application/json
Parameters
| Name | Located in | Required | Description | Default | Schema |
|---|---|---|---|---|---|
| redemptionId | path | yes | The randomly generated UUID identifying this redemption, as defined for a variant 4 UUID in RFC 4122. | string | |
| body | body | yes | The redemption information. | RedemptionRequest |
Response
Content-Type: application/json
| Status Code | Reason | Response Model |
|---|---|---|
| 201 | Created | RedemptionResponse |
| 400 | Bad Request | ErrorDetail |
| 500 | Internal Server Error | ErrorDetail |
| 503 | Service Unavailable | ErrorDetail |
| 504 | Gateway Timeout | ErrorDetail |
confirmRedemption
Confirm a redemption against a gift card.
POST /giftcard/v3/redemptions/{redemptionId}/confirmations/{confirmationId}
The Redemption Confirmations endpoint registers the confirmation of a prior redemption of a gift card. Redemption confirmations are advice type messages and should continue to be sent at suitable intervals until a response has been received. Multiple confirmation advices may be sent which refer to the same redemption. The net result is that the redemption is confirmed once.
Security
- httpBasic
Request
Content-Type: application/json
Parameters
| Name | Located in | Required | Description | Default | Schema |
|---|---|---|---|---|---|
| redemptionId | path | yes | The randomly generated redemptionId UUID as sent in the original redemption. | string | |
| confirmationId | path | yes | The randomly generated UUID identifying this confirmation, as defined for a variant 4 UUID in RFC 4122. | string | |
| body | body | yes | The redemption confirmation information. | RedemptionConfirmation |
Response
Content-Type: application/json
| Status Code | Reason | Response Model |
|---|---|---|
| 202 | Accepted | BasicAdviceResponse |
| 400 | Bad Request | ErrorDetail |
| 404 | Not Found | ErrorDetail |
| 500 | Internal Server Error | ErrorDetail |
| 503 | Service Unavailable | ErrorDetail |
| 504 | Gateway Timeout | ErrorDetail |
reverseRedemption
Simplistically, a redemption reversal undoes a redemption if the redemption was successfully processed.
POST /giftcard/v3/redemptions/{redemptionId}/reversals/{reversalId}
The Redemption Reversals endpoint allows redemptions on a gift card to be reversed. If the sender of a redemption request is uncertain of the state of a redemption request then the sender must send a redemption reversal. Reversals should continue to be sent at suitable intervals until a response has been received. Multiple reversals may be sent which refer to the same redemption. The net result is that the redemption is reversed once. Note that a reversal does not equate to a load.
Security
- httpBasic
Request
Content-Type: application/json
Parameters
| Name | Located in | Required | Description | Default | Schema |
|---|---|---|---|---|---|
| redemptionId | path | yes | The randomly generated redemptionId UUID as sent in the original redemption. | string | |
| reversalId | path | yes | The randomly generated UUID identifying this reversal, as defined for a variant 4 UUID in RFC 4122. | string | |
| body | body | yes | The redemption reversal information. | RedemptionReversal |
Response
Content-Type: application/json
| Status Code | Reason | Response Model |
|---|---|---|
| 202 | Accepted | BasicAdviceResponse |
| 400 | Bad Request | ErrorDetail |
| 404 | Not Found | ErrorDetail |
| 500 | Internal Server Error | ErrorDetail |
| 503 | Service Unavailable | ErrorDetail |
| 504 | Gateway Timeout | ErrorDetail |
data
Retrieve the test data confirgured in the Giftcard Test Server.
GET /giftcard/v3/testServerAdmin/data
The Test Server Admin Data endpoint allows a user of the Test Server to retrieve all the card and product data currently configured in the Test Server. This allows the user to obtain valid card and product information to use for testing. Note that requests submitted which use cards or products different from those returned by this operations will not be recognised by the Test Server and will lead to an error response from the Test Server.
Request
Content-Type: application/json
Response
Content-Type: application/json
| Status Code | Reason | Response Model |
|---|---|---|
| 200 | OK | DataResponse |
| 500 | Internal Server Error |
singleCardData
Retrieve the test data configured in the Giftcard Test Server for a certain card.
GET /giftcard/v3/testServerAdmin/data/card/{cardNumber}
The Test Server Admin Data endpoint allows a user of the Test Server to retrieve the card data and state for a card configured in the Test Server. This allows the user to obtain valid card information to use for testing as well as the opportunity to examine the state of the card as it is 'used' in a test.
Security
- httpBasic
Request
Content-Type: application/json
Parameters
| Name | Located in | Required | Description | Default | Schema |
|---|---|---|---|---|---|
| cardNumber | path | yes | The PAN of the card for which data should be retrieved. | string |
Response
Content-Type: application/json
| Status Code | Reason | Response Model |
|---|---|---|
| 200 | OK | DataResponse |
| 500 | Internal Server Error |
singleProductData
Retrieve the test data configured in the Giftcard Test Server for a certain product.
GET /giftcard/v3/testServerAdmin/data/product/{productId}
The Test Server Admin Data endpoint allows a user of the Test Server to retrieve the product data currently configured in the Test Server for a single specified product. This allows the user to obtain valid product information to use for testing.
Security
- httpBasic
Request
Content-Type: application/json
Parameters
| Name | Located in | Required | Description | Default | Schema |
|---|---|---|---|---|---|
| productId | path | yes | The ID of the product for which data should be retrieved. | string |
Response
Content-Type: application/json
| Status Code | Reason | Response Model |
|---|---|---|
| 200 | OK | DataResponse |
| 500 | Internal Server Error |
reset
Reset the test data in the Giftcard Test Server.
POST /giftcard/v3/testServerAdmin/reset
The Test Server Admin Reset endpoint allows a user of the Test Server to reset the test data in the Test Server's database. This means that all card and product data will be reset to initial settings and ALL message data will be lost. This operation affects all data used by the user identified by the HTTP Basic Auth username and password combination. <em>This cannot be reversed.</em>
Security
- httpBasic
Request
Content-Type: application/json
Parameters
| Name | Located in | Required | Description | Default | Schema |
|---|---|---|---|---|---|
| body | body | yes | The activation confirmation information. | ResetRequest |
Response
Content-Type: application/json
| Status Code | Reason | Response Model |
|---|---|---|
| 200 | OK | ResetResponse |
| 400 | Bad Request | ResetResponse |
| 500 | Internal Server Error | ResetResponse |
voidGiftcard
Request a gift card be voided.
POST /giftcard/v3/voids/{voidId}
The Voids endpoint allows an activated giftcard to be voided. A void is not considered complete until a void confirmation or void reversal has been sent and acknowledged. While a gift card can only be voided once, a void request should only be sent once and then either confirmed or reversed.
Security
- httpBasic
Request
Content-Type: application/json
Parameters
| Name | Located in | Required | Description | Default | Schema |
|---|---|---|---|---|---|
| voidId | path | yes | The randomly generated UUID identifying this void, as defined for a variant 4 UUID in RFC 4122. | string | |
| body | body | yes | The void information. | VoidRequest |
Response
Content-Type: application/json
| Status Code | Reason | Response Model |
|---|---|---|
| 200 | successful operation | VoidResponse |
| 201 | Created | VoidResponse |
| 400 | Bad Request | ErrorDetail |
| 500 | Internal Server Error | ErrorDetail |
| 503 | Service Unavailable | ErrorDetail |
| 504 | Gateway Timeout | ErrorDetail |
confirmVoid
Confirm a void of a gift card.
POST /giftcard/v3/voids/{voidId}/confirmations/{confirmationId}
The Void Confirmations endpoint registers the confirmation of a prior void on a gift card. Void confirmations are advice type messages and should continue to be sent at suitable intervals until a response has been received. Multiple confirmation advices may be sent which refer to the same void. The net result is that the void is confirmed once.
Security
- httpBasic
Request
Content-Type: application/json
Parameters
| Name | Located in | Required | Description | Default | Schema |
|---|---|---|---|---|---|
| voidId | path | yes | The randomly generated voidId UUID as sent in the original void. | string | |
| confirmationId | path | yes | The randomly generated UUID identifying this confirmation, as defined for a variant 4 UUID in RFC 4122. | string | |
| body | body | yes | The void confirmation information. | VoidConfirmation |
Response
Content-Type: application/json
| Status Code | Reason | Response Model |
|---|---|---|
| 202 | Accepted | BasicAdviceResponse |
| 400 | Bad Request | ErrorDetail |
| 404 | Not Found | ErrorDetail |
| 500 | Internal Server Error | ErrorDetail |
| 503 | Service Unavailable | ErrorDetail |
| 504 | Gateway Timeout | ErrorDetail |
reverseVoid
Simplistically, a void reversal undoes a void if the void was successfully processed.
POST /giftcard/v3/voids/{voidId}/reversals/{reversalId}
The Void Reversals endpoint allows voids of a gift card to be reversed. If the sender of a void request is uncertain of the state of a void request then the sender must send a void reversal. Reversals should continue to be sent at suitable intervals until a response has been received. Multiple reversals may be sent which refer to the same void. The net result is that the void is reversed once.
Security
- httpBasic
Request
Content-Type: application/json
Parameters
| Name | Located in | Required | Description | Default | Schema |
|---|---|---|---|---|---|
| voidId | path | yes | The randomly generated voidId UUID as sent in the original void. | string | |
| reversalId | path | yes | The randomly generated UUID identifying this reversal, as defined for a variant 4 UUID in RFC 4122. | string | |
| body | body | yes | The void reversal information. | VoidReversal |
Response
Content-Type: application/json
| Status Code | Reason | Response Model |
|---|---|---|
| 202 | Accepted | BasicAdviceResponse |
| 400 | Bad Request | ErrorDetail |
| 404 | Not Found | ErrorDetail |
| 500 | Internal Server Error | ErrorDetail |
| 503 | Service Unavailable | ErrorDetail |
| 504 | Gateway Timeout | ErrorDetail |