Skip to main content
GET
Get instruction

Authorizations

Authorization
string
header
required

Auth0 JWT access token. See Authentication for details.

Path Parameters

instruction_id
string<uuid>
required

Response

Successful Response

Read schema for settlement instructions.

Maps party_data/legs_data from the ORM model to party/legs in the response using validation_alias with populate_by_name so both names are accepted.

id
string<uuid>
required
trade_reference
string
required
status
string
required
settlement_id
string<uuid> | null
required
template_slug
string
required
role
string
required
party
Party · object
required
legs
Legs · object[]
required
timeout_at
string<date-time>
required
expires_at
string<date-time>
required
created_at
string<date-time>
required