Stellar PHP SDK API Documentation

SEP24Transaction extends Response
in package

Soneso

StellarSDK

SEP

Interactive

Represents a SEP-24 hosted deposit/withdrawal transaction

This class encapsulates the complete state of an interactive deposit or withdrawal transaction as defined by SEP-24 (Hosted Deposit and Withdrawal). It contains all transaction details including status, amounts, timestamps, and transfer information for both deposit and withdrawal operations.

SEP-24 enables anchors to provide an interactive user experience for deposit and withdrawal flows, typically through a web interface. This class represents the transaction data returned by the anchor during transaction queries and status updates.

The transaction can represent either a deposit (external asset to Stellar) or a withdrawal (Stellar asset to external system), with transaction-specific fields available depending on the kind of operation.

Properties

$amountFee : string|null
$amountFeeAsset : string|null
$amountIn : string|null
$amountInAsset : string|null
$amountOut : string|null
$amountOutAsset : string|null
$claimableBalanceId : string|null
$completedAt : string|null
$depositMemo : string|null
$depositMemoType : string|null
$externalTransactionId : string|null
$from : string|null
$id : string
$kind : string
$kycVerified : bool|null
$message : string|null
$moreInfoUrl : string|null
$quoteId : string|null
$refunded : bool|null
$refunds : Refund|null
$startedAt : string
$status : string
$statusEta : int|null
$stellarTransactionId : string|null
$to : string|null
$updatedAt : string|null
$userActionRequiredBy : string|null
$withdrawAnchorAccount : string|null
$withdrawMemo : string|null
$withdrawMemoType : string|null
$httpClient : Client|null
$rateLimitLimit : int|null
$rateLimitRemaining : int|null
$rateLimitReset : int|null

Methods

fromJson() : SEP24Transaction: Constructs a new instance of SEP24Transaction by using the given data.
getAmountFee() : string|null
getAmountFeeAsset() : string|null
getAmountIn() : string|null
getAmountInAsset() : string|null
getAmountOut() : string|null
getAmountOutAsset() : string|null
getClaimableBalanceId() : string|null
getCompletedAt() : string|null
getDepositMemo() : string|null
getDepositMemoType() : string|null
getExternalTransactionId() : string|null
getFrom() : string|null
getHttpClient() : Client|null: Gets the HTTP client used for pagination requests
getId() : string
getKind() : string
getKycVerified() : bool|null
getMessage() : string|null
getMoreInfoUrl() : string|null
getQuoteId() : string|null
getRateLimitLimit() : int|null: Returns X-RateLimit-Limit header from the response.
getRateLimitRemaining() : int|null: Returns X-RateLimit-Remaining header from the response.
getRateLimitReset() : int|null: Returns X-RateLimit-Reset header from the response. Seconds until a new window starts.
getRefunded() : bool|null
getRefunds() : Refund|null
getStartedAt() : string
getStatus() : string
getStatusEta() : int|null
getStellarTransactionId() : string|null
getTo() : string|null
getUpdatedAt() : string|null
getUserActionRequiredBy() : string|null: Gets the deadline by when user action is required
getWithdrawAnchorAccount() : string|null
getWithdrawMemo() : string|null
getWithdrawMemoType() : string|null
setAmountFee() : void
setAmountFeeAsset() : void
setAmountIn() : void
setAmountInAsset() : void
setAmountOut() : void
setAmountOutAsset() : void
setClaimableBalanceId() : void
setCompletedAt() : void
setDepositMemo() : void
setDepositMemoType() : void
setExternalTransactionId() : void
setFrom() : void
setHeaders() : void: Extracts and sets rate limiting information from HTTP response headers
setHttpClient() : void: Sets the HTTP client for making follow-up requests
setId() : void
setKind() : void
setKycVerified() : void
setMessage() : void
setMoreInfoUrl() : void
setQuoteId() : void
setRefunded() : void
setRefunds() : void
setStartedAt() : void
setStatus() : void
setStatusEta() : void
setStellarTransactionId() : void
setTo() : void
setUpdatedAt() : void
setUserActionRequiredBy() : void: Sets the deadline by when user action is required
setWithdrawAnchorAccount() : void
setWithdrawMemo() : void
setWithdrawMemoType() : void
loadFromJson() : void: Loads the needed data from a json array.

