Statement Request API

This API is used to retrieve up to latest three months' generated statements. The Credit+ Issuing system receives, validates and returnsthe statement detailsfor each month in XML format.
NOTE: This API is applicable for e-mail statement mode only. Further, this API, if sent with Card Number Alias (CNA), will fetch the corresponding associated device for further processing only if DEVICE _STATUS_CODE = NORMAL (0) OR (DEVICE_STATUS_CODE = UPGRADE (9) AND UPGRADE_STATUS = 1).

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 CodeError CodesReason
201HDS000Request processed successfully.
400997Incorrect Month's value passed, should be 1 or 2 or 3.
403900Invalid User.
404998Device Number does not exists.
400997Product type not supported.
400997Product Type field is invalid.
400997Only alphanumeric characters and underscore are allowed.
400997Program Code field should only contain [A-Z 0-9] and underscore and must start and end with alphanumeric character.
400997Program Code field value must have max length 6.
400997Device Plan Code field should only contain [A-Z 0-9] and underscore and must start and end with alphanumeric character.
400997Device status is not supported.
500999Statement not available for last months Data parameter
500999Inactive Wallet.
400997Device Plan Code field value must have max length 10.
400CNA005Multiple device numbers are active for given details.
400CNA003Record does not exists for the given details.
400CNA001Bank Does Not Exists
400CNA002Card Number Alias Functionality is not applicable for this Institution
400CNA006Error while fetching device details.
400997Card Number Alias field value must have max length 24.
500913Backward offset time limit violated.
400994Invalid Request - Unrecognized field.
400988Encryption type Not Supported.
400913Forward offset time limit violated.
400994Invalid Encryption-Algorithm header value
400994Invalid Encryption Request Parameters
400994Cryptography error
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
enum
required
length ≤ 3

Identifies if it is a Card Number (CRD) or Card Number Alias (CNA). Not NULL. Must be CRD or CNA. Maximum length: 3.

Allowed:
string
required
length between 10 and 24

Card Number or Card Number Alias. Not NULL. Maximum length: 24. Minimum length: 10 (not applicable for CNA).

string
enum
required
length ≤ 1

Number of past statements to retrieve. Must be 1, 2, or 3. Length: 1.

Allowed:
cnaParameters
object

Parameters required when formFactorType is CNA and multiple devices are linked.

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
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.

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:
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
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json