PUT
/
v1
/
ledger
/
{ledger_key}
/
asset-move

Headers

Authorization
string
required

The Basic Authentication header. Format: "Basic {base64(orgID:apiKey)}"

Path Parameters

ledger_key
string
required

The key of the ledger. Examples:

  • "123e4567-e89b-12d3-a456-426614174000"
  • "id:123e4567-e89b-12d3-a456-426614174000"
  • "ref:ledger:customer_a"

Body

application/json · object[]
asset_move_key
object
required

The unique identifier for the asset move to be updated. Either 'ref' or 'id' must be provided, but not both.

categories
string[]

An array of categories to associate with the asset move. These can be used for classification or reporting purposes.

metadata
object

Additional custom data to associate with the asset move. This can be any JSON-serializable object.

status
string

The new status for the asset move. Should be one of the valid AssetMoveStatus values.

Response

200 - application/json
amount
string
required

The amount of the asset to move

asset_code
string
required

The reference of the asset

Minimum length: 1
asset_move_ref
string
required

The unique reference of the asset move, set by you when creating the asset move

created_at
string
required

The created at timestamp

destination_account
object
required

The represantation of the destination account

source_account
object
required

The representation of the source account

status
enum<string>
required

The status of the asset move

Available options:
EXPECTED,
LOCKED,
COMPLETED,
DECLINED,
REFUNDED
type
string
required

The type of the asset move

Minimum length: 1
updated_at
string
required

The updated at timestamp

categories
string[]

The categories of the asset move

decline_type
string

the specific decline reason for the asset move in case the asset-move has been declined. This can be a system-defined reason such as INSUFFICIENT_FUNDS, or LIMIT_EXCEEDED, or it can be a custom defined type of so set during the transaction creation

metadata
object

Additional, optional, metadata for the asset move