Common data types and responses

These fields are used in multiple operations for both the Account Information and Points Bank APIs.

Amount

Variables indicating the loyalty rewards affected by the transaction.

FieldDescriptionSample valueMandatory?
valueAmount of loyalty reward, in points, miles, or other program currency100.00Yes
currencyThe currency in which the redemption was made, such as CAD, USD, POINTS, MILES, and moreUSDYes

DeclineReason

Reasons that a transaction would be declined. You can also add custom messaging that would be displayed to the customer.

reasonCodeDescriptionHTTP status code
ACCOUNT_INELIGIBLEAccount not eligible for the current redemption request200
ACCOUNT_NOT_FOUNDAccount for redemption not found200
COULD_NOT_FIND_THE_ORIGINAL_TRANSACTIONOriginal transaction could not be found200
DUPLICATE_TRANSACTIONThe redemption request has been previously received200
INSUFFICIENT_BALANCEInsufficient balance in the user’s account200
INVALID_AMOUNTRedemption amount is not valid200
INVALID_PROMO_IDRedemption promo ID is not valid200

Errors

Information about errors to assist with logging and investigation.

Error responses

FieldDescription
statusFailure status
requestIdUnique request identifier
errorCodeError code; see Error codes table for values
errorMessageCustom error message
additionalInfoMapList of key value pairs

Error codes

Error codeHTTP status code
ACCOUNT_NOT_FOUND4xx
AUTH_FAILED4xx
BAD_REQUEST4xx
INTERNAL_CONFIGURATION_ISSUE5xx
INVALID_ACCOUNT4xx
INVALID_CREDENTIALS4xx
REQUEST_IN_PROGRESS5xx
RESOURCE_NOT_FOUND4xx
TIMEOUT_ERROR5xx
TIMEOUT_ERROR_CODE5xx
UNKNOWN_ERROR_CODE5xx
Did you find this page helpful?
How can we improve this content?
Thank you for helping us improve!