Skip to content
Webhooks
/
/
BUSINESS_FRONTING_RELATIO...

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

BUSINESS_FRONTING_PAYOUT_UPDATEWebhook

Request

The status of a partial fronting loan payout has changed to transfers_complete.

Bodyapplication/json
idstringrequired

The unique ID of a business fronting loan's payout.

Example: "963347398e47416c9df216a63ef035c2bflp"
loan_idstringrequired

The unique ID of the business fronting loan.

Example: "29e1a05906954ce082ec779d81de8c1ebflo"
recipient_ibanstringrequired

The IBAN of the loan payout's recipient.

Example: "DE92370601930002130041"
recipient_namestringrequired

The name of the loan payout's recipient.

Example: "Max Mustermann"
tagstringrequired

The tag of the business fronting loan's payout.

Enum"INITIAL_PAYOUT""RETENTION_FEE""FACTORING_INTEREST"
Example: "INITIAL_PAYOUT"
statusstringrequired

The status of the business fronting loan's payout.

Enum"transfers_pending""transfers_complete"
Example: "transfers_pending"
amountobject(SolarisToolkit.Web.Money)required

The amount of the loan payout.

Example: {"value":1000,"unit":"cents","currency":"EUR"}
amount.​valueintegerrequired

The amount value

Example: 1000
amount.​currencystringrequired

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

Example: "EUR"
amount.​unitstringrequired

The unit of the given value.

Value"cents"
Example: "cents"
transaction_descriptionstring or null

The transaction reference, which the recipient will see. Only use characters allowed by SEPA in this field.

Example: "Example transaction."
transaction_end_to_end_idstring or null

SEPA identifier (provided by the end customer who initiated the SEPA transaction), routed through the whole payment process. (Max 35 characters without whitespace)

Example: "DDHHDHG333243"
application/json
{
  "amount": {
    "value": 1000,
    "unit": "cents",
    "currency": "EUR"
  },
  "id": "963347398e47416c9df216a63ef035c2bflp",
  "loan_id": "29e1a05906954ce082ec779d81de8c1ebflo",
  "recipient_iban": "DE92370601930002130041",
  "recipient_name": "Max Mustermann",
  "status": "transfers_pending",
  "tag": "INITIAL_PAYOUT",
  "transaction_description": "Example transaction.",
  "transaction_end_to_end_id": "DDHHDHG333243"
}

Responses

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

BUSINESS_FRONTING_RELATIONSHIP_STATUS_CHANGEDWebhook

Request

The status of the fronting business relationship with a customer has changed.

Bodyapplication/json
idstring

The ID of the business resource whose business relationship status has changed.

Example: "3311ac2c0a6243a8836ab290380918facbiz"
statusstring

The status of the business relationship.

Example: "active"
application/json
{
  "id": "3311ac2c0a6243a8836ab290380918facbiz",
  "status": "active"
}

Responses

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

BUSINESS_IDENTIFICATIONWebhook

Request

A business identification was created, or its status was updated. The primary purpose of this webhook is to deliver the URL where the customer must be redirected to complete a video identification.

Bodyapplication/json
idstring

The unique ID of the business identification resource.

Example: "4c74c804eaea5d2a2d64ef400a27a4d3bid"
methodstring

The identification method. Default value is idnow.

Enum"idnow""itm""import"
Example: "idnow"
referencestring or null

The reference of the itm identification request. Empty when the identification method is idnow.

Example: null
urlstring

The URL to which you must redirect the business' legal representative(s) and/or authorized person(s) to complete the identification process.

Example: "https://go.test.idnow.de/..."
statusstring

The status of the business identification process.

Enum"created""pending""successful""failed""expired"
Example: "pending"
completed_atstring or null

The date and time when the business identification was completed.

Example: null
business_idstring

The ID of the business resource.

Example: "880bbac68a34add190786b9c74f4c82fcbiz"
application/json
{
  "id": "4c74c804eaea5d2a2d64ef400a27a4d3bid",
  "method": "idnow",
  "reference": null,
  "url": "https://go.test.idnow.de/...",
  "status": "pending",
  "completed_at": null,
  "business_id": "880bbac68a34add190786b9c74f4c82fcbiz"
}

Responses

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