SEP24TransactionsRequest
in package
Request parameters for querying SEP-24 transaction history
This class contains the parameters needed to retrieve a list of transactions from the anchor using the /transactions endpoint. The response can be filtered by asset, transaction type, time range, and paginated using the limit and paging_id parameters.
Tags
Table of Contents
Properties
- $assetCode : string
- $jwt : string
- $kind : string|null
- $lang : string|null
- $limit : int|null
- $noOlderThan : DateTime|null
- $pagingId : string|null
Methods
- getAssetCode() : string
- getJwt() : string
- getKind() : string|null
- getLang() : string|null
- getLimit() : int|null
- getNoOlderThan() : DateTime|null
- getPagingId() : string|null
- setAssetCode() : void
- setJwt() : void
- setKind() : void
- setLang() : void
- setLimit() : void
- setNoOlderThan() : void
- setPagingId() : void
Properties
$assetCode
public
string
$assetCode
The code of the asset to filter transactions. Examples: 'BTC', 'ETH', 'USD', 'native' for XLM
$jwt
public
string
$jwt
JWT token obtained from SEP-10 authentication flow containing the authenticated Stellar account and optional memo
$kind
public
string|null
$kind
= null
Filter by transaction type. Valid values: 'deposit' or 'withdrawal'. Omit to retrieve both deposit and withdrawal transactions
$lang
public
string|null
$lang
= null
Language code for localized responses following RFC 4646 format. Supports locale variants like 'en-US'. Defaults to 'en' if not specified or if the specified language is not supported by the anchor
$limit
public
int|null
$limit
= null
Maximum number of transactions to return in the response. Used for pagination to control response size
$noOlderThan
public
DateTime|null
$noOlderThan
= null
Filter to include only transactions created on or after this date and time. Specified as DateTime object that will be converted to UTC ISO 8601 format
$pagingId
public
string|null
$pagingId
= null
Pagination cursor. Returns transactions created before this transaction ID. Use the oldest transaction ID from the previous response to fetch the next page
Methods
getAssetCode()
public
getAssetCode() : string
Return values
string —The code of the asset of interest. E.g. BTC, ETH, USD, INR, etc.
getJwt()
public
getJwt() : string
Return values
string —jwt token previously received from the anchor via the SEP-10 authentication flow
getKind()
public
getKind() : string|null
Return values
string|null —(optional) The kind of transaction that is desired. Should be either 'deposit' or 'withdrawal'.
getLang()
public
getLang() : string|null
Return values
string|null —(optional) Defaults to en if not specified or if the specified language is not supported. Language code specified using RFC 4646 which means it can also accept locale in the format en-US.
getLimit()
public
getLimit() : int|null
Return values
int|null —(optional) The response should contain at most limit transactions.
getNoOlderThan()
public
getNoOlderThan() : DateTime|null
Return values
DateTime|null —(optional) The response should contain transactions starting on or after this date & time. UTC ISO 8601 string.
getPagingId()
public
getPagingId() : string|null
Return values
string|null —(optional) The response should contain transactions starting prior to this ID (exclusive).
setAssetCode()
public
setAssetCode(string $assetCode) : void
Parameters
- $assetCode : string
-
The code of the asset of interest. E.g. BTC, ETH, USD, INR, etc.
setJwt()
public
setJwt(string $jwt) : void
Parameters
- $jwt : string
-
jwt token previously received from the anchor via the SEP-10 authentication flow
setKind()
public
setKind(string|null $kind) : void
Parameters
- $kind : string|null
-
(optional) The kind of transaction that is desired. Should be either 'deposit' or 'withdrawal'.
setLang()
public
setLang(string|null $lang) : void
Parameters
- $lang : string|null
-
(optional) Defaults to en if not specified or if the specified language is not supported. Language code specified using RFC 4646 which means it can also accept locale in the format en-US.
setLimit()
public
setLimit(int|null $limit) : void
Parameters
- $limit : int|null
-
(optional) The response should contain at most limit transactions.
setNoOlderThan()
public
setNoOlderThan(DateTime|null $noOlderThan) : void
Parameters
- $noOlderThan : DateTime|null
-
(optional) The response should contain transactions starting on or after this date & time. UTC ISO 8601 string.
setPagingId()
public
setPagingId(string|null $pagingId) : void
Parameters
- $pagingId : string|null
-
(optional) The response should contain transactions starting prior to this ID (exclusive).