> This page is for Afterpay Partner API.

> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://developers.afterpay.com/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://developers.afterpay.com/_mcp/server.

# Settlement File Schema

The following is a typical settlement file format that is delivered in a CSV format.

Download an example transactions file: transactions.csv

| Index | Column                           | Data Type | Description                                                                                                                                                                         |
| ----- | -------------------------------- | --------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| 0     | Settlement Date                  | Date      | Date of settlement. Example: 4/21/2024                                                                                                                                              |
| 1     | Order Date and Time              | Datetime  | Order placed timestamp. Example: 4/20/2024 5:28:00                                                                                                                                  |
| 2     | Order Month                      | String    | Order placed month. Example: Apr                                                                                                                                                    |
| 3     | Order Year                       | Int       | Order placed year. Example: 2024                                                                                                                                                    |
| 4     | Afterpay Order ID                | String    | A unique ID generated by Afterpay to identify orders Example: 3398663780                                                                                                            |
| 5     | Merchant Order ID                | String    | A unique ID generated by the seller to identify orders Example: fasdfas123122                                                                                                       |
| 6     | Merchant Refund ID               | String    | A unique id generated by the seller’s system to identify refunds Example: 32123123xddff                                                                                             |
| 7     | Presentment Amount               | Decimal   | The full order amount displayed to the customer Example: 30.00                                                                                                                      |
| 8     | Presentment Currency             | String    | Currency displayed to the customer in the three-letter ISO 4217 currency code. Example: USD                                                                                         |
| 9     | Settlement Exchange Rate         | Decimal   | The exchange rate used to convert the presentment currency to the settlement currency. This applies to Cross Border Trade (CBT) orders only. Default value is 1. Example: 1         |
| 10    | Order Amount                     | Decimal   | Total order amount after the settlement exchange rate is applied. This amount is different from Presentment Amount only in cases of Cross Border Trade (CBT) orders. Example: 30.00 |
| 11    | Settlement Amount                | Decimal   | Settlement amount usually equals the Order Amount. It may be different than the Order Amount if partial or multi capture is used. Example: 30.00                                    |
| 12    | Variable Rate                    | Decimal   | Variable part of the buy rate associated with the seller. Example: 0.05                                                                                                             |
| 13    | Fixed Rate                       | Decimal   | Fixed part of the buy rate associated with the seller expressed in Fee Currency. Example: 0.3                                                                                       |
| 14    | Fee Amount                       | Decimal   | (`Settlement Amount` \* `Variable Rate`) + `Fixed Rate` expressed in Fee Currency.                                                                                                  |
| 15    | CBT Rate                         | Decimal   | Cross Border Trade (CBT) fee if applicable. Example: 0.01                                                                                                                           |
| 16    | CBT Fee Amount                   | Decimal   | `Settlement Amount` \* `CBT Rate` expressed in Fee Currency. Example: 0.01                                                                                                          |
| 17    | Merchant Fee excl Tax            | Decimal   | `Fee Amount + CBT Fee Amount` expressed in Fee Currency. Example: 0.9                                                                                                               |
| 18    | Tax Rate OR VAT Rate OR GST Rate | Decimal   | Indirect transaction tax rate on the Merchant Fee excl Tax. Example: 0.2                                                                                                            |
| 19    | Merchant Fee Tax                 | Decimal   | `Merchant Fee excl Tax` \* `Tax Rate` expressed in Fee Currency. Example: 0.18                                                                                                      |
| 20    | Merchant Fee incl Tax            | Decimal   | `Merchant Fee Excl Tax` + `Merchant Fee Tax` Example: 1.09                                                                                                                          |
| 21    | Fee Currency                     | String    | Currency fee is calculated in the three-letter ISO 4217 currency code. Example: USD                                                                                                 |
| 22    | Net Settlement Amount            | Decimal   | `Settlement Amount` - `Merchant Fee incl Tax` Example: 8.92                                                                                                                         |
| 23    | Net Settlement Currency          | String    | Currency to be settled to the partner in the three-letter ISO 4217 currency code. Example: USD                                                                                      |
| 24    | Type                             | String    | Line item event (i.e. "Order", "Refund") Example: Order                                                                                                                             |
| 25    | Channel                          | String    | Line item source (i.e. “Online”, or “In-store”) Example: Online                                                                                                                     |
| 26    | Store Name                       | String    | Store name for partners using the in-store channel only.                                                                                                                            |
| 27    | Store ID                         | String    | Store ID for partners using the in-store channel only.                                                                                                                              |
| 28    | Device Name                      | String    | Device name for partners using the in-store channel only.                                                                                                                           |
| 29    | Device ID                        | String    | Store name for partners using the in-store channel only.                                                                                                                            |
| 30    | Afterpay Refund ID               | String    | A                                                                                                                                                                                   |

**Important**

The following field names will change region-to-region due to different nomenclature for indirect tax by the auditing authorities.

**US/CA (Tax)**

* Merchant Fee excl Tax
* Tax Rate
* Merchant Fee Tax
* Merchant Fee incl Tax

**AU/NZ (GST)**

* Merchant Fee excl GST
* GST Rate
* Merchant Fee GST
* Merchant Fee incl GST

**AU/NZ (VAT)**

* Merchant Fee excl VAT
* VAT Rate
* Merchant Fee VAT
* Merchant Fee incl VAT

## Aggregation File Schema

The following is a typical aggregation file format that is delivered in a csv format.

Download an example aggregation file: aggregated.csv

| Index | Column               | Data Type | Description                                                                                    |
| ----- | -------------------- | --------- | ---------------------------------------------------------------------------------------------- |
| 0     | Settlement time      | Datetime  | Date of settlement. Example: 2024-04-04T13:01:25Z                                              |
| 1     | Settlement amount    | Int       | Amount settled with the partner. Example: 111001251                                            |
| 2     | Settlement currency  | String    | Currency of the settlement. Example: USD                                                       |
| 3     | Settlement account   | String    | Account of the settlement. Example: Partner Name                                               |
| 4     | Statement descriptor | String    | A statement descriptor for the settlement. Example: AfterPay settlement Partner Account Number |