API Reference

Deal Performance File

Liberis can share data about the history of deals for merchants that have used our platform for our BCA product.

This file is currently only available via SFTP. Your SFTP Credentials should be shared with you by Liberis when you are onboarded.

Filetypes currently available: CSV.

Filetypes available in the near future: Parquet. See: https://parquet.apache.org/docs/file-format/types/

Note: Data Type is only defined for Parquet exports. when sharing via CSV, the data type column can be used to infer what type you should store these as if you are ingesting the file into your own systems.

Note For outputs in CSV format, the ordering of columns within the file itself is not guaranteed to match the table below.

Fields - Partner Reporting V1.0 - Deal Performance

Column nameColumn DefinitionData Type (Parquet)NullableExample
application_idThe unique ID for the application that links to this contracted BCA. Format is Alphanumeric.STRINGNoAPP123
contract_idThe unique ID for the contracted BCA that has been made. Format is Alphanumeric.STRINGNoCONTRACT123
country_codeThe country code of the partner that this contract is linked to.

ISO 3166-1 A-3 format.
STRINGNoGBR
currency_codeThe currency code of the contract.

ISO 4217 format.
STRINGNoGBP
contract_splitThe amount of each payment that will be used to pay the remaining balance on the contract.

This will be a decimal between 0 and 1. For example, if a deal has a 21% split, the value of the contract_split column will be 0.21.
DECIMALNo0.23
contract_start_dateThe start date of the contract.

Datetime format: yyyy-MM-ddThh:mm:ss
DATETIMENo2024-01-05T00:00:00
contract_purchase_amount_lcyThe total amount the customer is contracted to repay.DECIMALNo25000.00
contract_purchase_price_lcyThe amount of money advanced according the contract. DECIMALNo20000.00
disbursed_purchase_amount_lcyThe net cash disbursed to the merchant, exclusive of fees, in the currency of the contract.DECIMALNo15000.00
disbursed_purchase_price_lcyThe net cash disbursed to the merchant, inclusive of fees, in the currency of the contract.DECIMALNo10000.00
factor_rateThe ratio of the purchased price divided by the purchased amount. DECIMALNo1.21
is_on_liberis_balance_sheetDetermines if the contract has been calculated as "On balance sheet" for Liberis.

true means that liberis has funded the contract_amount_lcy.
BOOLEANNoTRUE
merchant_reference_idAn Alphanumeric reference ID provided to liberis during an application, usually as part of the partner flow. This is unique to the merchant but not unique across applications. This can be an ID such as the anonymised Merchant_ID, or another reference ID generated by our partners and provided in journey.STRINGYesMERCHANTREF123
outstanding_balanceThe outstanding amount due still remaining on the contract.DECIMALNo123.45
payoff_amount_due_to_liberisThe amount due back to liberis.DECIMALNo123.45
partner_nameThe name of the partnerSTRINGNoLIBERIS