Skip to content

Commit 3ea5a3e

Browse files
tierriMonteirojackmurdoch
tierriMonteiro
authored and
jackmurdoch
committed
Add country to order flow docs
1 parent 85f56cc commit 3ea5a3e

2 files changed

Lines changed: 55 additions & 0 deletions

File tree

‎docs/flows/crypto-offramp.mdx‎

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -154,6 +154,8 @@ Triggered when a user has placed an order.
154154
- `asset`: Asset used to charge the fee.
155155
- `normalized`: Amount in USD that the user was charged for this fee.
156156
- `type`: Type of fee (`network`, `deposit` or `partner`).
157+
- `user`: An object containing user related information.
158+
- `country`: country of the user.
157159
- `widget`: Widget associated with the session.
158160
- `id` UUID of the widget.
159161
- `name`: Name of the widget.
@@ -210,6 +212,9 @@ The values for `destination.paymentMethod.type` can be found using our [REST API
210212
"type": "partner"
211213
}
212214
],
215+
"user": {
216+
"country": "US"
217+
},
213218
"widget": {
214219
"id": "998544f2-5b01-4062-9394-22827ff5db6c",
215220
"name": "ACME",
@@ -257,6 +262,8 @@ Triggered when a user has sent funds for their order.
257262
- `asset`: Asset used to charge the fee.
258263
- `normalized`: Amount in USD that the user was charged for this fee.
259264
- `type`: Type of fee (`network`, `deposit` or `partner`).
265+
- `user`: An object containing user related information.
266+
- `country`: country of the user.
260267
- `widget`: Widget associated with the session.
261268
- `id` UUID of the widget.
262269
- `name`: Name of the widget.
@@ -313,6 +320,9 @@ The values for `destination.paymentMethod.type` can be found using our [REST API
313320
"type": "partner"
314321
}
315322
],
323+
"user": {
324+
"country": "US"
325+
},
316326
"widget": {
317327
"id": "998544f2-5b01-4062-9394-22827ff5db6c",
318328
"name": "ACME",
@@ -360,6 +370,8 @@ Triggered when a user has sent funds for their order and we have received them.
360370
- `asset`: Asset used to charge the fee.
361371
- `normalized`: Amount in USD that the user was charged for this fee.
362372
- `type`: Type of fee (`network`, `deposit` or `partner`).
373+
- `user`: An object containing user related information.
374+
- `country`: country of the user.
363375
- `widget`: Widget associated with the session.
364376
- `id` UUID of the widget.
365377
- `name`: Name of the widget.
@@ -416,6 +428,9 @@ The values for `destination.paymentMethod.type` can be found using our [REST API
416428
"type": "partner"
417429
}
418430
],
431+
"user": {
432+
"country": "US"
433+
},
419434
"widget": {
420435
"id": "998544f2-5b01-4062-9394-22827ff5db6c",
421436
"name": "ACME",
@@ -463,6 +478,8 @@ Triggered when a user's order has completed.
463478
- `asset`: Asset used to charge the fee.
464479
- `normalized`: Amount in USD that the user was charged for this fee.
465480
- `type`: Type of fee (`network`, `deposit` or `partner`).
481+
- `user`: An object containing user related information.
482+
- `country`: country of the user.
466483
- `widget`: Widget associated with the session.
467484
- `id` UUID of the widget.
468485
- `name`: Name of the widget.
@@ -519,6 +536,9 @@ The values for `destination.paymentMethod.type` can be found using our [REST API
519536
"type": "partner"
520537
}
521538
],
539+
"user": {
540+
"country": "US"
541+
},
522542
"widget": {
523543
"id": "998544f2-5b01-4062-9394-22827ff5db6c",
524544
"name": "ACME",
@@ -566,6 +586,8 @@ Triggered when a user's order has failed.
566586
- `asset`: Asset used to charge the fee.
567587
- `normalized`: Amount in USD that the user was charged for this fee.
568588
- `type`: Type of fee (`network`, `deposit` or `partner`).
589+
- `user`: An object containing user related information.
590+
- `country`: country of the user.
569591
- `widget`: Widget associated with the session.
570592
- `id` UUID of the widget.
571593
- `name`: Name of the widget.
@@ -624,6 +646,9 @@ The values for `destination.paymentMethod.type` can be found using our [REST API
624646
"type": "partner"
625647
}
626648
],
649+
"user": {
650+
"country": "US"
651+
},
627652
"widget": {
628653
"id": "998544f2-5b01-4062-9394-22827ff5db6c",
629654
"name": "ACME",
@@ -684,6 +709,8 @@ Triggered when a user's order has been successfully refunded.
684709
- `tag`: Tag of the crypto transaction, used to complement the address.
685710
- `type`: Tag type (e.g.: `memo` or `destination-tag`).
686711
- `value`: Tag value.
712+
- `user`: An object containing user related information.
713+
- `country`: country of the user.
687714
- `widget`: Widget associated with the session.
688715
- `id` UUID of the widget.
689716
- `name`: Name of the widget.
@@ -748,6 +775,9 @@ The values for `destination.paymentMethod.type` can be found using our [REST API
748775
"address": "0xb794F5eA0ba39494cE839613fffBA74279579268",
749776
"priority": "normal"
750777
},
778+
"user": {
779+
"country": "US"
780+
},
751781
"widget": {
752782
"id": "998544f2-5b01-4062-9394-22827ff5db6c",
753783
"name": "ACME",

‎docs/flows/crypto-onramp.mdx‎

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -232,6 +232,8 @@ Triggered when a user has placed an order.
232232
- `asset`: Asset used to charge the fee.
233233
- `normalized`: Amount in USD that the user was charged for this fee.
234234
- `type`: Type of fee (`network`, `deposit` or `partner`).
235+
- `user`: An object containing user related information.
236+
- `country`: country of the user.
235237
- `widget`: Widget associated with the session.
236238
- `id` UUID of the widget.
237239
- `name`: Name of the widget.
@@ -290,6 +292,9 @@ The values for `origin.paymentMethod.type` can be found using our [REST API](../
290292
"type": "partner"
291293
}
292294
],
295+
"user": {
296+
"country": "US"
297+
},
293298
"widget": {
294299
"id": "998544f2-5b01-4062-9394-22827ff5db6c",
295300
"name": "ACME",
@@ -335,6 +340,8 @@ Triggered when a user has been charged.
335340
- `asset`: Asset used to charge the fee.
336341
- `normalized`: Amount in USD that the user was charged for this fee.
337342
- `type`: Type of fee (`network`, `deposit` or `partner`).
343+
- `user`: An object containing user related information.
344+
- `country`: country of the user.
338345
- `widget`: Widget associated with the session.
339346
- `id` UUID of the widget.
340347
- `name`: Name of the widget.
@@ -393,6 +400,9 @@ The values for `origin.paymentMethod.type` can be found using our [REST API](../
393400
"type": "partner"
394401
}
395402
],
403+
"user": {
404+
"country": "US"
405+
},
396406
"widget": {
397407
"id": "998544f2-5b01-4062-9394-22827ff5db6c",
398408
"name": "ACME",
@@ -442,6 +452,8 @@ Triggered when a user's order has completed.
442452
- `asset`: Asset used to charge the fee.
443453
- `normalized`: Amount in USD that the user was charged for this fee.
444454
- `type`: Type of fee (`network`, `deposit` or `partner`).
455+
- `user`: An object containing user related information.
456+
- `country`: country of the user.
445457
- `widget`: Widget associated with the session.
446458
- `id` UUID of the widget.
447459
- `name`: Name of the widget.
@@ -504,6 +516,9 @@ The values for `origin.paymentMethod.type` can be found using our [REST API](../
504516
"type": "partner"
505517
}
506518
],
519+
"user": {
520+
"country": "US"
521+
},
507522
"widget": {
508523
"id": "998544f2-5b01-4062-9394-22827ff5db6c",
509524
"name": "ACME",
@@ -549,6 +564,8 @@ Triggered when a user's order has failed.
549564
- `asset`: Asset used to charge the fee.
550565
- `normalized`: Amount in USD that the user was charged for this fee.
551566
- `type`: Type of fee (`network`, `deposit` or `partner`).
567+
- `user`: An object containing user related information.
568+
- `country`: country of the user.
552569
- `widget`: Widget associated with the session.
553570
- `id` UUID of the widget.
554571
- `name`: Name of the widget.
@@ -609,6 +626,9 @@ The values for `origin.paymentMethod.type` can be found using our [REST API](../
609626
"type": "partner"
610627
}
611628
],
629+
"user": {
630+
"country": "US"
631+
},
612632
"widget": {
613633
"id": "998544f2-5b01-4062-9394-22827ff5db6c",
614634
"name": "ACME",
@@ -661,6 +681,8 @@ Triggered when a user's order has been successfully refunded.
661681
- `formattedAmount`: Amount refunded to the user
662682
- `asset`: Currency code in the [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) format used to make the payment.
663683
- `rate`: Rate used to calculate the amount.
684+
- `user`: An object containing user related information.
685+
- `country`: country of the user.
664686
- `widget`: Widget associated with the session.
665687
- `id` UUID of the widget.
666688
- `name`: Name of the widget.
@@ -724,6 +746,9 @@ The values for `origin.paymentMethod.type` can be found using our [REST API](../
724746
"formattedAmount": "$ 100.00",
725747
"rate": "1770.27534301775263314892",
726748
},
749+
"user": {
750+
"country": "US"
751+
},
727752
"widget": {
728753
"id": "998544f2-5b01-4062-9394-22827ff5db6c",
729754
"name": "ACME",

0 commit comments

Comments
 (0)