WithdrawRequest

public struct WithdrawRequest : Sendable

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

This struct encapsulates all the parameters needed to start a withdrawal flow where a user sends an on-chain asset (Stellar token) to an anchor. In return, the anchor sends an equal amount of an external token (minus fees) to the user’s external account such as a bank account, mobile money account, or crypto wallet.

The endpoint allows the anchor to specify additional information that the user must submit via SEP-12 to complete the withdrawal. Anchors are instructed to accept a variation of ±10% between the informed amount and the actual value sent to the anchor’s Stellar account, with the withdrawn amount adjusted accordingly.

See also:

Show on GitHub

  • Type of withdrawal. Can be: crypto, bank_account, cash, mobile, bill_payment or other custom values. This field may be necessary for the anchor to determine what KYC information is necessary to collect.

    Declaration

    Swift

    public var type: String
    Show on GitHub

  • Code of the on-chain asset the user wants to withdraw. The value passed must match one of the codes listed in the /info response’s withdraw object.

    Declaration

    Swift

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

  • The account that the user wants to withdraw their funds to. This can be a crypto account, a bank account number, IBAN, mobile number, or email address. Deprecated: Anchors should use SEP-12 to collect this information.

    Declaration

    Swift

    public var dest: String?
    Show on GitHub

  • Extra information to specify withdrawal location. For crypto it may be a memo in addition to the dest address. It can also be a routing number for a bank, a BIC, or the name of a partner handling the withdrawal. Deprecated: Anchors should use SEP-12 to collect this information.

    Declaration

    Swift

    public var destExtra: String?
    Show on GitHub

  • The Stellar (G…), muxed (M…), or contract (C…) account the client will use as the source of the withdrawal payment to the anchor. If SEP-10 authentication is not used, the anchor can use account to look up the user’s KYC information. 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

  • This field should only be used if SEP-10 authentication is not. It was originally intended to distinguish users of the same Stellar account. However if SEP-10 is supported, the anchor should use the sub value included in the decoded SEP-10 JWT instead.

    Declaration

    Swift

    public var memo: String?
    Show on GitHub

  • Type of memo. One of text, id or hash. Deprecated because memos used to identify users of the same Stellar account should always be of type id.

    Declaration

    Swift

    public var memoType: String?
    Show on GitHub

  • In communications about the withdrawal, anchor should display the wallet name to the user to explain where funds are coming from. 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 can show this to the user when referencing the wallet involved in the withdrawal. 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 withdraw. 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

  • The memo the anchor must use when sending refund payments back to the user. If not specified, the anchor should use the same memo used by the user to send the original payment. If specified, refund_memo_type must also be specified.

    Declaration

    Swift

    public var refundMemo: String?
    Show on GitHub

  • The type of the refund_memo. Can be id, text, or hash. If specified, refund_memo must also be specified.

    Declaration

    Swift

    public var refundMemoType: 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 pick up 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 withdrawal request.

    Declaration

    Swift

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

    Parameters

    type

    The type of withdrawal (crypto, bank_account, cash, etc)
    assetCode

    The code of the on-chain asset to withdraw
    jwt

    Optional JWT token from SEP-10 authentication
    Show on GitHub