Skip to main content
POST
Settle a trade
v1 sunsets December 31, 2026. Migrate to v2 — see the migration guide.
Settles an existing trade. Use this endpoint to:
  • Move a trade from its pending settlement window into a terminal settled state
  • Confirm settlement timing for reconciliation
Idempotency is supported on v2 and v3 for this endpoint. v1 does not support idempotency keys — see Migration guide.

Errors

See the full v1 error reference.

Authorizations

Authorization
string
header
required

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

Headers

Idempotency-Key
string<uuid>

V2 only. Unique key for an idempotent settle trade request. Valid for 24 hours.

Example:

"323e4567-e89b-42d3-a456-426614174000"

Path Parameters

orgId
string
required

Body

application/json
tradeId
string<uuid>
required

Unique identifier of the trade being settled

Example:

"123e4567-e89b-42d3-a456-426614174000"

Response

Trade settled successfully

data
object
required
status
enum<string>
Available options:
success,
error
Example:

"success"

message
string
Example:

"Data fetched successfully"