v2

latestOpenAPI 3.1.02026-07-262279731.3 MB

Settlements

Update a Settlement and generate a new upload URL

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}

Path parameters

ClientIdstring required

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

SettlementIdstring required

The unique identifier of the Settlement object.

Headers

Authorizationstring required

Bearer authentication of the form Bearer <token>, where token is your auth token.

If your platform is using a proxy to take SCA-triggering action on behalf of users, you also need to integrate mTLS authentication and use the api-mtls base URL.

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.