diff --git a/docs/flows/crypto-offramp.mdx b/docs/flows/crypto-offramp.mdx index f004647..68a1754 100644 --- a/docs/flows/crypto-offramp.mdx +++ b/docs/flows/crypto-offramp.mdx @@ -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. @@ -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", @@ -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. @@ -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", @@ -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. @@ -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", @@ -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. @@ -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", @@ -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. @@ -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", @@ -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. @@ -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", diff --git a/docs/flows/crypto-onramp.mdx b/docs/flows/crypto-onramp.mdx index 44944f5..e3ed99d 100644 --- a/docs/flows/crypto-onramp.mdx +++ b/docs/flows/crypto-onramp.mdx @@ -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. @@ -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", @@ -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. @@ -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", @@ -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. @@ -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", @@ -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. @@ -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", @@ -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. @@ -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",