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
Possible values: [6
, 24
, 31
]
Lookup transactions belonging to this SEP.
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.
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.
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)
Default value: 20
Size of a single search page. Must be positive.
Default value: 0
Page number to use for continuous search. Page count beings at 0.
Responses
- 200
- 400
- 404
- application/json
- Schema
- Example (from schema)
Schema
- TransactionListSEP6
- TransactionListSEP24
- TransactionListSEP31
Array [
Array [
]
Array [
Array [
]
]
]
Array [
Array [
]
Array [
Array [
]
]
]
Array [
Array [
]
Array [
Array [
]
]
]
records
object[]
Possible values: [6
]
Possible values: [deposit
, deposit-exchange
, withdrawal
, withdrawal-exchange
]
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
amount_expected
object
amount_in
object
amount_out
object
amount_fee
object
refunds
object
amount_refunded
object
amount_fee
object
payments
object[]
Possible values: [stellar
, external
]
amount
object
fee
object
stellar_transactions
object[]
The ID of the transaction in the Stellar network.
The memo of the transaction in the Stellar network.
Possible values: [text
, hash
, id
]
The memo type of the transaction in the Stellar network. Should be present if memo is not null.
The time the transaction was registered in the Stellar network.
The transaction envelope, containing all the transaction information.
payments
object[]
required
The ID of the payment in the Stellar Network.
Possible values: [payment
, path_payment
]
Default value: payment
The type of payment in the Stellar Network.
The account being debited in the Stellar Network.
The account being credited in the Stellar Network.
amount
object
required
Possible values: [text id hash
]
The memo type of the transaction in the Stellar network. Should be present if memo is not null.
if provided, this memo should be used for refund transactions
Possible values: [text id hash
]
The memo type of the transaction in the Stellar network. Should be present if memo is not null.
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.
The id
of the customer registered through SEP-12.
Either the Stellar account or Muxed account address of the on-chain entity.
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.
The id
of the customer registered through SEP-12.
Either the Stellar account or Muxed account address of the on-chain entity.
The memo value identifying a customer with a shared account, where the shared account is account
.
records
object[]
Possible values: [24
]
Possible values: [deposit
, withdrawal
]
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_in
object
amount_out
object
amount_fee
object
refunds
object
amount_refunded
object
amount_fee
object
payments
object[]
Possible values: [stellar
, external
]
amount
object
fee
object
stellar_transactions
object[]
The ID of the transaction in the Stellar network.
The memo of the transaction in the Stellar network.
Possible values: [text
, hash
, id
]
The memo type of the transaction in the Stellar network. Should be present if memo is not null.
The time the transaction was registered in the Stellar network.
The transaction envelope, containing all the transaction information.
payments
object[]
required
The ID of the payment in the Stellar Network.
Possible values: [payment
, path_payment
]
Default value: payment
The type of payment in the Stellar Network.
The account being debited in the Stellar Network.
The account being credited in the Stellar Network.
amount
object
required
Possible values: [text id hash
]
The memo type of the transaction in the Stellar network. Should be present if memo is not null.
if provided, this memo should be used for refund transactions
Possible values: [text id hash
]
The memo type of the transaction in the Stellar network. Should be present if memo is not null.
records
object[]
Possible values: [31
]
Possible values: [receive
]
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_in
object
amount_out
object
amount_fee
object
refunds
object
amount_refunded
object
amount_fee
object
payments
object[]
Possible values: [stellar
, external
]
amount
object
fee
object
stellar_transactions
object[]
The ID of the transaction in the Stellar network.
The memo of the transaction in the Stellar network.
Possible values: [text
, hash
, id
]
The memo type of the transaction in the Stellar network. Should be present if memo is not null.
The time the transaction was registered in the Stellar network.
The transaction envelope, containing all the transaction information.
payments
object[]
required
The ID of the payment in the Stellar Network.
Possible values: [payment
, path_payment
]
Default value: payment
The type of payment in the Stellar Network.
The account being debited in the Stellar Network.
The account being credited in the Stellar Network.
amount
object
required
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.
The id
of the customer registered through SEP-12.
Either the Stellar account or Muxed account address of the on-chain entity.
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.
The id
of the customer registered through SEP-12.
Either the Stellar account or Muxed account address of the on-chain entity.
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.
The id
of the customer registered through SEP-12.
Either the Stellar account or Muxed account address of the on-chain entity.
The memo value identifying a customer with a shared account, where the shared account is account
.
{}
- application/json
- Schema
- Example (from schema)
Schema
{
"error": "string",
"id": "string"
}
- application/json
- Schema
- Example (from schema)
Schema
{
"error": "string",
"id": "string"
}