This page lists the various events you may encounter while a deal is under processing for Liberis. Be aware that the events you receive will vary based on the agreed Payment Method between you and Liberis. For any inquiries, please contact your partner manager.
Events: settlement_account_ready
This webhook notification is triggered to inform you about an established agreement for a Settlement Account deal with a merchant, urging you to update your system for seamless processing. Unlike the previous arrangement where funds were directed to the Merchant's account, now these funds are to be channeled into a settlement account created by Liberis in the Merchant's name. It's imperative that you update your records accordingly to redirect the merchant’s funds into the specified settlement account, ensuring the new transaction pathway adheres to the updated protocol.
{
"id": "6e17e99c-d2fc-48d6-b60a-d543c5c8aa52",
"api_version": "1.0",
"event": "settlement_account_ready",
"created_date": "2023-02-06T13:40:00Z",
"data": {
"currency": "GBP",
"created_date": "2023-02-06T13:40:00Z",
"identifiers": {
"account_number": "12345678",
"sort_code": "000000",
"routing_number": "026073150"
},
"references": {
"application": "3h2701-s2d0-4d1a-b312-afs3219014fe",
"merchant": "6f07701-96d0-4d1a-b82c-ad6c069014fe",
"deal": "5001a000002bsyxcch",
"external_merchant": "M_12432_4345",
"ownership_document_id": "7af5f640-584d-4b6d-9d7b-3b38864a93e1"
},
"actions": {
"notify": "/actions/funding/sa-notify/6f07701-96d0-4d1a-b82c-ad6c069014fe"
}
}
}
| Field | Datatype | Description |
|---|---|---|
| currency | string | The standardized three-letter ISO code representing the currency associated with the account. |
| created_date | string | The ISO 8601 formatted date string indicating the creation date of the account. |
| identifiers | object | A collection of banking information associated with the new account. |
| account_number | string | The unique number assigned to the new account by the banking institution. |
| sort_code | string | The bank's identification code assigned to the new account, facilitating the routing of funds. |
| routing_number | string | A nine-digit code assigned to a bank or financial institution in the United States. |
| references | object | A collection of identifiers relating to various associated entities or objects. |
| deal | string | The unique identifier for the deal as recorded in Liberis' system. |
| application | string | The unique identifier for the application as recorded in Liberis' system. |
| merchant | guid | The unique identifier for the merchant within Liberis' system, also referred to as the LiberisId. |
| external_merchant | string | The unique identifier for the merchant within your system, as provided to Liberis. |
| ownership_document_id | string | Identifier to query the documents endpoint for any attached ownership documents of the merchant's virtual settlement account. Null if no document is present. |
| actions | object | A collection of URLs for actions pertinent to this event. |
| notify | string | The URL to be called to notify Liberis of successful updates to the merchant's account for fund redirection to the settlement account. Refer to Replying to Webhook Actions for more details. |
The notify action is required to be called by consumers after they have updated their payment records. Merchant deals will not be funded without a successful notification.
Events: awaiting_split_validation
This webhook notification acts as the initiation signal for validating a partner split deal. Upon receipt of this webhook, you are required to conduct preliminary checks to ascertain your capability to apply a split for the merchant. This is a crucial step to proficiently process the partner split deal. It's imperative to confirm each application or removal of a split, ensuring a structured validation process. It is important to note that during this initial checking phase, the actual split should not be applied. The aim is to determine the feasibility of applying a split for this merchant before proceeding to the actual application of the split.
{
"id": "6e17e99c-d2fc-48d6-b60a-d543c5c8aa52",
"api_version": "1.0",
"event": "awaiting_split_validation",
"created_date": "2023-02-06T13:40:00Z",
"data": {
"currency": "GBP",
"created_date": "2023-02-06T13:40:00Z",
"split_percent": "20",
"references": {
"application": "5001a000002axxeef",
"merchant": "6f07701-96d0-4d1a-b82c-ad6c069014fe",
"deal": "5001a000002bsyxcch",
"external_merchant": "M_12432_4345"
},
"actions": {
"notify": "<url>"
}
}
}
| Field | Datatype | Description |
|---|---|---|
| currency | string | The three-letter ISO currency code of the account. |
| created_date | string | The ISO 8601 formatted date string marking the creation date of the account. |
| split_percent | string | The agreed percentage for the split pertaining to the deal. |
| references | object | A collection of identifiers relating to various associated entities or objects. |
| deal | string | The unique identifier for the deal as recorded in Liberis' system. |
| application | string | The unique identifier for the application as recorded in Liberis' system. |
| merchant | guid | The unique identifier for the merchant within Liberis' system, also referred to as the LiberisId. |
| external_merchant | string | The unique identifier for the merchant within your system, as provided to Liberis. |
| actions | object | A collection of URLs for actions pertinent to this event. |
| notify | string | The URL to be called to notify Liberis of the outcomes of the pre-split checks. Refer to Replying to Webhook Actions for more details. |
The notify action is required to be called by consumers after they have performed their pre-split checks. Merchant deals will not be funded without a successful notification.