Skip to content
/
Consumer Overdrafts Limit...

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

Consumer Overdrafts Limit Change

Operations

Update Limit Change

Request

Updates the limit change and activates the requested overdraft limit in the customer's account. After Solaris approves a consumer limit change, you have to call this endpoint and the requested 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_idstringrequired

The unique ID of a consumer overdraft.

limit_change_idstringrequired

The unique ID of a consumer limit change.

Bodyapplication/json

The application attributes

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

Responses

Application

Bodyapplication/json
idstringrequired

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

Example: "00556cd181f2409aaa6c2a033cce3a8fcovd"
overdraft_idstringrequired

The unique ID of the related overdraft.

Example: "b83z264de98741018419b53648e20ca9coap"
statusstringrequired

The status of a limit change.

Enum"requested""tnc_pending""tnc_accepted""conditions_pending""limit_pending""attached""cancelled""expired"
Example: "requested"
created_atstring(datetime)required

The date and time the overdraft was created.

Example: "2021-08-03T18:01:48.000Z"
requested_limitobject(SolarisToolkit.Web.Money)required
Example: {"value":1000,"unit":"cents","currency":"EUR"}
requested_limit.​valueintegerrequired

The amount value

Example: 1000
requested_limit.​currencystringrequired

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

Example: "EUR"
requested_limit.​unitstringrequired

The unit of the given value.

Value"cents"
Example: "cents"
tnc_accepted_atstring or null(datetime)

The date and time the terms and conditions were accepted by the customer.

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

The reason why the limit change was requested.

Example: "Customer has a good scoring."
limit_at_creation_timeobject or null(SolarisToolkit.Web.Money.Optional)
Example: {"value":1000,"unit":"cents","currency":"EUR"}
attached_atstring or null(datetime)

The date and time the new limit was attached.

Example: "2021-08-03T18:01:48.000Z"
Response
application/json
{
  "tnc_accepted_at": "2021-08-03T18:01:48.000Z",
  "status": "requested",
  "requested_limit": {
    "value": 1000,
    "unit": "cents",
    "currency": "EUR"
  },
  "reason": "Customer has a good scoring.",
  "overdraft_id": "b83z264de98741018419b53648e20ca9coap",
  "limit_at_creation_time": {
    "value": 1000,
    "unit": "cents",
    "currency": "EUR"
  },
  "id": "00556cd181f2409aaa6c2a033cce3a8fcovd",
  "created_at": "2021-08-03T18:01:48.000Z",
  "attached_at": "2021-08-03T18:01:48.000Z"
}

Show Consumer Overdraft Limit Change

Request

Shows a consumer overdraft limit change.

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 chnage ID, generated after creating a limit change.

No request payload

Responses

LimitChange

Bodyapplication/json
idstringrequired

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

Example: "00556cd181f2409aaa6c2a033cce3a8fcovd"
overdraft_idstringrequired

The unique ID of a overdraft.

Example: "b83z264de98741018419b53648e20ca9coap"
statusstringrequired

The status of a limit change.

Enum"requested""tnc_pending""tnc_accepted""conditions_pending""limit_pending""attached""cancelled""expired"
Example: "limit_pending"
created_atstring(datetime)required

The date and time the overdraft was created.

Example: "2021-08-03T18:01:48.000Z"
requested_limitobject(SolarisToolkit.Web.Money)required
Example: {"value":1000,"unit":"cents","currency":"EUR"}
requested_limit.​valueintegerrequired

The amount value

Example: 1000
requested_limit.​currencystringrequired

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

Example: "EUR"
requested_limit.​unitstringrequired

The unit of the given value.

Value"cents"
Example: "cents"
tnc_accepted_atstring or null(datetime)

The date and time the terms and conditions were accepted by the customer.

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

The reason why the limit change was requested.

Example: "Customer has a good scoring."
limit_at_creation_timeobject or null(SolarisToolkit.Web.Money.Optional)
Example: {"value":1000,"unit":"cents","currency":"EUR"}
attached_atstring or null(datetime)

The date and time the new limit was attached.

Example: "2021-08-03T18:01:48.000Z"
Response
application/json
{
  "tnc_accepted_at": "2021-08-03T18:01:48.000Z",
  "status": "limit_pending",
  "requested_limit": {
    "value": 1000,
    "unit": "cents",
    "currency": "EUR"
  },
  "reason": "Customer has a good scoring.",
  "overdraft_id": "b83z264de98741018419b53648e20ca9coap",
  "limit_at_creation_time": {
    "value": 1000,
    "unit": "cents",
    "currency": "EUR"
  },
  "id": "00556cd181f2409aaa6c2a033cce3a8fcovd",
  "created_at": "2021-08-03T18:01:48.000Z",
  "attached_at": "2021-08-03T18:01:48.000Z"
}

Create Consumer Overdraft Limit Change

Request

Creates a consumer overdraft limit change.

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 limit change attributes

requested_limitobject(SolarisToolkit.Web.Money)required
Example: {"value":1000,"unit":"cents","currency":"EUR"}
requested_limit.​valueintegerrequired

The amount value

Example: 1000
requested_limit.​currencystringrequired

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

Example: "EUR"
requested_limit.​unitstringrequired

The unit of the given value.

Value"cents"
Example: "cents"
reasonstring

The reason why the limit should be changed.

Example: "Customer scoring improved"
application/json
{
  "requested_limit": {
    "value": 1000,
    "unit": "cents",
    "currency": "EUR"
  },
  "reason": "Customer scoring improved"
}

Responses

LimitChange

Bodyapplication/json
idstringrequired

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

Example: "00556cd181f2409aaa6c2a033cce3a8fcovd"
overdraft_idstringrequired

The unique ID of the related overdraft.

Example: "b83z264de98741018419b53648e20ca9coap"
statusstringrequired

The status of a limit change.

Enum"requested""tnc_pending""tnc_accepted""conditions_pending""limit_pending""attached""cancelled""expired"
Example: "requested"
created_atstring(datetime)required

The date and time the overdraft was created.

Example: "2021-08-03T18:01:48.000Z"
requested_limitobject(SolarisToolkit.Web.Money)required
Example: {"value":1000,"unit":"cents","currency":"EUR"}
requested_limit.​valueintegerrequired

The amount value

Example: 1000
requested_limit.​currencystringrequired

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

Example: "EUR"
requested_limit.​unitstringrequired

The unit of the given value.

Value"cents"
Example: "cents"
tnc_accepted_atstring or null(datetime)

The date and time the terms and conditions were accepted by the customer.

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

The reason why the limit change was requested.

Example: "Customer has a good scoring."
limit_at_creation_timeobject or null(SolarisToolkit.Web.Money.Optional)
Example: {"value":1000,"unit":"cents","currency":"EUR"}
attached_atstring or null(datetime)

The date and time the new limit was attached.

Example: "2021-08-03T18:01:48.000Z"
Response
application/json
{
  "tnc_accepted_at": "2021-08-03T18:01:48.000Z",
  "status": "requested",
  "requested_limit": {
    "value": 1000,
    "unit": "cents",
    "currency": "EUR"
  },
  "reason": "Customer has a good scoring.",
  "overdraft_id": "b83z264de98741018419b53648e20ca9coap",
  "limit_at_creation_time": {
    "value": 1000,
    "unit": "cents",
    "currency": "EUR"
  },
  "id": "00556cd181f2409aaa6c2a033cce3a8fcovd",
  "created_at": "2021-08-03T18:01:48.000Z",
  "attached_at": "2021-08-03T18:01:48.000Z"
}

Business Overdrafts

Operations