$amountFee


        public
            string|null
    $amountFee
     = null

Amount of fee charged by anchor.

$amountFeeAsset


        public
            string|null
    $amountFeeAsset
     = null

(optional) The asset in which fees are calculated in. Should be present if the deposit/withdraw was made using non-equivalent assets. The value must be in SEP-38 Asset Identification Format.

Examples:

Stellar asset: stellar:USDC:GA5ZSEJYB37JRC5AVCIA5MOP4RHTM335X2KGX3IHOJAPP5RE34K4KZVN
Fiat currency: iso4217:USD

https://github.com/stellar/stellar-protocol/blob/v2.5.0/ecosystem/sep-0038.md#asset-identification-format See also the Asset Exchanges section for more information. https://github.com/stellar/stellar-protocol/blob/v3.8.0/ecosystem/sep-0024.md#asset-exchanges

$amountIn


        public
            string|null
    $amountIn
     = null

Amount received by anchor at start of transaction as a string with up to 7 decimals. Excludes any fees charged before the anchor received the funds.

$amountInAsset


        public
            string|null
    $amountInAsset
     = null

(optional) The asset received or to be received by the Anchor. Should be present if the deposit/withdraw was made using non-equivalent assets. The value must be in SEP-38 Asset Identification Format.

Examples:

Stellar asset: stellar:USDC:GA5ZSEJYB37JRC5AVCIA5MOP4RHTM335X2KGX3IHOJAPP5RE34K4KZVN
Fiat currency: iso4217:USD

$amountOut


        public
            string|null
    $amountOut
     = null

Amount sent by anchor to user at end of transaction as a string with up to 7 decimals. Excludes amount converted to XLM to fund account and any external fees.

$amountOutAsset


        public
            string|null
    $amountOutAsset
     = null

(optional) The asset delivered or to be delivered to the user. Should be present if the deposit/withdraw was made using non-equivalent assets. The value must be in SEP-38 Asset Identification Format.

Examples:

Stellar asset: stellar:USDC:GA5ZSEJYB37JRC5AVCIA5MOP4RHTM335X2KGX3IHOJAPP5RE34K4KZVN
Fiat currency: iso4217:USD

$claimableBalanceId


        public
            string|null
    $claimableBalanceId
     = null

(optional) Only for deposit transactions: ID of the Claimable Balance used to send the asset initially requested.

$completedAt


        public
            string|null
    $completedAt
     = null

(optional) The date and time of transaction reaching completed or refunded status. UTC ISO 8601 string

$depositMemo


        public
            string|null
    $depositMemo
     = null

(optional) Only for deposit transactions: This is the memo (if any) used to transfer the asset to the to Stellar address.

$depositMemoType


        public
            string|null
    $depositMemoType
     = null

(optional) Only for deposit transactions: Type for the depositMemo.

$externalTransactionId


        public
            string|null
    $externalTransactionId
     = null

(optional) ID of transaction on external network that either started the deposit or completed the withdrawal.

$from


        public
            string|null
    $from
     = null

In case of deposit: Sent from address, perhaps BTC, IBAN, or bank account. In case of withdraw: Stellar address the assets were withdrawn from.

$id


        public
            string
    $id

Unique, anchor-generated id for the deposit/withdrawal.

$kind


        public
            string
    $kind

Possible values: 'deposit' or 'withdrawal'.

$kycVerified


        public
            bool|null
    $kycVerified
     = null

(optional) True if the anchor has verified the user's KYC information for this transaction.

$message


        public
            string|null
    $message
     = null

(optional) Human readable explanation of transaction status, if needed.

$moreInfoUrl


        public
            string|null
    $moreInfoUrl
     = null

A URL that is opened by wallets after the interactive flow is complete. It can include banking information for users to start deposits, the status of the transaction, or any other information the user might need to know about the transaction.

$quoteId


        public
            string|null
    $quoteId
     = null

(optional) The ID of the quote (sep-38) used when creating this transaction. Should be present if a quote_id was included in the POST /transactions/deposit/interactive or POST /transactions/withdraw/interactive request. Clients should be aware that the quote_id may not be present in older implementations.

