Skip to main content

Loan Statement Response

This method is called by the LA to get the account statement for the loan for a specified period. If the start and end dates are blank, it will return the entire Loan Statement.

Request Body
metadata object REQUIRED

Metadata specific to each API request.

version string REQUIRED
originatorOrgId string

The organisation id on the Participant Registry.

originatorParticipantId string

The participant id on the Participant Registry. This will be different for every role under the same organisation.

timestamp string REQUIRED
traceId string REQUIRED
requestId string REQUIRED

UUID used to tie request and response and for idempotency

response object REQUIRED

Status of response. Whether success or has encountered error

status string REQUIRED

Possible values: [SUCCESS, ERROR]

responseDetail string
productData object REQUIRED

Product Metadata specific to each API request.

productId string REQUIRED

The product id on the Product Registry.

productNetworkId string

The product network id on the Product Registry.

loanId string REQUIRED
loanStatus string REQUIRED

Possible values: [EMI_DUE, EMI_PAID, EMI_OVERDUE, EMI_WAIVED, LOAN_CLOSED, NPA, PARTIALLY_PAID, PRECLOSURE, SETTLEMENT_STARTED, SETTLEMENT_COMPLETED, SETTLEMENT_FAILED, SETTLEMENT_PAID, HEALTHY]

accountStatement object[] REQUIRED
date date REQUIRED
narration string REQUIRED
txnRefNo string REQUIRED
amount string REQUIRED
type string REQUIRED

Possible values: [DEPOSIT, WITHDRAWL]

closingBalance string REQUIRED
url string
extensibleData object

This API schema is for additional keys & values according to specific need. User can add JSON objects as per the requirements.

Responses
200

Acknowledgement of Request Received

Schema OPTIONAL
error string
traceId string
timestamp string