Device Limit Update API

post

https://uatmea-iss-apigw.creditpluspinelabs.com/deviceapi/apis/v1/services/cardholder/deviceLimitUpdate

This API is used by the cardholder to manage and set transaction limits. The Credit+ Issuing system receives, validates, and processesthe request. If the request is successful, the cardholder specific transaction limit plan is attached at the device level. You cannot update the transaction limit for a refund transaction using this API. For more details about configurations for routing refund transactions refer to the Appendix section.

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
201	000	Successful.
400	997	productType field is mandatory.
400	997	productType field is invalid.
400	900	User Or Bank does not support API.
400	997	formFactorType field is mandatory.
400	997	formFactorType field value must have size 3.
400	997	formFactorType field is invalid.
400	997	formfactor field is mandatory.
400	997	formFactor field value must have max length 24.
400	997	formFactor field value must have min length 10.
400	997	Only alphanumeric characters and special characters [_!'()*+,-.] are allowed.
400	997	Program Code field should only contain [A-Z 0-9] and underscore and must start and end with alphanumeric character.
400	997	Program Code field value must have max length 10.
400	997	Device Plan Code field should only contain [A-Z 0-9] and underscore and must start and end with alphanumeric character.
400	997	Device Plan Code field value must have max length 10.
400	997	limits field is mandatory.
400	997	Limits field max size limit reached.
400	997	{} field is mandatory.
400	997	transactionType field value must have size 2.
400	997	transactionSource field value must have size 3.
400	997	{} field is invalid.
400	997	Found duplicate limits.
400	997	Invalid Floor Amount field.
400	997	Invalid Ceiling Amount field.
400	997	Invalid Daily Amount field.
400	997	Invalid Periodic Amount field.
400	997	Invalid Yearly Amount field.
400	997	Floor Amount should not be greater than Ceiling Amount.
400	997	Ceiling Amount should not be greater than Daily Amount.
400	997	Ceiling Amount should not be greater than Periodic Amount.
400	997	Ceiling Amount should not be greater than Yearly Amount.
400	997	Daily Amount should not be greater than Periodic Amount.
400	997	Daily Amount should not be greater than Yearly Amount.
400	997	Periodic Amount should not be greater than Yearly Amount.
400	997	{} field must be a positive value with maximum 12 integers and 0 fractions.
400	997	Invalid Transaction Channel.
400	997	Invalid combination of Transaction Type and Transaction Source.
400	997	Transaction Channel field is invalid.
400	CNA002	Card Number Alias Functionality is not applicable for this Institution.
400	CNA003	Record does not exists for the given details.
400	CNA005	Multiple device numbers are linked for given details.
400	998	Device Number does not exist.
400	901	Device is cancelled.
400	901	Device is replaced.
400	901	Device is expired.
400	999	Generating invalid limit plan code.
400	994	Invalid Request - Unrecognized field.
401	900	Access is denied.
500	912	Forward offset time limit violated.
500	913	Backward offset time limit violated.
500	999	Internal error.
400	994	Invalid Encryption-Algorithm header value.
400	994	Invalid Encryption Request Parameters.
400	994	Cryptography error.
400	997	Refund Transaction’s Limit Update is not allowed.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

formFactorType

string

enum

required

length between 3 and 3

Indicates the data that is being sent in the formFactor attribute, identifies whether formFactor is Card Pack ID (CPI), Card Number Alias (CNA), or Card Number (CRD), not null.

Allowed:

formFactor

string

required

length between 10 and 24

Indicates Card Number, Card Pack ID, or Card Number Alias depending on the formFactorType value, if formFactorType is 'CPI' then this field is Card Pack ID, if formFactorType is 'CNA' then this field is Card Number Alias, if formFactorType is 'CRD' then this field is Card Number, not null, minimum length not applicable for CNA.

productType

string

enum

required

length between 1 and 1

Product type of the device, valid values: P (Prepaid), C (Credit), D (Debit).

Allowed:

programCode

string

length ≤ 10

^[A-Z0-9][A-Z0-9_]*[A-Z0-9]$

Program attached to the device, [A-Z 0-9] and underscore are allowed, required only when formFactorType is CNA and multiple devices are linked with same CNA.

devicePlanCode

string

length ≤ 10

^[A-Z0-9][A-Z0-9_]*[A-Z0-9]$

Device Plan Code, [A-Z 0-9] and underscore are allowed, required only when formFactorType is CNA and multiple devices are linked with same CNA.

limits

array of objects

required

length ≤ 20

List of transaction limits, maximum length: 20.

limits*

timestamp

string

^[0-9]+$

Current UTC timestamp in milliseconds, AES key expiration criteria depends on input UTC timestamp, applicable 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

200Successful operation