The Feature is under construction and subject to change
Fetching data on a merchant
Please note it is advised to use Liberis' webhooks functionality to receive offer and contract status information for the merchant. This endpoint does not expose and personally identifiable information about the merchant.
The key purpose of this endpoint is to act as a way to retrieve all merchant deals and application data in a single request. A scenario would be if a merchant clicks a refresh CTA on your dashboard. We do not recommend polling this endpoint and is heavily discouraged.
Merchant request
Information is provided via a GET request. We require a LiberisId that is returned within the response when accepting an offer. An example of a request would be:
https://api.eu.liberis.com/v2/Merchant?LiberisId=88054d65-aa2d-4ff8-a1c3-209c2b66a353
Merchant response
The response data returns a list of deals and applications associated with the Merchant via their LiberisId. The deals list could be empty if the merchant has accepted an offer but a deal has not yet been approved.
Each deal will be returned on a deals object as an array. An object below it will display deal data relating to the offer and the merchants performance. Each application will be returned on a applications object as an array. An object below it will display application data relating to the offer and any contract links.
An example of a typical merchant response would be:
{
"deals": [
{
"id": "5001a000002bsyxcch",
"application_id": "6df65a6e-e6f5-e372-b157-e06b5427defb",
"type": "Renewal | Initial",
"status": "active deal",
"active": true,
"balance": 13500.00,
"currency": "GBP",
"performance": {
"performance": 80.5,
"progress": 10.0,
"renewal_eligibility": true
},
"pricing": {
"repayment_amount": 15000.00,
"funded_amount": 10000.00,
"split_percent": 20,
"factor_rate": 1.5,
"estimated_length_months": 9
},
"transactions": [
{
"principal_repaid": 667,
"repay_amount": 1000,
"repay_rate": 5.0,
"transaction_amount": 5000,
"transaction_date": "2023-03-20T00:00:00+00:00",
"transaction_type": "repayment",
"payment_channel_id": "POXXXXXXXXX42"
}
]
}
],
"applications": [
{
"application_id": "6df65a6e-e6f5-e372-b157-e06b5427defb",
"liberis_id": "88054d65-aa2d-4ff8-a1c3-209c2b66a353",
"created_at": "2023-02-09T12:21:39+00:00",
"status": "Quoted",
"pricing": {
"fixed_fee": 5000.0,
"repayment_amount": 15000.0,
"funded_amount": 10000.0,
"split_percent": 20.0,
"factor_rate": 1.5,
"estimated_length_months": 9.0
},
"contract_link": "contracts_link_example"
}
]
}
Deals
| Field | Datatype | Description |
|---|---|---|
| deals | array | List of deals associated with Liberis id provided. |
Deal
| Field | Datatype | Description |
|---|---|---|
| id | guid | The identifier for the deal. |
| application_id | guid | The identifier for the application that lead to the deal. |
| status | string | The deals status. This could be active, written off or closed. |
| active | boolean | Boolean field determining is the deal active. |
| balance | number | Decimal number representing the remaining balance of the deal. |
| type | string | Shows if the type of deal is an "Initial" or "Renewal". |
| performance | object | Merchants performance over the lifecycle of the deal. |
| pricing | object | Selected price the merchant agreed and remaining balance. |
| transactions | array | Rolling balance of transactions performed over the deal. |
Performance
| Field | Datatype | Description |
|---|---|---|
| performance | number | Performance percentage represented as a decimal number. |
| progress | number | Progress through the deal represented as a decimal number. |
| renewal_eligibility | boolean | Is the merchant eligible for renewal on this deal. |
Pricing
| Field | Datatype | Description |
|---|---|---|
| repayment_amount | number | Amount the merchant will repay. |
| funded_amount | number | Amount the merchant has been advanced. |
| split_percent | number | Decimal number representing the split amount. |
| factor_rate | number | Decimal number indicating the applied factor rate. |
| currency | string | Currency code the funded was funded in. |
| estimated_length_months | number | Number representing the estimated payback time in months. |
Transaction
| Field | Datatype | Description |
|---|---|---|
| principle_repaid | number | Amount of transaction that goes towards repaying the principle. Principle is the advance without fee (repay amount/factor rate) |
| repay_amount | number | Value of the transaction taken by liberis, this value is used to roll down the balance. |
| repay_rate | number | The agreed split on the transaction. |
| transaction_type | string | Type of transaction the represented. In example, repayment or refund. |
| transaction_amount | number | Inferred value of the transaction that was split from the repay amount. |
| transaction_date | string | The date the transaction took place on. |
| payment_channel_id | string | This is the id of the terminal used to collect the transaction |
Applications
| Field | Datatype | Description |
|---|---|---|
| applications | array | List of applications associated with Liberis id provided. |
Application
| Field | Datatype | Description |
|---|---|---|
| application_id | guid | The identifier for the application that lead to the deal. |
| liberis_id | guid | The identifier for the customer. |
| created_at | datetime | The date and time the application was created at. |
| status | string | The application status. - SEE BELOW FOR STATUSES |
| pricing | object | Pricing information for the accepted offer. |
| contract_link | string | Link to the contract for the application. |
Application Status
| Application Status | Recommended UI Message / UX progression |
|---|---|
| Created Assigned Quoted Submitted Evidenced Approved Agreement Signed Split Placed Payments Set Processed by Liberis | Application under review |
| Funded | Changed to active product page |
| Declined | Application has been declined |
| Withdrawn Rescinded Cancelled Lost Ineligible Written Off | Application has been closed |
Pricing
| Field | Datatype | Description |
|---|---|---|
| fixed_fee | number | The amount the merchant will repay beyond the funded amount, that is repayment_amount - funded_amount. |
| repayment_amount | number | Amount the merchant will repay. |
| funded_amount | number | Amount the merchant has been advanced. |
| split_percent | number | Decimal number representing the split amount. |
| factor_rate | number | Decimal number indicating the applied factor rate. |
| estimated_length_months | number | Number representing the estimated payback time in months. |