Skip to content
Webhooks
/
/
CREDIT_CARD_BILL

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

CREDIT_CARD_APPLICATION_TERMINATIONWebhook

Request

A credit card termination was created by Solaris for one of your customers' credit cards, or the status of an open termination has changed.

Bodyapplication/json
idstring

The ID of the credit card termination.

Example: "c7184779-3a57-5c8c-8ef4-c3aec9528531"
application_idstring

The ID of the credit card application that is being terminated.

Example: "a8cafe0c24e949c78bfbea04cb5b2905ccla"
reasonstring

The reason for the termination.

Enum"CUSTOMER_WISH""OTHER_IMMEDIATE""OTHER_ORDINARY"
Example: "CUSTOMER_WISH"
statusstring

The current status of the termination.

Enum"INITIATED""IN_PROGRESS""COMPLETED""REVOKED"
Example: "IN_PROGRESS"
legally_terminated_atstring(date)

The date when the credit card termination will take effect.

Example: "2023-08-31"
revocable_untilstring(date)

The date until which the termination can be revoked.

Example: "2023-08-02"
created_atstring(date-time)

UTC timestamp from when the termination was created.

Example: "2023-07-28T14:47:00.000Z"
application/json
{
  "id": "c7184779-3a57-5c8c-8ef4-c3aec9528531",
  "application_id": "a8cafe0c24e949c78bfbea04cb5b2905ccla",
  "reason": "CUSTOMER_WISH",
  "status": "IN_PROGRESS",
  "legally_terminated_at": "2023-08-31",
  "revocable_until": "2023-08-02",
  "created_at": "2023-07-28T14:47:00.000Z"
}

Responses

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

CREDIT_CARD_BILLWebhook

Request

The status of a credit card bill has changed.

Bodyapplication/json
idstring

UUID of the bill whose status changed.

Example: "aa21dag9d713a066597474a4568fa015bill"
application_idstring

UUID of the credit card application with which the bill is associated.

Example: "55906d353e6e4208b8172c165d2b61a1ccla"
statusstring

Status of the credit card bill.

Enum"PENDING""PAID""PRELIMINARILY_PAID""IN_DUNNING""CLOSED"
Example: "PAID"
start_datestring(date)

The billing cycle start date.

Example: "2022-04-01"
end_datestring(date)

The billing cycle end date.

Example: "2022-04-30"
statement_datestring(date)

Date when the statement was issued.

Example: "2022-05-01"
due_datestring(date)

Date when payment for this bill is due.

Example: "2022-05-15"
sdd_collection_datestring(date)

Date when the SEPA Direct Debit for collecting the payment will occur.

Example: "2022-05-16"
previous_bill_amountobject

The amount of the previous credit card bill.

total_outstanding_amountobject

The total outstanding amount for the credit card.

minimum_due_amountobject

The minimum payment the customer must make for this credit card bill.

outstanding_sddr_amountobject

The total amount outstanding for the dunning process.

outstanding_amountobject

The amount remaining to be paid on the current credit card bill (i.e., the total_outstanding_amount minus any previous payments).

current_bill_amountobject

The amount of the current credit card bill.

dunning_feesobject

The amount of dunning fees applied during this billing cycle.

other_feesobject

Any other fees applied during this billing cycle.

repayment_typestring

The type of credit card. Possible options are FULL (charge) and PARTIAL (revolving).

Enum"FULL""PARTIAL"
grace_period_in_daysinteger

Indicates number of days in the grace period for paying off the required amount in each billing cycle.

Example: 15
minimum_amountobject

The minimum amount to be repaid each billing cycle.

minimum_percentageinteger

The minimum percentage of the outstanding balance to be repaid each billing cycle.

Example: 3
accumulated_interest_amountobject

The total amount of interest accrued.

postbox_item_idstring

ID of the Postbox item that corresponds with the credit card bill.