$refunded


        public
            bool|null
    $refunded
     = null

(deprecated, optional) This field is deprecated in favor of the refunds object and the refunded status. True if the transaction was refunded in full. False if the transaction was partially refunded or not refunded. For more details about any refunds, see the Refund object.

$refunds


        public
            Refund|null
    $refunds
     = null

(optional) An object describing any on or off-chain refund associated with this transaction.

$startedAt


        public
            string
    $startedAt

Start date and time of transaction. UTC ISO 8601 string

$status


        public
            string
    $status

Processing status of deposit/withdrawal.

Possible status values:

incomplete: User incomplete deposit/withdrawal requiring more info
pending_user_transfer_start: Waiting for user to send funds to anchor
pending_user_transfer_complete: User funds sent, waiting for confirmation
pending_external: Processing external transfer (e.g., bank transfer)
pending_anchor: Anchor processing the transaction
on_hold: Transaction held pending additional user info or authorization
pending_stellar: Waiting for Stellar network transaction to complete
pending_trust: User needs to add trustline for the asset
pending_user: Waiting for user action (check message or more_info_url)
completed: Transaction successfully completed
refunded: Transaction has been refunded
expired: Transaction expired before completion
no_market: No market for the asset pair (for SEP-38 exchanges)
too_small: Transaction amount below minimum threshold
too_large: Transaction amount above maximum threshold
error: Transaction failed due to an error

For complete documentation see: https://github.com/stellar/stellar-protocol/blob/v3.8.0/ecosystem/sep-0024.md#transaction-history

$statusEta


        public
            int|null
    $statusEta
     = null

(optional) Estimated number of seconds until a status change is expected.

$stellarTransactionId


        public
            string|null
    $stellarTransactionId
     = null

(optional) transaction_id on Stellar network of the transfer that either completed the deposit or started the withdrawal.

$to


        public
            string|null
    $to
     = null

In case of deposit: Stellar address the deposited assets were sent to. In case of withdraw: Sent to address (perhaps BTC, IBAN, or bank account in the case of a withdrawal, Stellar address in the case of a deposit).

$updatedAt


        public
            string|null
    $updatedAt
     = null

(optional) The date and time of transaction reaching the current status. UTC ISO 8601 string

$userActionRequiredBy


        public
            string|null
    $userActionRequiredBy
     = null

(optional) The date and time by when the user action is required. UTC ISO 8601 string.

This field is populated only for transaction statuses where user action is required, such as:

incomplete: User must provide additional information
pending_user_transfer_start: User must initiate the transfer
pending_user: User must take action as described in message or more_info_url

The anchor sets this deadline to indicate when the transaction will automatically transition to a different status (typically expired or refunded) if the user does not act. Omitted for all other statuses. The specific action required should be described in the message field or more_info_url.

$withdrawAnchorAccount


        public
            string|null
    $withdrawAnchorAccount
     = null

(optional) Only for withdraw transactions: If this is a withdrawal, this is the anchor's Stellar account that the user transferred (or will transfer) their asset to.

$withdrawMemo


        public
            string|null
    $withdrawMemo
     = null

(optional) Only for withdraw transactions: Memo used when the user transferred to withdrawAnchorAccount. Assigned null if the withdrawal is not ready to receive payment, for example if KYC is not completed.

$withdrawMemoType


        public
            string|null
    $withdrawMemoType
     = null

(optional) Only for withdraw transactions: Memo type for withdrawMemo.

$httpClient


        protected
            Client|null
    $httpClient
     = null

$rateLimitLimit


        protected
            int|null
    $rateLimitLimit
     = null

$rateLimitRemaining


        protected
            int|null
    $rateLimitRemaining
     = null

$rateLimitReset


        protected
            int|null
    $rateLimitReset
     = null

fromJson()

Constructs a new instance of SEP24Transaction by using the given data.


    public
            static        fromJson(array<string|int, mixed> $json) : SEP24Transaction

Parameters

$json : array<string|int, mixed>: the data to construct the object from.

Return values

SEP24Transaction —

the object containing the parsed data.

getAmountFee()


    public
                    getAmountFee() : string|null

Return values

string|null —

Amount of fee charged by anchor.

getAmountFeeAsset()


    public
                    getAmountFeeAsset() : string|null

