EchoSettlements

Create a Settlement and generate a secure URL for file upload

Generate a pre-signed URL to which you can upload your Mangopay-format settlement file

This endpoint returns a unique temporary pre-signed URL, SettlementFileUploadUrl, that you can use to upload your Mangopay-format settlement file (see PUT Upload settlement file to secure URL).

Authentication

AuthorizationBearer
Bearer authentication of the form `Bearer <token>`, where token is your auth token. If your platform is using a [proxy](/guides/sca/proxy-management) to take SCA-triggering action on behalf of users, you also need to integrate [mTLS authentication](/guides/sca/platform) and use the `api-mtls` base URL.

Path parameters

ClientIdstringRequired
Platform's API account identifier, associated with the API key.

Request

This endpoint expects an object.
FileNamestringRequired

The name of your file, which can be anything you wish. The file extension must be .csv.

Response

Success
UploadUrlstring

The unique temporary pre-signed URL to which to upload your CSV file. Use the full dynamic URL including the host, path, and all query parameters. The URL is already authenticated, so the call does not require an Authorization header. See PUT Upload settlement file to secure URL for details

SettlementIdstring
The unique identifier of the Settlement.

Errors

400
Bad Request Error