Add ticket details to offramp webhooks

uphold · Nov 14, 2024 · 35a9cf5 · 35a9cf5
1 parent 3a1ad01
commit 35a9cf5
Showing 1 changed file with 120 additions and 6 deletions.
diff --git a/docs/flows/crypto-offramp.mdx b/docs/flows/crypto-offramp.mdx
@@ -132,6 +132,14 @@ Triggered when a user has placed an order.
   - `rate`: Rate used to calculate the amount.
   - `asset`: Cryptoasset the user will send.
   - `network`: Network of the sending asset.
+  - `params`: Object containing additional parameters.
+    - `ticket`: Object containing information related to the deposit.
+      - `expiredAt`: Timestamp at which the deposit expires.
+      - `remindAt`: Timestamp at which the user is reminded.
+      - `tag`: Tag of the crypto transaction, used to complement the `address`.
+        - `type`: Tag type.
+        - `value`: Tag value.
+      - `value`: Address to which the user sends the funds.
 - `destination`: Object containing information about what the user will receive.
   - `amount`: Amount the user will receive.
   - `rate`: Rate used to calculate the amount.
@@ -170,7 +178,18 @@ The values for `destination.paymentMethod.type` can be found using our [REST API
       "amount": "0.047116964221968237",
       "rate": "0.00056488387749632223",
       "asset": "ETH",
-      "network": "ethereum"
+      "network": "ethereum",
+      "params": {
+        "ticket": {
+          "expiredAt": "2023-06-12T17:21:21.240Z",
+          "remindAt": "2023-06-12T17:21:21.240Z",
+          "tag": {
+            "type": "memo",
+            "value": "123456"
+          },
+          "value": "0xb794F5eA0ba39494cE839613fffBA74279579268"
+        }
+      },
     },
     "destination": {
       "amount": "100.00",
@@ -223,6 +242,14 @@ Triggered when a user has sent funds for their order.
   - `rate`: Rate used to calculate the amount.
   - `asset`: Cryptoasset the user sent.
   - `network`: Network of the sending asset.
+  - `params`: Object containing additional parameters.
+    - `ticket`: Object containing information related to the deposit.
+      - `expiredAt`: Timestamp at which the deposit expires.
+      - `remindAt`: Timestamp at which the user is reminded.
+      - `tag`: Tag of the crypto transaction, used to complement the `address`.
+        - `type`: Tag type.
+        - `value`: Tag value.
+      - `value`: Address to which the user sends the funds.
 - `destination`: Object containing information about what the user will receive.
   - `amount`: Amount the user will receive.
   - `rate`: Rate used to calculate the amount.
@@ -261,7 +288,18 @@ The values for `destination.paymentMethod.type` can be found using our [REST API
       "amount": "0.047116964221968237",
       "rate": "0.00056488387749632223",
       "asset": "ETH",
-      "network": "ethereum"
+      "network": "ethereum",
+      "params": {
+        "ticket": {
+          "expiredAt": "2023-06-12T17:21:21.240Z",
+          "remindAt": "2023-06-12T17:21:21.240Z",
+          "tag": {
+            "type": "memo",
+            "value": "123456"
+          },
+          "value": "0xb794F5eA0ba39494cE839613fffBA74279579268"
+        }
+      }
     },
     "destination": {
       "amount": "100.00",
@@ -314,6 +352,14 @@ Triggered when a user has sent funds for their order and we have received them.
   - `rate`: Rate used to calculate the amount.
   - `asset`: Cryptoasset the user sent.
   - `network`: Network of the sending asset.
+  - `params`: Object containing additional parameters.
+    - `ticket`: Object containing information related to the deposit.
+      - `expiredAt`: Timestamp at which the deposit expires.
+      - `remindAt`: Timestamp at which the user is reminded.
+      - `tag`: Tag of the crypto transaction, used to complement the `address`.
+        - `type`: Tag type.
+        - `value`: Tag value.
+      - `value`: Address to which the user sends the funds.
 - `destination`: Object containing information about what the user will receive.
   - `amount`: Amount the user will receive.
   - `rate`: Rate used to calculate the amount.
@@ -352,7 +398,18 @@ The values for `destination.paymentMethod.type` can be found using our [REST API
       "amount": "0.047116964221968237",
       "rate": "0.00056488387749632223",
       "asset": "ETH",
-      "network": "ethereum"
+      "network": "ethereum",
+      "params": {
+        "ticket": {
+          "expiredAt": "2023-06-12T17:21:21.240Z",
+          "remindAt": "2023-06-12T17:21:21.240Z",
+          "tag": {
+            "type": "memo",
+            "value": "123456"
+          },
+          "value": "0xb794F5eA0ba39494cE839613fffBA74279579268"
+        }
+      }
     },
     "destination": {
       "amount": "100.00",
@@ -405,6 +462,14 @@ Triggered when a user's order has completed.
   - `rate`: Rate used to calculate the amount.
   - `asset`: Cryptoasset the user sent.
   - `network`: Network of the sending asset.
+  - `params`: Object containing additional parameters.
+    - `ticket`: Object containing information related to the deposit.
+      - `expiredAt`: Timestamp at which the deposit expires.
+      - `remindAt`: Timestamp at which the user is reminded.
+      - `tag`: Tag of the crypto transaction, used to complement the `address`.
+        - `type`: Tag type.
+        - `value`: Tag value.
+      - `value`: Address to which the user sends the funds.
 - `destination`: Object containing information about what the user received.
   - `amount`: Amount the user received.
   - `rate`: Rate used to calculate the amount.
@@ -443,7 +508,18 @@ The values for `destination.paymentMethod.type` can be found using our [REST API
       "amount": "0.047116964221968237",
       "rate": "0.00056488387749632223",
       "asset": "ETH",
-      "network": "ethereum"
+      "network": "ethereum",
+      "params": {
+        "ticket": {
+          "expiredAt": "2023-06-12T17:21:21.240Z",
+          "remindAt": "2023-06-12T17:21:21.240Z",
+          "tag": {
+            "type": "memo",
+            "value": "123456"
+          },
+          "value": "0xb794F5eA0ba39494cE839613fffBA74279579268"
+        }
+      }
     },
     "destination": {
       "amount": "100.00",
@@ -496,6 +572,14 @@ Triggered when a user's order has failed.
   - `rate`: Rate used to calculate the amount.
   - `asset`: Cryptoasset the user sent.
   - `network`: Network of the sending asset.
+  - `params`: Object containing additional parameters.
+    - `ticket`: Object containing information related to the deposit.
+      - `expiredAt`: Timestamp at which the deposit expires.
+      - `remindAt`: Timestamp at which the user is reminded.
+      - `tag`: Tag of the crypto transaction, used to complement the `address`.
+        - `type`: Tag type.
+        - `value`: Tag value.
+      - `value`: Address to which the user sends the funds.
 - `destination`: Object containing information about what the user would have received.
   - `amount`: Amount the user would have received.
   - `rate`: Rate used to calculate the amount.
@@ -536,7 +620,18 @@ The values for `destination.paymentMethod.type` can be found using our [REST API
       "amount": "0.047116964221968237",
       "rate": "0.00056488387749632223",
       "asset": "ETH",
-      "network": "ethereum"
+      "network": "ethereum",
+      "params": {
+        "ticket": {
+          "expiredAt": "2023-06-12T17:21:21.240Z",
+          "remindAt": "2023-06-12T17:21:21.240Z",
+          "tag": {
+            "type": "memo",
+            "value": "123456"
+          },
+          "value": "0xb794F5eA0ba39494cE839613fffBA74279579268"
+        }
+      }
     },
     "destination": {
       "amount": "100.00",
@@ -592,6 +687,14 @@ Triggered when a user's order has been successfully refunded.
   - `rate`: Rate used to calculate the amount.
   - `asset`: Cryptoasset the user sent.
   - `network`: Network of the sending asset.
+  - `params`: Object containing additional parameters.
+    - `ticket`: Object containing information related to the deposit.
+      - `expiredAt`: Timestamp at which the deposit expires.
+      - `remindAt`: Timestamp at which the user is reminded.
+      - `tag`: Tag of the crypto transaction, used to complement the `address`.
+        - `type`: Tag type.
+        - `value`: Tag value.
+      - `value`: Address to which the user sends the funds.
 - `destination`: Object containing information about what the user would have received.
   - `amount`: Amount the user would have received.
   - `rate`: Rate used to calculate the amount.
@@ -640,7 +743,18 @@ The values for `destination.paymentMethod.type` can be found using our [REST API
       "amount": "0.047116964221968237",
       "rate": "0.00056488387749632223",
       "asset": "ETH",
-      "network": "ethereum"
+      "network": "ethereum",
+      "params": {
+        "ticket": {
+          "expiredAt": "2023-06-12T17:21:21.240Z",
+          "remindAt": "2023-06-12T17:21:21.240Z",
+          "tag": {
+            "type": "memo",
+            "value": "123456"
+          },
+          "value": "0xb794F5eA0ba39494cE839613fffBA74279579268"
+        }
+      }
     },
     "destination": {
       "amount": "100.00",