API Reference

Outstanding to EMI API

post
https://uatmea-iss-apigw.creditpluspinelabs.com/deviceapi/apis/v1/services/helpdesk/outstandingtoemi

This API is used to convert partial or full outstanding amount into EMIs for requests received through various channels such as online banking or mobile banking.
The Credit+ Issuing system receives, validates and processes the request. If the request is successful, the total or partial outstanding amount (as specified in the request attributes) is converted into EMIs, system logs the “Outstanding to EMI” (Service Code: 240) service request (SR) and sends the service request details in the response message. If the request fails, the system returns the corresponding error code in the response and the SR is not logged.

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.
HTTPS CodeError CodeReason
201000Request processed successfully [Application Code: HDS000]
400997Outstanding to EMI Request failed: invalid request
400997Device Number field should be numeric.
400997Either Device Number or Card Number Alias field must be present.
400997Card Number Alias field should be alphanumeric with only allowed special characters are [_!'()*+,-.].
400997Device Number field should be numeric.
400997Tenure field should be numeric.
400997Priority Request field is invalid.
400997Request Date field must be in MM/dd/yyyy HH:mm:ss format.
400997Device Number field is mandatory.
400997Request Date field is mandatory.
400997Service Code field is mandatory.
400997Loan Amount field is mandatory.
400997Tenure field is mandatory.
400997Interest Rate field is mandatory.
400997Moratorium Period field should be numeric.
400997EMI Option field is invalid.
400997EMI Option field is invalid.
400997Loan Product Type field is invalid.
400997Loan Product Type field is mandatory.
400997Loan Product Type field is invalid.
400997Processing Fee field value should not be less than zero.
400997Processing Fee field must be a positive value with maximum 10 integers and 7 fractions.
400997Pre Close Fee field value should not be less than zero.
400997Pre Close Fee must be a positive value with maximum 10 integers and 7 fractions.
400997Interest Rate must be a positive value with maximum 10 integers and 7 fractions.
400997Note field should be alphanumeric with no special characters.
400OUT001Invalid device number.
400OUT002Error while fetching details from device.
400RTL113Invalid WALLET.
400RTL114Error While fetching wallet details.
400LOAN00018Loan Plan not defined.
400LOAN00018Loan Plan not defined at Program Or Wallet.
400LOAN00030Not eligible for loan offer
400CLMT010Invalid Client code.
400CLMT011Error while fetching details from client.
400RTL103Invalid ARN/Sequence no.
400RTL104Error while fetching ARN details.
400LOAN00040Loan amount exceeded the total outstanding amount.
400LOAN00025No transactions available for loan on this device.
400OUT005Error while executing Outstanding to EMI Payment API
403900Invalid User Device(s) does not exist [Application Error Code: 998]
404998Device(s) does not exist [OUT001Application Error Code: 998 Response Code]
500999Invalid Request Type [Application Error Code: 999]
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
required
length ≤ 24
^[0-9]+$

Card number. Numeric. Not Null. Maximum Length: 24.

string
enum

Denotes whether the request is to be taken on priority. Must be 0 (No priority) or 1 (Priority request).

Allowed:
string
length ≤ 4000

Any text that the requestor may want to send for logging purpose. Maximum length: 4000.

string
length ≤ 10

Channel through which transactions are performed. Maximum Length: 10.

string
required
^(0[1-9]|1[0-2])/(0[1-9]|[12][0-9]|3[01])/([0-9]{4}) ([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]$

Denotes the date and time of request. Format: MM/DD/YYYY HH:MM:SS. Must be less than or equal to the institution date.

double
0 to 1000000000000

Amount that is to be converted to a loan. Numeric. Maximum twelve integer places. Maximum seven decimal places. Must be present if emiOption is P. Should be less than or equal to the outstanding amount.

string
enum
required

Indicates whether the total or partial outstanding amount is to be converted to EMIs. Value should be T (Total amount) or P (Partial amount).

Allowed:
string
required
length ≤ 10

Type of loan product that is assigned to the cardholder. Validated against defined loan plans.

string
required
^[0-9]+$

Number of EMIs of the loan amount. Numeric. Should be validated against applicable loan plans.

string
required
^[0-9]{1,2}(\.[0-9]{1,2})?$

Proportion of loan that is charged as interest to the cardholder. Numeric. Maximum two integer places. Maximum two decimal places. Should be validated against applicable loan plans.

string
^[0-9]+$

Time within the loan term that the cardholder is not required to make any repayment. Numeric. Should be validated against applicable loan plans.

string
enum
required

Loan product type. Must be LOANEMI.

Allowed:
string
^[0-9]{1,10}(\.[0-9]{1,7})?$

Fee required to process the loan.

string
^[0-9]{1,10}(\.[0-9]{1,7})?$

Amount required to close the current loan.

boolean

Indicates if interest is waived off for the cardholder for the indicated moratorium period. Applicable when moratoriumPeriod is provided. Valid values: true, false. If not provided, default value is considered from Card Management > Institution Parameter Setup > Loan Configuration > Loan Plan configuration.

Headers
string
^[a-zA-Z0-9-]{1,50}$

API Consumer must share a Correlation-ID in the HTTP header for API requests. The Correlation-ID must be unique for each request. It is recommended to generate 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 the 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?