Skip to content
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

Jump to bottom

Add ticket details to offramp webhooks #74

Open
wants to merge 1 commit into
base: feature/add-offramp-funds-sent-webhook
Choose a base branch
from
Open

Add ticket details to offramp webhooks #74

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
108 changes: 97 additions & 11 deletions docs/flows/crypto-offramp.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -83,10 +83,6 @@ We recommend that you use `XRP` for testing purposes when integrating Topper sin
"refund": {
"address": "0xb794f5ea0ba39494ce839613fffba74279579268",
"priority": "normal"
"tag": {
"type": "memo",
"value": "123456"
}
},
"source": {
"allowedAssets": [
Expand Down Expand Up @@ -132,6 +128,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.
Expand Down Expand Up @@ -170,7 +174,14 @@ 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",
"value": "0xb794F5eA0ba39494cE839613fffBA74279579268"
}
},
},
"destination": {
"amount": "100.00",
Expand Down Expand Up @@ -223,6 +234,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.
Expand Down Expand Up @@ -261,7 +280,14 @@ 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",
"value": "0xb794F5eA0ba39494cE839613fffBA74279579268"
}
}
},
"destination": {
"amount": "100.00",
Expand Down Expand Up @@ -314,6 +340,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.
Expand Down Expand Up @@ -352,7 +386,14 @@ 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",
"value": "0xb794F5eA0ba39494cE839613fffBA74279579268"
}
}
},
"destination": {
"amount": "100.00",
Expand Down Expand Up @@ -405,6 +446,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.
Expand Down Expand Up @@ -443,7 +492,14 @@ 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",
"value": "0xb794F5eA0ba39494cE839613fffBA74279579268"
}
}
},
"destination": {
"amount": "100.00",
Expand Down Expand Up @@ -496,6 +552,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.
Expand Down Expand Up @@ -536,7 +600,14 @@ 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",
"value": "0xb794F5eA0ba39494cE839613fffBA74279579268"
}
}
},
"destination": {
"amount": "100.00",
Expand Down Expand Up @@ -592,6 +663,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.
Expand All @@ -610,7 +689,7 @@ Triggered when a user's order has been successfully refunded.
- `network`: Network of the receiving asset.
- `address`: User's wallet address to receive funds.
- `priority`: Priority of the crypto transaction.
- `tag`: Tag of the crypto transaction, used to complement the `address`.
- `tag`: Tag of the crypto transaction, used to complement the address.
- `type`: Tag type (e.g.: `memo` or `destination-tag`).
- `value`: Tag value.
- `widget`: Widget associated with the session.
Expand Down Expand Up @@ -640,7 +719,14 @@ 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",
"value": "0xb794F5eA0ba39494cE839613fffBA74279579268"
}
}
},
"destination": {
"amount": "100.00",
Expand Down
Loading