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
Copy file name to clipboardExpand all lines: docs/events/crypto-onramp.mdx
+111Lines changed: 111 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -11,6 +11,7 @@ import TabItem from '@theme/TabItem';
11
11
| - | - |
12
12
|[`order:crypto-onramp:committed`](#ordercrypto-onrampcommitted)| User placed an order. |
13
13
|[`order:crypto-onramp:charged`](#ordercrypto-onrampcharged)| User has been charged for their order. |
14
+
|[`order:crypto-onramp:crypto-sent`](#ordercrypto-onrampcrypto-sent)| User's crypto delivery has started. |
14
15
|[`order:crypto-onramp:completed`](#ordercrypto-onrampcompleted)| User's order has completed. |
15
16
|[`order:crypto-onramp:failed`](#ordercrypto-onrampfailed)| User's order has failed. |
16
17
|[`order:crypto-onramp:refund:completed`](#ordercrypto-onramprefundcompleted)| User's order has been successfully refunded. |
@@ -221,6 +222,116 @@ The values for `origin.paymentMethod.type` can be found using our [REST API](../
221
222
</TabItem>
222
223
</Tabs>
223
224
225
+
## `order:crypto-onramp:crypto-sent`
226
+
227
+
Triggered when a user's crypto delivery has started and is in progress.
228
+
229
+
<Tabs>
230
+
<TabItemlabel="Schema"value="schema"default>
231
+
232
+
-`id`: UUID of the order.
233
+
-`status`: Status of the order (`processing`).
234
+
-`createdAt`: Timestamp at which the order was created.
235
+
-`updatedAt`: Timestamp at which the order was last updated.
236
+
-`origin`: Object containing information about how the user paid.
237
+
-`amount`: Amount the user paid.
238
+
-`rate`: Rate used to calculate the amount.
239
+
-`asset`: Currency code in the [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) format used to make the payment.
240
+
-`paymentMethod`: Object containing information about the payment method used.
241
+
-`type`: Type of payment method.
242
+
-`destination`: Object containing information about what the user will receive.
243
+
-`amount`: Amount the user will receive.
244
+
-`rate`: Rate used to calculate the amount.
245
+
-`asset`: Cryptoasset the user will receive.
246
+
-`network`: Network of the receiving asset.
247
+
-`address`: Recipient wallet address.
248
+
-`tag` (_optional_): Tag of the crypto transaction, used to complement the `address`.
249
+
-`type`: Tag type (e.g.: `memo` or `destination-tag`).
250
+
-`value`: Tag value.
251
+
-`priority` (_optional_): Priority of the crypto transaction.
252
+
-`ledger` (_optional_): Object containing information about the transaction on the ledger.
253
+
-`txid`: Transaction ID on the ledger.
254
+
-`url`: URL to view the transaction details on a blockchain explorer.
255
+
-`fees`: Array containing fees associated with the order.
256
+
-`amount`: Amount user was charged for this fee.
257
+
-`asset`: Asset used to charge the fee.
258
+
-`normalized`: Amount in USD that the user was charged for this fee.
259
+
-`type`: Type of fee (`network`, `deposit` or `partner`).
260
+
-`widget`: Widget associated with the session.
261
+
-`id` UUID of the widget.
262
+
-`name`: Name of the widget.
263
+
-`flow`: Flow associated with the widget.
264
+
265
+
:::note
266
+
The values for `origin.paymentMethod.type` can be found using our [REST API](../rest-api.md), via the [payment methods endpoint](https://api.topperpay.com/payment-methods/crypto-onramp).
Copy file name to clipboardExpand all lines: docs/webhooks.mdx
+1Lines changed: 1 addition & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -30,6 +30,7 @@ Full information about the available events and their associated payloads can be
30
30
| - | - |
31
31
|[`order:crypto-onramp:committed`](./events/crypto-onramp.mdx#ordercrypto-onrampcommitted)| User placed an order. |
32
32
|[`order:crypto-onramp:charged`](./events/crypto-onramp.mdx#ordercrypto-onrampcharged)| User has been charged for their order. |
33
+
|[`order:crypto-onramp:crypto-sent`](./events/crypto-onramp.mdx#ordercrypto-onrampcrypto-sent)| User's crypto delivery has started. |
33
34
|[`order:crypto-onramp:completed`](./events/crypto-onramp.mdx#ordercrypto-onrampcompleted)| User's order has completed. |
34
35
|[`order:crypto-onramp:failed`](./events/crypto-onramp.mdx#ordercrypto-onrampfailed)| User's order has failed. |
35
36
|[`order:crypto-onramp:refund:completed`](./events/crypto-onramp.mdx#ordercrypto-onramprefundcompleted)| User's order has been successfully refunded. |
0 commit comments