Prepaid Statement Request API

post

https://uatmea-iss-apigw.creditpluspinelabs.com/deviceapi/apis/statements/prepaids/searches

This API can be used to retrieve maximum three prepaid statements within provided date range or up to latest three months prepaid statements. The API can be accessed through various sources such as mobile application or net banking or any other Issuer application to get a prepaid device statement. A consolidated statement data for Primary, Add-On and Supplementary devices will be sent in the API response. The request call is made using form factor as either of client code, mobile number, device number, device number alias or card pack ID. Both API request and response are encrypted using AES encryption.

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	INVALID_FIELD_FORMAT	'client.profile.birthDate' field value '1-Jan' format is invalid
400	INVALID_FIELD_LENGTH	'client.mobile.isdCode' size must be between 1 and 3.
400	CRYPTOGRAPHY_ERROR	Error occurred while decryption of the encrypted request payload.
400	UNIQUE_RECORD_NOT_FOUND	Multiple records found for given search criteria.
403	PERMISSION_DENIED	It seems you don't have permission to access this API.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

publicKeyFingerprint

string

required

The hex-encoded SHA-256 digest of the recipient's RSA public key used for encryption, which serves as an identifier for the key.

encryptedKey

string

required

One-time use AES key encrypted by the Pinelabs public key (as identified by publicKeyFingerprint) using the PKCS#1 v1.5 scheme. It must be hex-encoded.

oaepPaddingDigestAlgorithm

string

Indicates the digest algorithm used with the RSA-OAEP scheme.

string

The initialization vector used when encrypting data using the one-time use AES key. Must be exactly 16 bytes (32-character hex string) to match the block size. If not present, an IV of zero is assumed.

encryptedValue

string

CDM request data to be encrypted by the ephemeral AES key using CBC mode (IV as provided in 'iv', or zero if none provided) and PKCS#7 padding. It must be hex-encoded.

filter

object

required

client

object

required

device

object

required

statementFilters

object

required

dataValidUntilTimestamp

date-time

required

length ≤ 29

The date and time after which this encrypted data object is considered invalid. Expressed in ISO-8601 extended format.

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:

Response

Language

URL

Loading…

Response

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

application/json

200Successful operation