Skip to content
Overdraft
/
/
List Consumer Overdrafts

Overdrafts (1.0)

Download OpenAPI description
overdrafts.json
overdrafts.yaml
Languages
Servers
Mock Server

https://docs.solarisgroup.com/_mock/api-reference/lending/overdrafts/

Freelancer Overdrafts

Operations

Consumer Overdrafts

Operations

Create Consumer Overdraft Application

Request

Creates a consumer overdraft application and assigns it to the person with the given person_id in the path parameter. Before calling this endpoint, you must collect the required information from the customer, such as the employment status and income declaration and the consent to the account snapshot and credit check. Additionally, you need to create a credit record for the customer. Afterwards, Solaris' credit scoring system assesses the application to determine the person credit eligibility and either approves or rejects the application.

Path
person_idstringrequired

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

Bodyapplication/json

The application attributes

identification_idstringrequired

The unique identification ID of a person, generated after completing the person identification process.

Example: "176a96d1ecf7459d659d1b7f0108a3f2cidt"
account_ibanstringrequired

The IBAN of a person account.

Example: "DE87110101001000057123"
employment_statusstringrequired

The consumer's employment status, mentioned in the signed self-declaration form.

Enum"EMPLOYED""UNEMPLOYED""PUBLIC_SECTOR_EMPLOYEE""PROFESSIONAL_SOLDIER""FREELANCER""HOUSEWORK""APPRENTICE""MANAGEMENT""RETIRED""STUDENT"
Example: "EMPLOYED"
net_income_amountobject(SolarisToolkit.Web.Money)required
Example: {"value":1000,"unit":"cents","currency":"EUR"}
net_income_amount.​valueintegerrequired

The amount value

Example: 1000
net_income_amount.​currencystringrequired

The currency of the given value. Only EURO is currently supported.

Example: "EUR"
net_income_amount.​unitstringrequired

The unit of the given value.

Value"cents"
Example: "cents"
partner_risk_classstring

The risk class assigned to a customer by the partner.

Example: "d"
partner_requested_limitobject or null(SolarisToolkit.Web.Money)
Example: {"value":1000,"unit":"cents","currency":"EUR"}
partner_reference_numberstring

The partner's reference number.

Example: "a123456"
partner_contact_numberstring

The number of the partner's contact person.

Example: "+491565904345"
partner_contact_namestring

The name of the partner's contact person.

Example: "Peter Mustermann"
minimum_credit_risk_criteriaobject or null

Minimum credit risk criteria fields for scorer

credit_record_idstring

The unique ID of a credit record, generated after creating a consumer credit record.

Example: "fbb7d15fa4c54ba0b077592665ef04a4ccrd"
application/json
{
  "partner_risk_class": "d",
  "partner_requested_limit": {
    "value": 0,
    "unit": "cents",
    "currency": "EUR"
  },
  "partner_reference_number": "a123456",
  "partner_contact_number": "+491565904345",
  "partner_contact_name": "Peter Mustermann",
  "net_income_amount": {
    "value": 1000,
    "unit": "cents",
    "currency": "EUR"
  },
  "minimum_credit_risk_criteria": {},
  "identification_id": "176a96d1ecf7459d659d1b7f0108a3f2cidt",
  "employment_status": "EMPLOYED",
  "credit_record_id": "fbb7d15fa4c54ba0b077592665ef04a4ccrd",
  "account_iban": "DE87110101001000057123"
}

Responses

Application

Bodyapplication/json
idstringrequired

The unique ID of a consumer overdraft application.

Example: "b83z264de98741018419b53648e20ca9coap"
partner_idstringrequired

The unique partner ID, generated after creating a partner.

Example: "6ee8e4c8bdc2f9b15870c989706aa9cccpar"
person_idstringrequired

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

Example: "dc1a6812a14f6cc338cd084208535bcdcper"
identification_idstringrequired

The unique identification ID of a person, generated after completing the person identification process.

Example: "176a96d1ecf7459d659d1b7f0108a3f2cidt"
account_ibanstringrequired

The IBAN of a person account.

Example: "DE87110101001000057123"
statusstringrequired

The status of a consumer overdraft application.

Enum"scoring_pending""offered""overdraft_created""rejected""deleted"
Example: "offered"
created_atstring(datetime)required

