Setup Collection Account Request

This endpoint is initiated by the LA on the Collections Partner before the Set Repayment Plan request to present the borrower with the available repayment methods.

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
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 — REQUIRED
paymentMethod object — REQUIRED id string — REQUIRED description string type string Possible values: [EMANDATE_UPI, ELIEN, ENACH, ANY] status string — REQUIRED Possible values: [INACTIVE, ACTIVE, CANCELLED, PAUSE] data object This API schema is for additional keys & values according to specific need. User can add JSON objects as per the requirements. 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.
loanApplication object — REQUIRED createdDate date — REQUIRED loanApplicationId string — REQUIRED loanApplicationStatus string — REQUIRED Possible values: [CREATED, PROCESSING, CONSENT_INITIATED, CONSENT_RECEIVED, CONSENT_REJECTED, OFFERED, OFFER_ACCEPTED, KYC_INITIATED, KYC_COMPLETED, KYC_FAILED, KYC_REJECTED, LOAN_AGREEMENT_INITIATED, LOAN_AGREEMENT_COMPLETED, LOAN_AGREEMENT_FAILED, REPAYMENT_SETUP_INITIATED, REPAYMENT_SETUP_COMPLETED, REPAYMENT_SETUP_FAILED, REPAYMENT_SETUP_REJECTED, SET_DISBURSEMENT_ACCOUNT_INITIATED, SET_DISBURSEMENT_ACCOUNT_COMPLETED, SET_DISBURSEMENT_ACCOUNT_FAILED, SET_DISBURSEMENT_ACCOUNT_REJECTED, GRANTED, REJECTED, ACTION_REQUIRED, DISBURSEMENT_INITIATED, DISBURSEMENT_COMPLETED, DISBURSED_FAILED, CLOSED, CANCELLED] pledgedDocuments object — REQUIRED totalDocumentCount integer — REQUIRED hasAdditionalDocuments boolean — REQUIRED documents object[] — REQUIRED id string source string — REQUIRED Possible values: [GSTN, AA, FIP, FSR, FIU, USER, OTHER] sourceIdentifier string — REQUIRED format string — REQUIRED Possible values: [JSON, DOC, IMAGE, CSV, XML, PDF, URL] reference string — REQUIRED type string — REQUIRED Possible values: [GST_PROFILE, GSTN_B2B_INVOICE, PAN, AADHAAR, DRIVING_LICENSE, PASSPORT, OTHER] isDataInline boolean — REQUIRED data string — REQUIRED borrower object — REQUIRED primaryId string — REQUIRED primaryIdType string — REQUIRED Possible values: [PAN, MOBILE, AADHAAR] additionalIdentifiers object[] key string — REQUIRED value 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. name string category string — REQUIRED Possible values: [ORGANIZATION, INDIVIDUAL] contactDetails object[] — REQUIRED type string — REQUIRED Possible values: [PRIMARY, OTHER] desctiption string phone string — REQUIRED email string address object hba string — REQUIRED srl string — REQUIRED landmark string als string vtc string pinCode string — REQUIRED po string district string state string — REQUIRED country string — REQUIRED url string latitude string longitude string extensibleData object This API schema is for additional keys & values according to specific need. User can add JSON objects as per the requirements. 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. documents object[] id string source string — REQUIRED Possible values: [GSTN, AA, FIP, FSR, FIU, USER, OTHER] sourceIdentifier string — REQUIRED format string — REQUIRED Possible values: [JSON, DOC, IMAGE, CSV, XML, PDF, URL] reference string — REQUIRED type string — REQUIRED Possible values: [GST_PROFILE, GSTN_B2B_INVOICE, PAN, AADHAAR, DRIVING_LICENSE, PASSPORT, OTHER] isDataInline boolean — REQUIRED data 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. aaIdentifier string For AA based flows, account aggregator identifier will be provided by the borrower guarantors object[] — REQUIRED primaryId string — REQUIRED primaryIdType string — REQUIRED Possible values: [PAN, MOBILE, AADHAAR] description string additionalIdentifiers object[] key string — REQUIRED value 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. name string relationshipWithBorrower string category string — REQUIRED Possible values: [ORGANIZATION, INDIVIDUAL] contactDetails object[] — REQUIRED type string — REQUIRED Possible values: [PRIMARY, OTHER] desctiption string phone string — REQUIRED email string address object hba string — REQUIRED srl string — REQUIRED landmark string als string vtc string pinCode string — REQUIRED po string district string state string — REQUIRED country string — REQUIRED url string latitude string longitude string extensibleData object This API schema is for additional keys & values according to specific need. User can add JSON objects as per the requirements. 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. documents object[] — REQUIRED id string source string — REQUIRED Possible values: [GSTN, AA, FIP, FSR, FIU, USER, OTHER] sourceIdentifier string — REQUIRED format string — REQUIRED Possible values: [JSON, DOC, IMAGE, CSV, XML, PDF, URL] reference string — REQUIRED type string — REQUIRED Possible values: [GST_PROFILE, GSTN_B2B_INVOICE, PAN, AADHAAR, DRIVING_LICENSE, PASSPORT, OTHER] isDataInline boolean — REQUIRED data 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. applicants object[] — REQUIRED primaryId string — REQUIRED primaryIdType string — REQUIRED Possible values: [PAN, MOBILE, AADHAAR] additionalIdentifiers object[] key string — REQUIRED value 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. name string category string Possible values: [ORGANIZATION, INDIVIDUAL] relationshipWithBorrower string contactDetails object[] type string — REQUIRED Possible values: [PRIMARY, OTHER] desctiption string phone string — REQUIRED email string address object hba string — REQUIRED srl string — REQUIRED landmark string als string vtc string pinCode string — REQUIRED po string district string state string — REQUIRED country string — REQUIRED url string latitude string longitude string extensibleData object This API schema is for additional keys & values according to specific need. User can add JSON objects as per the requirements. 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. documents object[] id string source string — REQUIRED Possible values: [GSTN, AA, FIP, FSR, FIU, USER, OTHER] sourceIdentifier string — REQUIRED format string — REQUIRED Possible values: [JSON, DOC, IMAGE, CSV, XML, PDF, URL] reference string — REQUIRED type string — REQUIRED Possible values: [GST_PROFILE, GSTN_B2B_INVOICE, PAN, AADHAAR, DRIVING_LICENSE, PASSPORT, OTHER] isDataInline boolean — REQUIRED data 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. terms object — REQUIRED requestedAmount float — REQUIRED currency string — REQUIRED sanctionedAmount float netDisbursedAmount float interestType string Possible values: [FIXED, FLOATING] interestRate float annualPercentageRate float coolingOffPeriod object duration number — REQUIRED unit string — REQUIRED Possible values: [MONTH, DAY, YEAR] totalRepayableAmount float interestAmount float description string tenure object duration number — REQUIRED unit string — REQUIRED Possible values: [MONTH, DAY, YEAR] legalAgreement object type string — REQUIRED Possible values: [TEXT, DOCUMENT_URL, REDIRECT_TO_LENDER_URL] data string — REQUIRED documents object[] id string source string — REQUIRED Possible values: [GSTN, AA, FIP, FSR, FIU, USER, OTHER] sourceIdentifier string — REQUIRED format string — REQUIRED Possible values: [JSON, DOC, IMAGE, CSV, XML, PDF, URL] reference string — REQUIRED type string — REQUIRED Possible values: [GST_PROFILE, GSTN_B2B_INVOICE, PAN, AADHAAR, DRIVING_LICENSE, PASSPORT, OTHER] isDataInline boolean — REQUIRED data string — REQUIRED charges object prepayment object chargeType string — REQUIRED Possible values: [FIXED_AMOUNT, RATE_BASED] data object — REQUIRED rate float amount float applicableParameter string Possible values: [TOTAL_LOAN_AMOUNT, OUTSTANDING_PAYABLE_AMOUNT, EMI, REPAYMENT_PRINCIPAL] description string url string 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. bounce object chargeType string — REQUIRED Possible values: [FIXED_AMOUNT, RATE_BASED] data object — REQUIRED rate float amount float applicableParameter string Possible values: [TOTAL_LOAN_AMOUNT, OUTSTANDING_PAYABLE_AMOUNT, EMI, REPAYMENT_PRINCIPAL] description string url string 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. latePayment object chargeType string — REQUIRED Possible values: [FIXED_AMOUNT, RATE_BASED] data object — REQUIRED rate float amount float applicableParameter string Possible values: [TOTAL_LOAN_AMOUNT, OUTSTANDING_PAYABLE_AMOUNT, EMI, REPAYMENT_PRINCIPAL] description string url string 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. processing object chargeType string — REQUIRED Possible values: [FIXED_AMOUNT, RATE_BASED] data object — REQUIRED rate float amount float applicableParameter string Possible values: [TOTAL_LOAN_AMOUNT, OUTSTANDING_PAYABLE_AMOUNT, EMI, REPAYMENT_PRINCIPAL] description string url string 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. other object chargeType string — REQUIRED Possible values: [FIXED_AMOUNT, RATE_BASED] data object — REQUIRED rate float amount float applicableParameter string Possible values: [TOTAL_LOAN_AMOUNT, OUTSTANDING_PAYABLE_AMOUNT, EMI, REPAYMENT_PRINCIPAL] description string url string 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. 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. url string description string creditGuarantees object cgtmseEligible boolean 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