Trigger a settlement run (testing and sandbox ONLY)

A POST request to trigger the settlement process. Only available in non-production environments.
Rate limited to 1 request per 5 minutes.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
date-time
required

The cutoff datetime for settling cleared transactions

string
length between 40 and 40

Optional wallet ID to scope settlement to a specific wallet

Responses
200

Settlement run triggered successfully

400

The server cannot or will not process the request due to something that is perceived to be a client error (e.g., malformed request syntax, invalid request message framing, or deceptive request routing).

401

Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response.

403

The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource. Unlike 401 Unauthorized, the client's identity is known to the server.

429

The user has sent too many requests in a given amount of time ("rate limiting").

500

The server has encountered a situation it does not know how to handle.

Language
Credentials
Header
LoadingLoading…