The date and time the consumer overdraft application was created.

Example: "2021-08-03T18:01:48.000Z"
status_descriptionstring or null

The description of the consumer overdraft application status.

Example: "The overdraft is approved and offered to the customer."
partner_risk_classstring or null

The risk class assigned to a customer by the partner.

Example: "d"
partner_requested_limitobject or null(SolarisToolkit.Web.Money.Optional)
Example: {"value":1000,"unit":"cents","currency":"EUR"}
partner_reference_numberstring or null

The partner's reference number.

Example: "a123456"
partner_contact_numberstring or null

The number of the partner's contact person.

Example: "+491565904345"
partner_contact_namestring or null

The name of the partner's contact person.

Example: "Peter Mustermann"
overdraft_idstring or null

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

Example: "00556cd181f2409aaa6c2a033cce3a8fcovd"
net_income_amountobject(SolarisToolkit.Web.Money)
Example: {"value":1000,"unit":"cents","currency":"EUR"}
minimum_credit_risk_criteriaobject or null

Minimum credit risk criteria fields for scorer

limitobject or null(SolarisToolkit.Web.Money.Optional)
Example: {"value":1000,"unit":"cents","currency":"EUR"}
interest_accrual_ratenumber or null(float)

Scorer rate for risk based pricing

employment_statusstring or null

The consumer's employment status, mentioned in the signed self-declaration form.

Enum"EMPLOYED""UNEMPLOYED""PUBLIC_SECTOR_EMPLOYEE""PROFESSIONAL_SOLDIER""FREELANCER""HOUSEWORK""APPRENTICE""MANAGEMENT""RETIRED""STUDENT"
Example: "EMPLOYED"
credit_record_idstring or null

The unique ID of a credit record, generated after creating a consumer credit record.

Example: "fbb7d15fa4c54ba0b077592665ef04a4ccrd"
Response
application/json
{
  "status_description": "The overdraft is approved and offered to the customer.",
  "status": "offered",
  "person_id": "dc1a6812a14f6cc338cd084208535bcdcper",
  "partner_risk_class": "d",
  "partner_requested_limit": {
    "value": 1000,
    "unit": "cents",
    "currency": "EUR"
  },
  "partner_reference_number": "a123456",
  "partner_id": "6ee8e4c8bdc2f9b15870c989706aa9cccpar",
  "partner_contact_number": "+491565904345",
  "partner_contact_name": "Peter Mustermann",
  "overdraft_id": "00556cd181f2409aaa6c2a033cce3a8fcovd",
  "net_income_amount": {
    "value": 1000,
    "unit": "cents",
    "currency": "EUR"
  },
  "minimum_credit_risk_criteria": {},
  "limit": {
    "value": 1000,
    "unit": "cents",
    "currency": "EUR"
  },
  "interest_accrual_rate": 0.1,
  "identification_id": "176a96d1ecf7459d659d1b7f0108a3f2cidt",
  "id": "b83z264de98741018419b53648e20ca9coap",
  "employment_status": "EMPLOYED",
  "credit_record_id": "fbb7d15fa4c54ba0b077592665ef04a4ccrd",
  "created_at": "2021-08-03T18:01:48.000Z",
  "account_iban": "DE87110101001000057123"
}

Get Consumer Overdraft Application

Request

Returns the status and details of an existing consumer overdraft application.

Path
person_idstringrequired

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

overdraft_application_idstringrequired

The unique ID of a consumer overdraft application.

No request payload

Responses

Application

Bodyapplication/json
idstringrequired

The unique ID of a consumer overdraft application.

Example: "b83z264de98741018419b53648e20ca9coap"
partner_idstringrequired

The unique partner ID, generated after creating a partner.

Example: "6ee8e4c8bdc2f9b15870c989706aa9cccpar"
person_idstringrequired

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

Example: "dc1a6812a14f6cc338cd084208535bcdcper"
identification_idstringrequired

The unique identification ID of a person, generated after completing the person identification process.

Example: "176a96d1ecf7459d659d1b7f0108a3f2cidt"
account_ibanstringrequired

The IBAN of a person account.

Example: "DE87110101001000057123"
statusstringrequired

The status of a consumer overdraft application.

Enum"scoring_pending""offered""overdraft_created""rejected""deleted"
Example: "offered"
created_atstring(datetime)required

