Skip to main content
GET
Read a settlement movement

Authorizations

Authorization
string
header
required

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

Scopes

settlements_read
bearer_auth
settlements_read
api_key

Headers

X-Workspace-Id
string<uuid>

The workspace the request acts in. An API key bound to a workspace implies it: omit the header, or send that same id (another id answers 403 WORKSPACE_SCOPE_MISMATCH). A member session must send it (400 MISSING_WORKSPACE without it).

Path Parameters

workspaceId
string
required

Workspace id

venueAccountId
string<uuid>
required

The venue account's id

movementId
string<uuid>
required

The movement's id

Response

amount
string
required

Exact asset quantity, never a floating-point value.

asset
string
required
correlationState
enum<string>
required

New values may be added; treat unknown values as other.

Available options:
pending,
matched,
ambiguous
direction
enum<string>
required

New values may be added; treat unknown values as other.

Available options:
intoVenue,
outOfVenue
evidence
any
required
finalityState
enum<string>
required

New values may be added; treat unknown values as other.

Available options:
observed,
confirming,
final,
failed,
reorged,
reversed
lastSuccessfulReadAt
string<date-time>
required
movementId
string<uuid>
required
observedAt
string<date-time>
required
occurredAt
string<date-time>
required
revision
integer<int64>
required
venueAccountId
string<uuid>
required
blockHash
string | null
confirmations
integer<int64> | null
Required range: x >= 0
destinationFinancialAccountId
string | null
lpTransferId
string | null
network
string | null
requiredConfirmations
integer<int64> | null
Required range: x >= 0
sourceFinancialAccountId
string | null
transferIndex
integer<int32> | null
Required range: x >= 0
txHash
string | null
walletTransferId
string | null