The create Revenue Claims endpoint is used to send Partner Client Revenue Claim data which Liberis will use as part of an Eligibility Check for a given Partner Client.
Definitions
Currency (currency)
We accept only one currency as part of your integration. This will be aligned with you during onboarding.
For example:
- EUR: for European companies
- GBP: for British companies
- USD: for United States companies
- etc...
Time Period (time_period)
We accept two levels of granularity for time period:
- Monthly
- Daily
Monthly Revenue Claims
To send a revenue claim at a monthly level of granularity, the start and end dates should represent the start and end of the month the revenue claim is related to.
i.e.
- start_date: 2025-01-01T00:00:00:000
- end_date: 2025-01-31T23:59:59:999
Daily revenue Claims
To send a revenue claim at a daily level of granularity, the start and end dates should represent the start and end of the day the revenue claim is related to.
i.e.
- start_date: 2025-01-01T00:00:00:000
- end_date:2025-01-01T23:59:59:999
Total Amount (total_amount) & Transaction Count (transaction_count)
At Liberis, we view revenue claims as either positively or negatively influencing revenue. Typically, in the world of transaction you might see a positive influencing transaction type being a sale and a negatively influencing transaction type being a return / chargeback
We simplified and extracted the concept of transactions and transaction types in our API and to indicate how a revenue claim influences a partner clients revenue, you should send total amount and transaction count in the same mathematical signage (i.e + or -) to indicate if this increases or decreases revenue.
For example, a positively influencing revenue claims (i.e a sale), would have these properties set with positive signage, as below:
- total_amount: 100
- transaction_count: 1000
A negatively influencing revenue claims (i.e a return or chargeback), would have both these properties set with negative signage, as below:
- total_amount: -100
- transaction_count: -1000