Paths
/v1/rewards/selectAndCredit/redemption
Redeem the credit card reward points
Request for the redemption to be processed for credit card enrolled.
The most recent Authorization token. This will have the format Bearer + {space} + {accessToken}. Example: Bearer KGNsaWVudF9pZDpjbGllbnRfc2VjcmV0KQ==
128 bit random UUID generated uniquely for every request.
Content-Type that are acceptable for the response.
Client ID generated during application registration.
application/json
This field is used to capture device,browser and network information. Refer the developer portal for more information.These are the fields which will be passed as part of the header devicePrint,deviceTokenCookie,userIpAddress,userAgent,hardwareId,simId,deviceModel,deviceName,deviceOsName,deviceOsVersion,multitaskingSupportFlag,languageSupport,wifiMacAddress,cellTowerId,locationAreaCode,rsaApplicationKey,wapClientId,mobileCarrierCode,mobileCountryCode,osId,geoLongitude,geoLatitude,geoHorizontalAccuracy,geoAltitude,geoAltitudeAccuracy,geoSpeed,geoTimestamp,geoStatus,basicServiceSetId,signalStrength,wifiChannel,serviceSetId
Select And Credit Redemption Request
Successful operation.
| Type | Code | Details |
| invalid | invalidRequest | Missing or invalid parameters |
| error | inSufficientPointBalance | The order points cannot be more than available balance of the member |
| error | exceedsMaximumPointsAllowed | Requested amount or points are more than allowed equivalent points. |
| error | notEligibleToRedeem | Member not eligible to order this item |
| error | belowMinimumPointsAllowed | Requested amount or points are less than allowed equivalent points. |
| error | transactionAlreadyRedeemed | Transaction is already redeemed |
| error | errorGeneratingOrderId | Order Id is not generated |
| invalid | invalidPointsAndAmountCombination | Points and amount combination are invalid |
| error | RedemptionNotAllowed | Redemption Not allowed |
| error | exceedsMaximumAmountAllowed | Requested partial amount is greater than maximum transaction amount to be redeemed. |
| error | unAuthorized | Authorization credentials are missing or invalid |
| error | accessNotConfigured | Access is not configured for this resource |
| fatal | serverUnavailable | The request failed due to an internal error/server unavailability |
/v1/apac/rewards/{rewardLinkCode}/redemption
Redeem the credit card reward points
Request for the redemption to be processed for credit card enrolled.
Unique link code per card associated with a member account
The most recent Authorization token. This will have the format Bearer + {space} + {accessToken}. Example: Bearer KGNsaWVudF9pZDpjbGllbnRfc2VjcmV0KQ==.
128 bit random UUID generated uniquely for every request.
Content-Type that are acceptable for the response.
application/json
The client ID you received during application registration in the developer portal
Accept-Language header.
This field is used to capture device,browser and network information. Refer the developer portal for more information.These are the fields which will be passed as part of the header devicePrint,deviceTokenCookie,userIpAddress,userAgent,hardwareId,simId,deviceModel,deviceName,deviceOsName,deviceOsVersion,multitaskingSupportFlag,languageSupport,wifiMacAddress,cellTowerId,locationAreaCode,rsaApplicationKey,wapClientId,mobileCarrierCode,mobileCountryCode,osId,geoLongitude,geoLatitude,geoHorizontalAccuracy,geoAltitude,geoAltitudeAccuracy,geoSpeed,geoTimestamp,geoStatus,basicServiceSetId,signalStrength,wifiChannel,serviceSetId
Redemption information
Successful operation.
| Type | Code | Details |
| invalid | invalidRequest | Missing or invalid parameters |
| error | invalidRewardLinkCode | Reward link code is invalid |
| error | errorGeneratingOrderId | Order Id is not generated |
| error | inSufficientPointBalance | The order points cannot be more than available balance of the member |
| error | exceedsMaximumPointsAllowed | Requested amount or points are more than allowed equivalent points. |
| error | notEligibleToRedeem | Member not eligible to order this item |
| error | belowMinimumPointsAllowed | Requested amount or points are less than allowed equivalent points. |
| error | inactiveRewardLinkCode | Reward link code is inactive |
| error | invalidPointsAndAmountCombination | Points and amount combination are invalid |
| error | currencyNotSupported | Currency is not supported |
| error | transactionAlreadyRedeemed | Transaction is already redeemed |
| error | unAuthorized | Authorization credentials are missing or invalid |
| error | accessNotConfigured | Access is not configured for this resource |
| fatal | serverUnavailable | The request failed due to an internal error/server unavailability |
/v1/rewardsPointsAwardsAndRedemption/transactions/retrieve
Thsi API will be used to inquire the history of redemption details(earned or redeemed) for all the transactions done for the specified period
Thsi API will be used to inquire the history of redemption details(earned or redeemed) for all the transactions done for the specified period
The most recent Authorization token. This will have the format Bearer + {space} + {accessToken}. Example: Bearer KGNsaWVudF9pZDpjbGllbnRfc2VjcmV0KQ==.
128 bit random UUID generated uniquely for every request.
Content-Type that are acceptable for the response.
Client ID generated during application registration.
application/json
This field is used to capture device,browser and network information. Refer the developer portal for more information.These are the fields which will be passed as part of the header devicePrint,deviceTokenCookie,userIpAddress,userAgent,hardwareId,simId,deviceModel,deviceName,deviceOsName,deviceOsVersion,multitaskingSupportFlag,languageSupport,wifiMacAddress,cellTowerId,locationAreaCode,rsaApplicationKey,wapClientId,mobileCarrierCode,mobileCountryCode,osId,geoLongitude,geoLatitude,geoHorizontalAccuracy,geoAltitude,geoAltitudeAccuracy,geoSpeed,geoTimestamp,geoStatus,basicServiceSetId,signalStrength,wifiChannel,serviceSetId
Indicator for retrieving the next records or the previous records in the response
RetrieveRewardPointTransactionRedemptionHistoryRequest
Successful operation.
No content.
| Type | Code | Details |
| invalid | invalidRequest | Missing or invalid Parameters |
| 1 | RWS_6402_0004 | InvalidAccountId |
| Type | Code | Details |
| error | unAuthorized | Authorization credentials are missing or invalid |
| Type | Code | Details |
| error | accessNotConfigured | The request operation is not configured to access this resource |
| error | resourceNotFound | Empty resource/resource not found |
| Type | Code | Details |
| invalid | invalidRequest | Missing or invalid parameters |
| Type | Code | Details |
| fatal | serverUnavailable | The request failed due to an internal error |
/v1/offers/{offerId}/payWithPoints/unused
This API is used to fetch the Pay with points unused offers.
This API is used to fetch the Pay with points unused offers.
The most recent Authorization token. This will have the format Bearer + {space} + {accessToken}. Example: Bearer KGNsaWVudF9pZDpjbGllbnRfc2VjcmV0KQ==.
128 bit random UUID generated uniquely for every request.
Content-Type that are acceptable for the response.
Client ID generated during application registration.
Accept-Language header.
This field is used to capture device,browser and network information. Refer the developer portal for more information.These are the fields which will be passed as part of the header devicePrint,deviceTokenCookie,userIpAddress,userAgent,hardwareId,simId,deviceModel,deviceName,deviceOsName,deviceOsVersion,multitaskingSupportFlag,languageSupport,wifiMacAddress,cellTowerId,locationAreaCode,rsaApplicationKey,wapClientId,mobileCarrierCode,mobileCountryCode,osId,geoLongitude,geoLatitude,geoHorizontalAccuracy,geoAltitude,geoAltitudeAccuracy,geoSpeed,geoTimestamp,geoStatus,basicServiceSetId,signalStrength,wifiChannel,serviceSetId
Unique offer Id associated with the offer.
Successful operation.
No content
| Type | Code | Details |
| invalid | invalidRequest | Missing or invalid parameters |
| error | invalidOfferId | Offer Id is invalid |
| error | customerNotEligible | Customer is not eligible for the offer |
| error | unAuthorized | Authorization credentials are missing or invalid |
| error | accessNotConfigured | Access is not configured for this resource |
| fatal | serverUnavailable | The request failed due to an internal error/server unavailability |
/v1/rewards/payWithPoints/redemption/unusedOffers
This API is used to redeem the Pay with points unused offers.
This API is used to redeem the Pay with points unused offers.
The most recent Authorization token. This will have the format Bearer + {space} + {accessToken}. Example: Bearer KGNsaWVudF9pZDpjbGllbnRfc2VjcmV0KQ==.
128 bit random UUID generated uniquely for every request.
Content-Type that are acceptable for the response.
application/json
The client ID you received during application registration in the developer portal
Accept-Language header.
This field is used to capture device,browser and network information. Refer the developer portal for more information.These are the fields which will be passed as part of the header devicePrint,deviceTokenCookie,userIpAddress,userAgent,hardwareId,simId,deviceModel,deviceName,deviceOsName,deviceOsVersion,multitaskingSupportFlag,languageSupport,wifiMacAddress,cellTowerId,locationAreaCode,rsaApplicationKey,wapClientId,mobileCarrierCode,mobileCountryCode,osId,geoLongitude,geoLatitude,geoHorizontalAccuracy,geoAltitude,geoAltitudeAccuracy,geoSpeed,geoTimestamp,geoStatus,basicServiceSetId,signalStrength,wifiChannel,serviceSetId
RedeemPayWithPointsUnusedOffersRequest
Successful operation.
| Type | Code | Details |
| invalid | invalidRequest | Missing or invalid parameters | error | exceedsMaximumNumberOfTransactions | Maximum number of transactions is exceeded |
| error | unAuthorized | Authorization credentials are missing or invalid |
| error | accessNotConfigured | Access is not configured for this resource |
| fatal | serverUnavailable | The request failed due to an internal error/server unavailability |
/v1/rewards/{rewardLinkCode}/shopWithPoints/reversals
This is to reverse the points redeemed during shop with points
This is to reverse the points redeemed during shop with points
The most recent Authorization token. This will have the format Bearer + {space} + {accessToken}. Example: Bearer KGNsaWVudF9pZDpjbGllbnRfc2VjcmV0KQ==.
128 bit random UUID generated uniquely for every request.
Content-Type that are acceptable for the response.
Client ID generated during application registration.
application/json
This field is used to capture device,browser and network information. Refer the developer portal for more information.These are the fields which will be passed as part of the header devicePrint,deviceTokenCookie,userIpAddress,userAgent,hardwareId,simId,deviceModel,deviceName,deviceOsName,deviceOsVersion,multitaskingSupportFlag,languageSupport,wifiMacAddress,cellTowerId,locationAreaCode,rsaApplicationKey,wapClientId,mobileCarrierCode,mobileCountryCode,osId,geoLongitude,geoLatitude,geoHorizontalAccuracy,geoAltitude,geoAltitudeAccuracy,geoSpeed,geoTimestamp,geoStatus,basicServiceSetId,signalStrength,wifiChannel,serviceSetId
Unique link code issued during registration process.
ShopWithPointsRedemtionReversalRequest
Successful operation.
No content
| error | invalidRequest | Missing or invalid Parameters |
| error | unAuthorized | Authorization credentials are missing or invalid |
| error | accessNotConfigured | Access is not configured for this resource |
| error | resourceNotFound | Resource not found |
| error | customerLocked | Customer is locked |
| error | customerNotEligibleForRedemptionReversal | Customer is not eligible for redemption reversal |
| error | transationAlreadyReversed | Transaction has already been redeemed |
| error | partialRedemptionReversalNotAllowed | Partial redemption reversal is not allowed |
| error | invalidRewardLinkCode | Invalid reward link code |
| error | inactiveRewardLinkCode | Inactve reward link code |
| fatal | serverUnavailable | The request failed due to an internal error |
/v1/rewards/shopWithPoints/redemption/reversals
This is to reverse the points redeemed during shop with points
This is to reverse the points redeemed during shop with points
The most recent Authorization token. This will have the format Bearer + {space} + {accessToken}. Example: Bearer KGNsaWVudF9pZDpjbGllbnRfc2VjcmV0KQ==.
128 bit random UUID generated uniquely for every request.
Content-Type that are acceptable for the response.
Client ID generated during application registration.
application/json
This field is used to capture device,browser and network information. Refer the developer portal for more information.These are the fields which will be passed as part of the header devicePrint,deviceTokenCookie,userIpAddress,userAgent,hardwareId,simId,deviceModel,deviceName,deviceOsName,deviceOsVersion,multitaskingSupportFlag,languageSupport,wifiMacAddress,cellTowerId,locationAreaCode,rsaApplicationKey,wapClientId,mobileCarrierCode,mobileCountryCode,osId,geoLongitude,geoLatitude,geoHorizontalAccuracy,geoAltitude,geoAltitudeAccuracy,geoSpeed,geoTimestamp,geoStatus,basicServiceSetId,signalStrength,wifiChannel,serviceSetId
ShopWithPointsPointRedemptionReversalRequest
Successful operation.
| Type | Code | Details |
| invalid | invalidRequest | Missing or invalid Parameters |
| Type | Code | Details |
| error | unAuthorized | Authorization credentials are missing or invalid |
| Type | Code | Details |
| error | accessNotConfigured | The request operation is not configured to access this resource |
| Type | Code | Details |
| error | resourceNotFound | Empty resource/resource not found |
| Type | Code | Details |
| error | customerNotEligibleForRedemptionReversal | Customer is not eligible for redemption reversal |
| error | partialRedemptionReversalNotAllowed | Partial redemption reversal is not allowed |
| error | transationAlreadyReversed | Transaction has already been redeemed |
| error | customerLocked | Customer is locked |
| Type | Code | Details |
| fatal | serverUnavailable | The request failed due to an internal error |
/v1/rewardPointsAwardsAndRedemption/rewardPrograms/enrollment
This API is for enrollment of rewards program.
This API is for enrollment of rewards program.
The most recent Authorization token. This will have the format Bearer + {space} + {accessToken}. Example: Bearer KGNsaWVudF9pZDpjbGllbnRfc2VjcmV0KQ==.
128 bit random UUID generated uniquely for every request.
Content-Type that are acceptable for the response.
Client ID generated during application registration.
application/json
This field is used to capture device,browser and network information. Refer the developer portal for more information.These are the fields which will be passed as part of the header devicePrint,deviceTokenCookie,userIpAddress,userAgent,hardwareId,simId,deviceModel,deviceName,deviceOsName,deviceOsVersion,multitaskingSupportFlag,languageSupport,wifiMacAddress,cellTowerId,locationAreaCode,rsaApplicationKey,wapClientId,mobileCarrierCode,mobileCountryCode,osId,geoLongitude,geoLatitude,geoHorizontalAccuracy,geoAltitude,geoAltitudeAccuracy,geoSpeed,geoTimestamp,geoStatus,basicServiceSetId,signalStrength,wifiChannel,serviceSetId
RequestRewardPointsTransactionRewardProgramsEnrollmentRequest
Successful operation.
| Type | Code | Details |
| invalid | invalidRequest | Missing or invalid Parameters |
| Type | Code | Details |
| error | unAuthorized | Authorization credentials are missing or invalid |
| Type | Code | Details |
| error | accessNotConfigured | The request operation is not configured to access this resource |
| Type | Code | Details |
| error | resourceNotFound | Empty resource/resource not found |
| Type | Code | Details |
| error | businessValidationsFailed | Business validations failed |
| Error | InvalidProduct | ProductId is invalid |
| Error | InvalidCardId | CardId is invalid |
| Error | InvalidBundle | BundleId is invalid |
| Error | BundleAlreadyEnrolled | Bundle is already enrolled |
| Error | BudnleAwaitingEnrollment | Bundle is awaiting enrollment |
| Error | BundleAwaitingDeEnrollment | Bundle is awaiting deenrollment |
| Type | Code | Details |
| fatal | serverUnavailable | The request failed due to an internal error |
/v1/rewardPointsAwardsAndRedemption/rewardPrograms/disenrollment
This API is for de-enrollment of rewards program.
This API is for de-enrollment of rewards program.
The most recent Authorization token. This will have the format Bearer + {space} + {accessToken}. Example: Bearer KGNsaWVudF9pZDpjbGllbnRfc2VjcmV0KQ==.
128 bit random UUID generated uniquely for every request.
Content-Type that are acceptable for the response.
Client ID generated during application registration.
application/json
This field is used to capture device,browser and network information. Refer the developer portal for more information.These are the fields which will be passed as part of the header devicePrint,deviceTokenCookie,userIpAddress,userAgent,hardwareId,simId,deviceModel,deviceName,deviceOsName,deviceOsVersion,multitaskingSupportFlag,languageSupport,wifiMacAddress,cellTowerId,locationAreaCode,rsaApplicationKey,wapClientId,mobileCarrierCode,mobileCountryCode,osId,geoLongitude,geoLatitude,geoHorizontalAccuracy,geoAltitude,geoAltitudeAccuracy,geoSpeed,geoTimestamp,geoStatus,basicServiceSetId,signalStrength,wifiChannel,serviceSetId
RequestRewardPointsTransactionRewardProgramsDisenrollmentRequest
Successful operation.
| Type | Code | Details |
| invalid | invalidRequest | Missing or invalid Parameters |
| Type | Code | Details |
| error | unAuthorized | Authorization credentials are missing or invalid |
| Type | Code | Details |
| error | accessNotConfigured | The request operation is not configured to access this resource |
| Type | Code | Details |
| error | resourceNotFound | Empty resource/resource not found |
| Type | Code | Details |
| error | businessValidationsFailed | Business validations failed |
| Error | InvalidProduct | ProductId is invalid |
| Error | InvalidCardId | CardId is invalid |
| Error | InvalidBundle | BundleId is invalid |
| Error | BundleAlreadyEnrolled | Bundle is already enrolled |
| Error | BudnleAwaitingEnrollment | Bundle is awaiting enrollment |
| Error | BundleAwaitingDeEnrollment | Bundle is awaiting deenrollment |
| Type | Code | Details |
| fatal | serverUnavailable | The request failed due to an internal error |
/v1/rewards/shopWithPoints/redemption
The customer can buy any item from partners website using his points that have been accumulated on his credit card. There is not point redemption in this case. Points are transferred from customers account to partners account. Partner can then convert the points in currency
The customer can buy any item from partners website using his points that have been accumulated on his credit card. There is not point redemption in this case. Points are transferred from customers account to partners account. Partner can then convert the points in currency
The most recent Authorization token. This will have the format Bearer + {space} + {accessToken}. Example: Bearer KGNsaWVudF9pZDpjbGllbnRfc2VjcmV0KQ==.
128 bit random UUID generated uniquely for every request.
Content-Type that are acceptable for the response.
Client ID generated during application registration.
application/json
This field is used to capture device,browser and network information. Refer the developer portal for more information.These are the fields which will be passed as part of the header devicePrint,deviceTokenCookie,userIpAddress,userAgent,hardwareId,simId,deviceModel,deviceName,deviceOsName,deviceOsVersion,multitaskingSupportFlag,languageSupport,wifiMacAddress,cellTowerId,locationAreaCode,rsaApplicationKey,wapClientId,mobileCarrierCode,mobileCountryCode,osId,geoLongitude,geoLatitude,geoHorizontalAccuracy,geoAltitude,geoAltitudeAccuracy,geoSpeed,geoTimestamp,geoStatus,basicServiceSetId,signalStrength,wifiChannel,serviceSetId
ShopWithPointsPointRedemptionRequest
Successful operation.
This is applicable for scenarios when one or more requests are failed.
| Type | Code | Details |
| invalid | invalidRequest | Missing or invalid Parameters |
| Type | Code | Details |
| error | unAuthorized | Authorization credentials are missing or invalid |
| Type | Code | Details |
| error | accessNotConfigured | The request operation is not configured to access this resource |
| Type | Code | Details |
| error | errorGeneratingOrderId | Order Id is not generated |
| error | inSufficientPointBalance | The order points cannot be more than available balance of the member |
| error | exceedsMaximumPointsAllowed | Requested amount or points are more than allowed equivalent points. |
| error | notEligibleToRedeem | Member not eligible to order this item |
| error | belowMinimumPointsAllowed | Requested amount or points are less than allowed equivalent points. |
| error | inactiveRewardLinkCode | Reward link code is inactive |
| error | invalidPointsAndAmountCombination | Points and amount combination are invalid |
| error | currencyNotSupported | Currency is not supported |
| error | transactionAlreadyRedeemed | Transaction is already redeemed |
| error | RedemptionNotAllowed | Redemption Not allowed |
| Type | Code | Details |
| fatal | serverUnavailable | The request failed due to an internal error |
Definitions
{
"properties": {
"cardId": {
"description": "The card id in encrypted format",
"type": "string",
"example": "3255613852316f2b4d4d796c344e38756339654972776f663745446e6d4c32486f455a4165374a476858343d"
},
"transactionReferenceId": {
"description": "Reference Id to uniquely identify the transaction.This array is deprecated from version 1.1.0 onwards ",
"type": "array",
"example": "10001278",
"items": {
"type": "string"
}
},
"transactions": {
"type": "array",
"items": {
"$ref": "#/definitions/Transactions"
}
}
},
"required": [
"cardId"
]
}
{
"properties": {
"transactionReferenceId": {
"description": "Reference Id to uniquely identify the transaction.",
"type": "string",
"example": "10001278"
},
"transactionAmount": {
"description": "Transaction amount,This field is required for partial rewards redemption.",
"type": "number",
"format": "double",
"example": 800.91
},
"currencyCode": {
"description": "The currency code of the account in ISO 4217 format",
"type": "string",
"example": "SGD"
},
"pointsToRedeem": {
"description": "The points or miles that needs to redeemed. If both transactionAmount and pointsToRedeem are sent, it should be correct combination as per the below programConversionRate logic:pointsToRedeem = RoundOf (transactionAmount/programConversionRate)",
"type": "integer",
"format": "int64",
"example": 2500
},
"transactionDescription": {
"description": "Transaction description from the merchant",
"type": "string",
"example": "Completed"
}
},
"required": [
"transactionReferenceId"
]
}
{
"properties": {
"redemptionDetails": {
"type": "array",
"items": {
"$ref": "#/definitions/RedemptionDetails"
}
},
"availablePointBalance": {
"description": "The new points or miles balance.",
"type": "integer",
"format": "int64",
"example": 6000
},
"actualAvailablePointBalance": {
"description": "The new points or miles balance.",
"type": "number",
"format": "double",
"example": 6000.25
}
},
"required": [
"redemptionDetails"
]
}
{
"properties": {
"orderId": {
"description": "The unique order id.",
"type": "string",
"example": "T25100025"
},
"transactionReferenceId": {
"description": "Reference Id to uniquely identify the transaction.",
"type": "string",
"example": "10001278"
},
"redemptionOrderStatus": {
"description": "This is the status code of the redemption order. This is a reference data field. Please use /v1/utilities/referenceData/{redemptionOrderStatus} resource to get valid value of this field with description.",
"type": "string",
"example": "SUCCESS"
},
"redemptionOrderFailureReason": {
"description": "This field is to indicate the reason of the failure of redemption order. Applicable only in case of any error in redemption.This is a reference data field. Please use /v1/utilities/referenceData/{redemptionOrderFailureReason} resource to get valid value of this field with description.",
"type": "string",
"example": "REDEMPTION_NOT_ALLOWED"
}
},
"required": [
"transactionReferenceId"
]
}
{
"properties": {
"transactionReferenceNumber": {
"description": "This is reference number for the original transaction done at merchant side using the card.",
"type": "string",
"example": "10001278"
},
"redemptionOrder": {
"$ref": "#/definitions/RedemptionOrder"
}
},
"required": [
"transactionReferenceNumber",
"redemptionOrder"
]
}
{
"properties": {
"transactionAmount": {
"description": "The total transaction amount. If both transactionAmount and pointsToRedeem are sent, it should be correct combination as per the below programConversionRate logic: pointsToRedeem = RoundOf (transactionAmount/programConversionRate)",
"type": "number",
"format": "double",
"example": 100.25
},
"currencyCode": {
"description": "The currency code of the account in ISO 4217 format",
"type": "string",
"example": "SGD"
},
"pointsToRedeem": {
"description": "The points or miles that needs to redeemed. If both transactionAmount and pointsToRedeem are sent, it should be correct combination as per the below programConversionRate logic:pointsToRedeem = RoundOf (transactionAmount/programConversionRate)",
"type": "integer",
"format": "int64",
"example": 2500
},
"transactionDescription": {
"description": "Transaction description from the merchant",
"type": "string",
"example": "Completed"
}
},
"required": [
"transactionAmount"
]
}
{
"properties": {
"orderId": {
"description": "The unique order id",
"type": "string",
"example": "T25100025"
},
"availablePointBalance": {
"description": "The new points or miles balance",
"type": "integer",
"format": "int64",
"example": 6000
}
},
"required": [
"orderId"
]
}
{
"properties": {
"cardId": {
"description": "Card number of the customer",
"type": "string",
"example": 12345678987456
},
"startDate": {
"description": "Start Date in ISO 8601 date format YYYY-MM-DD",
"type": "string",
"format": "date",
"example": "8/2/19"
},
"endDate": {
"description": "End Date in ISO 8601 date format YYYY-MM-DD",
"type": "string",
"format": "date",
"example": "9/2/19"
},
"redemptionTransactionIndicator": {
"description": "Type of request. Possible values. - EARN - REDEMPTION - ALL This is a reference data field. Please use /v1/utilities/referenceData/{redemptionTransactionIndicator} resource to get valid value of this field with description.",
"type": "string",
"example": "ALL"
}
},
"required": [
"cardId",
"redemptionTransactionIndicator"
]
}
{
"properties": {
"transactionDetails": {
"type": "array",
"items": {
"$ref": "#/definitions/TransactionDetails"
}
},
"startDate": {
"description": "Start Date in ISO 8601 date format YYYY-MM-DD",
"type": "string",
"format": "date",
"example": "2019-01-01"
},
"endDate": {
"description": "End Date in ISO 8601 date format YYYY-MM-DD",
"type": "string",
"format": "date",
"example": "2019-01-01"
},
"listRs": {
"$ref": "#/definitions/ListRs"
},
"totalRecordsCount": {
"description": "This element gives Total Number of records.",
"type": "integer",
"format": "int32",
"example": 50
}
}
}
{
"properties": {
"transactionDescription": {
"description": "Transaction description",
"type": "string",
"example": "Referral Program"
},
"transactionReferenceId": {
"description": "Unique reference Id of the transaction",
"type": "string",
"example": "ID235687"
},
"transactionDate": {
"description": "Transaction Date in ISO 8601 date format YYYY-MM-DD",
"type": "string",
"format": "date",
"example": "2019-01-01"
},
"transactionRewardPoints": {
"description": "For redemption, number of Points redeemed. For earn, number of Points earned.",
"type": "number",
"format": "integer",
"example": 55
},
"redemptionCategory": {
"description": "Category of redemption. This is a reference data field. Please use /v1/utilities/referenceData/{redemptionCategory} resource to get valid value of this field with description.",
"type": "string",
"example": "SNC"
},
"redemptionStatus": {
"description": "For Redemption, fulfillment status - fulfilled/cancelled. For transaction, earned/reserved. This is a reference data field. Please use /v1/utilities/referenceData/{redemptionStatus} resource to get valid value of this field with description.",
"type": "string",
"example": "FULFILLED"
},
"redemptionTransactionIndicator": {
"description": "Type of request. Possible values. - EARN - REDEMPTION - ALL This is a reference data field. Please use /v1/utilities/referenceData/{redemptionTransactionIndicator} resource to get valid value of this field with description.",
"type": "string",
"example": "EARN or REDEMPTION"
},
"inventoryName": {
"description": "Inventory name is actually used to identify the texture of the merchant name.",
"type": "string",
"example": "Travel Insurance"
},
"merchantName": {
"description": "The merchant name with which this transaction was made with.",
"type": "string",
"example": "ABC Corp."
},
"transactionCashAmount": {
"description": "Cash amount paid for that transaction .",
"type": "number",
"format": "double",
"example": 200
}
},
"required": [
"transactionDescription",
"transactionDate",
"transactionRewardPoints",
"redemptionTransactionIndicator"
]
}
{
"properties": {
"moreIndicator": {
"description": "For pagination - indicates that more records are available for retrieval. Y = more records are available for retrieval, N = no more records are available for retrieval",
"type": "string",
"example": "Y"
},
"nextStartIndex": {
"description": "For pagination - the starting index for retrieving the next page/batch of records. The value of the previous requests listRs.nextStartIndex is echoed back in this field.",
"type": "string",
"example": 51
},
"size": {
"description": "For pagination - the number of records requested for the next page/batch of records.",
"type": "integer",
"format": "int32",
"example": 5
}
}
}
{
"properties": {
"customerId": {
"description": "Unique Id associated with the customer.",
"type": "string",
"example": "P011100000125"
},
"availablePointBalance": {
"type": "number",
"format": "int64",
"description": "Number of rewards points or miles available as per the latest statement generated.",
"example": 10000
},
"customerOfferDetails": {
"type": "array",
"items": {
"$ref": "#/definitions/CustomerOfferDetails"
}
}
},
"required": [
"availablePointBalance"
]
}
{
"properties": {
"accountId": {
"type": "string",
"description": "The customer account identifier in encrypted format.",
"example": "3255613852316f2b4d4d796c344e38756339654972776f663745446e6d4c32486f455a4165374a476858343d"
},
"cardId": {
"description": "The card id in encrypted format.",
"type": "string",
"example": "3255613852316f2b4d4d796c344e38756339654972776f663745446e6d4c32486f455a4165374a476858343d"
},
"productCode": {
"type": "string",
"description": "A unique code that identifies the product",
"example": "0800_VC601"
},
"offerId": {
"description": "Unique offer ID associated with the offer",
"type": "string",
"example": 111000125
},
"transactionAmount": {
"description": "The total transaction amount.",
"type": "number",
"format": "double",
"example": 1000.25
},
"minimuPointsToRedeem": {
"description": "The minimum number of points that can be used towards a purchase",
"type": "number",
"format": "int64",
"example": 10000
},
"programConversionRate": {
"description": "Points to currency conversion rate for the rewards program",
"type": "number",
"format": "double",
"example": 0.2521
},
"merchantName": {
"description": "The merchant name with which this transaction was made.",
"type": "string",
"example": "LAZADA"
},
"transactionReferenceId": {
"description": "This is reference id for the original transaction done at merchant side using the card.",
"type": "string",
"example": "10001278"
},
"redemptionType": {
"description": "It Indicates whether Order is for Subscription or Redemption.. This is a reference data field. Please use /v1/utilities/referenceData/{redemptionType} resource to get possible values of this field with descriptions.",
"type": "string",
"example": "Partial"
},
"minimiumRedemptionAmount": {
"type": "number",
"format": "double",
"description": "Minimum amount available for redemption..",
"example": 100.12
},
"incrementalRedemptionAmount": {
"type": "number",
"format": "double",
"description": "Incremental redemption amount.",
"example": 5.11
},
"maximumRedemptionAmount": {
"type": "number",
"format": "double",
"description": "Maximum amount available for redemption.",
"example": 1000.15
},
"overseasTransactionFlag": {
"description": "Indicator for overseas Transaction.",
"type": "boolean",
"example": true
},
"redemptionDateTimeStamp": {
"description": "Date and time of the redemption.",
"type": "string",
"format": "dateTime",
"example": "2018-11-23T00:00:02+05:00"
}
},
"required": [
"offerId",
"cardId",
"productCode",
"transactionAmount",
"programConversionRate",
"transactionReferenceId",
"redemptionType"
]
}
{
"properties": {
"cardId": {
"description": "The card id in encrypted format.",
"type": "string",
"example": "3255613852316f2b4d4d796f663745446e6d4c32486f455a4165374a476858343d"
},
"redemptionMedia": {
"description": "This field is used to identify the way the offer is sent. This is a reference data field. Please use /v1/utilities/referenceData/{redemptionMedia} resource to get valid value of this field with description.",
"type": "string",
"example": "COPS_1_WAY_SMS"
},
"redemptionOrder": {
"type": "array",
"items": {
"$ref": "#/definitions/RedemptionOrders"
}
}
},
"required": [
"redemptionMedia",
"redemptionOrder",
"cardId"
]
}
{
"properties": {
"pointsToRedeem": {
"description": "The points or miles that needs to redeemed.",
"type": "number",
"format": "int64",
"example": 25000
},
"currencyCode": {
"description": "The currency code of the account in ISO 4217 format",
"type": "string",
"example": "SGD"
},
"transactionReferenceId": {
"description": "This is reference id for the original transaction done at merchant side using the card.",
"type": "string",
"example": "10001278"
}
},
"required": [
"pointsToRedeem",
"currencyCode",
"transactionReferenceId"
]
}
{
"properties": {
"availablePointBalance": {
"type": "number",
"format": "double",
"description": "Available reward points on the credit card",
"example": 1500.25
},
"redemptionOrderStatusDetails": {
"type": "array",
"items": {
"$ref": "#/definitions/RedemptionOrderStatusDetails"
}
}
},
"required": [
"availablePointBalance",
"redemptionOrderStatusDetails"
]
}
{
"properties": {
"transactionReferenceId": {
"description": "This is reference id for the original transaction done at merchant side using the card.",
"type": "string",
"example": "10001278"
},
"redemptionOrderStatus": {
"description": "This is the status code of the redemption order. This is a reference data field. Please use /v1/utilities/referenceData/{redemptionOrderStatus} resource to get valid value of this field with description.",
"type": "string",
"example": "SUCCESS"
},
"redemptionOrderFailureReason": {
"description": "This field is to indicate the reason of the failure of redemption order. Applicable only in case of any error in redemption.",
"type": "string",
"example": "RedemptionNotAllowed"
}
},
"required": [
"transactionReferenceId",
"redemptionOrderStatus"
]
}
{
"properties": {
"orderId": {
"description": "The unique order id",
"type": "string",
"example": "T25100025"
},
"transactionReferenceNumber": {
"description": "This is reference number for the original transaction done at merchant side using the card",
"type": "string",
"example": "CTRRT200"
}
}
}
{
"properties": {
"cardId": {
"description": "The card id in encrypted format",
"type": "string",
"example": "3255613852316f2b4d4d796c344e38756339654972776f663745446e6d4c32486f455a4165374a476858343d"
},
"orderId": {
"description": "The unique order id",
"type": "string",
"example": "T25100025"
},
"transactionReferenceNumber": {
"description": "A unique reference number being generated at the time of show with points Redemption",
"type": "string",
"example": 10000000
}
}
}
{
"properties": {
"cardId": {
"description": "The card id in encrypted format",
"type": "string",
"example": "3255613852316f2b4d4d796c344e38756339654972776f663745446e6d4c32486f455a4165374a476858343d"
},
"transactions": {
"type": "array",
"items": {
"$ref": "#/definitions/Transactions"
}
}
},
"required": [
"cardId"
]
}
{
"properties": {
"availablePointBalance": {
"description": "The new reward points or miles balance after Redemption",
"type": "integer",
"format": "int64",
"example": 6000
},
"redemptionDetails": {
"type": "array",
"items": {
"$ref": "#/definitions/RedemptionDetails"
}
}
}
}
{
"properties": {
"cardId": {
"description": "Card number in encrypted format.",
"type": "string",
"example": "1233446dghg67"
},
"rewardsProgramProductId": {
"description": "Product ID",
"type": "string",
"example": "CREDIT_CARD"
},
"agentId": {
"description": "agent Id",
"type": "string",
"example": "ab67899"
},
"bundleDetails": {
"type": "array",
"items": {
"$ref": "#/definitions/BundleDetails"
}
},
"rewardsProgramType": {
"description": "Reward Program Type",
"type": "string",
"example": "REWARDS_BUNDLE_ENROLLMENT"
}
},
"required": [
"cardId",
"rewardsProgramProductId"
]
}
{
"properties": {
"cardId": {
"description": "Card number in encrypted format.",
"type": "string",
"example": "1233446dghg67"
},
"rewardsProgramProductId": {
"description": "Product ID",
"type": "string",
"example": "CREDIT_CARD"
},
"agentId": {
"description": "agent Id",
"type": "string",
"example": "ab67899"
},
"bundleDetails": {
"type": "array",
"items": {
"$ref": "#/definitions/BundleDetails"
}
},
"rewardsProgramType": {
"description": "Reward Program Type",
"type": "string",
"example": "REWARDS_BUNDLE_ENROLLMENT"
}
},
"required": [
"cardId",
"rewardsProgramProductId"
]
}
{
"properties": {
"bundleId": {
"description": "Bundle ID defined by Biz for the logo",
"type": "string",
"example": "FUN MIL"
},
"bundleName": {
"description": "Bundle Name (Short Name) defined by Biz",
"type": "string",
"example": "Tiered Bundle"
},
"autoRenewalFlag": {
"description": "Bundle auto renewal indicator.",
"type": "boolean",
"example": true
}
},
"required": [
"bundleId",
"bundleName"
]
}
{
"properties": {
"bundleStartDate": {
"description": "Bundle Subscription start date should be in ISO 8601 format YYYY-MM-DD",
"type": "string",
"format": "date",
"example": "2020-10-24"
},
"bundleEndDate": {
"description": "Bundle Subscription End date should be in ISO 8601 format YYYY-MM-DD",
"type": "string",
"format": "date",
"example": "2020-10-24"
}
}
}
{
"properties": {
"type": {
"description": "Invalid - Request did not confirm to the specification and was unprocessed and rejected. Please fix the value and try again",
"enum": [
"error",
"warn",
"invalid",
"fatal"
],
"type": "string"
},
"code": {
"description": "Error code which qualifies the error",
"type": "string"
},
"details": {
"description": "Human readable explanation specific to the occurrence of the problem",
"type": "string"
},
"location": {
"description": "The name of the field that resulted in the error",
"type": "string"
},
"moreInfo": {
"description": "URI to human readable documentation of the error",
"type": "object"
}
},
"required": [
"type",
"code"
]
}