The date and time the consumer overdraft application was created.

Example: "2021-08-03T18:01:48.000Z"
status_descriptionstring or null

The description of the consumer overdraft application status.

Example: "The overdraft is approved and offered to the customer."
partner_risk_classstring or null

The risk class assigned to a customer by the partner.

Example: "d"
partner_requested_limitobject or null(SolarisToolkit.Web.Money.Optional)
Example: {"value":1000,"unit":"cents","currency":"EUR"}
partner_reference_numberstring or null

The partner's reference number.

Example: "a123456"
partner_contact_numberstring or null

The number of the partner's contact person.

Example: "+491565904345"
partner_contact_namestring or null

The name of the partner's contact person.

Example: "Peter Mustermann"
overdraft_idstring or null

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

Example: "00556cd181f2409aaa6c2a033cce3a8fcovd"
net_income_amountobject(SolarisToolkit.Web.Money)
Example: {"value":1000,"unit":"cents","currency":"EUR"}
minimum_credit_risk_criteriaobject or null

Minimum credit risk criteria fields for scorer

limitobject or null(SolarisToolkit.Web.Money.Optional)
Example: {"value":1000,"unit":"cents","currency":"EUR"}
interest_accrual_ratenumber or null(float)

Scorer rate for risk based pricing

employment_statusstring or null

The consumer's employment status, mentioned in the signed self-declaration form.

Enum"EMPLOYED""UNEMPLOYED""PUBLIC_SECTOR_EMPLOYEE""PROFESSIONAL_SOLDIER""FREELANCER""HOUSEWORK""APPRENTICE""MANAGEMENT""RETIRED""STUDENT"
Example: "EMPLOYED"
credit_record_idstring or null

The unique ID of a credit record, generated after creating a consumer credit record.

Example: "fbb7d15fa4c54ba0b077592665ef04a4ccrd"
Response
application/json
{
  "status_description": "The overdraft is approved and offered to the customer.",
  "status": "offered",
  "person_id": "dc1a6812a14f6cc338cd084208535bcdcper",
  "partner_risk_class": "d",
  "partner_requested_limit": {
    "value": 1000,
    "unit": "cents",
    "currency": "EUR"
  },
  "partner_reference_number": "a123456",
  "partner_id": "6ee8e4c8bdc2f9b15870c989706aa9cccpar",
  "partner_contact_number": "+491565904345",
  "partner_contact_name": "Peter Mustermann",
  "overdraft_id": "00556cd181f2409aaa6c2a033cce3a8fcovd",
  "net_income_amount": {
    "value": 1000,
    "unit": "cents",
    "currency": "EUR"
  },
  "minimum_credit_risk_criteria": {},
  "limit": {
    "value": 1000,
    "unit": "cents",
    "currency": "EUR"
  },
  "interest_accrual_rate": 0.1,
  "identification_id": "176a96d1ecf7459d659d1b7f0108a3f2cidt",
  "id": "b83z264de98741018419b53648e20ca9coap",
  "employment_status": "EMPLOYED",
  "credit_record_id": "fbb7d15fa4c54ba0b077592665ef04a4ccrd",
  "created_at": "2021-08-03T18:01:48.000Z",
  "account_iban": "DE87110101001000057123"
}

List Consumer Overdraft Applications

Request

Query
page[number]integer

The page number to be fetched

page[size]integer

The page size (maximum amount of results) to be fetched

filter[id]string

Consumer overdraft application id to filter by

filter[person_id]string

Filter by person id

filter[account_iban]string

Filter by account_iban

filter[partner_id]string

Filter by partner id

filter[status]string

Filter by status

Enum"scoring_pending""offered""overdraft_created""rejected""deleted"
filter[created_at][min]string

Filter by created_at min date

filter[created_at][max]string

Filter by created_at max date

No request payload

Responses

OverdraftWeb.V1.Consumer.ListOverdraftApplicationResponse

