Settlements

Update a Settlement and generate a new upload URL

Changed on

Generate a new pre-signed URL to replace the file of an existing Settlement

You can use this endpoint to generate a new SettlementFileUploadUrl for an existing Settlement object (with SettlementId).

This is necessary if a file you uploaded previously is not parsed or reconciled successfully.

put/v3.0/{ClientId}/payins/intents/settlements/{SettlementId}

Request

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

Path parameters

ClientIdstring required

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

SettlementIdstring required

The unique identifier of the Settlement object.

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 update_settlement removed and replaced with settlements_update_settlement