Sign in
latestOpenAPI 3.0.02026-08-102633113.7 KB

ab5ecf64ab87

Consumer Overdrafts

Get Consumer Overdraft

Returns all the details of an existing consumer overdraft, assigned to the person with the given person_id in the path parameter.

get/v1/persons/{person_id}/consumer_overdrafts/{overdraft_id}

Path parameters

person_idstring required

The unique person ID, generated after completing the person onboarding process.

overdraft_idstring required

The unique ID of a consumer overdraft, generated after an overdraft is offered.

Response

Overdraft

status'created' | 'conditions_pending' | 'limit_pending' | 'attached' | 'defaulted_pending' | 'conditions_termination_pending' | 'termination_pending' | 'terminated' required

The status of an overdraft offered to a consumer.

person_idstring required

The unique person ID, generated after completing the person onboarding process.

overdraft_ratenumber float required

The interest rate applicable to the overdraft.

negative_sincestring datetime nullable required

The date and time when overdraft went negative.

interest_accrual_ratenumber float required

The daily rate at which interest is accrued on the used amount of an overdraft.

idstring required

The unique ID of a consumer overdraft, generated after an overdraft is offered.

created_atstring datetime required

The date and time the overdraft was created.

consumer_application_idstring required

The unique ID of a consumer overdraft application.

account_ibanstring required

The IBAN of a person account.

Example response

{
  "status": "created",
  "person_id": "dc1a6812a14f6cc338cd084208535bcdcper",
  "overdraft_rate": 9,
  "negative_since": "2021-08-03T18:01:48Z",
  "limit": {
    "value": 1000,
    "unit": "cents",
    "currency": "EUR"
  },
  "interest_accrued": {
    "value": 1000,
    "unit": "cents",
    "currency": "EUR"
  },
  "interest_accrual_rate": 3,
  "id": "00556cd181f2409aaa6c2a033cce3a8fcovd",
  "created_at": "2021-08-03T18:01:48.000Z",
  "consumer_application_id": "b83z264de98741018419b53648e20ca9coap",
  "account_iban": "DE87110101001000057123"
}