WithdrawResponse

public struct WithdrawResponse : Decodable, Sendable

Response returned when initiating a withdrawal transaction.

This response is returned by GET /withdraw and GET /withdraw-exchange requests in SEP-6. It provides the Stellar account and memo that the user should send their tokens to in order to initiate the withdrawal.

The wallet should use the transaction ID to query the GET /transaction endpoint to check the status of the withdrawal.

See SEP-6 Withdraw

Show on GitHub

  • (optional) The account the user should send its token back to. This field can be omitted if the anchor cannot provide this information at the time of the request.

    Declaration

    Swift

    public let accountId: String?
    Show on GitHub

  • (optional) type of memo to attach to transaction, one of text, id or hash

    Declaration

    Swift

    public let memoType: String?
    Show on GitHub

  • (optional) Value of memo to attach to transaction, for hash this should be base64-encoded. The anchor should use this memo to match the Stellar transaction with the database entry associated created to represent it.

    Declaration

    Swift

    public let memo: String?
    Show on GitHub
  • id

    (optional) The anchor’s ID for this withdrawal. The wallet will use this ID to query the /transaction endpoint to check status of the request.

    Declaration

    Swift

    public let id: String?
    Show on GitHub
  • eta

    (optional) Estimate of how long the withdrawal will take to credit in seconds.

    Declaration

    Swift

    public let eta: Int?
    Show on GitHub

  • (optional) Minimum amount of an asset that a user can withdraw.

    Declaration

    Swift

    public let minAmount: Double?
    Show on GitHub

  • (optional) Maximum amount of asset that a user can withdraw.

    Declaration

    Swift

    public let maxAmount: Double?
    Show on GitHub

  • (optional) If there is a fee for withdraw. In units of the withdrawn asset.

    Declaration

    Swift

    public let feeFixed: Double?
    Show on GitHub

  • (optional) If there is a percent fee for withdraw.

    Declaration

    Swift

    public let feePercent: Double?
    Show on GitHub

  • (optional) Any additional data needed as an input for this withdraw, example: Bank Name.

    Declaration

    Swift

    public let extraInfo: ExtraInfo?
    Show on GitHub

  • Initializer - creates a new instance by decoding from the given decoder.

    Declaration

    Swift

    public init(from decoder: Decoder) throws

    Parameters

    decoder

    The decoder containing the data
    Show on GitHub