Return values

string|null —

The asset in which fees are calculated in. Should be present if the deposit/withdraw was made using non-equivalent assets. The value must be in SEP-38 Asset Identification Format. https://github.com/stellar/stellar-protocol/blob/v2.5.0/ecosystem/sep-0038.md#asset-identification-format See also the Asset Exchanges section for more information. https://github.com/stellar/stellar-protocol/blob/v3.8.0/ecosystem/sep-0024.md#asset-exchanges

getAmountIn()


    public
                    getAmountIn() : string|null

Return values

string|null —

Amount received by anchor at start of transaction as a string with up to 7 decimals. Excludes any fees charged before the anchor received the funds.

getAmountInAsset()


    public
                    getAmountInAsset() : string|null

Return values

string|null —

The asset received or to be received by the Anchor. Should be present if the deposit/withdraw was made using non-equivalent assets. The value must be in SEP-38 Asset Identification Format. https://github.com/stellar/stellar-protocol/blob/v2.5.0/ecosystem/sep-0038.md#asset-identification-format See also the Asset Exchanges section for more information. https://github.com/stellar/stellar-protocol/blob/v3.8.0/ecosystem/sep-0024.md#asset-exchanges

getAmountOut()


    public
                    getAmountOut() : string|null

Return values

string|null —

Amount sent by anchor to user at end of transaction as a string with up to 7 decimals. Excludes amount converted to XLM to fund account and any external fees.

getAmountOutAsset()


    public
                    getAmountOutAsset() : string|null

Return values

string|null —

The asset delivered or to be delivered to the user. Should be present if the deposit/withdraw was made using non-equivalent assets. The value must be in SEP-38 Asset Identification Format. https://github.com/stellar/stellar-protocol/blob/v2.5.0/ecosystem/sep-0038.md#asset-identification-format See also the Asset Exchanges section for more information. https://github.com/stellar/stellar-protocol/blob/v3.8.0/ecosystem/sep-0024.md#asset-exchanges

getClaimableBalanceId()


    public
                    getClaimableBalanceId() : string|null

Return values

string|null —

(optional) Only for deposit transactions: ID of the Claimable Balance used to send the asset initially requested.

getCompletedAt()


    public
                    getCompletedAt() : string|null

Return values

string|null —

The date and time of transaction reaching completed or refunded status. UTC ISO 8601 string.

getDepositMemo()


    public
                    getDepositMemo() : string|null

Return values

string|null —

(optional) Only for deposit transactions: This is the memo (if any) used to transfer the asset to the to Stellar address.

getDepositMemoType()


    public
                    getDepositMemoType() : string|null

Return values

string|null —

(optional) Only for deposit transactions: Type for the depositMemo.

getExternalTransactionId()


    public
                    getExternalTransactionId() : string|null

Return values

string|null —

ID of transaction on external network that either started the deposit or completed the withdrawal.

getFrom()


    public
                    getFrom() : string|null

Return values

string|null —

In case of deposit: Sent from address, perhaps BTC, IBAN, or bank account. In case of withdraw: Stellar address the assets were withdrawn from.

getHttpClient()

Gets the HTTP client used for pagination requests


    public
                    getHttpClient() : Client|null

Return values

Client|null —

The HTTP client instance, or null if not set

getId()


    public
                    getId() : string

Return values

string —

Unique, anchor-generated id for the deposit/withdrawal.

getKind()


    public
                    getKind() : string

Return values

string —

Possible values: 'deposit' or 'withdrawal'.

getKycVerified()


    public
                    getKycVerified() : bool|null

Return values

bool|null —

(optional) True if the anchor has verified the user's KYC information for this transaction.

getMessage()


    public
                    getMessage() : string|null

Return values

string|null —

Human-readable explanation of transaction status, if needed.

getMoreInfoUrl()


    public
                    getMoreInfoUrl() : string|null

Return values

string|null —

getQuoteId()


    public
                    getQuoteId() : string|null

Return values

string|null —

getRateLimitLimit()

Returns X-RateLimit-Limit header from the response.


    public
                    getRateLimitLimit() : int|null

This number represents the he maximum number of requests that the current client can make in one hour.

Return values

int|null

getRateLimitRemaining()

