API Reference

Mini Statement for Prepaid and Credit Card API (V2)

post
https://uatmea-iss-apigw.creditpluspinelabs.com/deviceapi/apis/v2/services/cardholder/miniStatement

This API is used to get the mini statement. This API is used for the same purposes as ‘Mini statementfor Prepaid card and Credit card API (V1)’. However, this API has additional response attribute(s).
Depending on the request, the system validates the following details:The system verifies if the Allow Mini Statement API flag is selected for the current status of the device used, on the Card Management> Institution Parameter Setup> Device Status screen.
• If the flag is enabled and the request is a financial request, the request is processed according to the response code of the device status.
• If the response code is in approved stage, the request is processed further.
• If the value of DEVICE_STATUS_CODE = UPGRADE (9) AND UPGRADE_STATUS = 1 for a financial transaction, the request is approved irrespective of the response code for program change status.
• If the value of DEVICE_STATUS_CODE = UPGRADE (9) AND UPGRADE_STATUS = 2 for a financial transaction, the request is processed according to the response code of the device status.
• If the account is in Freeze status and fee is not applicable, and the Allow Mini Statement API flag is selected in the Device Status screen, the API request is processed successfully.
• If the account isin Freeze status and fee is applicable, the API request is not processed. An error message 'Transaction not permitted' is displayed.

Card Number Alias (CNA) processing logic- Institution level uniqueness

  1. If the system locates a device with status code as Normal (0) or Upgrade (9 with upgrade status as 1), then that device is used for processing the request.
  2. If the system locates two devices; one with status code as Normal (0) and another with status code as Upgrade (9 with upgrade status as 1), and both have the same client ID, then the device with status code as Upgrade isselected and the request is processed on that device.
  3. If the CNA is linked to multiple devices with status code as Normal (0) or Upgrade (9 with upgrade status as 1), the request is rejected.
  4. If the system does not find any device with status code as per step 1 and 2, then the system tries to find the CNA linked to only one device in Cancelled status. If found, the device is used for further processing the request.
  5. If the system does not find any device with status code as perstep 4, then system tries to find the CNA linked to the latest device. The device is used for further processing the request. This does not include CNA that is linked to a device with status as Cancelled.

Card Number Alias (CNA) processing logic- Device level uniqueness

  1. If the system locates a device with status code as Normal (0) or Upgrade (9 with upgrade status as 1), then that device is used for processing the request.
  2. If the system locates two devices; one with status code as Normal (0) and another with status code as Upgrade (9 with upgrade status as 1), and both have the same client ID, then the device with status code as Upgrade isselected and the request is processed on that device.
  3. If the CNA is linked to multiple devices with status code as Normal (0) or Upgrade (9 with upgrade status as 1), the request is rejected.
  4. If the system does not find any device with status code as per step 1 and 2, then the system tries to find the CNA linked to only one device in Cancelled status. If found, the device is used for further processing the request.
  5. If the system does not find any device with status code as per step 4, then the system checksifthe Device Plan Code and Program Code are present in API request. If found, the system tries to locate the CNA linked to the latest device. The device is used for further processing the request. This does not include CNA that islinked to a device with status as Cancelled.
    Once the Mini Statement API validation issuccessful, the statement details are sent as a response message.

Why would I need to use this resource?
Third party enables the transaction history and services to cardholder using this API resource. In case of prepaid and credit card cardholders, you can fetch the ministatement based on the date range or can fetch the last transactions performed on the respective card. The maximum number of transactions records is displayed in the response as configured in the Institution Parameter Setup > System Codes against TYPE_ID = MINI_STMT_API_MAX_TXNS

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 CodeReason
400997Invalid Request Type.
400997Form Factor Type field is mandatory.
400997Form Factor Type field is invalid.
400997Form Factor field is mandatory.
400997Form Factor field value must have max length 24.
400997Form Factor field value must have min length 10.
400997RRN field is mandatory.
400997RRN field should be numeric.
400997RRN field value must have size 12.
400997Trace Audit Number field is mandatory.
400997Trace Audit Number field should be numeric.
400997Trace Audit Number field value must have size 6.
400997Transaction Flag field is mandatory.
400997Transaction Flag field is invalid.
400997From Date field is mandatory.
400997From Date field must be in MMddyyyy format.
400997TO Date field is mandatory.
400997TO Date field must be in MMddyyyy format.
400997Request Txn Count is not allowed for 'Transaction Flag' : 0.
400997From Date is not allowed for 'Transaction Flag' : 1.
400997To Date is not allowed for 'Transaction Flag' : 1.
400997Request Txn Count field is mandatory.
400997Request Txn Count field should be numeric.
400997Request Txn Count field value must have max length 2.
400997Request Txn Count exceeds for 'Transaction Flag' : 1 'range 1 - 60'.
400997Note field value must have max length 100.
400997Form Factor Expiry Date field is mandatory.
400997Form Factor Expiry Date field must be in yyMM format.
400997No of months allowed exceeds for 'Transaction Flag' : 0 'range 1 - 6'.
400997Internal Error.
400997Product type is currently not supported.
404998Device Number does not exist.
500999Internal error.
201000No Transaction Available.
400997Only alphanumeric characters and underscore are allowed.
400997Product Type field is invalid.
400997Program Code field value must have max length 6.
400997Program Code field should only contain [A-Z 0-9] and underscore and must start and end with alphanumeric character.
400997Device Plan Code field should only contain [A-Z 0-9] and underscore and must start and end with alphanumeric character.
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.
400997Device Plan Code and Program Code are mandatory in request.
400API_TXN_NOT_PERMITTEDTransaction not permitted to card holder.
400CPI_MULTIPLE_DEVICE_FOUNDMultiple device numbers are active for given details.
400CPI_NO_DEVICE_FOUNDRecord does not exists for the given details.
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string

