Skip to content

Document campaignIds on on/offramp flows #121

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
+6 −4
Open

Document campaignIds on on/offramp flows #121

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
2 changes: 2 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 @@ -14,6 +14,7 @@ The crypto off-ramp flow allows a user to sell cryptocurrency and convert it int
<Tabs>
<TabItem label="Schema" value="schema" default>

- `campaignIds` (_optional_): Public campaigns to be added to the widget session, it overrides any private campaign that would be applied to the session. Only one id can be provided for now. If they cannot be attributed to the session they will be silently ignored.
- `partner` (_optional_): Partner object.
- `continueUrl` (_optional_): URL to redirect the user to after the order is placed and the funds were received.
- `continueUrlTarget` (_optional_): In which tab should the `continueUrl` be opened.
Expand Down Expand Up @@ -90,6 +91,7 @@ We recommend that you use `XRP` for testing purposes when integrating Topper sin
"jti": "4b552af1-1592-42f8-bbc9-dac28e2b4000",
"sub": "b9fe022b-f436-49e1-bb89-6f2e8eabf336",
// highlight-start
"campaignIds": ["7c757c81-39dc-4e42-8c06-3ebafc579d0d"],
"partner": {
"continueUrl": "https://example.com",
"continueUrlTarget": "new-tab",
Expand Down
8 changes: 4 additions & 4 deletions docs/flows/crypto-onramp.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ The crypto on-ramp flow allows a user to add funds from a credit or debit card t
<Tabs>
<TabItem label="Schema" value="schema" default>

- `campaignIds` (_optional_): Public campaigns to be added to the widget session, it overrides any private campaign that would be applied to the session. Only one id can be provided for now. If they cannot be attributed to the session they will be silently ignored.
- `partner` (_optional_): Partner object.
- `continueUrl` (_optional_): URL to redirect the user to after the order is placed.
- `continueUrlTarget` (_optional_): In which tab should the `continueUrl` be opened.
Expand Down Expand Up @@ -81,6 +82,7 @@ We recommend that you use `XRP` for testing purposes when integrating Topper sin
"jti": "4b552af1-1592-42f8-bbc9-dac28e2b4000",
"sub": "b9fe022b-f436-49e1-bb89-6f2e8eabf336",
// highlight-start
"campaignIds": ["7c757c81-39dc-4e42-8c06-3ebafc579d0d"],
"partner": {
"continueUrl": "https://example.com",
"continueUrlTarget": "new-tab",
Expand Down Expand Up @@ -133,11 +135,9 @@ We accept this validation parameters as plain strings or as an hashed string. If
If you plan on using hashed validation, please check the example below to see how you should hash your data.

```js
import { createHash } from 'node:crypto';
import { createHash } from "node:crypto";

await createHash('sha256')
.update('1.2.3.4')
.digest('hex');
await createHash("sha256").update("1.2.3.4").digest("hex");
```

:::note
Expand Down
Loading