From 7196499227485b2a2f8beae31b7fea2a98b90950 Mon Sep 17 00:00:00 2001 From: joaobaptistanqda Date: Wed, 13 Aug 2025 16:15:35 +0100 Subject: [PATCH] Document `simulation.country` session properties for onramp/offramp flows Signed-off-by: joaobaptistanqda --- docs/flows/crypto-offramp.mdx | 5 +++++ docs/flows/crypto-onramp.mdx | 5 +++++ 2 files changed, 10 insertions(+) diff --git a/docs/flows/crypto-offramp.mdx b/docs/flows/crypto-offramp.mdx index f004647..056d4c8 100644 --- a/docs/flows/crypto-offramp.mdx +++ b/docs/flows/crypto-offramp.mdx @@ -29,6 +29,8 @@ The crypto off-ramp flow allows a user to sell cryptocurrency and convert it int - `type`: Tag type (e.g.: `memo` or `destination-tag`). - `value`: Tag value. - `priority` (_optional_): Priority of the crypto transaction (e.g.: `fast` will enable instant send for `Dash` transactions). Defaults to `normal`. +- `simulation` (_optional_): Simulation object. + - `country` (_optional_): Country to use during simulations, in alpha-2 code format; It will be ignored after the user is authenticated and the user's country will be used. - `source` (_optional_): An object configuring the asset and amount to be sold. - `allowedAssets` (_optional_): Set of cryptoassets that the user can set as source asset. - `amount` (_optional_): Amount to be sold. @@ -87,6 +89,9 @@ We recommend that you use `XRP` for testing purposes when integrating Topper sin "address": "0xb794f5ea0ba39494ce839613fffba74279579268", "priority": "normal" }, + "simulation": { + "country": "US" + }, "source": { "allowedAssets": [ "BTC", diff --git a/docs/flows/crypto-onramp.mdx b/docs/flows/crypto-onramp.mdx index 4b010ac..c872e83 100644 --- a/docs/flows/crypto-onramp.mdx +++ b/docs/flows/crypto-onramp.mdx @@ -24,6 +24,8 @@ The crypto on-ramp flow allows a user to add funds from a credit or debit card t - `same-tab`: Open in the same tab or iframe (default). - `parent-tab`: Useful only in an iframe: open in the tab that contains the iframe. - `partnerFee` (_deprecated_): Use `partner.fee` instead. +- `simulation` (_optional_): Simulation object. + - `country` (_optional_): Country to use during simulations, in alpha-2 code format; It will be ignored after the user is authenticated and the user's country will be used. - `source` (_optional_): An object configuring the asset and amount to be paid. - `amount` (_optional_): Amount to be paid. - `asset`: Currency code in the [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) format used to make the payment. @@ -76,6 +78,9 @@ We recommend that you use `XRP` for testing purposes when integrating Topper sin "continueUrl": "https://example.com", "continueUrlTarget": "new-tab" }, + "simulation": { + "country": "US" + }, "source": { "amount": "100.00", "asset": "USD",