Skip to content

Commit fce7e2c

Browse files
Update offramp edit mode
1 parent 6c9f2ac commit fce7e2c

1 file changed

Lines changed: 5 additions & 3 deletions

File tree

docs/flows/crypto-offramp.mdx

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -47,8 +47,10 @@ The crypto off-ramp flow allows a user to sell cryptocurrency and convert it int
4747
- `amount` (_optional_): Amount to be sold.
4848
- `asset`: Cryptoasset the user will send.
4949
- `editMode` (_optional_): Controls what values the user can change on the widget.
50-
- `all-editable`: The user can change `amount`, `asset` and `network` on the widget. (default)
51-
- `only-amount`: The user can only change the amount on the widget.
50+
- `only-asset-and-network`: The user can change `asset` and `network` on the widget. (default)
51+
- `not-editable`: The user cannot change `asset` or `network` on the widget.
52+
- `all-editable` (_deprecated_): Use `only-asset-and-network` instead.
53+
- `only-amount` (_deprecated_): Use `not-editable` instead.
5254
- `network` (_optional_): Network of the receiving asset.
5355
- `walletSendUrl` (_optional_): URL to redirect the user to send the crypto from their wallet. It will include order details as query parameters like `topper_order_address`, `topper_order_amount`, `topper_order_asset_code`, `topper_order_asset_network`, `topper_order_tag_type`, `topper_order_tag_value`, and others. Placeholders `{topper_*}` can be used on the given URL for dynamic value replacement, useful for deep linking (e.g: `https://partner.app/send?amount={topper_order_amount}&address={topper_order_address}`).
5456
- `walletSendUrlTarget` (_optional_): In which tab should the `walletSendUrl` be opened.
@@ -120,7 +122,7 @@ We recommend that you use `XRP` for testing purposes when integrating Topper sin
120122
]
121123
"amount": "1",
122124
"asset": "ETH",
123-
"editMode": "all-editable",
125+
"editMode": "only-asset-and-network",
124126
"network": "ethereum",
125127
"walletSendUrl": "https://example.com",
126128
"walletSendUrlTarget": "new-tab"

0 commit comments

Comments
 (0)