GET
/
v1
/
ledger
/
{ledger_key}
/
transaction
curl --request GET \
  --url https://api.sandbox.nxos.io/v1/ledger/{ledger_key}/transaction \
  --header 'Authorization: <authorization>'
[
  {
    "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"

Query Parameters

​
cursor
string

The cursor for the next set of results. This is an opaque string representing the starting point for the next page. For the first request, this should be omitted or set to null.

​
limit
integer
default:25

The number of items to be returned per page. Determines the page size for the paginated results. Default value: 25 Maximum value: 100 (to prevent excessive load on the server)

​
source_account_id
string

The id of the source account for the transaction - lists all transactions where the account was the source

​
source_account_ref
string

The reference of the source account for the transaction - lists all transactions where the account was the source

​
destination_account_id
string

The id of the destination account for the transaction - lists all transactions where the account was the destination

​
destination_account_ref
string

The reference of the destination account for the transaction - lists all transactions where the account was the destination

Response

200 - application/json
The request has succeeded.
​
transaction_id
string
required

The unique internally assigned identifier of the transaction

​
asset_moves
object[]
required

The asset moves for the transaction

​
created_at
string
required

The created at timestamp

​
updated_at
string
required

The updated at timestamp

​
transaction_ref
string

The externally defined reference of the transaction