Skip to main content
POST
Settle a trade
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 required. This POST requires an Idempotency-Key header. Keys are cached for 24 hours. Reusing the same key with the same body returns the cached response; reusing it with different parameters returns a 422 error.

Errors

See the full v2 error reference for retry semantics and idempotency-specific codes.

Authorizations

Authorization
string
header
required

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

Headers

Idempotency-Key
string<uuid>
required

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"