Reconciliation Report
The reconciliation report will include all rewards that are eligible for payment to you within the date range of the report.
Use this report to validate PAYOUT_CONFIRM reward events you have received through the notifyReward webhook. Reward events can be matched from the rewardId to the reconciliation report reward_id.
This report will also specify the revenue share earned per reward (if applicable).
Example report
To get an idea of what a reconciliation file will look like, you can download a sample report here: sample reconciliation report.
Delivery
Reconciliation files will be made available via SFTP - the uri and ssh key will be provided to you during integration. Reports generated on the first day of the month for the previous month. This frequency can be customized if needed.
Format
The reconciliation report is made available as an CSV file. Each file will include a header row following by zero or more rows.
| Column Name | Example | Description |
|---|---|---|
| id | 5 | The identifier for the report - together the id and the revision_number make up a unique identifier. |
| revision_number | 0 | The revision number - a sequential integer starting at 0 representing a revision of a report with the same id. In cases where a reconciliation report contains errors, a new report will be generated under a new revision. |
| start_date_utc | 2020-05-01 | The start date of the date range for this report. |
| end_date_utc | 2020-05-15 | The end date of the date range for this report. |
| merchant_name | Walmart | The normalized merchant name. |
| user_id | 00000000-0000-0000-0000-000000000000 | Corresponds to the userId sent in the notifyTransaction. |
| transaction_id | 22222222-0000-0000-0000-000000000000 | Corresponds to the transactionId sent in the notifyTransaction. |
| transaction_date_utc | 2020-05-01 11:06:55 | The utc datetime corresponding to the transactionTimestamp sent in the notifyTransaction. |
| transaction_amount | 34.78 | The total amount of the transaction in dollars. |
| transaction_currency | USD | ISO three letter currency code of the transaction amount. |
| cash_back_amount | 3.48 | The total amount of cashback the user is owed in dollars. |
| cash_back_currency | USD | ISO three letter currency code of the cash_back_amount. |
| reward_id | 33333333-0000-0000-0000-000000000000 | UUID identifier for the cash_back reward. |
| marketing_fee_amount | 3.45 | Cardlytics platform marketing fee in dollars. |
| marketing_fee_currency | USD | ISO three letter currency code of the marketing_fee_currency. |
| rev_share_amount | 1.33941 | The total amount of revenue share you earned from the transaction. |
| rev_share_currency | USD | ISO three letter currency code of the rev_share_amount. |
| rev_share_rate | 0.10 | The revenue share percentage expressed as a decimal between zero and one. |
| payout_confirmation_date_utc | 2020-05-04 11:06:55 | The utc datetime the reward was credited to the user's account. |