DepositRequest

public struct DepositRequest : Sendable

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

This struct encapsulates all the parameters needed to start a deposit flow where a user sends an external token (such as fiat via bank transfer) to an address held by an anchor. In return, the anchor sends an equal amount of the equivalent token on the Stellar network (minus fees) to the user’s Stellar account.

The endpoint allows the anchor to specify additional information that the user must submit via SEP-12 to complete the deposit. If the anchor’s /deposit endpoint immediately returns success, the wallet should display the deposit information to the user including the fee.

See also:

Show on GitHub

  • The code of the on-chain asset the user wants to receive from the anchor after making an off-chain deposit. The value passed must match one of the codes listed in the /info response’s deposit object.

    Declaration

    Swift

    public var assetCode: String
    Show on GitHub

  • The Stellar (G…), muxed (M…), or contract (C…) account ID of the user that wants to deposit. This is where the asset token will be sent. Note that the account specified in this request could differ from the account authenticated via SEP-10.

    Declaration

    Swift

    public var account: String
    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

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

    Declaration

    Swift

    public var memoType: 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 as well as memo_type can be different than the values 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

  • Email address of depositor. If desired, an anchor can use this to send email updates to the user about the deposit.

    Declaration

    Swift

    public var emailAddress: String?
    Show on GitHub

  • Type of deposit. If the anchor supports multiple deposit methods (e.g. SEPA or SWIFT), the wallet should specify type. This field may be necessary for the anchor to determine which KYC fields to collect.

    Declaration

    Swift

    public var type: String?
    Show on GitHub

  • In communications about the deposit, anchor should display the wallet name to the user to explain where funds are going. However, anchors should use client_domain (for non-custodial) and sub value of JWT (for custodial) to determine wallet information.

    Declaration

    Swift

    public var walletName: String?
    Show on GitHub

  • Anchor should link to this when notifying the user that the transaction has completed. However, anchors should use client_domain (for non-custodial) and sub value of JWT (for custodial) to determine wallet information.

    Declaration

    Swift

    public var walletUrl: String?
    Show on GitHub

  • Language code specified using RFC 4646. Defaults to en if not specified. Error fields and other human readable messages in the response should be in this language.

    Declaration

    Swift

    public var lang: String?
    Show on GitHub

  • A URL that the anchor should POST a JSON message to when the status property of the transaction created as a result of this request changes. The JSON message should be identical to the response format for the /transaction endpoint. The callback needs to be signed by the anchor and the signature needs to be verified by the wallet according to the callback signature specification.

    Declaration

    Swift

    public var onChangeCallback: String?
    Show on GitHub

  • The amount of the asset the user would like to deposit with the anchor. This field may be necessary for the anchor to determine what KYC information is necessary to collect.

    Declaration

    Swift

    public var amount: String?
    Show on GitHub

  • The ISO 3166-1 alpha-3 code of the user’s current address. This field may be necessary for the anchor to determine what KYC information is necessary to collect.

    Declaration

    Swift

    public var countryCode: 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

  • ID of an off-chain account (managed by the anchor) associated with this user’s Stellar account (identified by the JWT’s sub field). If the anchor supports SEP-12, the customer_id field should match the SEP-12 customer’s id. customer_id should be passed only when the off-chain id is known to the client, but the relationship between this id and the user’s Stellar account is not known to the anchor.

    Declaration

    Swift

    public var customerId: String?
    Show on GitHub

  • ID of the chosen location to drop off cash.

    Declaration

    Swift

    public var locationId: String?
    Show on GitHub

  • Additional custom fields that can be used to provide extra information for the request. For example, required fields from the /info endpoint that are not covered by the standard parameters.

    Declaration

    Swift

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

  • Creates a new deposit request.

    Declaration

    Swift

    public init(assetCode: String, account: String, jwt: String? = nil)

    Parameters

    assetCode

    The code of the on-chain asset the user wants to receive
    account

    The Stellar account ID where the asset will be sent
    jwt

    Optional JWT token from SEP-10 authentication
    Show on GitHub