Transactions

GET 
https://api.sandbox.noah.com/v1/transactions

Retrieves a paginated list of transaction history for your account.

Request

Query Parameters

PageSize integer
Default value: 20
Example: 10
PageToken string
SortDirection SortDirection
Possible values: [ASC, DESC]
Default value: DESC

Header Parameters

Api-Signature string

Digitally signed JWT.

Responses

200

List of transactions

application/json

Schema

Schema

Items object[]required
Array [
IDuuidrequired
NOAH's unique identifier for the transaction.
PublicIDstring
The public blockchain transaction id or hash. This identifier is only available for transactions that are broadcast to a public network as well as some private networks where available, e.g. Lightning
NetworkNetwork (string)required
Payments network (prod/sandbox):
• Bitcoin/BitcoinTest
• Lightning/LightningTest
• Ethereum/EthereumTestSepolia
• PolygonPos/PolygonTestAmoy
• Solana/SolanaDevnet
• OffNetwork/OffNetwork
Example: Bitcoin
Createddate-timerequired
When was this transaction created
Example: 2024-04-16T08:00:55Z
StatusTransactionStatus (string)required
Statuses for transactions.
Possible values: [Pending, Failed, Settled]
Example: Settled
DirectionTransactionDirection (string)required
Whether the transactions was a credit (in) or a debit (out) in your account
Possible values: [In, Out]
Example: In
CustomerIDCustomerID (string)
A unique ID which identifies the customer in the Business' internal system and in NOAH.
Possible values: non-empty and <= 36 characters
Example: 550e8400-e29b-41d4-a716-446655440000
ExternalIDExternalID (string)
A unique identifier used in the business system to store a reference for the transaction. This field allows businesses to track and manage transactions within their internal systems.
Possible values: non-empty and <= 36 characters
AmountPositiveDecimal (string)
The net crypto amount transacted, affecting the balance. This amount excludes the NetworkFee. For buy transactions, this is the amount after payment fees. For sell transactions, this is the amount before payment fees.
Possible values: non-empty and <= 38 characters, Value must match regular expression ^[+]?([.]\d+|\d+[.]?\d*)$
Example: 10.1
NetworkFeePositiveDecimal (string)
Amount paid to cover the the onchain network or gas fee associated with the transaction, if applicable.
Possible values: non-empty and <= 38 characters, Value must match regular expression ^[+]?([.]\d+|\d+[.]?\d*)$
Example: 10.1
CryptoCurrencyCryptoCurrencyCode (string)required
Cryptocurrency (prod/sandbox):
• BTC/BTC_TEST
• USDC/USDC_TEST
Example: BTC
FiatPayment object
• For buy transactions, Transaction.Amount = (FiatPayment.Amount - FiatPayment.FeeAmount) / FiatPayment.Rate
• For sell transactions, Transaction.Amount = (FiatPayment.Amount + FiatPayment.FeeAmount) / FiatPayment.Rate
AmountPositiveDecimal (string)required
The final amount that has been debited (for buy transactions) or credited (for sell transactions) from the payment method.
Possible values: non-empty and <= 38 characters, Value must match regular expression ^[+]?([.]\d+|\d+[.]?\d*)$
Example: 10.1
FeeAmountPositiveDecimal (string)required
The fee applied to this payment.
Possible values: non-empty and <= 38 characters, Value must match regular expression ^[+]?([.]\d+|\d+[.]?\d*)$
Example: 10.1
RatePositiveDecimal (string)
Crypto/Fiat exchange rate.
Possible values: non-empty and <= 38 characters, Value must match regular expression ^[+]?([.]\d+|\d+[.]?\d*)$
Example: 10.1
FiatCurrencyFiatCurrencyCode (string)required
Supported fiat ISO_4217 3 letter currency codes.
Example: USD
FiatDepositIDstring
The ID of the deposit when the payment originated from a deposit.
Orchestration object
Orchestration details for the transaction.
RuleIDstringrequired
Unique identifier for the rule that is matched for the transaction.
RuleExecutionIDstringrequired
Unique identifier for the execution of the rules that is matched for the transaction.
FiatPaymentMethod object
Information about the fiat payment method used to facilitate this transaction.
IDstringrequired
CustomerIDCustomerID (string)
A unique ID which identifies the customer in the Business' internal system and in NOAH.
Possible values: non-empty and <= 36 characters
Example: 550e8400-e29b-41d4-a716-446655440000
CountryCountryCode (string)required
ISO 3166-1 alpha-2 country code.
Example: US
PaymentMethodCategoryPaymentMethodCategory (string)required
Categorizes one or more PaymentMethodTypes into broader groups. Useful for listing channels, displaying payment methods:
• Bank
• Card
• Identifier
Example: Bank
DisplayDetails objectrequired
Contains information to display each payment method, with fields tailored to the specific type (e.g., last four digits or account number) to help identify the payment method.
Typerequired
Contains information to display each payment method, with fields tailored to the specific type (e.g., last four digits or account number) to help identify the payment method.
Possible values: [FiatPaymentMethodBankDisplay, FiatPaymentMethodCardDisplay, FiatPaymentMethodIdentifierDisplay]
FiatPaymentMethodBankDisplay
AccountNumberstring
BankCodestring
FiatPaymentMethodCardDisplay
Last4stringrequired
SchemeFiatPaymentCardScheme (string)required
The card scheme:
• Mastercard
• Visa
Example: Visa
FiatPaymentMethodIdentifierDisplay
IdentifierTypePaymentMethodIdentifierType (string)required
Identifier type:
• PhoneNumber
• Email
• TaxID
Example: PhoneNumber
Identifierstringrequired
Breakdown object[]
This list explains how the transaction amount was calculated.
Array [
TypeTransactionBreakdownType (string)required
What does the breakdown item amount refer to:
• ChannelFee: amount withheld by the system from the fiat payment
• BusinessFee: amount to withheld on behalf of the business over its customers transactions
• Remaining: amount withheld by the system from the fiat payment
AmountPositiveDecimal (string)required
Possible values: non-empty and <= 38 characters, Value must match regular expression ^[+]?([.]\d+|\d+[.]?\d*)$
Example: 10.1
]
AdjustmentFor object
Identifies a transaction that this transaction adjusts and details about the adjustment.
AdjustedTransactionIDuuidrequired
ID of the transaction being adjusted.
AdjustmentIDuuidrequired
A unique identifier linking related transactions that are involved in a single Adjustment. For Adjustments involving multiple transactions, this ID is shared across all associated records.
Reasonstringrequired
Why the adjustment was made:
• ExchangeRateCorrection
]
PageTokenstring

