This page outlines the webhook which relays information regarding payments received by Liberis and those transacted through a settlement account, detailing the data structure, fields, and examples of payment events.
Events: payment_received
This webhook provides information about payments that are received by Liberis, as well as payments that flow through a settlement account.
{
"id": "6e17e99c-d2fc-48d6-b60a-d543c5c8aa52",
"api_version": "1.0",
"event": "payment_received",
"created_date": "2023-02-06T13:40:00Z",
"data": {
"payment_id": "ff31d9a9-be6a-42bc-b6f1-744dbddc9ab0",
"amount": 150.0,
"currency": "GBP",
"description": "Payment to Liberis Ltd.",
"transaction_date": "2023-02-06T14:45:00Z",
"from": "settlement_account",
"to": "liberis",
"method": "settlement_account",
"remaining_balance": 15050,
"references": {
"application": "5001a000002axxeef",
"merchant": "6f07701-96d0-4d1a-b82c-ad6c069014fe",
"deal": "5001a000002bsyxcch",
"external_merchant": "M_12432_4345"
}
}
}
Field | Datatype | Description |
---|---|---|
payment_id | guid | The ID of the Payment in Liberis’ system. |
amount | number | The value of the payment |
currency | string | The three-letter ISO currency code of the payment. |
transaction_date | string | An ISO date string indicating when the payment was confirmed. |
from | string | The source of the payment. Will be one of "revenue", "liberis", "settlement_account", "merchant". |
to | string | The destination of the payment. Will be one of "revenue", "liberis", "settlement_account", "merchant". |
method | string | The type of payment. Could be one of "settlement_account", "direct_debit", "e-split", "other". Implementers should expect this list to grow in the future. |
remaining_balance | number | The remaining balance on the Deal |
references | object | A list of ids for related objects |
deal | string | The ID of the Deal in Liberis’ system. |
application | string | The ID of the Application in Liberis’ system. |
merchant | guid | The ID of the Merchant in Liberis’ system (also known as the LiberisId). |
external_merchant | string | The ID of the Merchant in the Partner's system (as supplied to Liberis by the Partner). |
Example – Multiple payment events generated by a single payment into a merchant’s settlement account
Payment | From | To | Amount | Balance | Date |
---|---|---|---|---|---|
Payment from Partner into the settlement account | revenue | settlement_account | 1000.00 | 15000.00 | 2023-02-02 14:15:00 |
Liberis’ Split | settlement_account | liberis | 150.00 | 14850.00 | 2023-02-02 14:15:30 |
Remainder to Merchant | settlement_account | merchant | 850.00 | 14850.00 | 2023-02-02 14:15:40 |