latestSwagger 2.02026-08-2181213270.0 KB

0a9c1f8784f2

Loan

List loans with pagination. Returns a paginated list of loans filterable by borrower, status, dates, and loan type.

get/loans

Query parameters

borrowerstring[]

Search by borrower company number (e.g. SIREN or NIF)

contractual_repayment_date_fromstring date-time

Returns loans where contractual_repayment_date field is greater or equal to this date.

contractual_repayment_date_tostring date-time

Returns loans where contractual_repayment_date field is lower to this date.

cursorstring

Pagination cursor from the previous response's next_page field. Omit to get the first page.

guarantee_calledboolean

Returns loans for which the guarantee was called

guarantorstring

Entity legally responsible to payback the loan

idstring[]

Filter by one or more loan UUIDs.

loan_typestring[]
page_sizeinteger

Maximum number of items to return per page.

postponedboolean

Returns loans that have been postponed

querystring

Search for loans based on one or more of the following fields: loan ID, invoice number, amount, estimated fees, status, or counterparty name.

sort_bystring

Specify the sorting field and order. Default sorting: created_at DESC. Possible values: ['created_at:asc', 'created_at:desc', 'to_repay_at:asc', 'to_repay_at:desc', 'to_pay_at:asc', 'to_pay_at:desc']

statusstring[]

Loan statuses. Possible values: ['SUBMITTED', 'PENDING_VALIDATION', 'TO_VALIDATE', 'DECLINED', 'VALIDATED', 'CANCELED', 'SCHEDULED', 'INITIATED', 'TO_REPAY', 'TO_REPAY_FEES', 'CLOSED', 'ISSUE_DETECTED', 'DELETED']

to_pay_at_fromstring date-time

Returns loans where pay_at field is greater or equal to this date.

to_pay_at_tostring date-time

Returns loans where pay_at field is lower to this date.

to_repay_at_fromstring date-time

Returns loans where repay_at field is greater or equal to this date.

to_repay_at_tostring date-time

Returns loans where repay_at field is lower to this date.

to_repay_at_within_daysinteger

Shorthand alias for to_repay_at_from=now() and to_repay_at_to=now().plus(x, 'days'). Mutually exclusive with to_repay_at_from & to_repay_at_to.

Response

OK