Contents
Reading Your Settlement Report
If you choose to receive your settlement reports via email or by SFTP, you will receive both a summary and detailed report file (.csv). The summary report contains totals so you can see a performance snapshot. The detailed report contains every single event so you can see exactly what is happening.
Opening up a detailed report may resemble the example below:
For your reference, you can download a sample settlement report here.
Standard settlement reports include the following details (note: the format column is useful for developers who want more control over the data. Additionally, the bolded name items are included as a default while non-bolded items are optional/may require additional configuration to include):
|
Name |
Format |
Description |
|
date |
String (ISO 8601 UTC) |
Transaction event date. |
|
charge_created_date |
String (ISO 8601 UTC) |
Loan creation date (ex: 2022-11-30). |
|
charge_id |
String (9 alphanumeric characters) |
Affirm's persistent transaction identifier. The Charge ID remains even after you refund a charge. |
|
transaction_id |
String (16 alphanumeric characters) |
A unique value created for each charge transaction. Capturing a charge and then voiding the charge will create 2 different Transaction ID’s. It is distinct from the Transaction ID and the Transaction Event ID in the Transaction APIs. |
|
order_id |
String (128 alphanumeric characters maximum) |
Partner's transaction identifier. This is an optional value that you provide in the checkout object. If you do not provide Order ID’s, this column will be empty. |
|
event_type |
String |
This is the current state of the charge. Possible values are: loan_captured loan_refunded dispute_opened dispute_resolved merchant_fee fee_adjustment refund_voided vcn_balance_fee_adjustment * split_capture |
|
sales |
Float (CAD dollars) |
This is the amount of the sales transaction and may be positive, negative, or zero. When you capture the loan or win a dispute, Sales is the positive value of that transaction. When a customer opens a dispute, Sales is zero and the negative value of that transaction is reflected under Refunds. |
|
refunds |
Float (CAD dollars) |
This is the amount of the refund and may be a negative value or zero. When you refund a loan, Refunds are the negative value of the refund. In all other cases, Refunds are zero. |
|
fees |
Float (CAD dollars) |
This is the fee that Affirm charges for this transaction and may be positive or negative. When you capture a loan or resolve a dispute, fees will be a negative value. If you refund a loan or if a customer opens a dispute, fees is a positive value. |
|
total_settled |
Float (CAD dollars) |
This is the total amount deposited into your bank account. It is the sum of all Sales, Refunds, and Fees. |
|
txn_fees |
Float (CAD dollars) |
This is a transaction fee that is charged by Affirm for processing a loan (Not to be confused with Fees as this is charged outside of that). Please confirm with your Affirm technical counterpart if you would like to enable this property |
|
merchant_name |
String |
The name of the Affirm account. Please confirm with Affirm if you would like to enable this property. |
|
financing_program |
String |
If the customer qualified for a financing program, the program name will be listed here. Please confirm with Affirm if you would like to enable this property. |
|
entity_name |
String |
If you have multiple channels that use the same API keys, the Entity Name is an optional string you can provide in the checkout object. Please confirm with Affirm if you would like to enable this property. |
|
deposit_id |
String (15 alphanumeric characters) |
Affirm assigns this random string related to a single deposit to every charge in a settlement. Each charge with the same Deposit ID was deposited on the same day. For any given day you’ll have a Deposit ID per lending partner that was involved in a charge for that day. |
|
dispute_reason |
String |
For dispute events, details on the reason for the dispute will be listed here. Please confirm with Affirm if you would like to enable this property. |
Reconciling Your Settlements
For simple reconciliation purposes, you can filter out/hide extra information so you can focus on items like total_settled.
- The date of the settlement file is the date we initiated the ACH transfer to your bank account, which is a different date than when the charge was processed.
- Take the sum of all the amounts in the total_settled column that have the same Deposit ID. This sum should equal the amount of a deposit made into your bank account. You may have multiple deposits each day (one per lending partner).
- If you use Order ID, take the sum of all the amounts with the same Order ID across different reports to calculate the final state of that order.
- You can optionally map each Transaction_id to your accounts payable or accounts receivable in your accounting system.