Sep38PostQuoteRequest

public struct Sep38PostQuoteRequest : Sendable

Request model for creating a firm quote via SEP-38.

This structure represents a POST request to the /quote endpoint, which creates a firm quote that can be executed by the client. Either sellAmount or buyAmount must be specified, but not both.

See SEP-38: Quote Service

Show on GitHub

  • The context in which the quote is being requested.

    Valid values are “sep6” for SEP-6 transfers or “sep31” for SEP-31 payments.

    Declaration

    Swift

    public var context: String
    Show on GitHub

  • The asset the client wants to sell.

    The value must be in SEP-38 Asset Identification Format. Example: “stellar:USDC:GBBD47IF6LWK7P7MDEVSCWR7DPUWV3NY3DTQEVFL4NAT4AQH3ZLLFLA5”

    Declaration

    Swift

    public var sellAsset: String
    Show on GitHub

  • The asset the client wants to buy.

    The value must be in SEP-38 Asset Identification Format. Example: “iso4217:BRL”

    Declaration

    Swift

    public var buyAsset: String
    Show on GitHub

  • The amount of sell asset the client wants to exchange.

    Must be provided if buyAmount is not provided. Mutually exclusive with buyAmount.

    Declaration

    Swift

    public var sellAmount: String?
    Show on GitHub

  • The amount of buy asset the client wants to receive.

    Must be provided if sellAmount is not provided. Mutually exclusive with sellAmount.

    Declaration

    Swift

    public var buyAmount: String?
    Show on GitHub

  • The timestamp after which the quote should expire.

    If not provided, the anchor will use its default expiration time.

    Declaration

    Swift

    public var expireAfter: Date?
    Show on GitHub

  • The method by which the client will deliver the sell asset to the anchor.

    Must be a valid delivery method for the sell asset as returned by the GET /info endpoint.

    Declaration

    Swift

    public var sellDeliveryMethod: String?
    Show on GitHub

  • The method by which the anchor will deliver the buy asset to the client.

    Must be a valid delivery method for the buy asset as returned by the GET /info endpoint.

    Declaration

    Swift

    public var buyDeliveryMethod: String?
    Show on GitHub

  • The ISO 3166-1 alpha-3 country code of the client.

    Used to determine available delivery methods and pricing. Must be one of the values specified in the asset’s country_codes array from the GET /info endpoint.

    Declaration

    Swift

    public var countryCode: String?
    Show on GitHub

  • Creates a new quote request with required parameters.

    Declaration

    Swift

    public init(context: String, sellAsset: String, buyAsset: String)

    Parameters

    context

    The context for the quote (“sep6” or “sep31”)
    sellAsset

    The asset to sell in SEP-38 format
    buyAsset

    The asset to buy in SEP-38 format
    Show on GitHub

  • Converts the request to a JSON dictionary for API submission.

    Transforms the Swift property names to the snake_case format expected by the SEP-38 API. Optional properties are only included if they have values.

    Declaration

    Swift

    public func toJson() -> [String : Any]

    Return Value

    Dictionary representation suitable for HTTP request body

    Show on GitHub