Webhooks
Wyre's webhooks allow you to get automatic updates anytime the status on your wallet orders or data subscription changes.
Wallet Order Webhooks
Wallet Order webhooks provide you with updates on card payments. The webhook will be called once when the order reaches the processing
status and once when it is complete
.
To configure a wallet order webhook Url, send a POST request to our /v2/digitalwallet/webhook
endpoint with your Wyre account Id and your webhook Url.
{
"owner":"account:AC_W4299GGHVUE",
"webhook":"https://requestinspector.com/inspect/wyreprod"
}
A successful request will replay the information back to you in response.
{
"owner": "account:AC_W4299GGHVUE",
"webhook": "https://requestinspector.com/inspect/wyreprod"
}
Once configured, your url will receive notifications at the PROCESSING status and COMPLETE status.
{
"referenceId": null,
"accountId": "AC_JVPFPWYQH4B",
"orderId": "WO_NMYEGUBDME",
"orderStatus": "PROCESSING",
"transferId": "TF_PCZ6N9ECMUC",
"failedReason": null,
"error": null,
"reservation": "LFUVG7CDCAZBDJQJUX3V",
"email": "[email protected]"
}
{
"referenceId": null,
"accountId": "AC_JVPFPWYQH4B",
"orderId": "WO_NMYEGUBDME",
"orderStatus": "COMPLETE",
"transferId": "TF_PCZ6N9ECMUC",
"failedReason": null,
"error": null,
"reservation": "LFUVG7CDCAZBDJQJUX3V",
"email": "[email protected]"
}
Callback Urls
Some Wyre endpoints allow you to provide a callback Url per request.
For Wallets, use the callbackUrl body parameter.
For Transfers, use the notifyUrl body parameter.
For transfers, you will receive one callback immediately informing you that we registered the and another when the transfer is completed.
{
"subscriptionId": "DA_A2GWGR4PQE6",
"trigger": "transfer:TF_HPYFMXCARXH"
}
{
"createdAt":1635182780554,
"id":"TR_E6H8H2AWEYP",
"source":"bitcoin:EXTERNAL",
"dest":"wallet:WA_9ABGC8LW7G4",
"currency":"BTC",
"amount":0.001,
"status":"CONFIRMED",
"confirmedAt":1635182780554,
"cancelledAt":null,
"reversedAt":null,
"message":null,
"allowOverdraft":true,
"authorizer":null,
"senderProvidedId":null,
"reversedBy":null,
"fees":0,
"feesDest":null,
"metadata":{
"BTCNetworkTxId":"cb109405ab870bc0f916aad79a605d2d6fa23e53eec4523a3be8c0d22d15e256"
},
"tags":[
],
"sourceFees":null,
"destFees":null,
"clientIp":"127.0.0.1"
}
{
"createdAt": 1633130340295,
"id": "TF_QA9GMG3GAWV-D",
"source": "transfer:TF_QA9GMG3GAWV",
"dest": "wallet:WA_9H8PB4XP92M",
"currency": "USD",
"amount": 10,
"status": "CONFIRMED",
"confirmedAt": 1633130340295,
"cancelledAt": null,
"reversedAt": null,
"message": "Deposit for transfer TF_QA9GMG3GAWV",
"allowOverdraft": true,
"authorizer": "account:AC_YC3NT6GEZ8U",
"senderProvidedId": null,
"reversedBy": null,
"fees": 0,
"feesDest": null,
"metadata": {
"transferId": "TF_QA9GMG3GAWV"
},
"tags": [],
"sourceFees": null,
"destFees": null
}
Data Subscriptions
Webhooks for Account and Payment Method updates are made using the data subscription endpoint. These webhooks do not deliver a full payload and require you to make a subsequent GET call to retrieve the status update details.
{
"subscriptionId": "DA_GD894ANFUGC",
"trigger": "account:AC_J8T8C7LFJ3V"
}
{
"subscriptionId": "DA_CCZRGH7H9CZ",
"trigger": "paymentmethod:PA_DJQGBPPPAA2"
}
User Updates
User webhook Urls are added by Wyre. Talk to sales to learn more.
Like data subscriptions, user webhooks require a subsequent GET call to retrieve the status details.
{
"userId":"US_9UG6JF2Y26T","type":
"USER_STATUS_UPDATED"
}
Securing Webhooks
The endpoint you have created to accept webhooks from Wyre is unauthenticated, you may wish to lock this endpoint down and only whitelist Wyre IPs, preventing the possibility of a DDoS attack.
Here are the IP addresses that you can whitelist:
Sendwyre:
52.36.189.92
52.27.236.228
34.208.229.152
Testwyre:
44.229.236.122
44.233.59.43
44.238.83.93
Updated 3 months ago