Skip to main content

Transaction by ID

GET 
/transactions/:TransactionID

Retrieve the details of a single transaction by TransactonID.

Request​

Path Parameters

    TransactionID uuidrequired

Header Parameters

    Api-Signature string

    Digitally signed JWT.

Responses​

Transaction details
Schema
    ID uuidrequired
    PublicID string
    Network Network (string)required

    Payments network:

    • Bitcoin
    • Lightning
    • Ethereum
    • PolygonPos
    • 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)

    Unique identifier in user's system.

    Possible values: non-empty and <= 36 characters

    Amount PositiveDecimal (string)

    Positive decimal number in string format

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

    Example: 10.1
    NetworkFee PositiveDecimal (string)

    Positive decimal number in string format

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

    Example: 10.1
    CryptoCurrency CryptoCurrencyCode (string)required

    Cryptocurrency code:

    • BTC
    • USDC
    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

    Positive decimal number in string format

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

    Example: 10.1
    FeeAmount PositiveDecimal (string)required

    Positive decimal number in string format

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

    Example: 10.1
    Rate PositiveDecimal (string)

    Positive decimal number in string format

    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
    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.

Loading...