Transaction Limit Inquiry API - Client

get

https://uatmea-iss-apigw.creditpluspinelabs.com/deviceapi/apis/transaction-limits/client/{client_code}

This API is used to retrieve transaction type wise limits configured at devices, associated device plans, and wallet level that are linked with a specific client ID. The API response is encrypted. 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 Transaction Limit Inquiry API - Client Encryption Parameters table under the Response Format of this section for specifications of the encryption parameters.

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 successfully processed the request.
400	MISSING_REQUIRED_FIELD	Error example: Missing Required Field 'productType'.
400	INVALID_FIELD_VALUE	'productType' field value 'pre-paid' is invalid.
400	RECORD_NOT_FOUND	Device record not found based on the given input.
400	UNIQUE_RECORD_NOT_FOUND	Multiple records found for given search criteria.
401	UNAUTHORIZED	We couldn't recognize you.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

client_code

string

required

API consumer must share client_code as a path parameter for API requests.

Query Params

offset

integer

≥ 0

API consumer can share offset as a query parameter for API requests. This is the number of items to skip before starting to collect the result.

limit

integer

≥ 1

Defaults to 10

API consumer can share limit as a query parameter for API requests. This is the maximum numbers of items to be returned in response. Default values are as configured in Institution Parameter Setup > System Codes against TYPE_ID = API_SEARCH_FILTER_LIMIT and CODE = LMTC. The system code value is non-editable and set to 10 records.

Headers

X-MC-Correlation-ID

string

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

API consumer can share X-MC-Correlation-ID in HTTP header for API requests. If it is not shared then the system generates a unique value for each request. X-MC-Correlation-ID must be unique for each request, Maximum supported length – 100 alphanumeric characters.

X-MC-Source

string

API consumer can share X-MC-Source (optional field) 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.

X-MC-Channel

string

enum

API consumer can share X-MC-Channel (optional field) in HTTP header for API requests. It is the network or channel through which request is routed. The only available value for Channel is API.

Allowed:

X-MC-Client-Client-Application-User-ID

string

length ≤ 50

API consumer can share X-MC-Client-Client-Application-User-ID in HTTP header for API requests. This is a unique identifier to track actual user performing action at the client's end. This field is used only for logging purpose. The maximum length is 50.

X-MC-Public-Key-Fingerprint

string

length ≤ 64

API consumer can share X-MC-Public-Key-Fingerprint as a header parameter for API requests. This is the hex-encoded SHA-256 digest of the recipient's RSA public key used for encryption, which serves as an identifier for the key. Maximum length: 64.

X-MC-Oaep-Padding-Digest-Algorithm

string

enum

X-MC-Oaep-Padding-Digest-Algorithm header parameter is reserved for future use in API requests. It indicates the digest algorithm used with the RSA-OAEP scheme. Currently, this field should be omitted or NONE value should be passed.

Allowed:

X-MC-Encrypted-Key

string

length ≤ 512

API consumer can share X-MC-Encrypted-Key as a header parameter for API requests. It is one-time use AES session key encrypted by the Pine Labs public key (as identified by X-MC-Public-Key-Fingerprint) using the OAEP or PKCS#1 v1.5 scheme (depending on the value of X-MC-Oaep-Padding-Digest-Algorithm). It is Hex-encoded and case-insensitive. Maximum length: 512.

X-MC-IV

string

length ≤ 32

^[0-9a-fA-F]{32}$

API consumer can share X-MC-IV as a header parameter for API requests. It is the initialization vector (IV) used when encrypting data using the one-time use AES key. It must be exactly 16 bytes (32 character hex string, case-insensitive) to match the block size. If not present, an IV of zero is assumed. Maximum length: 32.

Response

200Successful response with transaction limit details