Skip to main content
SEP-24SEP-31

Retrieve a List of Transactions‚Äč

Allows to query list of transactions for desired SEP. This api supports pagination, and it's possible (and recommended) to make multiple requests to query transactions. The last page is reached when the number of elements returned by the endpoint is smaller than provided page_size.

Query Parameters
  • sep string required

    Possible values: [24, 31]

    Lookup transactions belonging to this SEP.

  • order_by string

    Possible values: [created_at, transfer_received_at]

    Default value: created_at

    Specifies field that transactions will be ordered by. Note, that secondary sort is transaction id in ascending value. I.e. when timestamps for 2 or more transactions is identical, they will be sorted by id.

  • order string

    Possible values: [asc, desc]

    Default value: asc

    Specifies order. Note, that when the field is null, all transactions with null value will be last, regardless of soring order (NULLS LAST). For example, transfer time may not be specified for some transactions, resulting into transfer_received_at being null. If so, transactions with non-null values will be sorted and returned first, followed by all transactions with null timestamps.

  • statuses StatusSEPAll[]

    Possible values: [incomplete, completed, refunded, expired, error, pending_stellar, pending_external, pending_user_transfer_start, pending_user_transfer_complete, pending_anchor, pending_trust, pending_user, no_market, too_small, too_large, pending_sender, pending_receiver, pending_transaction_info_update, pending_customer_info_update]

    Filters transactions for specified array of statuses. If not provided, filtering is disabled (default behavior)

  • page_size integer

    Default value: 20

    Size of a single search page. Must be positive.

  • page_number integer

    Page number to use for continuous search. Page count beings at 0.

Responses

Transaction found.


Schema
  • oneOf

  • records object[]
  • Array [
  • id string required
  • sep string required

    Possible values: [24]

  • kind string required

    Possible values: [deposit, withdrawal]

  • status StatusSEP24 required

    Possible values: [incomplete, completed, refunded, expired, error, pending_stellar, pending_external, pending_user_transfer_start, pending_user_transfer_complete, pending_anchor, pending_trust, pending_user, no_market, too_small, too_large]

    Possible status value for SEP-24 transactions

  • amount_expected object required
  • amount string required
  • asset string required
  • amount_in object
  • amount string required
  • asset string required
  • amount_out object
  • amount string required
  • asset string required
  • amount_fee object
  • amount string required
  • asset string required
  • started_at date-time required
  • updated_at date-time
  • completed_at date-time
  • transfer_received_at date-time
  • message string
  • refunds object
  • amount_refunded object
  • amount string required
  • asset string required
  • amount_fee object
  • amount string required
  • asset string required
  • payments object[]
  • Array [
  • id string
  • id_type string

    Possible values: [stellar, external]

  • amount object
  • amount string required
  • asset string required
  • fee object
  • amount string required
  • asset string required
  • requested_at date-time
  • refunded_at date-time
  • ]
  • stellar_transactions object[]
  • Array [
  • id string required

    The ID of the transaction in the Stellar network.

  • memo string

    The memo of the transaction in the Stellar network.

  • memo_type string

    Possible values: [text, hash, id]

    The memo type of the transaction in the Stellar network. Should be present if memo is not null.

  • created_at date-time required

    The time the transaction was registered in the Stellar network.

  • envelope string required

    The transaction envelope, containing all the transaction information.

  • payments object[] required
  • Array [
  • id string required

    The ID of the payment in the Stellar Network.

  • payment_type string required

    Possible values: [payment, path_payment]

    Default value: payment

    The type of payment in the Stellar Network.

  • source_account string required

    The account being debited in the Stellar Network.

  • destination_account string required

    The account being credited in the Stellar Network.

  • amount object required
  • amount string required
  • asset string required
  • ]
  • ]
  • source_account string
  • destination_account string required
  • external_transaction_id string
  • memo string
  • memo_type MemoType

    Possible values: [text id hash]

    The memo type of the transaction in the Stellar network. Should be present if memo is not null.

  • refund_memo string

    if provided, this memo should be used for refund transactions

  • refund_memo_type MemoType

    Possible values: [text id hash]

    The memo type of the transaction in the Stellar network. Should be present if memo is not null.

  • ]
Loading...