Exchange Points for Reward
Changed onThis API method allows the calling application to perform a Reward Bank exchange. Exchange means a Consumer will receive a specific reward as per Rewards Bank definition. For example: receive a two for one COUPON in exchange for 150 loyalty points (reward cost), after reaching or exceeding 170 points current balance (reward threshold)). If for any reasons this operation fails, EES AIR would perform a Rollback operation, so Consumer Account's will be restored to the state before this API call. Most typical causes why an exchange could fail could be linked to Reward's complex configuration (e.g. Campaign's Issuance limits or Issuance Windows) Returned error code and an error message would explain why this exchange call failed.
Please note:
- by default for Loyalty Points Accounts, EES AIR allows exchanges of an amount larger than the account's available balance, which would result in a negative balance. This could be mitigated by EES Scheme settings:
- Disable 'allow negative balance'
- Enable 'AUTOTOPUP' - EES AIR will detect these negative balances and instantly correct them by bringing a balance to zero (and creating a corresponding Account Transaction of type 'AUTOTOPUP').
- ROLLBACK would leave traces in EES AIR in the form of VOIDED Wallet Transaction and VOIDED Wallet Account Transaction. If for any reasons Rollback mechanism fails, this endpoint would return the HTTP 207 (Multi-Status) header with all details, allowing to rectify this situation. If for any reasons Rollback mechanism fails, this endpoint would return the HTTP 207 (Multi-Status) header with all details, allowing to rectify this situation.
If the Reward Bank has an Exchange Limit set against it then the number of exchanges will be checked. The call will fail with an ELE Exchange Limit Exceeded error if the limit has been reached.
- For PUBLIC Reward Banks the number of exchanges is counted against the calling walletId.
- For PRIVATE Reward Banks the number of exchanges is counted against an active Wallet Link for the Reward Bank.
If multiple active Wallet Links exist between the same Personal Reward Bank and Wallet and are both valid for the same Reward then each link can be used up to the Exchange Limit before being marked as USED. EES AIR automatically selects the link expiring the soonest first, then the link most specific to the Reward being exchanged.
Request
- Base URLhttps://wallet.uk.eagleeye.com/2.0
- URLhttps://wallet.uk.eagleeye.com/2.0/services/wallet/{walletId}/transaction/exchange/pointsreward
- AuthAPI key in header X-EES-AUTH-CLIENT-ID and API key in header X-EES-AUTH-HASH
Path parameters
EES AIR Wallet ID
Request body
Example request
{
"accountId": "1178",
"pointsRewardBankId": "55637",
"pointsRewardBankRewardId": "222333444",
"walletTransaction": {
"state": "A_STATE",
"reference": "An exchange Wallet Transaction reference",
"meta": {
"key": "Value"
}
},
"exchangeAccountTransaction": {
"details": {
"key1": "Key 1 Value"
}
},
"createAccountTransaction": {
"state": "BASIC",
"meta": {
"accountMeta1": "foo-bar"
},
"details": {
"foo": "bar"
}
},
"location": {
"storeId": "32432"
}
}Response
Created
Changes
- breaking
the response's body type changed from no type to
objectfor status - breaking
the response's body type changed from no type to
objectfor status - breaking
the response property
///////became optional for the status - breaking
the response property
/////////became optional for the status - breaking
the response property
//////////became optional for the status - breaking
the response property
////////////became optional for the status - breaking
the response property
/////////////became optional for the status - breaking
the response property
//////////////became optional for the status - breaking
the
///////response's property format changed fromdate-timeto no format for status - breaking
the
////////response's property format changed fromdate-timeto no format for status - breaking
the
////////response's property format changed fromdate-timeto no format for status - breaking
the
///////response's property format changed fromdate-timeto no format for status - breaking
the
/////////response's property type changed fromobjecttoarrayfor status - breaking
the
/////////response's property type changed fromobjecttoarrayfor status - breaking
the
/////////response's property format changed fromdate-timeto no format for status - breaking
the
//////////response's property format changed fromdate-timeto no format for status - breaking
the
//////////response's property format changed fromdate-timeto no format for status - breaking
the
/////////response's property format changed fromdate-timeto no format for status - breaking
the
///////////response's property type changed fromobjecttoarrayfor status - breaking
the
///////////response's property type changed fromobjecttoarrayfor status - breaking
the
//////////response's property format changed fromdate-timeto no format for status - breaking
the
///////////response's property format changed fromdate-timeto no format for status - breaking
the
///////////response's property format changed fromdate-timeto no format for status - breaking
the
//////////response's property format changed fromdate-timeto no format for status - breaking
the
////////////response's property type changed fromobjecttoarrayfor status - breaking
the
////////////response's property type changed fromobjecttoarrayfor status - breaking
the
////////////response's property format changed fromdate-timeto no format for status - breaking
the
/////////////response's property format changed fromdate-timeto no format for status - breaking
the
/////////////response's property format changed fromdate-timeto no format for status - breaking
the
////////////response's property format changed fromdate-timeto no format for status - breaking
the
//////////////response's property type changed fromobjecttoarrayfor status - breaking
the
//////////////response's property type changed fromobjecttoarrayfor status - breaking
the
/////////////response's property format changed fromdate-timeto no format for status - breaking
the
//////////////response's property format changed fromdate-timeto no format for status - breaking
the
//////////////response's property format changed fromdate-timeto no format for status - breaking
the
/////////////response's property format changed fromdate-timeto no format for status - breaking
the
///////////////response's property type changed fromobjecttoarrayfor status - breaking
the
///////////////response's property type changed fromobjecttoarrayfor status - breaking
the
//////////////response's property format changed fromdate-timeto no format for status - breaking
the
///////////////response's property format changed fromdate-timeto no format for status - breaking
the
///////////////response's property format changed fromdate-timeto no format for status - breaking
the
//////////////response's property format changed fromdate-timeto no format for status - breaking
the
////////////////response's property type changed fromobjecttoarrayfor status - breaking
the
////////////////response's property type changed fromobjecttoarrayfor status - breaking
the
////response's property type changed from no type toobjectfor status - breaking
removed the required property
//////////from the response with the status - breaking
removed the required property
//////////from the response with the status - breaking
removed the required property
//////////from the response with the status - breaking
removed the required property
//////////from the response with the status - breaking
removed the required property
////////////from the response with the status - breaking
removed the required property
////////////from the response with the status - breaking
removed the required property
////////////from the response with the status - breaking
removed the required property
////////////from the response with the status - breaking
removed the required property
/////////////from the response with the status - breaking
removed the required property
/////////////from the response with the status - breaking
removed the required property
/////////////from the response with the status - breaking
removed the required property
/////////////from the response with the status - breaking
removed the required property
///////////////from the response with the status - breaking
removed the required property
///////////////from the response with the status - breaking
removed the required property
///////////////from the response with the status - breaking
removed the required property
///////////////from the response with the status - breaking
removed the required property
////////////////from the response with the status - breaking
removed the required property
////////////////from the response with the status - breaking
removed the required property
////////////////from the response with the status - breaking
removed the required property
////////////////from the response with the status - breaking
removed the required property
/////////////////from the response with the status - breaking
removed the required property
/////////////////from the response with the status - breaking
removed the required property
/////////////////from the response with the status - breaking
removed the required property
/////////////////from the response with the status - warning
removed the optional property
///////from the response with the status - warning
removed the optional property
/////////from the response with the status - warning
removed the optional property
//////////from the response with the status - warning
removed the optional property
////////////from the response with the status - warning
removed the optional property
/////////////from the response with the status - warning
removed the optional property
//////////////from the response with the status - warning
removed the optional property
/////from the response with the status - warning
added the new
AALRenum value to the////response property for the response status - warning
added the new
AALRenum value to the////response property for the response status - warning
added the new
AALRenum value to the////response property for the response status - warning
added the new
AALRenum value to the///////response property for the response status - warning
added the new
CILRenum value to the////response property for the response status - warning
added the new
CILRenum value to the////response property for the response status - warning
added the new
CILRenum value to the////response property for the response status - warning
added the new
CILRenum value to the///////response property for the response status - warning
added the new
CLPPRenum value to the////response property for the response status - warning
added the new
CLPPRenum value to the////response property for the response status - warning
added the new
CLPPRenum value to the////response property for the response status - warning
added the new
CLPPRenum value to the///////response property for the response status - warning
added the new
CONTINUITYenum value to the///////response property for the response status - warning
added the new
CONTINUITYenum value to the/////////response property for the response status - warning
added the new
CONTINUITYenum value to the//////////response property for the response status - warning
added the new
CONTINUITYenum value to the////////////response property for the response status - warning
added the new
CONTINUITYenum value to the/////////////response property for the response status - warning
added the new
CONTINUITYenum value to the//////////////response property for the response status - warning
added the new
ELEenum value to the////response property for the response status - warning
added the new
ELEenum value to the////response property for the response status - warning
added the new
ELEenum value to the////response property for the response status - warning
added the new
ELEenum value to the///////response property for the response status - warning
added the new
POINTSenum value to the///////response property for the response status - warning
added the new
POINTSenum value to the/////////response property for the response status - warning
added the new
POINTSenum value to the//////////response property for the response status - warning
added the new
POINTSenum value to the////////////response property for the response status - warning
added the new
POINTSenum value to the/////////////response property for the response status - warning
added the new
POINTSenum value to the//////////////response property for the response status - warning
added the new
QUESTenum value to the///////response property for the response status - warning
added the new
QUESTenum value to the/////////response property for the response status - warning
added the new
QUESTenum value to the//////////response property for the response status - warning
added the new
QUESTenum value to the////////////response property for the response status - warning
added the new
QUESTenum value to the/////////////response property for the response status - warning
added the new
QUESTenum value to the//////////////response property for the response status - warning
added the new
RFenum value to the////response property for the response status - warning
added the new
RFenum value to the////response property for the response status - warning
added the new
RFenum value to the////response property for the response status - warning
added the new
RFenum value to the///////response property for the response status - warning
added the new
RFLenum value to the////response property for the response status - warning
added the new
RFLenum value to the////response property for the response status - warning
added the new
RFLenum value to the////response property for the response status - warning
added the new
RFLenum value to the///////response property for the response status - warning
added the new
STAMP_CARDenum value to the///////response property for the response status - warning
added the new
STAMP_CARDenum value to the/////////response property for the response status - warning
added the new
STAMP_CARDenum value to the//////////response property for the response status - warning
added the new
STAMP_CARDenum value to the////////////response property for the response status - warning
added the new
STAMP_CARDenum value to the/////////////response property for the response status - warning
added the new
STAMP_CARDenum value to the//////////////response property for the response status - warning
added the new
STANDARD_SUBSCRIPTIONenum value to the///////response property for the response status - warning
added the new
STANDARD_SUBSCRIPTIONenum value to the/////////response property for the response status - warning
added the new
STANDARD_SUBSCRIPTIONenum value to the//////////response property for the response status - warning
added the new
STANDARD_SUBSCRIPTIONenum value to the////////////response property for the response status - warning
added the new
STANDARD_SUBSCRIPTIONenum value to the/////////////response property for the response status - warning
added the new
STANDARD_SUBSCRIPTIONenum value to the//////////////response property for the response status - warning
added the new
SUSPENDEDenum value to the///////response property for the response status - warning
added the new
SUSPENDEDenum value to the/////////response property for the response status - warning
added the new
SUSPENDEDenum value to the//////////response property for the response status - warning
added the new
SUSPENDEDenum value to the////////////response property for the response status - warning
added the new
SUSPENDEDenum value to the/////////////response property for the response status - warning
added the new
SUSPENDEDenum value to the//////////////response property for the response status - warning
added the new
TBRenum value to the////response property for the response status - warning
added the new
TBRenum value to the////response property for the response status - warning
added the new
TBRenum value to the////response property for the response status - warning
added the new
TBRenum value to the///////response property for the response status - warning
added the new
TBSenum value to the////response property for the response status - warning
added the new
TBSenum value to the////response property for the response status - warning
added the new
TBSenum value to the////response property for the response status - warning
added the new
TBSenum value to the///////response property for the response status - warning
added the new
WLNFenum value to the////response property for the response status - warning
added the new
WLNFenum value to the////response property for the response status - warning
added the new
WLNFenum value to the////response property for the response status - warning
added the new
WLNFenum value to the///////response property for the response status - warning
added the new
WTFenum value to the////response property for the response status - warning
added the new
WTFenum value to the////response property for the response status - warning
added the new
WTFenum value to the////response property for the response status - warning
added the new
WTFenum value to the///////response property for the response status - warning
added the new
WTNFenum value to the////response property for the response status - warning
added the new
WTNFenum value to the////response property for the response status - warning
added the new
WTNFenum value to the////response property for the response status - warning
added the new
WTNFenum value to the///////response property for the response status - info
added to the response body
allOflist for the response status - info
added to the response body
allOflist for the response status - info
removed from the response body
allOflist for the response status - info
removed from the response body
allOflist for the response status - info
removed from the response body
allOflist for the response status - info
removed from the response body
allOflist for the response status - info
added the optional property
////////to the response with the status - info
added the optional property
////////to the response with the status - info
added the optional property
///////to the response with the status - info
added the optional property
////////to the response with the status - info
added the optional property
////////to the response with the status - info
added the optional property
////////to the response with the status - info
added the optional property
////////to the response with the status - info
added the optional property
////////to the response with the status - info
added the optional property
////////to the response with the status - info
added the optional property
////////to the response with the status - info
added the optional property
////////to the response with the status - info
added the optional property
////////to the response with the status - info
added the optional property
//////////to the response with the status - info
added the optional property
//////////to the response with the status - info
added the optional property
/////////to the response with the status - info
added the optional property
//////////to the response with the status - info
added the optional property
//////////to the response with the status - info
added the optional property
//////////to the response with the status - info
added the optional property
//////////to the response with the status - info
added the optional property
//////////to the response with the status - info
added the optional property
//////////to the response with the status - info
added the optional property
//////////to the response with the status - info
added the optional property
//////////to the response with the status - info
added the optional property
//////////to the response with the status - info
added the optional property
///////////to the response with the status - info
added the optional property
///////////to the response with the status - info
added the optional property
//////////to the response with the status - info
added the optional property
///////////to the response with the status - info
added the optional property
///////////to the response with the status - info
added the optional property
///////////to the response with the status - info
added the optional property
///////////to the response with the status - info
added the optional property
///////////to the response with the status - info
added the optional property
///////////to the response with the status - info
added the optional property
///////////to the response with the status - info
added the optional property
///////////to the response with the status - info
added the optional property
///////////to the response with the status - info
added the optional property
/////////////to the response with the status - info
added the optional property
/////////////to the response with the status - info
added the optional property
////////////to the response with the status - info
added the optional property
/////////////to the response with the status - info
added the optional property
/////////////to the response with the status - info
added the optional property
/////////////to the response with the status - info
added the optional property
/////////////to the response with the status - info
added the optional property
/////////////to the response with the status - info
added the optional property
/////////////to the response with the status - info
added the optional property
/////////////to the response with the status - info
added the optional property
/////////////to the response with the status - info
added the optional property
/////////////to the response with the status - info
added the optional property
//////////////to the response with the status - info
added the optional property
//////////////to the response with the status - info
added the optional property
/////////////to the response with the status - info
added the optional property
//////////////to the response with the status - info
added the optional property
//////////////to the response with the status - info
added the optional property
//////////////to the response with the status - info
added the optional property
//////////////to the response with the status - info
added the optional property
//////////////to the response with the status - info
added the optional property
//////////////to the response with the status - info
added the optional property
//////////////to the response with the status - info
added the optional property
//////////////to the response with the status - info
added the optional property
//////////////to the response with the status - info
added the optional property
///////////////to the response with the status - info
added the optional property
///////////////to the response with the status - info
added the optional property
//////////////to the response with the status - info
added the optional property
///////////////to the response with the status - info
added the optional property
///////////////to the response with the status - info
added the optional property
///////////////to the response with the status - info
added the optional property
///////////////to the response with the status - info
added the optional property
///////////////to the response with the status - info
added the optional property
///////////////to the response with the status - info
added the optional property
///////////////to the response with the status - info
added the optional property
///////////////to the response with the status - info
added the optional property
///////////////to the response with the status - info
added the optional property
/////to the response with the status - info
added the optional property
/////to the response with the status - info
added the optional property
/////to the response with the status - info
added the optional property
/////to the response with the status - info
added the optional property
/////to the response with the status - info
the response property
////became required for the status - info
the response property
////became required for the status - info
the response property
////became required for the status - info
the response property
////became required for the status - info
the response property
////became required for the status - info
the response property
////became required for the status - info
the response property
///////became required for the status - info
the response property
///////became required for the status - info
the
response's property default valueACTIVEwas added for the status - info
the
response's property default valueACTIVEwas added for the status - info
the
response's property default valueACTIVEwas added for the status - info
the
response's property default valueACTIVEwas added for the status - info
the
response's property default valueACTIVEwas added for the status - info
the
response's property default valueACTIVEwas added for the status - info
removed discriminator from
////response property for the response status - info
removed from the
////response propertyoneOflist for the response status - info
the
///////response's property pattern/\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2]\d|3[0-1])T[0-2]\d:[0-5]\d:[0-5]\d[+-][0-2]\d:[0-5]\d/was added for the status - info
the
////////response's property pattern/\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2]\d|3[0-1])T[0-2]\d:[0-5]\d:[0-5]\d[+-][0-2]\d:[0-5]\d/was added for the status - info
the
////////response's property pattern/\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2]\d|3[0-1])T[0-2]\d:[0-5]\d:[0-5]\d[+-][0-2]\d:[0-5]\d/was added for the status - info
the
///////response's property pattern/\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2]\d|3[0-1])T[0-2]\d:[0-5]\d:[0-5]\d[+-][0-2]\d:[0-5]\d/was added for the status - info
the
/////////response's property pattern/\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2]\d|3[0-1])T[0-2]\d:[0-5]\d:[0-5]\d[+-][0-2]\d:[0-5]\d/was added for the status - info
the
//////////response's property pattern/\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2]\d|3[0-1])T[0-2]\d:[0-5]\d:[0-5]\d[+-][0-2]\d:[0-5]\d/was added for the status - info
the
//////////response's property pattern/\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2]\d|3[0-1])T[0-2]\d:[0-5]\d:[0-5]\d[+-][0-2]\d:[0-5]\d/was added for the status - info
the
/////////response's property pattern/\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2]\d|3[0-1])T[0-2]\d:[0-5]\d:[0-5]\d[+-][0-2]\d:[0-5]\d/was added for the status - info
the
//////////response's property pattern/\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2]\d|3[0-1])T[0-2]\d:[0-5]\d:[0-5]\d[+-][0-2]\d:[0-5]\d/was added for the status - info
the
///////////response's property pattern/\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2]\d|3[0-1])T[0-2]\d:[0-5]\d:[0-5]\d[+-][0-2]\d:[0-5]\d/was added for the status - info
the
///////////response's property pattern/\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2]\d|3[0-1])T[0-2]\d:[0-5]\d:[0-5]\d[+-][0-2]\d:[0-5]\d/was added for the status - info
the
//////////response's property pattern/\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2]\d|3[0-1])T[0-2]\d:[0-5]\d:[0-5]\d[+-][0-2]\d:[0-5]\d/was added for the status - info
the
////////////response's property pattern/\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2]\d|3[0-1])T[0-2]\d:[0-5]\d:[0-5]\d[+-][0-2]\d:[0-5]\d/was added for the status - info
the
/////////////response's property pattern/\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2]\d|3[0-1])T[0-2]\d:[0-5]\d:[0-5]\d[+-][0-2]\d:[0-5]\d/was added for the status - info
the
/////////////response's property pattern/\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2]\d|3[0-1])T[0-2]\d:[0-5]\d:[0-5]\d[+-][0-2]\d:[0-5]\d/was added for the status - info
the
////////////response's property pattern/\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2]\d|3[0-1])T[0-2]\d:[0-5]\d:[0-5]\d[+-][0-2]\d:[0-5]\d/was added for the status - info
the
/////////////response's property pattern/\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2]\d|3[0-1])T[0-2]\d:[0-5]\d:[0-5]\d[+-][0-2]\d:[0-5]\d/was added for the status - info
the
//////////////response's property pattern/\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2]\d|3[0-1])T[0-2]\d:[0-5]\d:[0-5]\d[+-][0-2]\d:[0-5]\d/was added for the status - info
the
//////////////response's property pattern/\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2]\d|3[0-1])T[0-2]\d:[0-5]\d:[0-5]\d[+-][0-2]\d:[0-5]\d/was added for the status - info
the
/////////////response's property pattern/\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2]\d|3[0-1])T[0-2]\d:[0-5]\d:[0-5]\d[+-][0-2]\d:[0-5]\d/was added for the status - info
the
//////////////response's property pattern/\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2]\d|3[0-1])T[0-2]\d:[0-5]\d:[0-5]\d[+-][0-2]\d:[0-5]\d/was added for the status - info
the
///////////////response's property pattern/\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2]\d|3[0-1])T[0-2]\d:[0-5]\d:[0-5]\d[+-][0-2]\d:[0-5]\d/was added for the status - info
the
///////////////response's property pattern/\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2]\d|3[0-1])T[0-2]\d:[0-5]\d:[0-5]\d[+-][0-2]\d:[0-5]\d/was added for the status - info
the
//////////////response's property pattern/\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2]\d|3[0-1])T[0-2]\d:[0-5]\d:[0-5]\d[+-][0-2]\d:[0-5]\d/was added for the status - info
added the required property
///////to the response with the status - info
added the required property
/////////to the response with the status - info
added the required property
//////////to the response with the status - info
added the required property
////////////to the response with the status - info
added the required property
/////////////to the response with the status - info
added the required property
//////////////to the response with the status - info
added the required property
to the response with the status - info
added the required property
to the response with the status - info
added the required property
to the response with the status - info
added the required property
to the response with the status
This list may be incomplete.
- breaking