The transaction object

The transaction object represents all the funds moving through the Speed account. These transactions are created for every type of fund that comes in or flows out of the Speed account. This makes it easy to manage payments and track your business transactions regularly. The balance_transaction endpoint can be used to retrieve additional information about the transaction like target_currency (currently only SATS), source, type, and so on.

Overall, it provides insight into the payouts and payments of your business. You can use the pagination parameters: starting_after, limit, and ending_before to get the desired list of transactions if the has_more attribute is true.

{
  "object": "list",
  "has_more": false,
  "data": [
    {
      "id": "txn_1032HU2eZvKYlo2CEPtcnUvl",
      "object": "balance_transaction",
      "amount": 100,
      "fee": 7,
      "net": 93,
      "target_currency": "SATS",
      "type": "Payment",
      "transaction_type": "credit",
      "source": "pi_l4hzwbjfjskAO7bQ",
      "created": 1655442814345
    },
    {
      "id": "txn_liy9cffu0p6YIAaE",
      "object": "balance_transaction",
      "amount": 1000,
      "fee": 0,
      "net": 1000,
      "target_currency": "SATS",
      "type": "Swap Out",
      "transaction_type": "debit",
      "source": "swap_liy9cfd9b7NO7ydj",
      "created": 1686901074474
    },
    {
      "id": "txn_ljimhod83xCtwVJe",
      "object": "balance_transaction",
      "amount": 300,
      "fee": 0,
      "net": 300,
      "target_currency": "SATS",
      "type": "Transfer In",
      "transaction_type": "credit",
      "source": "tr_ljimhod5tw7bFvUg",
      "created": 1688132477852
    }
  ]
}

Attributes

has_more boolean
If there are more transactions than returned in the response, it has the value true; otherwise, it has the value false.

id string
Unique identifier for the object.

object string
The type of the object indicates to which entity this response belongs.

amount BigDecimal
The total amount managed in this transaction.

fee BigDecimal
Specifies the aggregated fee applied during this transaction.

net BigDecimal
The total funds received/paid in this transaction after the deduction of fees.

target_currency string
The cryptocurrency in which the amount/fees/net is expressed. As of now, Speed only supports SATS.

type string
Categorizes the transactions based on activities like payment, payout, transfers or others.

transaction_type string
Categorizes the transactions based on whether funds are credited or debited.

source string
Contains the ID of the related source that initiated the transaction.

created timestamp
Time at which this transaction was created.