Skip to main content
POST
/
v1
/
ledger
/
{ledger_key}
/
transaction
Record Transaction
curl --request POST \
  --url https://api.sandbox.nxos.io/v1/ledger/{ledger_key}/transaction \
  --header 'Authorization: <authorization>' \
  --header 'Content-Type: application/json' \
  --data '{
  "transaction_ref": "<string>",
  "asset_moves": [
    {
      "asset_move_ref": "<string>",
      "source_account": {
        "ref": "<string>",
        "id": "<string>"
      },
      "destination_account": {
        "ref": "<string>",
        "id": "<string>"
      },
      "asset_code": "<string>",
      "amount": "<string>",
      "type": "<string>",
      "categories": [
        "<string>"
      ],
      "metadata": {}
    }
  ]
}'
{
  "transaction_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "transaction_ref": "<string>",
  "asset_moves": [
    {
      "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"
    }
  ],
  "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
​
asset_moves
object[]
required

The asset moves for the transaction

​
transaction_ref
string

The reference of the transaction - needs to be unique for the transaction, can be anything from a UUID to a reference of your choice. This is the reference you will use to interact with the transaction. This reference also guarantees idempotency, so if you send the same transaction reference twice, the second request will be ignored.

Minimum length: 1

Response

200 - application/json

The request has succeeded.

​
transaction_id
string<uuid>
required

The unique internally assigned identifier of the transaction

​
asset_moves
object[]
required

The asset moves for the transaction

​
created_at
string<date-time>
required

The created at timestamp

​
updated_at
string<date-time>
required

The updated at timestamp

​
transaction_ref
string

The externally defined reference of the transaction

⌘I