Skip to content

Add country to order flow docs #108

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

Merged
jackmurdoch merged 1 commit into from
Jan 30, 2026
Merged

Add country to order flow docs #108

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
30 changes: 30 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 @@ -149,6 +149,8 @@ Triggered when a user has placed an order.
- `asset`: Asset used to charge the fee.
- `normalized`: Amount in USD that the user was charged for this fee.
- `type`: Type of fee (`network`, `deposit` or `partner`).
- `user`: An object containing user related information.
- `country`: country of the user.
- `widget`: Widget associated with the session.
- `id` UUID of the widget.
- `name`: Name of the widget.
Expand Down Expand Up @@ -205,6 +207,9 @@ The values for `destination.paymentMethod.type` can be found using our [REST API
"type": "partner"
}
],
"user": {
"country": "US"
},
"widget": {
"id": "998544f2-5b01-4062-9394-22827ff5db6c",
"name": "ACME",
Expand Down Expand Up @@ -252,6 +257,8 @@ Triggered when a user has sent funds for their order.
- `asset`: Asset used to charge the fee.
- `normalized`: Amount in USD that the user was charged for this fee.
- `type`: Type of fee (`network`, `deposit` or `partner`).
- `user`: An object containing user related information.
- `country`: country of the user.
- `widget`: Widget associated with the session.
- `id` UUID of the widget.
- `name`: Name of the widget.
Expand Down Expand Up @@ -308,6 +315,9 @@ The values for `destination.paymentMethod.type` can be found using our [REST API
"type": "partner"
}
],
"user": {
"country": "US"
},
"widget": {
"id": "998544f2-5b01-4062-9394-22827ff5db6c",
"name": "ACME",
Expand Down Expand Up @@ -355,6 +365,8 @@ Triggered when a user has sent funds for their order and we have received them.
- `asset`: Asset used to charge the fee.
- `normalized`: Amount in USD that the user was charged for this fee.
- `type`: Type of fee (`network`, `deposit` or `partner`).
- `user`: An object containing user related information.
- `country`: country of the user.
- `widget`: Widget associated with the session.
- `id` UUID of the widget.
- `name`: Name of the widget.
Expand Down Expand Up @@ -411,6 +423,9 @@ The values for `destination.paymentMethod.type` can be found using our [REST API
"type": "partner"
}
],
"user": {
"country": "US"
},
"widget": {
"id": "998544f2-5b01-4062-9394-22827ff5db6c",
"name": "ACME",
Expand Down Expand Up @@ -458,6 +473,8 @@ Triggered when a user's order has completed.
- `asset`: Asset used to charge the fee.
- `normalized`: Amount in USD that the user was charged for this fee.
- `type`: Type of fee (`network`, `deposit` or `partner`).
- `user`: An object containing user related information.
- `country`: country of the user.
- `widget`: Widget associated with the session.
- `id` UUID of the widget.
- `name`: Name of the widget.
Expand Down Expand Up @@ -514,6 +531,9 @@ The values for `destination.paymentMethod.type` can be found using our [REST API
"type": "partner"
}
],
"user": {
"country": "US"
},
"widget": {
"id": "998544f2-5b01-4062-9394-22827ff5db6c",
"name": "ACME",
Expand Down Expand Up @@ -561,6 +581,8 @@ Triggered when a user's order has failed.
- `asset`: Asset used to charge the fee.
- `normalized`: Amount in USD that the user was charged for this fee.
- `type`: Type of fee (`network`, `deposit` or `partner`).
- `user`: An object containing user related information.
- `country`: country of the user.
- `widget`: Widget associated with the session.
- `id` UUID of the widget.
- `name`: Name of the widget.
Expand Down Expand Up @@ -619,6 +641,9 @@ The values for `destination.paymentMethod.type` can be found using our [REST API
"type": "partner"
}
],
"user": {
"country": "US"
},
"widget": {
"id": "998544f2-5b01-4062-9394-22827ff5db6c",
"name": "ACME",
Expand Down Expand Up @@ -679,6 +704,8 @@ Triggered when a user's order has been successfully refunded.
- `tag`: Tag of the crypto transaction, used to complement the address.
- `type`: Tag type (e.g.: `memo` or `destination-tag`).
- `value`: Tag value.
- `user`: An object containing user related information.
- `country`: country of the user.
- `widget`: Widget associated with the session.
- `id` UUID of the widget.
- `name`: Name of the widget.
Expand Down Expand Up @@ -743,6 +770,9 @@ The values for `destination.paymentMethod.type` can be found using our [REST API
"address": "0xb794F5eA0ba39494cE839613fffBA74279579268",
"priority": "normal"
},
"user": {
"country": "US"
},
"widget": {
"id": "998544f2-5b01-4062-9394-22827ff5db6c",
"name": "ACME",
Expand Down
25 changes: 25 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 @@ -227,6 +227,8 @@ Triggered when a user has placed an order.
- `asset`: Asset used to charge the fee.
- `normalized`: Amount in USD that the user was charged for this fee.
- `type`: Type of fee (`network`, `deposit` or `partner`).
- `user`: An object containing user related information.
- `country`: country of the user.
- `widget`: Widget associated with the session.
- `id` UUID of the widget.
- `name`: Name of the widget.
Expand Down Expand Up @@ -285,6 +287,9 @@ The values for `origin.paymentMethod.type` can be found using our [REST API](../
"type": "partner"
}
],
"user": {
"country": "US"
},
"widget": {
"id": "998544f2-5b01-4062-9394-22827ff5db6c",
"name": "ACME",
Expand Down Expand Up @@ -330,6 +335,8 @@ Triggered when a user has been charged.
- `asset`: Asset used to charge the fee.
- `normalized`: Amount in USD that the user was charged for this fee.
- `type`: Type of fee (`network`, `deposit` or `partner`).
- `user`: An object containing user related information.
- `country`: country of the user.
- `widget`: Widget associated with the session.
- `id` UUID of the widget.
- `name`: Name of the widget.
Expand Down Expand Up @@ -388,6 +395,9 @@ The values for `origin.paymentMethod.type` can be found using our [REST API](../
"type": "partner"
}
],
"user": {
"country": "US"
},
"widget": {
"id": "998544f2-5b01-4062-9394-22827ff5db6c",
"name": "ACME",
Expand Down Expand Up @@ -437,6 +447,8 @@ Triggered when a user's order has completed.
- `asset`: Asset used to charge the fee.
- `normalized`: Amount in USD that the user was charged for this fee.
- `type`: Type of fee (`network`, `deposit` or `partner`).
- `user`: An object containing user related information.
- `country`: country of the user.
- `widget`: Widget associated with the session.
- `id` UUID of the widget.
- `name`: Name of the widget.
Expand Down Expand Up @@ -499,6 +511,9 @@ The values for `origin.paymentMethod.type` can be found using our [REST API](../
"type": "partner"
}
],
"user": {
"country": "US"
},
"widget": {
"id": "998544f2-5b01-4062-9394-22827ff5db6c",
"name": "ACME",
Expand Down Expand Up @@ -544,6 +559,8 @@ Triggered when a user's order has failed.
- `asset`: Asset used to charge the fee.
- `normalized`: Amount in USD that the user was charged for this fee.
- `type`: Type of fee (`network`, `deposit` or `partner`).
- `user`: An object containing user related information.
- `country`: country of the user.
- `widget`: Widget associated with the session.
- `id` UUID of the widget.
- `name`: Name of the widget.
Expand Down Expand Up @@ -604,6 +621,9 @@ The values for `origin.paymentMethod.type` can be found using our [REST API](../
"type": "partner"
}
],
"user": {
"country": "US"
},
"widget": {
"id": "998544f2-5b01-4062-9394-22827ff5db6c",
"name": "ACME",
Expand Down Expand Up @@ -656,6 +676,8 @@ Triggered when a user's order has been successfully refunded.
- `formattedAmount`: Amount refunded to the user
- `asset`: Currency code in the [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) format used to make the payment.
- `rate`: Rate used to calculate the amount.
- `user`: An object containing user related information.
- `country`: country of the user.
- `widget`: Widget associated with the session.
- `id` UUID of the widget.
- `name`: Name of the widget.
Expand Down Expand Up @@ -719,6 +741,9 @@ The values for `origin.paymentMethod.type` can be found using our [REST API](../
"formattedAmount": "$ 100.00",
"rate": "1770.27534301775263314892",
},
"user": {
"country": "US"
},
"widget": {
"id": "998544f2-5b01-4062-9394-22827ff5db6c",
"name": "ACME",
Expand Down