/loans

get

https://api-sandbox.getdefacto.com/loans

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

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

borrower

array of strings

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

borrower

contractual_repayment_date_from

date-time

Defaults to null

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

contractual_repayment_date_to

date-time

Defaults to null

Returns loans where contractual_repayment_date field is lower to this date.

cursor

string

Defaults to null

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

guarantee_called

boolean

Defaults to null

Returns loans for which the guarantee was called

guarantor

string

Defaults to null

Entity legally responsible to payback the loan

array of uuids

Filter by one or more loan UUIDs.

loan_type

array of strings

loan_type

page_size

integer

Defaults to 100

Maximum number of items to return per page.

postponed

boolean

Defaults to null

Returns loans that have been postponed

query

string

Defaults to null

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

sort_by

string

enum

Defaults to null

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']

Allowed:

status

array of strings

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

status

to_pay_at_from

date-time

Defaults to null

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

to_pay_at_to

date-time

Defaults to null

Returns loans where pay_at field is lower to this date.

to_repay_at_from

date-time

Defaults to null

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

to_repay_at_to

date-time

Defaults to null

Returns loans where repay_at field is lower to this date.

to_repay_at_within_days

integer

Defaults to null

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

200