Returns X-RateLimit-Remaining header from the response.


    public
                    getRateLimitRemaining() : int|null

The number of remaining requests for the current window.

Return values

int|null

getRateLimitReset()

Returns X-RateLimit-Reset header from the response. Seconds until a new window starts.


    public
                    getRateLimitReset() : int|null

Return values

int|null

getRefunded()


    public
                    getRefunded() : bool|null

Return values

bool|null —

getRefunds()


    public
                    getRefunds() : Refund|null

Return values

Refund|null —

(optional) An object describing any on or off-chain refund associated with this transaction.

getStartedAt()


    public
                    getStartedAt() : string

Return values

string —

Start date and time of transaction. UTC ISO 8601 string.

getStatus()


    public
                    getStatus() : string

Return values

string —

Processing status of deposit/withdrawal.

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

For complete documentation see: https://github.com/stellar/stellar-protocol/blob/v3.8.0/ecosystem/sep-0024.md#transaction-history

getStatusEta()


    public
                    getStatusEta() : int|null

Return values

int|null —

(optional) Estimated number of seconds until a status change is expected.

getStellarTransactionId()


    public
                    getStellarTransactionId() : string|null

Return values

string|null —

transaction_id on Stellar network of the transfer that either completed the deposit or started the withdrawal.

getTo()


    public
                    getTo() : string|null

Return values

string|null —

getUpdatedAt()


    public
                    getUpdatedAt() : string|null

Return values

string|null —

The date and time of transaction reaching the current status. UTC ISO 8601 string.

getUserActionRequiredBy()

Gets the deadline by when user action is required


    public
                    getUserActionRequiredBy() : string|null

Return values

string|null —

The date and time by when user action is required. UTC ISO 8601 string. Only specified for statuses where user action is required.

getWithdrawAnchorAccount()


    public
                    getWithdrawAnchorAccount() : string|null

Return values

string|null —

(optional) Only for withdraw transactions: If this is a withdrawal, this is the anchor's Stellar account that the user transferred (or will transfer) their asset to.

getWithdrawMemo()


    public
                    getWithdrawMemo() : string|null

Return values

string|null —

getWithdrawMemoType()


    public
                    getWithdrawMemoType() : string|null

Return values

string|null —

(optional) Only for withdraw transactions: Memo type for withdrawMemo.

setAmountFee()


    public
                    setAmountFee(string|null $amountFee) : void

Parameters

$amountFee : string|null: Amount of fee charged by anchor.

setAmountFeeAsset()


    public
                    setAmountFeeAsset(string|null $amountFeeAsset) : void

Parameters

$amountFeeAsset : string|null: The asset in which fees are calculated in. Should be present if the deposit/withdraw was made using non-equivalent assets. The value must be in SEP-38 Asset Identification Format. https://github.com/stellar/stellar-protocol/blob/v2.5.0/ecosystem/sep-0038.md#asset-identification-format See also the Asset Exchanges section for more information. https://github.com/stellar/stellar-protocol/blob/v3.8.0/ecosystem/sep-0024.md#asset-exchanges

setAmountIn()


    public
                    setAmountIn(string|null $amountIn) : void

Parameters

$amountIn : string|null: Amount received by anchor at start of transaction as a string with up to 7 decimals. Excludes any fees charged before the anchor received the funds.

setAmountInAsset()


    public
                    setAmountInAsset(string|null $amountInAsset) : void

Parameters

$amountInAsset : string|null: The asset received or to be received by the Anchor. Should be present if the deposit/withdraw was made using non-equivalent assets. The value must be in SEP-38 Asset Identification Format. https://github.com/stellar/stellar-protocol/blob/v2.5.0/ecosystem/sep-0038.md#asset-identification-format See also the Asset Exchanges section for more information. https://github.com/stellar/stellar-protocol/blob/v3.8.0/ecosystem/sep-0024.md#asset-exchanges

setAmountOut()


    public
                    setAmountOut(string|null $amountOut) : void

Parameters

$amountOut : string|null: Amount sent by anchor to user at end of transaction as a string with up to 7 decimals. Excludes amount converted to XLM to fund account and any external fees.

setAmountOutAsset()


    public
                    setAmountOutAsset(string|null $amountOutAsset) : void