CSC / AGT / Network Code associated to Acquirer ID (31 for API).

string
enum
required

Identifies whether the formFactor value is a card number, card number alias or card pack ID. Valid values: CRD (Card Number), CNA (Card Number Alias), CPI (Card Pack ID). Not NULL. Fix length. Either CRD, CNA or CPI.

Allowed:
string
required
length between 10 and 24

This attribute’s value depends on the selected formFactorType value. If formFactorType: 'CRD', it is the card number. If formFactorType: 'CNA', it is the card number alias. If formFactorType: CPI, it is the card pack ID. Not Null. Maximum length 24. Minimum length 10 (minimum length is not applicable for CNA).

string
required
length between 12 and 12
^[0-9]{12}$

(Reference Retrieval Number). It can be used to retrieve the original transaction data. It is Mandatory and a Unique Authorization Reference Number (Reference Retrieval Number). Not Null. Fix length 12. Numeric.

string
enum
required

Valid Values: 0 or 1. 0: Date range defined in ‘fromDate’ and ‘toDate’ field. Maximum range that can be defined is for last 6 months. 1: Last ‘n’ transactions. 'n' is user input defined in ‘requestTxnCount’ field. Maximum 100 transactions can be returned in response for date range or last 'n' transactions.

Allowed:
string
^\d{2}\d{2}\d{4}$

Transactions done after this date will be part of the response. MMDDYYYY format. Must be present if the ‘transactionFlag’ is 0.

string
^\d{2}\d{2}\d{4}$

Transactions done till this date will be part of response. MMDDYYYY format. Please note that this becomes mandatory if ‘fromDate’ is provided. Must be present if the ‘transactionFlag’ is 0.

string
length ≤ 3
^[0-9]+$

Number of transactions to be displayed in the ministatement. It can contain value less than or equal to 100. If greater than 100, then error will be sent. Must be present if the ‘transactionFlag’ is 1. requestTxnCount should not be greater than maximum number of records configured at the institution.

string
^[0-9]+$

It is the start of records from which the transaction details are sent. Numeric. startOffset is mandatory if endOffset is provided. startOffset should be less than endOffset. NOTE: Maximum number of transaction records are sent in the response based on the parameter defined in the MINI_STMT_API_MAX_TXNS system code.

string
^[0-9]+$

It is the end of records till which the transaction details are sent. Numeric. endOffset is mandatory if startOffset is provided. NOTE: Maximum number of transaction records are sent in the response based on the parameter defined in the MINI_STMT_API_MAX_TXNS system code.

string
length between 4 and 4
^\d{2}\d{2}$

It is the date on which the card number will expire. For formFactorType: CRD, Not NULL, Fix length 4, Date format YYMM, Numeric. For formFactorType: CPI, It should be Null.

string
length ≤ 100

Free text description of the request. If it is present, then Maximum length is 100.

string
required
length between 6 and 6
^[0-9]{6}$

A number assigned by the originator of a transaction to uniquely identify a transaction throughout its life. Fix length 6. Not Null.

string

MCC is used to classify the business by the type of goods or services it provides.

string

Identification code of acceptor terminal. This is mandatory for Closed Loop Programs.

string

Identification of acquiring entity. This is mandatory for Closed Loop Programs.

string
enum

Product type of Device. Allowed values (P/C/D). This field is required only when formFactorType is CNA and multiple devices are linked with same CNA.

Allowed:
string
length ≤ 6
^[A-Z0-9_]+$

Program attached to the device. Maximum Length: 6. This field is required only when formFactorType is CNA and multiple devices are linked with same CNA.

string
length ≤ 10
^[A-Z0-9_]+$

Device Plan Code attached with the device. Maximum Length: 10. This field is required only when formFactorType is CNA and multiple devices are linked with same CNA.

string
length between 12 and 12

A unique authorization reference number (Reference Retrieval Number). It retrieves the transaction data for a specific transaction. Fixed Length: 12. Alphanumeric.

string
length between 6 and 6

Trace audit number to retrieve the status of a specific transaction. Fixed Length: 6. Alphanumeric.

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

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

Updated about 1 year ago

Did this page help you?
Language
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 1 year ago

Did this page help you?