The RETAIL7 Gift Card API can be used to perform a variety of actions related to gift cards. These actions include e.g.:
Status check
Sell
Load
Redeem
Cancel
Create without sell
Update
Lock
Unlock
Close
If you want to get information about gift card status (e.g. balance, validity, etc.) you can use the following request:
The valid json looks like that:
{
"requestIDExternal": "GC10",
"timestamp": "2021-02-21T11:30:25.930Z",
"trainingFlag": false,
"operationType": "STATUS",
"cardID": "12399",
"clientStore": "1001",
"clientCountry": "US",
"clientID": "1001"
}Field | Type | Sample | Description | Mandatory |
| string (40) | "12345" | ID of the STATUS request. Must be unique. | M |
| timestamp | "2021-02-21T11:30:25.930Z" | Timestamp of the operation. | M |
| boolean | "True" or "False" | Flag which reflects if operating in training mode (true) or not (false). | M |
| string (40) | "STATUS" | Type of the requested gift card operation. | M |
| string (40) | "12345" | ID of the gift card relevant to the operation. | M |
| string (40) | "12345" | Store ID | M |
| string (40) | "DE" | ISO 3166-1 alpha-2 code of the country. | M |
| string (40) | "12345" | ID of the client posting the request. | M |
The valid json looks like that:
{
"requestIDExternal": "GC10",
"timestamp": "2021-02-21T11:30:25.930Z",
"trainingFlag": false,
"operationType": "SELL",
"cardID": "1234567",
"amount": 5.00,
"currencyCode": "USD",
"clientStore": "1001",
"clientCountry": "US",
"clientID": "1001",
"clientTrx": "1001201910311001000004"
"issuedByClient": false,
"validFrom": "2021-02-20",
"validUntil": "2023-02-20"
}Field | Type | Sample | Description | Mandatory |
| string (40) | ID of the SELL request. Must be unique. | M | |
| timestamp | "2019-10-31T21:29:51.779Z" | Timestamp of the operation. | M |
| boolean | "false" | Indicator, if operating in training mode (true) or not (false). | M |
| string (40) | "SELL" | Type of the requested gift card operation. | M |
| string (40) | "12399" | ID of the gift card relevant to the operation. | M |
| string (40) | "01" | Used only when gift card is issued by the client - it defines the type code of the gift card. | O |
| number | "5.00" | Amount of the operation. In case of SELL operation it defines the initial gift card balance. | M |
| number | "500.00" | Used only when gift card is issued by the client - it defines the maximum balance. The value can be taken from configuration. If not defined by the request, server default is used. | O |
| string (3) | "EUR" | ISO 4217 code of the currency of the operation. | M |
| string (40) | "1001" | Store ID of the client posting the request. | M |
| string (40) | "DE" | ISO 3166-1 alpha-2 code of the country of the client posting the request. | M |
| string (40) | "1001" | ID of the client posting the request. | M |
| string (40) | "1001201910311001000004" | ID of the transaction containing gift card sale / return / tender line item, created by the client. | M |
| boolean | "false" | Indicator, if the gift card was issued by client (true) or not (false). | M |
| date | "2021-02-20" | This defines from when is the gift card valid for redemption. Usually it is the date of sale. If it is not filled in the request, then it is set to current date. | O |
| date | "2023-02-20" | This defines until when is the gift card valid for redemption. If it is not filled in the request, then:
| O |
| boolean | "false" | Used only when gift card is issued by the client - it defines if gift card is re-loadable. The value can be taken from configuration. If not defined by the request, server default is used. | O |
| boolean | "true" | Used only when gift card is issued by the client - it defines if gift card can be returned. The value can be taken from configuration. If not defined by the request, server default is used. | O |
| boolean | "false" | Used only when gift card is issued by the client - it defines if gift card can be redeemed in part. The value can be taken from configuration. If not defined by the request, server default is used. | O |
| string (40) | If captured a reason code during the process, it is also passed on in the request. | O |
The valid json looks like that:
{
"requestIDExternal": "GC111",
"timestamp": "2021-02-21T11:30:25.930Z",
"trainingFlag": false,
"operationType": "LOAD",
"cardID": "12300",
"amount": 5.00,
"currencyCode": "USD",
"clientStore": "1001",
"clientCountry": "US",
"clientID": "1001",
"clientTrx": "1001201910311001000004"
}Field | Type | Sample | Description | Mandatory |
| string (40) | ID of the LOAD request assigned by the client. Must be unique. | M | |
| timestamp | "2021-02-21T11:30:25.930Z" | Timestamp of the operation (on client side). | M |
| boolean | "false" | Indicator, if the client is operating in training mode (true) or not (false). | M |
| string (40) | "LOAD" | Type of the requested gift card operation. | M |
| string (40) | "12399" | ID of the gift card relevant to the operation. | M |
| number | "5.00" | Amount of the operation. | M |
| string (3) | "EUR" | ISO 4217 code of the currency of the operation. | M |
| string (40) | "1001" | Store ID of the client posting the request. | M |
| string (40) | "DE" | ISO 3166-1 alpha-2 code of the country of the client posting the request. | M |
| string (40) | "1001" | ID of the client posting the request. | M |
| string (40) | "1001201910311001000004" | ID of the transaction containing gift card sale / return / tender line item, created by the client. | M |
| string (40) | If client captured a reason code during the process, it is also passed on in the request. | O |