Parameters

$amountOutAsset : string|null: The asset delivered or to be delivered to the user. Should be present if the deposit/withdraw was made using non-equivalent assets. The value must be in SEP-38 Asset Identification Format. https://github.com/stellar/stellar-protocol/blob/v2.5.0/ecosystem/sep-0038.md#asset-identification-format See also the Asset Exchanges section for more information. https://github.com/stellar/stellar-protocol/blob/v3.8.0/ecosystem/sep-0024.md#asset-exchanges

setClaimableBalanceId()


    public
                    setClaimableBalanceId(string|null $claimableBalanceId) : void

Parameters

$claimableBalanceId : string|null: (optional) Only for deposit transactions: ID of the Claimable Balance used to send the asset initially requested.

setCompletedAt()


    public
                    setCompletedAt(string|null $completedAt) : void

Parameters

$completedAt : string|null: The date and time of transaction reaching completed or refunded status. UTC ISO 8601 string.

setDepositMemo()


    public
                    setDepositMemo(string|null $depositMemo) : void

Parameters

$depositMemo : string|null: (optional) Only for deposit transactions: This is the memo (if any) used to transfer the asset to the to Stellar address.

setDepositMemoType()


    public
                    setDepositMemoType(string|null $depositMemoType) : void

Parameters

$depositMemoType : string|null: (optional) Only for deposit transactions: Type for the depositMemo.

setExternalTransactionId()


    public
                    setExternalTransactionId(string|null $externalTransactionId) : void

Parameters

$externalTransactionId : string|null: ID of transaction on external network that either started the deposit or completed the withdrawal.

setFrom()


    public
                    setFrom(string|null $from) : void

Parameters

$from : string|null: In case of deposit: Sent from address, perhaps BTC, IBAN, or bank account. In case of withdraw: Stellar address the assets were withdrawn from.

setHeaders()

Extracts and sets rate limiting information from HTTP response headers


    public
                    setHeaders(array<string|int, mixed> $headers) : void

This method processes the X-Ratelimit-* headers from the HTTP response and stores them for client access.

Parameters

$headers : array<string|int, mixed>: Associative array of HTTP headers from the response

setHttpClient()

Sets the HTTP client for making follow-up requests


    public
                    setHttpClient([Client|null $httpClient = null ]) : void

Paginated responses contain links to next/previous pages. This HTTP client is used when following those links to fetch additional pages.

Parameters

$httpClient : Client|null = null: The Guzzle HTTP client to use for pagination

setId()


    public
                    setId(string $id) : void

Parameters

$id : string: Unique, anchor-generated id for the deposit/withdrawal.

setKind()


    public
                    setKind(string $kind) : void

Parameters

$kind : string: Possible values: 'deposit' or 'withdrawal'.

setKycVerified()


    public
                    setKycVerified(bool|null $kycVerified) : void

Parameters

$kycVerified : bool|null: (optional) True if the anchor has verified the user's KYC information for this transaction.

setMessage()


    public
                    setMessage(string|null $message) : void

Parameters

$message : string|null: Human-readable explanation of transaction status, if needed.

setMoreInfoUrl()


    public
                    setMoreInfoUrl(string|null $moreInfoUrl) : void

Parameters

$moreInfoUrl : string|null: A URL that is opened by wallets after the interactive flow is complete. It can include banking information for users to start deposits, the status of the transaction, or any other information the user might need to know about the transaction.

setQuoteId()


    public
                    setQuoteId(string|null $quoteId) : void

Parameters

$quoteId : string|null: (optional) The ID of the quote (sep-38) used when creating this transaction. Should be present if a quote_id was included in the POST /transactions/deposit/interactive or POST /transactions/withdraw/interactive request. Clients should be aware that the quote_id may not be present in older implementations.

setRefunded()


    public
                    setRefunded(bool|null $refunded) : void

Parameters

$refunded : bool|null: (deprecated, optional) This field is deprecated in favor of the refunds object and the refunded status. True if the transaction was refunded in full. False if the transaction was partially refunded or not refunded. For more details about any refunds, see the Refund object.

setRefunds()


    public
                    setRefunds(Refund|null $refunds) : void

Parameters