Example (auto)

{
  "Items": [
    {
      "ID": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "PublicID": "string",
      "Network": "Bitcoin",
      "Created": "2024-04-16T08:00:55Z",
      "Status": "Settled",
      "Direction": "In",
      "CustomerID": "550e8400-e29b-41d4-a716-446655440000",
      "ExternalID": "string",
      "Amount": "10.1",
      "NetworkFee": "10.1",
      "CryptoCurrency": "BTC",
      "FiatPayment": {
        "Amount": "10.1",
        "FeeAmount": "10.1",
        "Rate": "10.1",
        "FiatCurrency": "USD",
        "FiatDepositID": "string"
      },
      "Orchestration": {
        "RuleID": "string",
        "RuleExecutionID": "string"
      },
      "FiatPaymentMethod": {
        "ID": "string",
        "CustomerID": "550e8400-e29b-41d4-a716-446655440000",
        "Country": "US",
        "PaymentMethodCategory": "Bank",
        "DisplayDetails": {
          "Type": "FiatPaymentMethodBankDisplay",
          "AccountNumber": "string",
          "BankCode": "string"
        }
      },
      "Breakdown": [
        {
          "Type": "string",
          "Amount": "10.1"
        }
      ],
      "AdjustmentFor": {
        "AdjustedTransactionID": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "AdjustmentID": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "Reason": "string"
      }
    }
  ],
  "PageToken": "string"
}

400

Bad request

application/json

Schema

Schema

TypeErrorType (string)
Type of error:
• InvalidMessage
• Unexpected
• ResourceNotFound
• Unauthorized
• Forbidden
• InsufficientBalance
Example: InvalidMessage
Instancestring
A unique reference that identifies the specific occurrence of the problem
Actionstring
Action taking place which resulted in error.
Detailstring
Details about the error.
Extensions object
Additional information about the error.
Requestobject
Details about invalid request properties.
Features object
Details about the disabled feature flags
property name* string[]
List of reasons
Array [
string
Type of reason:
• BetaAccess
• GloballyDisabled
• Maintenance
• RestrictedRegion
• Kyc
• Suspended
]

Example (auto)

{
  "Type": "InvalidMessage",
  "Instance": "string",
  "Action": "string",
  "Detail": "string",
  "Extensions": {
    "Request": {},
    "Features": {}
  }
}

401

Client is not authorized to perform this action

application/json

Schema

Schema

TypeErrorType (string)
Type of error:
• InvalidMessage
• Unexpected
• ResourceNotFound
• Unauthorized
• Forbidden
• InsufficientBalance
Example: InvalidMessage
Instancestring
A unique reference that identifies the specific occurrence of the problem
Actionstring
Action taking place which resulted in error.
Detailstring
Details about the error.
Extensions object
Additional information about the error.
Requestobject
Details about invalid request properties.
Features object
Details about the disabled feature flags
property name* string[]
List of reasons
Array [
string
Type of reason:
• BetaAccess
• GloballyDisabled
• Maintenance
• RestrictedRegion
• Kyc
• Suspended
]

Example (auto)

{
  "Type": "InvalidMessage",
  "Instance": "string",
  "Action": "string",
  "Detail": "string",
  "Extensions": {
    "Request": {},
    "Features": {}
  }
}

500

Internal server error

application/json

Schema

Schema

TypeErrorType (string)
Type of error:
• InvalidMessage
• Unexpected
• ResourceNotFound
• Unauthorized
• Forbidden
• InsufficientBalance
Example: InvalidMessage
Instancestring
A unique reference that identifies the specific occurrence of the problem
Actionstring
Action taking place which resulted in error.
Detailstring
Details about the error.
Extensions object
Additional information about the error.
Requestobject
Details about invalid request properties.
Features object
Details about the disabled feature flags
property name* string[]
List of reasons
Array [
string
Type of reason:
• BetaAccess
• GloballyDisabled
• Maintenance
• RestrictedRegion
• Kyc
• Suspended
]

Example (auto)

{
  "Type": "InvalidMessage",
  "Instance": "string",
  "Action": "string",
  "Detail": "string",
  "Extensions": {
    "Request": {},
    "Features": {}
  }
}

Authorization: X-Api-Key

name: X-Api-Keytype: apiKeydescription: This security scheme requires an API Key to successfully authenticate.in: header

• curl
• go
• nodejs
• python
• ruby
• csharp
• php
• java
• powershell

• CURL

curl -L 'https://api.sandbox.noah.com/v1/transactions' \
-H 'Accept: application/json' \
-H 'X-Api-Key: <X-Api-Key>'

Request Collapse all

Base URL

https://api.sandbox.noah.com/v1

Auth

ApiKey

Parameters

PageSize — query

PageToken — query

SortDirection — query

---ASCDESC

Api-Signature — header

ResponseClear

Click the Send API Request button above and see the response here!