Skip to main content
GET
/
v1
/
ledger
/
{ledger_key}
/
asset-move
/
{asset_move_key}
Get Asset Move
curl --request GET \
  --url https://api.sandbox.nxos.io/v1/ledger/{ledger_key}/asset-move/{asset_move_key} \
  --header 'Authorization: <authorization>'
{
  "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>",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "decline_type": "<string>",
  "categories": [
    "<string>"
  ],
  "metadata": {}
}

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"
​
asset_move_key
string
required

The key of the asset move. Examples:

  • "123e4567-e89b-12d3-a456-426614174000"
  • "id:123e4567-e89b-12d3-a456-426614174000"
  • "ref:move:transfer:account_a_to_b:2023-06-15"

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

​
destination_account
object
required

The represantation of the destination account

​
asset_code
string
required

The reference of the asset

Minimum string length: 1
​
amount
string
required

The amount of the asset to move

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