diff --git a/docs/flows/crypto-onramp.mdx b/docs/flows/crypto-onramp.mdx index 0879d26..cc98e3d 100644 --- a/docs/flows/crypto-onramp.mdx +++ b/docs/flows/crypto-onramp.mdx @@ -2,9 +2,8 @@ sidebar_position: 1 --- -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - +import Tabs from "@theme/Tabs"; +import TabItem from "@theme/TabItem"; # Crypto on-ramp @@ -152,8 +151,6 @@ When `recipientEditMode` is `all-editable`, the user can change `asset`, `networ ## Events - - ### `order:crypto-onramp:committed` Triggered when a user has placed an order. @@ -184,6 +181,7 @@ Triggered when a user has placed an order. - `fees`: Array containing fees associated with the order. - `amount`: Amount user was charged for this fee. - `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`). - `widget`: Widget associated with the session. - `id` UUID of the widget. @@ -227,16 +225,19 @@ The values for `origin.paymentMethod.type` can be found using our [REST API](../ { "amount": "14.17", "asset": "USD", + "normalized": "14.17", "type": "network" }, { "amount": "2.42", "asset": "USD", + "normalized": "2.42", "type": "deposit" }, { "amount": "1.00", "asset": "USD", + "normalized": "1.00", "type": "partner" } ], @@ -283,6 +284,7 @@ Triggered when a user has been charged. - `fees`: Array containing fees associated with the order. - `amount`: Amount user was charged for this fee. - `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`). - `widget`: Widget associated with the session. - `id` UUID of the widget. @@ -326,16 +328,19 @@ The values for `origin.paymentMethod.type` can be found using our [REST API](../ { "amount": "14.17", "asset": "USD", + "normalized": "14.17", "type": "network" }, { "amount": "2.42", "asset": "USD", + "normalized": "2.42", "type": "deposit" }, { "amount": "1.00", "asset": "USD", + "normalized": "1.00", "type": "partner" } ], @@ -384,6 +389,7 @@ Triggered when a user's order has completed. - `fees`: Array containing fees associated with the order. - `amount`: Amount user was charged for this fee. - `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`). - `widget`: Widget associated with the session. - `id` UUID of the widget. @@ -430,16 +436,19 @@ The values for `origin.paymentMethod.type` can be found using our [REST API](../ { "amount": "14.17", "asset": "USD", + "normalized": "14.17", "type": "network" }, { "amount": "2.42", "asset": "USD", + "normalized": "2.42", "type": "deposit" }, { "amount": "1.00", "asset": "USD", + "normalized": "1.00", "type": "partner" } ], @@ -486,6 +495,7 @@ Triggered when a user's order has failed. - `fees`: Array containing fees associated with the order. - `amount`: Amount user was charged for this fee. - `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`). - `widget`: Widget associated with the session. - `id` UUID of the widget. @@ -529,16 +539,19 @@ The values for `origin.paymentMethod.type` can be found using our [REST API](../ { "amount": "14.17", "asset": "USD", + "normalized": "14.17", "type": "network" }, { "amount": "2.42", "asset": "USD", + "normalized": "2.42", "type": "deposit" }, { "amount": "1.00", "asset": "USD", + "normalized": "1.00", "type": "partner" } ], @@ -585,6 +598,7 @@ Triggered when a user's order has been successfully refunded. - `fees`: Array containing fees associated with the order. - `amount`: Amount user was charged for this fee. - `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`). - `refund`: Object containing information about how much was refunded to the user. - `formattedAmount`: Amount refunded to the user @@ -632,16 +646,19 @@ The values for `origin.paymentMethod.type` can be found using our [REST API](../ { "amount": "14.17", "asset": "USD", + "normalized": "14.17", "type": "network" }, { "amount": "2.42", "asset": "USD", + "normalized": "2.42", "type": "deposit" }, { "amount": "1.00", "asset": "USD", + "normalized": "1.00", "type": "partner" } ], diff --git a/package-lock.json b/package-lock.json index 9d8397e..4c6a774 100644 --- a/package-lock.json +++ b/package-lock.json @@ -9,7 +9,7 @@ "version": "0.0.0", "dependencies": { "@docusaurus/core": "^3.1.1", - "@docusaurus/preset-classic": "^3.1.1 ", + "@docusaurus/preset-classic": "^3.1.1", "@mdx-js/react": "^3.0.1", "clsx": "^1.2.1", "prism-react-renderer": "^2.3.1",