Sep24DepositRequest

public struct Sep24DepositRequest : Sendable

Request parameters for initiating a deposit transaction via SEP-0024.

This struct encapsulates all the parameters needed to start an interactive deposit flow, where a user deposits off-chain assets (e.g., fiat currency) with an anchor and receives the equivalent Stellar asset.

See also:

  • [InteractiveService.deposit] for the method that uses this request
  • SEP-0024
Show on GitHub
  • jwt

    JWT previously received from the anchor via the SEP-10 authentication flow.

    Declaration

    Swift

    public var jwt: String
    Show on GitHub

  • The code of the stellar asset the user wants to receive for their deposit with the anchor. The value passed must match one of the codes listed in the /info response’s deposit object. ‘native’ is a special asset_code that represents the native XLM token.

    Declaration

    Swift

    public var assetCode: String
    Show on GitHub

  • The issuer of the stellar asset the user wants to receive for their deposit with the anchor. If assetIssuer is not provided, the anchor will use the asset issued by themselves as described in their TOML file. If ‘native’ is specified as the assetCode, assetIssuer must be not be set.

    Declaration

    Swift

    public var assetIssuer: String?
    Show on GitHub

  • String in Asset Identification Format - The asset user wants to send. Note, that this is the asset user initially holds (off-chain or fiat asset). If this is not provided, it will be collected in the interactive flow. When quote_id is specified, this parameter must match the quote’s sell_asset asset code or be omitted.

    Declaration

    Swift

    public var sourceAsset: String?
    Show on GitHub

  • Amount of asset requested to deposit. If this is not provided it will be collected in the interactive flow.

    Declaration

    Swift

    public var amount: String?
    Show on GitHub

  • The id returned from a SEP-38 POST /quote response.

    Declaration

    Swift

    public var quoteId: String?
    Show on GitHub

  • The Stellar (G…) or muxed account (M…) the client will use as the source of the withdrawal payment to the anchor. Defaults to the account authenticated via SEP-10 if not specified.

    Declaration

    Swift

    public var account: String?
    Show on GitHub

  • Value of memo to attach to transaction, for hash this should be base64-encoded. Because a memo can be specified in the SEP-10 JWT for Shared Accounts, this field can be different than the value included in the SEP-10 JWT. For example, a client application could use the value passed for this parameter as a reference number used to match payments made to account.

    Declaration

    Swift

    public var memo: String?
    Show on GitHub

  • Type of memo that anchor should attach to the Stellar payment transaction, one of text, id or hash.

    Declaration

    Swift

    public var memoType: String?
    Show on GitHub

  • In communications / pages about the deposit, anchor should display the wallet name to the user to explain where funds are going.

    Declaration

    Swift

    public var walletName: String?
    Show on GitHub

  • Anchor should link to this when notifying the user that the transaction has completed.

    Declaration

    Swift

    public var walletUrl: String?
    Show on GitHub

  • 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. Error fields in the response, as well as the interactive flow UI and any other user-facing strings returned for this transaction should be in this language.

    Declaration

    Swift

    public var lang: String?
    Show on GitHub

  • “true” if the client supports receiving deposit transactions as a claimable balance, false otherwise.

    Declaration

    Swift

    public var claimableBalanceSupported: String?
    Show on GitHub

  • One or more of the KYC fields for natural persons as listed in SEP-9.

    Declaration

    Swift

    public var kycFields: [KYCNaturalPersonFieldsEnum]?
    Show on GitHub

  • One or more of the KYC fields for organizations as listed in SEP-9.

    Declaration

    Swift

    public var kycOrganizationFields: [KYCOrganizationFieldsEnum]?
    Show on GitHub

  • One or more of the KYC fields for financial accounts as listed in SEP-9.

    Declaration

    Swift

    public var kycFinancialAccountFields: [KYCFinancialAccountFieldsEnum]?
    Show on GitHub

  • Additional custom fields to be added to the request.

    Declaration

    Swift

    public var customFields: [String : String]?
    Show on GitHub

  • Additional custom files to be added to the request.

    Declaration

    Swift

    public var customFiles: [String : Data]?
    Show on GitHub

  • Creates a new deposit request.

    Declaration

    Swift

    public init(jwt: String, assetCode: String)

    Parameters

    jwt

    JWT previously received from the anchor via SEP-10 authentication
    assetCode

    The code of the stellar asset the user wants to receive
    Show on GitHub

  • Converts the request parameters to a dictionary of data for multipart form submission.

    Declaration

    Swift

    public func toParameters() -> [String : Data]

    Return Value

    Dictionary mapping parameter names to their Data representations

    Show on GitHub