latestOpenAPI 3.0.02026-08-102737124.3 KB

06b62340347d

Credit Line Servicing

Index all credit lines

Returns an array of all credit lines for all of your customers.

get/v1/persons/credit_lines

Query parameters

page[number]integer

The number of result pages to return.

page[size]integer

The size of each result page (maximum amount of results) to return.

filter[person_id]string

Filter result by person_id

filter[status]string

Filter results by credit line status.

filter[granted_at_min]string

Filter results by the minimum date when the credit line was granted.

filter[granted_at_max]string

Filter results by the maximum date when the credit line was granted.

filter[id]string

Filter results by credit_line_id.

filter[eligible_renewal_expires_at_min]string

Filter by minimal expiration date for eligible renewal

filter[eligible_renewal_expires_at_max]string

Filter by maximal expiration date for eligible renewal

Response

ConsumerCreditLine.V1.ListCreditLinesResponse

status'authorization_pending,' | 'account_creation_pending' | 'mandate_creation_pending' | 'open' | 'closed' required

The status of the credit line.

person_idstring required

The person ID of the customer who has the credit line.

idstring required

The unique ID of a credit line, generated after a credit line is created.

granted_atstring datetime nullable

The timestamp from when the credit line was granted to the customer.

Example response

[
  {
    "status": "open",
    "person_id": "dc1a6812a14f6cc338cd084208535bcdcper",
    "limit": {
      "currency": "EUR",
      "unit": "cents",
      "value": 1000
    },
    "id": "1908331fb8384edcbfe63067366c4b6accln",
    "granted_at": "2022-02-07T11:57:42Z"
  }
]