Headers
totalinteger
Bodyapplication/jsonArray [
idstringrequired

The unique ID of a consumer overdraft application.

Example: "b83z264de98741018419b53648e20ca9coap"
partner_idstringrequired

The unique partner ID, generated after creating a partner.

Example: "6ee8e4c8bdc2f9b15870c989706aa9cccpar"
person_idstringrequired

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

Example: "dc1a6812a14f6cc338cd084208535bcdcper"
identification_idstringrequired

The unique identification ID of a person, generated after completing the person identification process.

Example: "176a96d1ecf7459d659d1b7f0108a3f2cidt"
account_ibanstringrequired

The IBAN of a person account.

Example: "DE87110101001000057123"
statusstringrequired

The status of a consumer overdraft application.

Enum"scoring_pending""offered""overdraft_created""rejected""deleted"
Example: "offered"
created_atstring(datetime)required

The date and time the consumer overdraft application was created.

Example: "2021-08-03T18:01:48.000Z"
status_descriptionstring or null

The description of the consumer overdraft application status.

Example: "The overdraft is approved and offered to the customer."
partner_risk_classstring or null

The risk class assigned to a customer by the partner.

Example: "d"
partner_requested_limitobject or null(SolarisToolkit.Web.Money.Optional)
Example: {"value":1000,"unit":"cents","currency":"EUR"}
partner_reference_numberstring or null

The partner's reference number.

Example: "a123456"
partner_contact_numberstring or null

The number of the partner's contact person.

Example: "+491565904345"
partner_contact_namestring or null

The name of the partner's contact person.

Example: "Peter Mustermann"
overdraft_idstring or null

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

Example: "00556cd181f2409aaa6c2a033cce3a8fcovd"
net_income_amountobject(SolarisToolkit.Web.Money)
Example: {"value":1000,"unit":"cents","currency":"EUR"}
minimum_credit_risk_criteriaobject or null

Minimum credit risk criteria fields for scorer

limitobject or null(SolarisToolkit.Web.Money.Optional)
Example: {"value":1000,"unit":"cents","currency":"EUR"}
interest_accrual_ratenumber or null(float)

Scorer rate for risk based pricing

employment_statusstring or null

The consumer's employment status, mentioned in the signed self-declaration form.

Enum"EMPLOYED""UNEMPLOYED""PUBLIC_SECTOR_EMPLOYEE""PROFESSIONAL_SOLDIER""FREELANCER""HOUSEWORK""APPRENTICE""MANAGEMENT""RETIRED""STUDENT"
Example: "EMPLOYED"
credit_record_idstring or null

The unique ID of a credit record, generated after creating a consumer credit record.

Example: "fbb7d15fa4c54ba0b077592665ef04a4ccrd"
]
Response
application/json
[
  {
    "status_description": "The overdraft is approved and offered to the customer.",
    "status": "offered",
    "person_id": "dc1a6812a14f6cc338cd084208535bcdcper",
    "partner_risk_class": "d",
    "partner_requested_limit": { … },
    "partner_reference_number": "a123456",
    "partner_id": "6ee8e4c8bdc2f9b15870c989706aa9cccpar",
    "partner_contact_number": "+491565904345",
    "partner_contact_name": "Peter Mustermann",
    "overdraft_id": "00556cd181f2409aaa6c2a033cce3a8fcovd",
    "net_income_amount": { … },
    "minimum_credit_risk_criteria": {},
    "limit": { … },
    "interest_accrual_rate": 0.1,
    "identification_id": "176a96d1ecf7459d659d1b7f0108a3f2cidt",
    "id": "b83z264de98741018419b53648e20ca9coap",
    "employment_status": "EMPLOYED",
    "credit_record_id": "fbb7d15fa4c54ba0b077592665ef04a4ccrd",
    "created_at": "2021-08-03T18:01:48.000Z",
    "account_iban": "DE87110101001000057123"
  }
]

Download the pre-contractual information for consumer overdraft

Request

Generates a SECCI form, which is the overview of the final offer and the contract. This endpoint downloads the SECCI form as a PDF, which you must share with the customer to review the data based on which the final contract is generated.

Path
person_idstringrequired

The unique person ID assigned to a specific customer.

application_idstringrequired

The unique overdraft application ID assigned to a specific customer.

No request payload

Responses

The binary of the pre-contractual information (SECCI)

Bodyapplication/pdf
string(binary)(OverdraftWeb.DownloadPreContractResponse)
Response
No content

Download the conditions form information for consumer overdraft

Request

Generates a conditions form, which is the overview of all conditions. This is an unsigned document and essentially replaces the contract document for overdrafts.

