Loan Installment Inquiry API

post

https://uatmea-iss-apigw.creditpluspinelabs.com/deviceapi/apis/loans/inquiries

This API allows inquiry of two types of use cases – pre loan booking and post loan booking. In case of post loan booking existing open or in-progress loan account details can be responded along with complete repayment schedule. For pre loan booking case, the issuer can inquire the installment details even before actual loan booking for a specific cardholder for the specific type of loan. Both API request and response are encrypted and the method is same for both request and response attributes. Refer to the Message Level Security - AES Encryption section in the CR+ REST API Security Requirements attachment document for detailed information on encryption of JSON payload. It is applicable for credit product issued on Pine Labs platform.

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
400	RECORD_NOT_FOUND	Either Loan Type or Loan Amount or Number of Instalments Should Be Mandatory
400	RECORD_NOT_FOUND	Entered Device number or Card Pack Id is Invalid
400	RECORD_NOT_FOUND	Device plan code and Program code is mandatory for CNA
400	ALIAS_CAPABILITY_NOT_ENABLED	Alias capability not enabled
400	UNIQUE_RECORD_NOT_FOUND	Multiple records found for given search criteria for CNA
400	RECORD_NOT_FOUND	Entered Values Data is not found for CNA
400	DEVICE_STATUS_NOT_SUPPORTED	Device, Operation not permitted
400	INVALID_FIELD_VALUE	Wallet Admin and Unpaid Status should Be Normal
400	INVALID_FIELD_VALUE	Loan Plan Code and Loan Type combination should be Unique
400	RECORD_NOT_FOUND	No matching Loan plan found with input values
400	INVALID_FIELD_VALUE	Loan Booking Date Should Be More Than The Institution Date

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

dataValidUntilTimestamp

date-time

required

length between 20 and 29

The date/time after which request is considered as invalid. If this timestamp is less than the current timestamp of institution, the current request (encrypted payload) is treated as invalid request. Expressed in ISO 8601 extended format. Must be either YYYY-MM-DDThh:mm:ss[.sss]Z or YYYY-MM-DDThh:mm:ss[.sss]±hh:mm where [.sss] is optional and can be 1 to 3 digits.

device

object

required

existingLoan

boolean

required

Indicates inquiry is related to existing loan. Valid values are true (Post loan booking inquiry), false (Pre loan booking inquiry).

loanType

string

enum

required

length between 4 and 7

Loan Type. Valid values are LOANPUR (Retail Transaction to Loan), ALOP (Loan Above Credit Limit), LOANCSH (Loan Below Cash Limit), LOANCR (Loan Below Credit Limit), LOANBT (Balance Transfer to Loan), LOANOTE (Outstanding to EMI), LOANEPP (Easy Pay Plan, Only Fixed Plan Type), LOANDD (Dial a Draft), LOANRTI (Retail Transaction to Loan, OBS by MCI, applicable only for existing loans), EAPOS (EMI at POS, applicable only for existing loans, loan outstanding should be greater than zero). Wallet Admin Status and Unpaid status should be Normal for all loan type except Easy Pay Plan Loan type.

loanAccountNumber

string

length between 15 and 15

Loan account number generated after booking the loan. Loan status must be open or in-progress. Loan account number must be blank for pre-loan booking inquiry usages. Valid loan account number of the cardholder.

loanPlanCode

string

length between 4 and 10

Loan Plan Code of a device linked to the chosen Loan Type. Denotes the validation required against the defined loan plans.

loanAmount

number

1 to 9999999999.99999

Loan Amount. Applicable for pre-loan booking inquiry usages. Validated for loan amount eligibility and credit limit (if applicable for the chosen loan type). For existing loan, if the values of this field is sent in request, then the request is rejected.

noOfInstallments

integer

1 to 999

Desirable tenure for loan conversion. Mandatory for pre-loan booking inquiry usages. Must be within Min/Max Loan Installment Number from Loan Plans.

interestRate

number

0 to 99.99

Annual Interest Rate for loan conversion. Must be same as available on loan account of cardholder.

installmentFrequency

string

length between 7 and 7

Installment Frequency. Default value is monthly. Applicable for pre-loan booking inquiry usages.

bookingDate

string

length between 10 and 10

Desirable date of loan booking/processing. Format: YYYY-MM-DD. Applicable for pre-loan booking inquiry usages. If booking date is not provided, then the institution date is considered for installment computation purpose.

moratoriumPeriod

integer

0 to 999

Number of Days by which 1st Installment to be delayed processing. Applicable for pre-loan booking inquiry usages. Must be less than the max moratorium period configured against chosen or applicable loan plans.

timestamp

string

required

Current UTC timestamp in milliseconds. DES key expiration criteria depends on input UTC timestamp.

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-Application-User-ID

string

length ≤ 50

API consumer can share X-MC-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.

Response

200Successful retrieval of loan installment details.