Get Ledger

Get a ledger

Nxos API Reference

Introduction

The central data structure that holds all financial information in nxos

Ledger

An entity within the ledger that holds assets

Accounts

Something of value that can be moved between accounts

Assets

The transfer of assets from one account to another

Asset Move

A group of asset moves executed together as a single, atomic operation

Transaction

The amount of a specific asset held by an account at a given time

Balance

Create Expected Payment

Attempts to reconcile an expected payment with reconciliation data such as reference code, amount, and currency.

Reconcile Expected Payment

Retrieves a list of quotes based on specified criteria.

This endpoint allows querying for quotes with filters for base and counter assets,
as well as the type of quote (BUY or SELL).

You can specify a provider (e.g., "coinsph", "ebury") to get quotes from a specific provider.
If no provider is specified, "coinsph" is used as the default.

Some providers (like Ebury) require additional parameters:
- counter_amount: The amount of the counter currency that will be sold or bought
- target_country: ISO 3166-1 alpha-2 country code for the destination (determines KYC requirements)

List Quotes

Accepts a quote and initiates a transfer.

This endpoint allows accepting a previously obtained quote to initiate a transfer
to the specified destination. The transfer will debit the source account and
initiate the transfer to the destination according to the quote details.

Accept Quote

Mints a new voucher with specified parameters.

This operation creates a voucher by allocating funds from a specified source account.
The voucher is assigned a unique identifier and can be redeemed before its expiration date.

Mint Voucher

Redeems a voucher, transferring all or part of its value to a specified target account.

This operation allows for full or partial redemption of a voucher. If the redeemed value
is less than the total voucher value, the voucher remains active with the remaining balance.
Once fully redeemed, a voucher cannot be used again.

Redeem Voucher

Updates an existing voucher with new parameters.

This operation allows modification of certain voucher properties.
Typically, this might include extending the expiration date or changing the status.

Update Voucher

Retrieves a list of vouchers based on specified criteria.

List Vouchers

The Create Ledger API endpoint establishes a new ledger in the system. A ledger serves as the primary container for financial data, including accounts, assets, and transactions. Each ledger can have a unique reference for easy identification. Users can create multiple ledgers to separate different business units or use cases.

Create a Ledger

The Create Account API endpoint adds a new account to the specified ledger. Each account can have a unique reference, which serves as a readable ID or account address. While optional, this reference provides an easy way to identify the account in subsequent operations. Accounts can hold multiple assets and are used to track balances and participate in transactions within the ledger.

Initialize Account

Enable Asset For Account

List Accounts

Gets the balance for a specific asset in an account

Get Asset Balance for Account

Get Balance History for an Account and Asset

Update Account

The Create Asset API endpoint adds a new asset to the specified ledger. The asset code must be unique and is used in all subsequent operations involving this asset. It can be a simple currency ISO code (e.g., USD, EUR) or include subunit precision (e.g., USD/2, USD/6) for higher accuracy.

Create Asset

List Assets

The Record Transaction API endpoint is the core method for creating and executing financial transactions in the Nxos system. It allows you to create complex, multi-asset transactions consisting of one or more asset moves, all processed atomically. 
This endpoint supports various transaction types, from simple transfers to intricate multi-hop exchanges, and includes features like idempotency through transaction references and metadata support for both transactions and individual asset moves. 
Importantly, the asset moves within a transaction are executed sequentially in the order they're included, allowing for self-funding chains where later moves can depend on the balance changes from earlier moves.

Create Transaction

The List Transactions API endpoint allows you to retrieve a paginated list of transactions within a specified ledger.

List Transactions

Refund a Transaction

Retrieve an Asset Move

Retrieve a Transaction

Retrieves the history of an asset move

The Update Asset Moves API endpoint allows updating multiple asset moves in a single request. Asset moves are processed sequentially from index 0 to n-1. This order is significant as each update can affect subsequent moves.

Get Started

Core Concepts

Payment

Transfer

Wallets and Vouchers

Ledger

Account

Asset

Transaction and Asset Moves

Classification Types

Get Ledger

Headers

Path Parameters

Response