Skip to content

Document simulation.country session properties for onramp/offramp flows #97

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
joaobaptistanqda wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Document simulation.country session properties for onramp/offramp flows #97

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions docs/flows/crypto-offramp.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down Expand Up @@ -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",
Expand Down
5 changes: 5 additions & 0 deletions docs/flows/crypto-onramp.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down Expand Up @@ -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",
Expand Down