Upload a settlement file to the secure URL
Changed onTo send your CSV settlement file to Mangopay, use the SettlementFileUploadUrl value dynamically returned by POST Create a Settlement and generate upload URL endpoint.
<Warning icon="fa-regular fa-triangle-exclamation"> **Caution – Use settlement file example as template**You must follow the specifications provided here.
Use this <Download src="./Example_Mangopay_Settlement_File.csv">Example_Mangopay_Settlement_File.csv</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. </Warning>
You need to send one file per currency, as soon as it becomes available. Read more about providing settlement files to Mangopay.
When calling the pre-signed SettlementFileUploadUrl:
- Ensure you integrate the full URL (host, path, queries) dynamically as it is unique to each file upload attempt
- Don't include the Authorization header, as the URL is already authenticated in the query strings
- Set the Content-Type header to text/csv and send the file as a raw binary stream using data-binary
Note that the FileName used by Mangopay is the one you sent on the POST Create a Settlement and generate upload URL endpoint (with a timestamp automatically appended); the name of the file on your system is only relevant for the data-binary stream in this call.
Request
- Base URLhttps://api.sandbox.mangopay.com
- URLhttps://api.sandbox.mangopay.com/{SettlementFileUploadUrl}
- AuthHTTP bearer
Path parameters
The variable URL is only documented as a path parameter on this path for documentation reasons. I allows it to be rendered visiablly on the page, and because there are two dynamic server URLs in the spec (so both would be on the / path). The variable URL is the server for this request, and it has a variable host and path and query parameters. You do not need to add anything to it.
Request body
Response
No response body. A 200 response indicates that the file was uploaded successfully.
Empty response body
Changes
- warning
deleted the
headerrequest parameterAuthorization - info
the endpoint scheme security
oauth2was added to the API
- warning
- info
api operation id
upload_settlement_fileremoved and replaced withsettlements_upload_settlement_file
- info