Path
person_idstringrequired

The unique person ID assigned to a specific customer.

application_idstringrequired

The unique overdraft application ID assigned to a specific customer.

No request payload

Responses

The binary of the overdraft conditions form

Bodyapplication/pdf
string(binary)(OverdraftWeb.DownloadConditionsResponse)
Response
No content

Create Consumer Overdraft

Request

Creates a consumer overdraft and activates the offered overdraft limit in the customer's account. After Solaris approves a consumer overdraft application, you have to call this endpoint and the overdraft amount will be set as an external limit to the customer's account.

Path
person_idstringrequired

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

overdraft_application_idstringrequired

The unique ID of a consumer overdraft application.

Bodyapplication/json

The application attributes

account_idstringrequired

The unique ID of a person's bank account.

Example: "575189c6eb825b10b9d0392fcb3bf61dcacc"
tnc_accepted_atstring(datetime)required
Example: "2021-08-03T18:01:48.000Z"
application/json
{
  "tnc_accepted_at": "2021-08-03T18:01:48.000Z",
  "account_id": "575189c6eb825b10b9d0392fcb3bf61dcacc"
}

Responses

Application

Bodyapplication/json
idstringrequired

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

Example: "00556cd181f2409aaa6c2a033cce3a8fcovd"
person_idstringrequired

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

Example: "dc1a6812a14f6cc338cd084208535bcdcper"
consumer_application_idstringrequired

The unique ID of a consumer overdraft application.

Example: "b83z264de98741018419b53648e20ca9coap"
account_ibanstringrequired

The IBAN of a person account.

Example: "DE87110101001000057123"
statusstringrequired

The status of an overdraft offered to a consumer.

Enum"conditions_pending""limit_pending""created""attached"
Example: "created"
interest_accrual_ratenumber(float)required

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

Example: 3
overdraft_ratenumber(float)required

The interest rate applicable to the overdraft.

Example: 9
created_atstring(datetime)required

The date and time the overdraft was created.

Example: "2021-08-03T18:01:48.000Z"
negative_sincestring or null(datetime)required

The date and time when overdraft went negative.

Example: "2021-08-03T18:01:48Z"
Response
application/json
{
  "status": "created",
  "person_id": "dc1a6812a14f6cc338cd084208535bcdcper",
  "overdraft_rate": 9,
  "negative_since": "2021-08-03T18:01:48Z",
  "interest_accrual_rate": 3,
  "id": "00556cd181f2409aaa6c2a033cce3a8fcovd",
  "created_at": "2021-08-03T18:01:48.000Z",
  "consumer_application_id": "b83z264de98741018419b53648e20ca9coap",
  "account_iban": "DE87110101001000057123"
}

Get Consumer Overdraft

Request

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

Path
person_idstringrequired

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

overdraft_idstringrequired

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

No request payload

Responses

Overdraft

Bodyapplication/json
idstringrequired

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

Example: "00556cd181f2409aaa6c2a033cce3a8fcovd"
person_idstringrequired

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

Example: "dc1a6812a14f6cc338cd084208535bcdcper"
consumer_application_idstringrequired

The unique ID of a consumer overdraft application.

Example: "b83z264de98741018419b53648e20ca9coap"
account_ibanstringrequired

The IBAN of a person account.

Example: "DE87110101001000057123"
statusstringrequired

The status of an overdraft offered to a consumer.

Enum"created""conditions_pending""limit_pending""attached""defaulted_pending""conditions_termination_pending""termination_pending""terminated"
Example: "created"
interest_accrual_ratenumber(float)required

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

Example: 3
overdraft_ratenumber(float)required

The interest rate applicable to the overdraft.

Example: 9
created_atstring(datetime)required

The date and time the overdraft was created.

Example: "2021-08-03T18:01:48.000Z"
negative_sincestring or null(datetime)required

The date and time when overdraft went negative.

Example: "2021-08-03T18:01:48Z"
interest_accruedSolarisToolkit.Web.Money (object)required
SolarisToolkit.Web.Money (object)
limitobject or null(SolarisToolkit.Web.Money.Optional)
Example: {"value":1000,"unit":"cents","currency":"EUR"}
Response
application/json
{
  "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"
}

List Consumer Overdrafts

Request

