Card Renewal API

post

https://uatmea-iss-apigw.creditpluspinelabs.com/deviceapi/apis/v1/cardholder/card/cardrenew

The card renewal API allows the end user or customer to enable or disable the card renewal. This API enables Renewal Option flag at card/device level or disables this flag at card/device level. Based on this flag, the card renewal batch picks this card/device for renewal. This API is effective only when Allow Renewal flag at device plan level is enable. For example, If out of 100 cardsissued under Program X with device level plan A, and you want to renew only 50 cards. Then, the Card Renewal API is called with request parameters, such as card number or card pack ID and renewal yes or no.

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
400	997	Form Factor Type field is mandatory.
400	997	Form Factor Type should be CRD or CPI
400	997	Form Factor field is mandatory
400	997	Device Number is of invalid format
400	997	Card Pack ID is of invalid format
400	997	Renewal flag should be either Yes or No
400	998	Device Number not registered in the system
400	998	No Card Pack ID found for given details
201	999	Allow renewal is disabled. Please contact bank
201	000	Request processed successfully
500	913	Backward offset time limit violated
400	994	Invalid Request - Unrecognized field
400	988	Encryption type Not Supported
400	913	Forward offset time limit violated
400	994	Invalid Encryption - Algorithm header value
400	994	Invalid Encryption Request Parameters
400	994	Cryptography error

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

channel

string

required

length ≤ 2

CSC / AGT / Network Code associated to Acquirer ID.

formFactorType

string

enum

required

Identifies whether the request contains Device Number (CRD) or Card Pack ID (CPI). Must be CRD or CPI.

Allowed:

formFactor

string

required

length between 10 and 24

Card Number or Card Pack ID. Maximum length: 24. Minimum length: 10.

renewalFlag

string

enum

required

Indicates whether renewal is enabled or disabled at the device level. Yes: Renewal option is selected at device level where card is picked for renewal. No: Renewal option is unchecked, if selected at device level and card is not picked for renewal. Must be Yes or No.

Allowed:

timestamp

string

required

^[0-9]+$

Current UTC timestamp in milliseconds. Numeric. AES key expiration criteria depends on input UTC timestamp. Applicable only for encrypted requests.

Headers

Correlation-ID

string

^[a-zA-Z0-9-]{1,50}$

API Consumer must share Correlation-ID in HTTP header for API requests. The Correlation-ID must be unique for each request. It is recommended to generate a universally unique identifier (UUID) of length 32 or 36 that is compliant with RFC 4122. The maximum supported length is 50 alphanumeric characters. For example, ac97d177-9345-4934-8343-0f91a7a02836. If the Correlation-ID is not received in the incoming request, the system generates the UUID dynamically and assigns it to the request.

Encryption-Algorithm

string

enum

required

API Consumer must share Encryption-Algorithm as a key (value: DES168) in HTTP header in order to encrypt the API requests.

Allowed:

Source

string

API Consumer can share Source in HTTP header for API requests. For the list of Source values, see the Pre-conditions for HTTP Header of REST API topic in the Pre-requisite for Rest API section.

Response

Language

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

201Request processed successfully