Creates an FX Quote object
Parameters
- from_
currenciesarray of enumsRequired A list of three letter ISO currency code, in lowercase. Must be supported currencies.
- lock_
durationenumRequired The duration that you wish the quote to be locked for. The quote will be usable for the duration specified. The default is
none. The maximum is 1 day.Possible enum valuesdayRequests a quote valid for one day
five_minutes Requests a quote valid for five minutes
hourRequests a quote valid for one hour
noneRequests a quote valid without lock rate
- to_
currencyenumRequired Three-letter ISO currency code, in lowercase. Must be a supported currency.
More parameters
- usageobject
The usage specific information for the quote.
- usage.
typeenumRequired Which transaction the FX Quote will be used for
Can be “payment” | “transfer”
Possible enum valuespaymentThe usage of the FX Quote is for payments.
transferThe usage of the FX Quote is for transfers.
- usage.
paymentobject The payment transaction details that are intended for the FX Quote.
- usage.
payment. 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 PaymentIntent’s transfer_data[destination] field.
- usage.
payment. on_ behalf_ ofstring The Stripe account ID that these funds are intended for.
This field should match the account ID that would be used in the PaymentIntent’s on_behalf_of field.
- usage.
transferobject The transfer transaction details that are intended for the FX Quote.
- usage.
transfer. destinationstringRequired 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.
Returns
Returns an FX Quote object
{ "id": "fxq_1QKf8UET9NELqCotgW6CNTnm", "object": "fx_quote", "created": 1731498806.6424642, "lock_duration": "hour", "lock_expires_at": 1731502406.5579598, "lock_status": "active", "rates": { "gbp": { "exchange_rate": 1.10167, "rate_details": { "base_rate": 1.12415, "fx_fee_rate": 0.02, "reference_rate": 1.12437, "reference_rate_provider": "ecb" } }, "krw": { "exchange_rate": 0.000617274, "rate_details": { "base_rate": 0.000629871, "fx_fee_rate": 0.02, "reference_rate": 0.000629997, "reference_rate_provider": "ecb" } } }, "to_currency": "chf", "usage": { "payment": null, "transfer": null, "type": "payment" }}- Need help? Contact Support.
- Check out our changelog.
- Questions? Contact Sales.
- LLM? Read llms.txt.
- Powered by Markdoc