Settlements

Create a Settlement and generate a secure URL for file upload

Changed on

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 a settlement file to the secure URL).

post/v3.0/{ClientId}/payins/intents/settlements

Request

  • Base URL
    https://api.sandbox.mangopay.com
  • URL
    https://api.sandbox.mangopay.com/v3.0/{ClientId}/payins/intents/settlements
  • Auth
    HTTP bearer

Path parameters

ClientIdstring required

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

Request body

FileNamestring required

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 a settlement file to the secure URL for details

SettlementIdstring

The unique identifier of the Settlement.

Changes

  • f44a59c76515Revision changes
    • warning

      deleted the header request parameter Authorization

    • info

      the endpoint scheme security oauth2 was added to the API

  • 8e731ec4a85bRevision changes
    • info

      api operation id create_settlement removed and replaced with settlements_create_settlement