Statement Request on IVR API (V3)

post

https://uatmea-iss-apigw.creditpluspinelabs.com/deviceapi/apis/v3/services/helpdesk/statementlog

This API is used to send statements on requests initiated through IVR to customers. The Credit+ Issuing system receives, validates and processes the request. If the request fails, the system returns the corresponding error code in the response and the entry for batch is not logged in system. The statement will be generated based on provided date parameters. However, if only one date parameter is provided, that is either from date or to date, then the latest month’s statement will be generated. If the statement is not generated for the current month, the request fails, and an error message is returned in response. It is applicable for credit and prepaid product issued on Pine Labs platform. This API is also applicable for Static Virtual Active primary devices.

NOTE: This API is applicable for e-mail statement mode only. This API is used for the same purposes as ‘Statement Request on IVR API (V1)’. However, this API is encrypted and has additional request and response attributes. Further this API, ifsent 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 Code	Error Code	Reason
201	CCRBO0004	Request processed successfully.
400	997	Form Factor Type field is mandatory.
400	997	Invalid Form Factor Type.
400	997	Form Factor field value must have min length 10.
400	997	Form Factor field is mandatory.
400	997	Form Factor field value must have max length 24.
400	997	One of the Dates not provided correctly.
400	997	Statement Period From must be in ddMMyyyy format.
400	997	Statement Period From field is mandatory.
400	997	Statement Period To must be in ddMMyyyy format.
400	997	Statement Mode field is mandatory.
400	997	Invalid Statement Mode.
400	997	Invalid Priority Request.
400	997	At least one transaction channel required.
400	VALFRM003	Invalid Device.
400	VALFRM004	Invalid Device.
400	VALFRM005	Invalid Card Pack Id.
400	VALFRM007	Invalid form factor type.
400	VALFRM015	Statement request not allowed for Debit product.
400	STMREQ011	Preferred address not present.
400	STMREQ010	Email-id not present.
400	STMREQ007	Statement Period To is mandatory for Prepaid device.
400	STMREQ005	Statement Period To not allowed for credit device.
400	STMREQ003	Statement not generated for the given period.
400	STMREQ009	Error while statement log req.
400	STMREQ000	Request Processed Successfully.
201	HDS000	Request processed successfully.
400	HDE192	Statement for specified date range not available.
500	HDE105	Error Occurred as Value not specified for Statement By.
500	HDE107	Error Occurred as Email ID not specified.
500	HDE108	Error in fetching Email ID from Device.
400	HDE109	Error Occurred as Email ID not specified in Device table.
400	HDE110	Error Occurred as Email ID is not matching with Device Email ID.
500	HDE111	Error Occurred while generating statement.
500	HDE112	Error Occurred while generating statement fees.
500	HDE113	Error Occurred while generating statement.
400	997	Program 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 should only contain [A-Z 0-9] and underscore and must start and end with alphanumeric character.
400	997	Product Type field is invalid.
400	997	Only alphanumeric characters and underscore are allowed.
400	997	FORM_FACTOR field value must have max length 24.
400	CNA006	Multiple device numbers are active for given details.
400	CNA002	Card Number Alias Functionality is not applicable for this Institution.
400	CNA003	Record does not exists for the given details.
400	CNA001	Bank Does Not Exists.
400	994	Invalid Encryption-Algorithm header value.
400	994	Invalid Encryption Request Parameters.
400	994	Cryptography error.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

priorityRequest

string

enum

It denotes whether the request is to be taken on priority or not. Valid values: 0 (No priority), 1 (Priority request)

Allowed:

note

string

length ≤ 4000

Any free text that requestor may want to send for logging purpose

formFactorType

string

enum

required

length ≤ 3

To identify if it is a Card Number or Card Pack ID or Card Number Alias. Valid values: CRD (Card Number), CPI (Card Pack ID), CNA (Card Number Alias, valid only if CNA functionality is turned on for the institution)

Allowed:

formFactor

string

required

length between 10 and 24

Card Number or Card Pack ID or Card Number Alias depending on the formFactorType value. Minimum length of 10 not applicable for CNA

stmtPeriodFrom

string

required

^(0[1-9]|[12]\d|3[01])(0[1-9]|1[0-2])\d{4}$

The system will retrieve the statement that is generated just after the date provided here. Format: DDMMYYYY

stmtPeriodTo

string

required

^(0[1-9]|[12]\d|3[01])(0[1-9]|1[0-2])\d{4}$

End date of the time period till which statement is required. Format: DDMMYYYY

statementMode

string

enum

required

Indicates the statement mode in which it will be delivered. Valid value: E (E-mail)

Allowed:

channel

string

length ≤ 10

Channel through which requests are performed

productType

string

enum

Product type of Device. Valid values: P (Pre-paid), C (Credit), D. Required only when formFactorType is CNA and multiple devices are linked with same CNA

Allowed:

devicePlan

string

length ≤ 10

^[a-zA-Z0-9][a-zA-Z0-9_]*[a-zA-Z0-9]$

Device Plan Code attached with the device. Required only when formFactorType is CNA and multiple devices are linked with same CNA

program

string

length ≤ 6

^[a-zA-Z0-9][a-zA-Z0-9_]*[a-zA-Z0-9]$

Program attached to the device. Required only when formFactorType is CNA and multiple devices are linked with same CNA

timestamp

string

required

^\d{13}$

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

201Successful statement request