The FX Quote object 

Attributes

• idstring

  Unique identifier for the object.

• lock_durationenum

  The duration the exchange rate quote remains valid from creation time. Allowed values are none, hour, and day. Note that for the test mode API available in alpha, you can request an extended quote, but it won’t be usable for any transactions.

  Possible enum values

  day Requests a quote valid for one day

  five_minutes Requests a quote valid for five minutes

  hour Requests a quote valid for one hour

  none Requests a quote valid without lock rate

• ratesobject

  Information about the rates.

  Hide child attributes

  • rates.<from_currency>.exchange_ratefloat

    The rate that includes the FX fee rate.

  • rates.<from_currency>.rate_detailsobject

    The breakdown of the rates.

    Hide child attributes

    • rates.<from_currency>.rate_details.base_ratefloat

      The rate for the currency pair.

    • rates.<from_currency>.rate_details.duration_premiumfloat

      The fee for locking the conversion rates.

    • rates.<from_currency>.rate_details.fx_fee_ratefloat

      The FX fee for the currency pair.

    • rates.<from_currency>.rate_details.reference_ratenullable float

      A reference rate for the currency pair provided by the reference rate provider.

    • rates.<from_currency>.rate_details.reference_rate_providernullable enum

      The reference rate provider.

      Possible enum values

      ecb The European Central Bank is reference rate provider. We provide the reference rate when both the from_currency and to_currency are in the following list: eur usd jpy bgn czk dkk gbp huf pln ron sek chf isk nok try aud brl cad cny hkd idr ils inr krw mxn myr nzd php sgd thb zar

• to_currencystring

  The currency to convert into, typically this is the currency that you want to settle to your Stripe balance. Three-letter ISO currency code, in lowercase. Must be a supported currency.

More attributes

Collapse all

• objectstring

  String representing the object’s type. Objects of the same type share the same value.

• createdtimestamp

  Time at which the quote was created, measured in seconds since the Unix epoch.

• lock_expires_atnullable timestamp

  Time at which the quote will expire, measured in seconds since the Unix epoch.

  If lock_duration is set to ‘none’ this field will be set to null.

• lock_statusenum

  Lock status of the quote. Transitions from active to expired once past the lock_expires_at timestamp.

  Can return value none, active, or expired.

  Possible enum values

  active FX Quote lock is active

  expired FX Quote lock has expired

  none FX Quote does not have a lock status

• usageobject

  The usage specific information for the quote.

  Hide child attributes

  • usage.paymentnullable object

    The details required to use an FX Quote for a payment

    Hide child attributes

    • usage.payment.destinationnullable string

      The Stripe account ID that the funds will be transferred to.

      This field should match the account ID that would be used in the PaymentIntent’s transfer_data[destination] field.

    • usage.payment.on_behalf_ofnullable string

      The Stripe account ID that these funds are intended for.

      This field must match the account ID that would be used in the PaymentIntent’s on_behalf_of field.

  • usage.transfernullable object

    The details required to use an FX Quote for a transfer

    Hide child attributes

    • usage.transfer.destinationstring

      The Stripe account ID that the funds will be transferred to.

      This field should match the account ID that would be used in the Transfer’s destination field.

  • usage.typeenum

    The transaction type for which the FX Quote will be used.

    Can be ‘payment’ or ‘transfer’.

    Possible enum values

    payment The usage of the FX Quote is for payments.

    transfer The usage of the FX Quote is for transfers.