Trades / API reference

Get trade by ID

Request and response reference for GET /v1/trades/{trade_id}.

GET/v1/trades/{trade_id}

Authentication: API key

Use the base URL and access configuration provided to your institution. Examples are request templates, not transaction results. Field tables focus on client fields; preserve additional metadata returned by the configured service.

Request

Keep API keys in your backend. Required entitlements and institution scope still apply.

Request templatecURL

curl -X GET "$OSAI_API_BASE_URL/v1/trades/$TRADE_ID" \
  -H "Authorization: ApiKey $OSAI_PUBLIC_ID:$OSAI_API_SECRET"

Parameters

Name	Location	Requirement	Description
`Authorization`	header · string	Required	Use the value defined for this resource.
`X-Request-Id`	header · string	Optional	Use the value defined for this resource.
`trade_id`	path · string	Required	Use the value defined for this resource.

Request body

This operation does not define a JSON request body.

Responses

Inspect HTTP status before parsing a body. These tables describe client response fields rather than invented successful transaction payloads.

200 · Trade found

Field	Type	Description & constraints
`trade_id`Required in parent object	`string`	Defined by the resource contract.
`quote_id`Required in parent object	`string`	Defined by the resource contract.
`institution_id`Required in parent object	`string`	Defined by the resource contract.
`status`Required in parent object	`string`	Defined by the resource contract.
`base_amount_minor`Optional	`integer`	Defined by the resource contract.
`base_currency`Optional	`string`	Defined by the resource contract.
`quote_currency`Optional	`string`	Defined by the resource contract.
`pricing_snapshot`Optional	`object`	Immutable accepted quote economics; present when the trade was created from a priced quote.
`pricing_snapshot.quote_mode`Required in parent object	`string`	Defined by the resource contract.Values: FIXED_SOURCE, FIXED_DESTINATION
`pricing_snapshot.requested_amount_minor`Optional	`integer`	Defined by the resource contract.
`pricing_snapshot.source_principal_minor`Required in parent object	`integer`	Defined by the resource contract.
`pricing_snapshot.fee_minor`Required in parent object	`integer`	Defined by the resource contract.
`pricing_snapshot.total_debit_minor`Required in parent object	`integer`	Defined by the resource contract.
`pricing_snapshot.destination_amount_minor`Required in parent object	`integer`	Defined by the resource contract.
`pricing_snapshot.destination_target_minor`Optional	`integer`	Defined by the resource contract.
`pricing_snapshot.destination_surplus_minor`Optional	`integer`	Defined by the resource contract.
`pricing_snapshot.source_currency`Required in parent object	`string`	Defined by the resource contract.
`pricing_snapshot.destination_currency`Required in parent object	`string`	Defined by the resource contract.
`pricing_snapshot.rate_scaled`Required in parent object	`integer`	Defined by the resource contract.
`pricing_snapshot.rate_direction`Required in parent object	`string`	Defined by the resource contract.
`pricing_snapshot.rate_scale`Required in parent object	`integer`	Defined by the resource contract.
`pricing_snapshot.fee_schedule_id`Required in parent object	`string`	Defined by the resource contract.
`pricing_snapshot.fee_schedule_version`Required in parent object	`integer`	Defined by the resource contract.
`pricing_snapshot.source_minor_exponent`Required in parent object	`integer`	Defined by the resource contract.
`pricing_snapshot.destination_minor_exponent`Required in parent object	`integer`	Defined by the resource contract.
`pricing_snapshot.expires_at`Required in parent object	`string`	Defined by the resource contract.
`settlement_id`Optional	`string`	Defined by the resource contract.
`fx_execution`Optional	`object`	FX execution state is separate from destination payout state; UNKNOWN requires reconciliation before another submission.
`fx_execution.execution_id`Optional	`string`	Defined by the resource contract.
`fx_execution.executor_id`Optional	`string`	Defined by the resource contract.
`fx_execution.request_reference`Optional	`string`	Defined by the resource contract.
`fx_execution.status`Optional	`string`	Defined by the resource contract.Values: READY, SUBMITTED, UNKNOWN, EXECUTED, FAILED
`customer_reference`Optional	`string`	Institution-scoped client reference, when supplied.
`request_id`Optional	`string`	Defined by the resource contract.

Retries & recovery

Keep the original request identifiers and any required idempotency key. A timeout does not establish failure. Read the original resource or command before another financial write; use expected versions for concurrent changes.

Error handling →Idempotency →