PUT
/
v1
/
ledger
/
{ledger_key}
/
asset-move
Update Asset Move
curl --request PUT \
  --url https://api.sandbox.nxos.io/v1/ledger/{ledger_key}/asset-move \
  --header 'Authorization: <authorization>' \
  --header 'Content-Type: application/json' \
  --data '[
  {
    "asset_move_key": {
      "ref": "<string>",
      "id": "<string>"
    },
    "status": "<string>",
    "categories": [
      "<string>"
    ],
    "metadata": {}
  }
]'
[
  {
    "asset_move_ref": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "source_account": {
      "ref": "<string>",
      "id": "<string>"
    },
    "destination_account": {
      "ref": "<string>",
      "id": "<string>"
    },
    "asset_code": "<string>",
    "amount": "<string>",
    "status": "EXPECTED",
    "type": "<string>",
    "decline_type": "<string>",
    "categories": [
      "<string>"
    ],
    "metadata": {},
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z"
  }
]

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.

​
status
string

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

​
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.

Response

200 - application/json

The request has succeeded.

​
asset_move_ref
string<uuid>
required

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

​
source_account
object
required

The representation of the source account Represents an account reference for asset moves. Used to specify source or destination accounts in asset movement operations. Exactly one of 'ref' or 'id' must be provided.

​
destination_account
object
required

The represantation of the destination account Represents an account reference for asset moves. Used to specify source or destination accounts in asset movement operations. Exactly one of 'ref' or 'id' must be provided.

​
asset_code
string
required

The reference of the asset

Minimum length: 1
​
amount
string
required

The amount of the asset to move

​
status
enum<string>
required

The status of the asset move Represents the current status of an asset move. Asset moves are transfers of assets between accounts and form the basis of transactions. Note: LOCKED and COMPLETED statuses affect account balances, while EXPECTED, DECLINED, and REFUNDED do not impact or release cap

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

The type of the asset move

Minimum length: 1
​
created_at
string<date-time>
required

The created at timestamp

​
updated_at
string<date-time>
required

The updated at timestamp

​
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

​
categories
string[]

The categories of the asset move

​
metadata
object

Additional, optional, metadata for the asset move