Skip to content
Webhooks
/
/
OVERDRAFT

Webhooks (1.0)

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

https://docs.solarisgroup.com/_mock/api-reference/onboarding/webhooks/

Webhook subscription

Operations

Webhook events

Webhooks

MESSAGEWebhook

Request

The message to a customer

Bodyapplication/json
account_idstring

ID of the account for which the message is being sent.

Example: "c2a13abed3b0686ab5343aa748d7f2fecacc"
channelstring

The notification channel used to send the message.

Enum"any""email"
Example: "email"
person_idstring

ID of the person associated to whom the message is being sent.

Example: "0ba2211cab11af6094d60ead81f2bd9dcper"
titlestring

The title of the message.

Example: "Ihre Samsung Pay Bezahlung"
textstring

The text of the message.

business_idstring

ID of the business to whom the message is being sent.

Example: "567eaf2b22fce21a1920e14e11e2bfa3cbiz"
application/json
{
  "account_id": "c2a13abed3b0686ab5343aa748d7f2fecacc",
  "channel": "email",
  "person_id": "0ba2211cab11af6094d60ead81f2bd9dcper",
  "title": "Ihre Samsung Pay Bezahlung",
  "text": "string",
  "business_id": "567eaf2b22fce21a1920e14e11e2bfa3cbiz"
}

Responses

Return 200 to indicate that you successfully received the webhook notification.

OVERDRAFTWebhook

Request

The status of a freelancer overdraft has changed.

Bodyapplication/json
idstringrequired

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

Example: "00556cd181f2409aaa6c2a033cce3a8fcovd"
person_idstringrequired

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

Example: "dc1a6812a14f6cc338cd084208535bcdcper"
statusstringrequired

The status of an overdraft offered to a freelancer.

Enum"created""interest_conditions_set""limit_set""terminated"
Example: "created"
created_atstring(datetime)required

The date and time the overdraft was created.

Example: "2021-08-03T18:01:48.000Z"
interest_accruedSolarisToolkit.Web.Money (object)required
SolarisToolkit.Web.Money (object)
overdraft_ratenumber

The interest rate applicable to the overdraft.

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

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

Example: 3
account_idstring or null

The unique ID of a customer's bank account.

Example: "575189c6eb825b10b9d0392fcb3bf61dcacc"
application/json
{
  "status": "created",
  "person_id": "dc1a6812a14f6cc338cd084208535bcdcper",
  "overdraft_rate": 9,
  "limit": {
    "value": 1000,
    "unit": "cents",
    "currency": "EUR"
  },
  "interest_conditions_enabled": true,
  "interest_accrued": {
    "value": 1000,
    "unit": "cents",
    "currency": "EUR"
  },
  "interest_accrual_rate": 3,
  "id": "00556cd181f2409aaa6c2a033cce3a8fcovd",
  "created_at": "2021-08-03T18:01:48.000Z",
  "account_id": "575189c6eb825b10b9d0392fcb3bf61dcacc"
}

Responses

Return 200 to indicate that you successfully received the webhook notification.

OVERDRAFT_APPLICATIONWebhook

Request

The status of a freelancer overdraft application has changed.

Bodyapplication/json
idstringrequired

The unique ID of a freelancer overdraft application.

Example: "b83z264de98741018419b53648e20ca9coap"
person_idstringrequired

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

Example: "dc1a6812a14f6cc338cd084208535bcdcper"
statusstringrequired

The status of a freelancer overdraft application.

Enum"initial_scoring_pending""account_snapshot_pending""account_snapshot_verification_pending""offered""rejected""expired""deleted""overdraft_created"
Example: "offered"
created_atstring(datetime)required

The date and time the freelancer overdraft application was created.

Example: "2021-08-03T18:01:48.000Z"
rejection_reasonsArray of strings or null

The reason(s) for rejecting an overdraft application.

partner_risk_classstring or null

The risk class assigned to a freelancer by the partner.

Example: "d"
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_ratenumber

The interest rate applicable to the overdraft.

Example: 9
overdraft_idstring or null

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

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

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

Example: 3
decisionstring or null

Solaris' decision on the overdraft application.

Enum"REJECTED""OFFERED"
Example: "OFFERED"
credit_record_idstring or null

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

Example: "fbb7d15fa4c54ba0b077592665ef04a4ccrd"
account_snapshot_idstring or null

The unique ID of an account snapshot of a specific person account.

application/json
{
  "status": "offered",
  "rejection_reasons": [
    "string"
  ],
  "person_id": "dc1a6812a14f6cc338cd084208535bcdcper",
  "partner_risk_class": "d",
  "partner_reference_number": "a123456",
  "partner_contact_number": "+491565904345",
  "partner_contact_name": "Peter Mustermann",
  "overdraft_rate": 9,
  "overdraft_id": "00556cd181f2409aaa6c2a033cce3a8fcovd",
  "limit": {
    "value": 1000,
    "unit": "cents",
    "currency": "EUR"
  },
  "interest_conditions_enabled": true,
  "interest_accrual_rate": 3,
  "id": "b83z264de98741018419b53648e20ca9coap",
  "decision": "OFFERED",
  "credit_record_id": "fbb7d15fa4c54ba0b077592665ef04a4ccrd",
  "created_at": "2021-08-03T18:01:48.000Z",
  "account_snapshot_id": "string"
}

Responses

Return 200 to indicate that you successfully received the webhook notification.