This API can be used to redeem available reward points against available merchandise (gift catalogue) or as a cash credit to the cardholder's account. It can be consumed through various channels such as online banking or mobile banking. The request for available reward point redemption can be used for one purpose at a time; that is, for either cash credit or merchandise. Both options can not be present in the same request. The Credit+ Issuing system receives, validates, and processesthe request. If the request is successful and adheres to business rules, then number of points coming in the request are redeemed from the account's loyalty point bucket. The system logs a service request (SR) as per the redemption type and sends the SR details in the response message. If the request fails, the system returns the corresponding error code in the response and the SR is not logged. The respective SRs are: • Reward Redemption (Merchandise) - Service Code: 512 • Reward Redemption (Cash Credit) - Service Code: 513 Both API request and response are encrypted and the method is same for both request and response attributes. Refer to Message Level Security - AES Encryption section in the CR+ REST API Security Requirements attachment document for detailed information on encryption of JSON payload. Also refer to Reward Redemption API Encryption Header Parameters table under the Request Format of this section for specifications of the encryption header parameters. This API is applicable for prepaid, credit and debit products issued on Pine Labs platform.
NOTE: This API is applicable for general purpose reloadable programs only in case of prepaid products. Further, the device status must not be blocked, cancelled or upgraded and the unpaid status must be normal (0).
HTTP Status and Response Status Matrix
- HTTP Code: This is the response status code issued by a server in response to a client's request made to the server.
- Error Code: This is the error code returned by Credit+ Issuing application in the ‘code’ field of the response message indicating if the request was processed successfully or failed.
- Reason: This is the description of the error code returned by Credit+ Issuing application.
| HTTP Code | Error Code | Reason |
|---|---|---|
| 200 | OK | The server has successfully processed your request. |
| 400 | MISSING_REQUIRED_FIELD | Missing Required Field ''. Error example: Missing Required Field 'redemption.merchandise.giftQuantity'. |
| 400 | INVALID_FIELD_VALUE | '' field value '' is invalid. Error example: 'redemption.type' field value 'CASHes' is invalid. |
| 400 | INVALID_FIELD_FORMAT | '' field value '' format is invalid. Error example: 'Device Number' field value '*****************' format is invalid. |
| 400 | INVALID_FIELD_LENGTH | '' field value length must be between and characters. Error example: Device Number size must be between 4 and 24. |
| 500 | RECORD_NOT_FOUND | Record not found for given search criteria(s) - <Field Name 1>,<Field Name 2>. Error example: Record not found for given search criteria(s) - P_ISD_CODE,P_MOBILE_NUMBER. |
| 400 | CRYPTOGRAPHY_ERROR | Error occurred while decryption of the encrypted request payload. |
| 403 | PERMISSION_DENIED | It seems you don't have permission to access this API. |
| 409 | CONFLICT | The requested operation failed because it tried to create a resource that already exists. |
| 500 | 956 | Available reward points are not sufficient for redemption. |
| 500 | 956 | Co-Brand Partner is not Configured/Available. |
| 500 | 957 | Minimum Redemption Points/ Amount criteria not met. |
| 500 | 957 | Account Unpaid Status is not Normal. |
| 500 | 957 | Loyalty plan is not configured. |
| 500 | 957 | Redeem amount less than the minimum amount set on the loyalty plan. |