- Transaction data – Header columns and a row for each transaction included in the settlement file
- A single empty row (string of commas)
- Footer rows – Summary data with header rows and a single value for each
Example template
You can use this Example_Mangopay_Settlement_File.csv (click here to download), which contains the correct column and row labels and example data for 3 transactions. Remove the example data lines before generating your own file.File requirements
- File type:
.csv - Delimiter: Comma
, - Max. file size: TBD
Mandatory fields
Columns (mandatory)
| Column name | Description | Format | Example |
|---|---|---|---|
ExternalProviderReference | The unique identifier of the transaction at the provider level. | string | auth-stripe-633781e6-bb10-4484-8a29-ff6da7d7464a |
ExternalTransactionType | The type of transaction using Mangopay’s accepted values:
| string | PAYMENT |
ExternalTransactionStatus | The status of the transaction. The accepted values listed can only apply to the ExternalTransactionType mentioned:
| string | SETTLED |
ExternalProcessingDate | The date on which the transaction was created. | date (DD-MM-YYYY) | 19-06-2025 |
Amount | The amount of the transaction in the currency’s minor unit. The Amount figure is positive or negative depending on the ExternalTransactionStatus:
- | string | 50000 (500) |
Currency | The currency of the transaction. | string | EUR |
Footer rows (mandatory)
| Footer row name | Description | Format | Example |
|---|---|---|---|
SettlementDate | The creation date of the settlement from the provider. | date (DD-MM-YYYY) | 19-06-2025 |
ExternalProviderName | The supported third-party PSP processing the transaction. | string | Stripe |
TotalSettlementFeesAmount | The total amount of fees taken by the provider from the settlement in the currency’s minor unit. This amount matches the sum of all ExternalProviderFees values in the file, if they are provided.The field accept a negative or positive value:
| string | 500 |
TotalNetSettlementAmount | Net settlement amount in the currency’s minor unit, which must be the sum of the Amount values of all transaction lines, minus the TotalSettlementFeesAmount. The Amount values must be declared as positive or negative as described depending on the ExternalTransactionStatus. | string | 50000 |
Optional fields
Columns (optional)
| Column name | Description | Format | Example |
|---|---|---|---|
ExternalPaymentMethod | The supported payment method used to process the transaction. | string | PAYPAL |
ExternalInitialReference | The unique identifier of the original transaction authorization or capture at the acquirer’s level.Required only when ExternalTransactionType is REFUND or DISPUTE. | string | capture-stripe-d5fad854-117c-4b1a-bf15-d8e2846749c7 |
ExternalProviderFees | The amount of fees deducted by the provider from the transaction Amount in the currency’s minor unit.The field accept a negative or positive value:
| string | 150 |
Footer rows (optional)
| Footer line name | Description | Format | Example |
|---|---|---|---|
SettlementCurrency | The currency of the settlement file. | string | EUR |
Related resources
Guides
Read more about Mangopay Echo
Endpoints
POST Create a Settlement