SEP-24SEP-31SEP-6

Retrieve a List of Transactions

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

Request

Query Parameters

sep stringrequired

Possible values: [6, 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

Default value: 0

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

Responses

200

Transaction found.

application/json

Schema

Schema

oneOf
TransactionListSEP6
records object[]
Array [
id stringrequired
sep stringrequired
Possible values: [6]
kind stringrequired
Possible values: [deposit, deposit-exchange, withdrawal, withdrawal-exchange]
status StatusSEP6 (string)required
Possible values: [incomplete, completed, refunded, expired, error, pending_stellar, pending_external, pending_customer_info_update, 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-6 transactions
type string
amount_expected object
amount stringrequired
asset stringrequired
amount_in object
amount stringrequired
asset stringrequired
amount_out object
amount stringrequired
asset stringrequired
amount_fee object
amount stringrequired
asset stringrequired
quote_id string
started_at date-timerequired
updated_at date-time
completed_at date-time
transfer_received_at date-time
message string
refunds object
amount_refunded object
amount stringrequired
asset stringrequired
amount_fee object
amount stringrequired
asset stringrequired
payments object[]
Array [
id string
id_type string
Possible values: [stellar, external]
amount object
amount stringrequired
asset stringrequired
fee object
amount stringrequired
asset stringrequired
requested_at date-time
refunded_at date-time
]
stellar_transactions object[]
Array [
id stringrequired
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-timerequired
The time the transaction was registered in the Stellar network.
envelope stringrequired
The transaction envelope, containing all the transaction information.
payments object[]required
Array [
id stringrequired
The ID of the payment in the Stellar Network.
payment_type stringrequired
Possible values: [payment, path_payment]
Default value: payment
The type of payment in the Stellar Network.
source_account stringrequired
The account being debited in the Stellar Network.
destination_account stringrequired
The account being credited in the Stellar Network.
amount objectrequired
amount stringrequired
asset stringrequired
]
]
source_account string
destination_account string
external_transaction_id string
memo string
memo_type MemoType (string)
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 (string)
Possible values: [text id hash]
The memo type of the transaction in the Stellar network. Should be present if memo is not null.
client_domain string
client_name string
customers object
The Identification info of the sending and receiving customers. If they were created through SEP-12, this object should contain the SEP-12 customer id. Otherwise, the account address of the customer.
sender object
StellarId's are objects that identify end-users and SEP-31 Sending Anchors, but not SEP-31 Receiving Anchors.
For a SEP-12 customer, the id field should be sufficient to fully identify the customer in the business' Backend.
For a SEP-31 Sending Anchor, the account and memo fields should be used.
For a SEP-6 Anchor, the account and memo fields should be used.
id string
The id of the customer registered through SEP-12.
account string
Either the Stellar account or Muxed account address of the on-chain entity.
memo string
The memo value identifying a customer with a shared account, where the shared account is account.
receiver object
StellarId's are objects that identify end-users and SEP-31 Sending Anchors, but not SEP-31 Receiving Anchors.
For a SEP-12 customer, the id field should be sufficient to fully identify the customer in the business' Backend.
For a SEP-31 Sending Anchor, the account and memo fields should be used.
For a SEP-6 Anchor, the account and memo fields should be used.
id string
The id of the customer registered through SEP-12.
account string
Either the Stellar account or Muxed account address of the on-chain entity.
memo string
The memo value identifying a customer with a shared account, where the shared account is account.
]
TransactionListSEP24
records object[]
Array [
id stringrequired
sep stringrequired
Possible values: [24]
kind stringrequired
Possible values: [deposit, withdrawal]
status StatusSEP24 (string)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 objectrequired
amount stringrequired
asset stringrequired
amount_in object
amount stringrequired
asset stringrequired
amount_out object
amount stringrequired
asset stringrequired
amount_fee object
amount stringrequired
asset stringrequired
quote_id string
started_at date-timerequired
updated_at date-time
completed_at date-time
transfer_received_at date-time
message string
refunds object
amount_refunded object
amount stringrequired
asset stringrequired
amount_fee object
amount stringrequired
asset stringrequired
payments object[]
Array [
id string
id_type string
Possible values: [stellar, external]
amount object
amount stringrequired
asset stringrequired
fee object
amount stringrequired
asset stringrequired
requested_at date-time
refunded_at date-time
]
stellar_transactions object[]
Array [
id stringrequired
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-timerequired
The time the transaction was registered in the Stellar network.
envelope stringrequired
The transaction envelope, containing all the transaction information.
payments object[]required
Array [
id stringrequired
The ID of the payment in the Stellar Network.
payment_type stringrequired
Possible values: [payment, path_payment]
Default value: payment
The type of payment in the Stellar Network.
source_account stringrequired
The account being debited in the Stellar Network.
destination_account stringrequired
The account being credited in the Stellar Network.
amount objectrequired
amount stringrequired
asset stringrequired
]
]
source_account string
destination_account stringrequired
external_transaction_id string
memo string
memo_type MemoType (string)
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 (string)
Possible values: [text id hash]
The memo type of the transaction in the Stellar network. Should be present if memo is not null.
client_domain string
client_name string
]
TransactionListSEP31
records object[]
Array [
id stringrequired
sep stringrequired
Possible values: [31]
kind stringrequired
Possible values: [receive]
status StatusSEP31 (string)required
Possible values: [incomplete, completed, refunded, expired, error, pending_stellar, pending_external, pending_sender, pending_receiver, pending_transaction_info_update, pending_customer_info_update]
Possible status value for SEP-31 transactions
amount_expected object
amount stringrequired
asset stringrequired
amount_in object
amount stringrequired
asset stringrequired
amount_out object
amount stringrequired
asset stringrequired
amount_fee object
amount stringrequired
asset stringrequired
quote_id string
started_at date-timerequired
updated_at date-time
completed_at date-time
transfer_received_at date-time
message string
refunds object
amount_refunded object
amount stringrequired
asset stringrequired
amount_fee object
amount stringrequired
asset stringrequired
payments object[]
Array [
id string
id_type string
Possible values: [stellar, external]
amount object
amount stringrequired
asset stringrequired
fee object
amount stringrequired
asset stringrequired
requested_at date-time
refunded_at date-time
]
stellar_transactions object[]
Array [
id stringrequired
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-timerequired
The time the transaction was registered in the Stellar network.
envelope stringrequired
The transaction envelope, containing all the transaction information.
payments object[]required
Array [
id stringrequired
The ID of the payment in the Stellar Network.
payment_type stringrequired
Possible values: [payment, path_payment]
Default value: payment
The type of payment in the Stellar Network.
source_account stringrequired
The account being debited in the Stellar Network.
destination_account stringrequired
The account being credited in the Stellar Network.
amount objectrequired
amount stringrequired
asset stringrequired
]
]
external_transaction_id string
client_domain string
client_name string
customers object
The Identification info of the sending and receiving customers. If they were created through SEP-12, this object should contain the SEP-12 customer id. Otherwise, the account address of the customer.
sender object
StellarId's are objects that identify end-users and SEP-31 Sending Anchors, but not SEP-31 Receiving Anchors.
For a SEP-12 customer, the id field should be sufficient to fully identify the customer in the business' Backend.
For a SEP-31 Sending Anchor, the account and memo fields should be used.
For a SEP-6 Anchor, the account and memo fields should be used.
id string
The id of the customer registered through SEP-12.
account string
Either the Stellar account or Muxed account address of the on-chain entity.
memo string
The memo value identifying a customer with a shared account, where the shared account is account.
receiver object
StellarId's are objects that identify end-users and SEP-31 Sending Anchors, but not SEP-31 Receiving Anchors.
For a SEP-12 customer, the id field should be sufficient to fully identify the customer in the business' Backend.
For a SEP-31 Sending Anchor, the account and memo fields should be used.
For a SEP-6 Anchor, the account and memo fields should be used.
id string
The id of the customer registered through SEP-12.
account string
Either the Stellar account or Muxed account address of the on-chain entity.
memo string
The memo value identifying a customer with a shared account, where the shared account is account.
creator object
StellarId's are objects that identify end-users and SEP-31 Sending Anchors, but not SEP-31 Receiving Anchors.
For a SEP-12 customer, the id field should be sufficient to fully identify the customer in the business' Backend.
For a SEP-31 Sending Anchor, the account and memo fields should be used.
For a SEP-6 Anchor, the account and memo fields should be used.
id string
The id of the customer registered through SEP-12.
account string
Either the Stellar account or Muxed account address of the on-chain entity.
memo string
The memo value identifying a customer with a shared account, where the shared account is account.
]

Example (from schema)

{}

400

Bad Request

application/json

Schema

Schema

error stringrequired
id string

Example (from schema)

{
  "error": "string",
  "id": "string"
}

404

Transaction not found.

application/json

Schema

Schema

error stringrequired
id string

Example (from schema)

{
  "error": "string",
  "id": "string"
}

Loading...