You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
-`device`: (_optional_): Device parameters to validate.
28
+
-`ip` (_optional_): User IP on partner's side that we should validate remains the same.
29
+
-`user-agent` (_optional_): User agent used on partner's side that we should validate remains the same.
30
+
-`encrypted` (_optional_): Encrypted parameters to validate.
31
+
-`alg` (_optional_): Algorithm used to hash the fields. In case no algorithm is set, we'll be assumed that `sha256` was used.
32
+
-`fields`: Fields that have been hashed.
33
+
-`hash`: Result of hashing the fields appended in the given order, without any extra characters or whitespaces, using the given algorithm.
34
+
-`ipVersion` (_optional_): Version of IP value used on the hash.
26
35
-`refund` (_optional_): An object configuring the refund details. The asset and network of the refund will be the same as the source asset and network.
27
36
-`address`: Address to which the refund will be sent.
28
37
-`tag` (_optional_): Tag of the crypto transaction, used to complement the `address`.
@@ -83,6 +92,12 @@ We recommend that you use `XRP` for testing purposes when integrating Topper sin
83
92
"displayName":"ACME",
84
93
"fee": {
85
94
"percentage":"1"
95
+
},
96
+
validation: {
97
+
device:{
98
+
ip:'1.2.3.4',
99
+
'user-agent':'Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7)'
100
+
}
86
101
}
87
102
},
88
103
"refund": {
@@ -118,6 +133,23 @@ We recommend that you use `XRP` for testing purposes when integrating Topper sin
118
133
</TabItem>
119
134
</Tabs>
120
135
136
+
### Custom partner validation
137
+
138
+
To increase customer security we support an extra layer of validations that can be customizable by our partners. This layer includes validations from customer's device, like IP and user agent, that we ensure is the same as the one provided by you. In case of any mismatch, the user request to initiate a widget session will fail.
139
+
We accept this validation parameters as a plain string or as an hashed string. If you send us hashed parameters, we'll fetch the same parameters we receive from the user request, hash them and compare if both hashes are equal.
140
+
If you plan on using hashed validation, please check the example below to see how you should hash your data.
141
+
142
+
```js
143
+
import { createHash } from'node:crypto';
144
+
145
+
awaitcreateHash('sha256')
146
+
.update('1.2.3.4')
147
+
.digest('hex');
148
+
```
149
+
150
+
:::note
151
+
When validating user IP, if the IP versions mismatch, validation will be partially (plain string validation) or entirely (hashed validation) skipped.
152
+
121
153
## Events
122
154
123
155
Full information about the available events and their associated payloads can be found on the [events page](../events/crypto-offramp.mdx).
-`device`: (_optional_): Device parameters to validate.
28
+
-`ip` (_optional_): User IP on partner's side that we should validate remains the same.
29
+
-`user-agent` (_optional_): User agent used on partner's side that we should validate remains the same.
30
+
-`encrypted` (_optional_): Encrypted parameters to validate.
31
+
-`alg` (_optional_): Algorithm used to hash the fields. In case no algorithm is set, we'll be assumed that `sha256` was used.
32
+
-`fields`: Fields that have been hashed.
33
+
-`hash`: Result of hashing the fields appended in the given order, without any extra characters or whitespaces, using the given algorithm.
34
+
-`ipVersion` (_optional_): Version of IP value used on the hash.
26
35
-`partnerFee` (_deprecated_): Use `partner.fee` instead.
27
36
-`simulation` (_optional_): Simulation object.
28
37
-`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.
@@ -71,12 +80,18 @@ We recommend that you use `XRP` for testing purposes when integrating Topper sin
71
80
"sub":"b9fe022b-f436-49e1-bb89-6f2e8eabf336",
72
81
// highlight-start
73
82
"partner": {
83
+
"continueUrl":"https://example.com",
84
+
"continueUrlTarget":"new-tab",
74
85
"displayName":"ACME",
75
86
"fee": {
76
87
"percentage":"1"
77
88
},
78
-
"continueUrl":"https://example.com",
79
-
"continueUrlTarget":"new-tab"
89
+
validation: {
90
+
device:{
91
+
ip:'1.2.3.4',
92
+
'user-agent':'Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7)'
93
+
}
94
+
}
80
95
},
81
96
"simulation": {
82
97
"country":"US"
@@ -109,6 +124,22 @@ We recommend that you use `XRP` for testing purposes when integrating Topper sin
109
124
</TabItem>
110
125
</Tabs>
111
126
127
+
### Custom partner validation
128
+
129
+
To increase customer security we support an extra layer of validations that can be customizable by our partners. This layer includes validations from customer's device, like IP and user agent, that we ensure is the same as the one provided by you. In case of any mismatch, the user request to initiate a widget session will fail.
130
+
We accept this validation parameters as a plain string or as an hashed string. If you send us hashed parameters, we'll fetch the same parameters we receive from the user request, hash them and compare if both hashes are equal.
131
+
If you plan on using hashed validation, please check the example below to see how you should hash your data.
132
+
133
+
```js
134
+
import { createHash } from'node:crypto';
135
+
136
+
awaitcreateHash('sha256')
137
+
.update('1.2.3.4')
138
+
.digest('hex');
139
+
140
+
:::note
141
+
When validating user IP, if the IP versions mismatch, validation will be partially (plain string validation) or entirely (hashed validation) skipped.```
0 commit comments