Transactions
Overview
In the Business API, a Transaction
represents a record of any financial activity, including deposits, withdrawals, buys, and sells.
The Transaction
enables you to track and manage the details of the activities, once they have occurred.
You can find an overview of all transactions against your Business account in the Business Dashboard and subscribe to Transaction events for updates on the status.
The Hosted Checkout experience guides your customers through NOAH's user interface to complete transactions. To use this as a payment gateway for your customers, visit the Hosted Checkout Journey.
Using Transactions
Get Details of a Transaction
To retrieve details of a specific transaction, use the GET /transactions/:TransactionID
endpoint in the Business API. This endpoint provides information about individual transactions, including their status and transaction details.
curl -L 'https://api.sandbox.noah.com/v1/transactions/:TransactionID' \
-H 'Accept: application/json' \
-H 'X-Api-Key: <X-Api-Key>'
To use this endpoint, supply the TransactionID
obtained from the /transactions/sell
or /transactions/buy
endpoints, the Transactions events, or from the Business Dashboard.
Get All Transactions
Additionally, to view a list of all the transactions on your account, the GET /transactions
endpoint offers paginated transaction history.
curl -L 'https://api.sandbox.noah.com/v1/transactions' \
-H 'Accept: application/json' \
-H 'X-Api-Key: <X-Api-Key>'
As described in the GET /transactions
documentation, you can finetune the returned payload, such as by overriding the default sort order,
as shown below.
curl -L 'https://api.sandbox.noah.com/v1/transactions?SortDirection=ASC' \
-H 'Accept: application/json' \
-H 'X-Api-Key: <X-Api-Key>'
For updates on transaction status, you are strongly recommended to subscribe to Transactions events.