Skip to main content

Transaction by ID

GET 
/transactions/:TransactionID

Retrieve the details of a single transaction by TransactionID.

Request​

Path Parameters

    TransactionID uuidrequired

Header Parameters

    Api-Signature string

    Digitally signed JWT.

Responses​

Transaction details
Schema
    ID uuidrequired

    NOAH's unique identifier for the transaction.

    PublicID string

    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

    Network Network (string)required

    Payments network (main/sandbox):

    • Bitcoin/BitcoinTest
    • Lightning/LightningTest
    • Ethereum/EthereumTestSepolia
    • PolygonPos/PolygonTestAmoy
    • OffNetwork/OffNetwork
    Example: Bitcoin
    Created date-timerequired

    When was this transaction created

    Example: 2024-04-16T08:00:55Z
    Status TransactionStatus (string)required

    Statuses for transactions.

    Possible values: [Pending, Failed, Settled]

    Example: Settled
    Direction TransactionDirection (string)required

    Whether the transactions was a credit (in) or a debit (out) in your account

    Possible values: [In, Out]

    Example: In
    CustomerID CustomerID (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
    ExternalID ExternalID (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

    Amount PositiveDecimal (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
    NetworkFee PositiveDecimal (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
    CryptoCurrency CryptoCurrencyCode (string)required

    Cryptocurrency (main/sandbox):

    • BTC/BTC_TEST
    • USDC/USDC_TEST
    Example: BTC
    FiatPaymentobject
    • For buy transactions, Transaction.Amount = (FiatPayment.Amount - FiatPayment.FeeAmount) / FiatPayment.Rate * For sell transactions, Transaction.Amount = (FiatPayment.Amount + FiatPayment.FeeAmount) / FiatPayment.Rate
    Amount PositiveDecimal (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
    FeeAmount PositiveDecimal (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
    Rate PositiveDecimal (string)

    Crypto/Fiat exchange rate.

    Possible values: non-empty and <= 38 characters, Value must match regular expression ^[+]?([.]\d+|\d+[.]?\d*)$

    Example: 10.1
    FiatCurrency FiatCurrencyCode (string)required

    Supported fiat ISO_4217 3 letter currency codes.

    Example: USD
    FiatDepositID string

    The ID of the deposit when the payment originated from a deposit.

    Orchestrationobject

    Orchestration details for the transaction.

    RuleID stringrequired

    Unique identifier for the rule that is matched for the transaction.

    RuleExecutionID stringrequired

    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.

    ID stringrequired
    CustomerID CustomerID (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
    Country CountryCode (string)

    ISO 3166-1 alpha-2 country code.

    Example: US
    PaymentMethodCategory PaymentMethodCategory (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.

    oneOf

    Type stringrequired

    Possible values: [FiatPaymentMethodBankDisplay]

    AccountNumber stringrequired
    Breakdownobject[]

    Transactions can be split, or brokendown, into parts according to the needs of the user. This list explains how the transaction amount should be split.

  • Array [

    • Type TransactionBreakdownType (string)required

    What does the breakdown item amount refer to:

    • BusinessFee
    • Remaining
    Amount PositiveDecimal (string)required

    Possible values: non-empty and <= 38 characters, Value must match regular expression ^[+]?([.]\d+|\d+[.]?\d*)$

    Example: 10.1

  • ]

Loading...