API Reference

Once Liberis has received both the business snapshot and transaction snapshot files, we will process the data and return a file containing offers for eligible merchants. These offers can be used for partner reporting, marketing, journey control etc.


File fields

*Note, this table has been flipped vertically to allow for all fields to be visible in the table

Column NameRow 1Row 2
Campaign_Name​PTNR_2021Jan_Core_1​PTNR_2021Jan_Core_1​
Date_Processed​2021-01-06​2021-01-06​
Offer_Expiry_Date​2021-02-06​2021-02-06​
Company_ID​ABC123​ABC124​
SubBrand​PartnerPartner
Country_Code​CANCAN
Currency_Code​CADCAD
Amount​50006000
Availability_Period98
Split​1516
Segment_Name​Newly Eligible​Newly Eligible​
Assigned_Drop​1​1

Definitions

Campaign_Name – This is an automatically generated identifying name for each campaign produced. Enables both Liberis and the partner to easily identify datasets and join across relevant datasets too.​

Date_Processed – This is the date this campaign dataset was produced.​

Offer_Expiry_Date – This is the date the offer, as it stands, is valid until.​

Company_ID - This is the agreed Company ID that is used (see the Transactions & Snapshots file explanations for more detail)​

SubBrand - This is the SubBrand of the company in this record – naming conventions for SubBrands to be agreed with partner in accordance with requirements for Business Snapshots and Transaction data receipt.​

Country_Code - This is the ISO alpha-3 country code of the company record that has been processed. Comes from the Business Snapshots file received from the Partner.​

Currency_Code - This is currency that the below offers will be expressed in. Comes from the Transactions file received from the Partner.​

Amount –This is the amount available to the company in this offer. The standardised file structure will allow for up to 3 offers per customer to be sent. By default, Offer1 will always be the primary offer. All values will be unformatted, whole rounded number, where possible but if building automated systems please allow for decimals. Must allow NULLs on all fields. ​

Availability_Period – This is timeframe in which a merchant is able to take an advance.

Split - This is the split required by the company to achieve this offer. With the Flexi Advance this is a % amount but the value will be expressed as a whole number (EG 20% would be shown as “20” in this field).​

Segment_Name – This is the name identifying the segment a company is in. This is dictated by the marketing teams and will be pre-agreed before the file is returned.​

Assigned_Drop – Where applicable, if customers need to be spread out over multiple drops, or given a rank-order preference of mailing – a drop number of rank value will be used here. Methodology agreed with partner