This endpoint returns a list containing all consumer overdrafts for all of your customers.

Query
page[number]integer

The page number to be fetched

page[size]integer

The page size (maximum amount of results) to be fetched

filter[person_id]string

Filter by business id

filter[account_iban]string

Filter by account_iban

filter[status]string

Filter by status

Enum"created""conditions_pending""limit_pending""attached""defaulted_pending""conditions_termination_pending""termination_pending""terminated""reported_to_schufa"
filter[negative_since_from]string or null(datetime)

Negative since from date.

filter[negative_since_to]string or null(datetime)

Negative since to date.

No request payload

Responses

OverdraftWeb.V1.Consumer.ListOverdraftsResponse

Headers
totalinteger
Bodyapplication/jsonArray [
idstringrequired

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

Example: "00556cd181f2409aaa6c2a033cce3a8fcovd"
person_idstringrequired

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

Example: "dc1a6812a14f6cc338cd084208535bcdcper"
consumer_application_idstringrequired

The unique ID of a consumer overdraft application.

Example: "b83z264de98741018419b53648e20ca9coap"
account_ibanstringrequired

The IBAN of a person account.

Example: "DE87110101001000057123"
statusstringrequired

The status of an overdraft offered to a consumer.

Enum"created""conditions_pending""limit_pending""attached""defaulted_pending""conditions_termination_pending""termination_pending""terminated"
Example: "created"
interest_accrual_ratenumber(float)required

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

Example: 3
overdraft_ratenumber(float)required

The interest rate applicable to the overdraft.

Example: 9
created_atstring(datetime)required

The date and time the overdraft was created.

Example: "2021-08-03T18:01:48.000Z"
negative_sincestring or null(datetime)required

The date and time when overdraft went negative.

Example: "2021-08-03T18:01:48Z"
limitobject or null(SolarisToolkit.Web.Money.Optional)
Example: {"value":1000,"unit":"cents","currency":"EUR"}
]
Response
application/json
[
  {
    "status": "created",
    "person_id": "dc1a6812a14f6cc338cd084208535bcdcper",
    "overdraft_rate": 9,
    "negative_since": "2021-08-03T18:01:48Z",
    "limit": { … },
    "interest_accrual_rate": 3,
    "id": "00556cd181f2409aaa6c2a033cce3a8fcovd",
    "created_at": "2021-08-03T18:01:48.000Z",
    "consumer_application_id": "b83z264de98741018419b53648e20ca9coap",
    "account_iban": "DE87110101001000057123"
  }
]

Download the pre-contractual information for consumer overdraft limit increase

Request

Generates a SECCI form for limit increase request, which is the overview of the final offer and the contract. This endpoint downloads the SECCI form as a PDF, which you must share with the customer to review the data based on which the final contract is generated.

Path
person_idstringrequired

The unique person ID assigned to a specific customer.

overdraft_idstringrequired

The unique ID of a consumer overdraft.

limit_change_idstringrequired

The unique limit change ID, generated after creating a limit change.

No request payload

Responses

The binary of the pre-contractual information (SECCI)

Bodyapplication/pdf
string(binary)(OverdraftWeb.DownloadPreContractResponse)
Response
No content

Download the conditions form information for consumer overdraft limit increase

Request

Generates a conditions form for limit increase request, which is the overview of all conditions. This is an unsigned document and essentially replaces the contract document for overdrafts.

Path
person_idstringrequired

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

overdraft_idstringrequired

The unique ID of a consumer overdraft.

limit_change_idstringrequired

The unique limit change ID, generated after creating a limit change.

No request payload

Responses

The binary of the overdraft conditions form

Bodyapplication/pdf
string(binary)(OverdraftWeb.DownloadConditionsResponse)
Response
No content

Terminate a Consumer Overdraft

Request

Terminates a consumer overdraft. This operation is only possible if the account balance is positive or zero after booking the accrued interest from the overdraft usage on the account.

Path
person_idstringrequired

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

overdraft_idstringrequired

The unique ID of a consumer overdraft.

Bodyapplication/json

The application attributes

object(OverdraftWeb.Consumer.TerminateOverdraftRequest)
application/json
{}

Responses

No Content

Response
No content

Consumer Overdrafts Limit Change

Operations

Business Overdrafts

Operations