Example: "c072c6e43f4d486cb553e9cd9fc1bae7pbxi"
application/json
{
  "id": "aa21dag9d713a066597474a4568fa015bill",
  "application_id": "55906d353e6e4208b8172c165d2b61a1ccla",
  "status": "PAID",
  "start_date": "2022-04-01",
  "end_date": "2022-04-30",
  "statement_date": "2022-05-01",
  "due_date": "2022-05-15",
  "sdd_collection_date": "2022-05-16",
  "previous_bill_amount": {
    "value": 5000,
    "unit": "cents",
    "currency": "EUR"
  },
  "total_outstanding_amount": {
    "value": 5000,
    "unit": "cents",
    "currency": "EUR"
  },
  "minimum_due_amount": {
    "value": 5000,
    "unit": "cents",
    "currency": "EUR"
  },
  "outstanding_sddr_amount": {
    "value": 5000,
    "unit": "cents",
    "currency": "EUR"
  },
  "outstanding_amount": {
    "value": 5000,
    "unit": "cents",
    "currency": "EUR"
  },
  "current_bill_amount": {
    "value": 5000,
    "unit": "cents",
    "currency": "EUR"
  },
  "dunning_fees": {
    "value": 5000,
    "unit": "cents",
    "currency": "EUR"
  },
  "other_fees": {
    "value": 5000,
    "unit": "cents",
    "currency": "EUR"
  },
  "repayment_type": "FULL",
  "grace_period_in_days": 15,
  "minimum_amount": {
    "value": 5000,
    "unit": "cents",
    "currency": "EUR"
  },
  "minimum_percentage": 3,
  "accumulated_interest_amount": {
    "value": 5000,
    "unit": "cents",
    "currency": "EUR"
  },
  "postbox_item_id": "c072c6e43f4d486cb553e9cd9fc1bae7pbxi"
}

Responses

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

CREDIT_LINE_APPLICATIONWebhook

Request

The status of a consumer credit line application has changed. Please see here all the events that trigger this webhook.

Bodyapplication/json
status_descriptionstring or null

Additional details about the credit line application status.

statusstring

The status of a consumer credit line application.

Enum"initial_scoring_pending""account_snapshot_pending""account_snapshot_verification_pending""identification_pending""offered""esign_pending""esign_complete""esign_failed""credit_line_creation_pending""credit_line_created"
Example: "account_snapshot_pending"
signing_idstring or null

The ID of the signing resource, created after the customer's identification and e-signing process has been triggered.

Example: "7c63600ddddec4f2668893af39c1b814csig"
scoring_workflowobject or null

An object containing certain actions required for the scoring process.

recipient_ibanstring or null

The IBAN of the customer's account to use for the account snapshot.

Example: "DE92370601930002130041"
reasonstring or null

The reason(s) for rejecting a credit line application.

person_idstring

The person ID of the customer applying for the credit line.

Example: "dc1a6812a14f6cc338cd084208535bcdcper"
partner_reference_numberstring or null

The partner reference number.

Example: "ABHP244919"
offered_limitobject or null(SolarisToolkit.Web.Money.Optional)

The offered credit line limit.

Example: {"value":1000,"unit":"cents","currency":"EUR"}
offered_interest_ratenumber or null

The offered interest rate to apply to the credit line.

Example: 2.5
net_disposable_incomeobject or null(SolarisToolkit.Web.Money.Optional)

The net disposable income available to the customer after deducting all taxes.

Example: {"value":1000,"unit":"cents","currency":"EUR"}
marriage_statusstring or null

The customer's marital status.

Enum"MARRIED""UNMARRIED""DIVORCED""UNKNOWN"
Example: "UNMARRIED"
identification_idstring or null

The unique ID of a customer's identification resource.

Example: "9e2e85c62230a652325964282c84559fcidt"
idstring

The unique ID of a consumer credit line application.

Example: "35eee37033c5436f9cbff6df1f88e097ccla"
employment_statusstring or null

The customer's employment status.

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

Solaris' decision on the credit line application.

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

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

Example: "1908331fb8384edcbfe63067366c4b6accln"
application/json
{
  "status_description": "string",
  "status": "account_snapshot_pending",
  "signing_id": "7c63600ddddec4f2668893af39c1b814csig",
  "scoring_workflow": {
    "required_actions": [ … ]
  },
  "recipient_iban": "DE92370601930002130041",
  "reason": "string",
  "person_id": "dc1a6812a14f6cc338cd084208535bcdcper",
  "partner_reference_number": "ABHP244919",
  "offered_limit": {
    "value": 1000,
    "unit": "cents",
    "currency": "EUR"
  },
  "offered_interest_rate": 2.5,
  "net_disposable_income": {
    "value": 1000,
    "unit": "cents",
    "currency": "EUR"
  },
  "marriage_status": "UNMARRIED",
  "identification_id": "9e2e85c62230a652325964282c84559fcidt",
  "id": "35eee37033c5436f9cbff6df1f88e097ccla",
  "employment_status": "EMPLOYED",
  "decision": "OFFERED",
  "credit_line_id": "1908331fb8384edcbfe63067366c4b6accln"
}

Responses

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