$refunds : Refund|null: (optional) An object describing any on or off-chain refund associated with this transaction.

setStartedAt()


    public
                    setStartedAt(string $startedAt) : void

Parameters

$startedAt : string: Start date and time of transaction. UTC ISO 8601 string.

setStatus()


    public
                    setStatus(string $status) : void

Parameters

$status : string: Processing status of deposit/withdrawal.

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

For complete documentation see: https://github.com/stellar/stellar-protocol/blob/v3.8.0/ecosystem/sep-0024.md#transaction-history

setStatusEta()


    public
                    setStatusEta(int|null $statusEta) : void

Parameters

$statusEta : int|null: (optional) Estimated number of seconds until a status change is expected.

setStellarTransactionId()


    public
                    setStellarTransactionId(string|null $stellarTransactionId) : void

Parameters

$stellarTransactionId : string|null: transaction_id on Stellar network of the transfer that either completed the deposit or started the withdrawal.

setTo()


    public
                    setTo(string|null $to) : void

Parameters

$to : string|null: In case of deposit: Stellar address the deposited assets were sent to. In case of withdraw: Sent to address (perhaps BTC, IBAN, or bank account in the case of a withdrawal, Stellar address in the case of a deposit).

setUpdatedAt()


    public
                    setUpdatedAt(string|null $updatedAt) : void

Parameters

$updatedAt : string|null: The date and time of transaction reaching the current status. UTC ISO 8601 string.

setUserActionRequiredBy()

Sets the deadline by when user action is required


    public
                    setUserActionRequiredBy(string|null $userActionRequiredBy) : void

Parameters

$userActionRequiredBy : string|null: The date and time by when user action is required. UTC ISO 8601 string.

setWithdrawAnchorAccount()


    public
                    setWithdrawAnchorAccount(string|null $withdrawAnchorAccount) : void

Parameters

$withdrawAnchorAccount : string|null: (optional) Only for withdraw transactions: If this is a withdrawal, this is the anchor's Stellar account that the user transferred (or will transfer) their asset to.

setWithdrawMemo()


    public
                    setWithdrawMemo(string|null $withdrawMemo) : void

Parameters

$withdrawMemo : string|null: (optional) Only for withdraw transactions: Memo used when the user transferred to withdrawAnchorAccount. Assigned null if the withdrawal is not ready to receive payment, for example if KYC is not completed.

setWithdrawMemoType()


    public
                    setWithdrawMemoType(string|null $withdrawMemoType) : void

Parameters

$withdrawMemoType : string|null: (optional) Only for withdraw transactions: Memo type for withdrawMemo.

loadFromJson()

Loads the needed data from a json array.


    protected
                    loadFromJson(array<string|int, mixed> $json) : void

Parameters

$json : array<string|int, mixed>: the data array to read from.

SEP24Transaction extends Response in package Soneso StellarSDK SEP Interactive

Tags

Table of Contents

Properties

Methods

Properties

$amountFee

$amountFeeAsset

$amountIn

$amountInAsset

$amountOut

$amountOutAsset

$claimableBalanceId

$completedAt

$depositMemo

$depositMemoType

$externalTransactionId

$from

$id

$kind

$kycVerified

$message

$moreInfoUrl

$quoteId

$refunded

$refunds

$startedAt

$status

$statusEta

$stellarTransactionId

$to

$updatedAt

$userActionRequiredBy

$withdrawAnchorAccount

$withdrawMemo

$withdrawMemoType

$httpClient

$rateLimitLimit

$rateLimitRemaining

$rateLimitReset

Methods

fromJson()

Parameters

Return values

getAmountFee()

Return values

getAmountFeeAsset()

Return values

getAmountIn()

Return values

getAmountInAsset()

Return values

getAmountOut()

Return values

getAmountOutAsset()

Return values

getClaimableBalanceId()

Return values

getCompletedAt()

Return values

getDepositMemo()

Return values

getDepositMemoType()

Return values

getExternalTransactionId()

Return values

getFrom()

Return values

getHttpClient()

Return values

getId()

Return values

getKind()

Return values

getKycVerified()

Return values

getMessage()

Return values

getMoreInfoUrl()

Return values

SEP24Transaction extends Response
in package

Soneso

StellarSDK

SEP

Interactive