Direct Deposit Switches Webhooks
Sent when a deposit switch flow in Link has completed.
#Completed
The direct_deposit_switches.completed webhook is sent when a deposit switch flow in Link has completed and Argyle has successfully updated the user's deposit settings on their payroll platform.
If both a direct deposit and card update are successful and were part of the same DDS configuration, two separate webhooks are sent.
- #eventsarray of stringsrequired
direct_deposit_switches.completed - #namestringrequired
Your name for the webhook subscription.
- #urlstringrequired
Where you want to receive webhook delivery. This can be either a backend URL that you manage, or a URL provided by a webhook management service.
- #secretstringoptional
Optional secret used to verify webhooks.
- #eventstring
direct_deposit_switches.completed - #namestring
Name used for the webhook subscription.
- #dataobject
- #accountstring (uuid)
ID of the account.
- #userstring (uuid)
ID of the user.
- #deposit_destinationstring (uuid)
ID of the deposit destination.
If an exact match to an existing deposit destination cannot be found, a
nullvalue is returned and thedetailsproperty will provide additional information. - #direct_deposit_changedboolean
trueif the deposit switch resulted in any changes to the account's current deposit destinations, including additions, removals, or changes to existing allocations. - #typestring (enum)
Whether the deposit switch was for bank accounts or cards.
- #flowstring (enum)
Indicates whether the deposit switch was a removal of an existing deposit destination.
- #detailsstring (enum)
Additional details when a one-to-one match between the update and an existing deposit destination cannot be determined.
- #resourceobjectoptional
1curl --request POST \
2 --url https://api.argyle.com/v2/webhooks \
3 --header 'accept: application/json' \
4 --header 'content-type: application/json' \
5 --data '{
6 "events": ["direct_deposit_switches.completed"],
7 "name": "name-for-the-webhook-subscription",
8 "url": "https://your-webhook-backend.com",
9 "secret": "optional-secret"
10 }'1{
2 "event": "direct_deposit_switches.completed",
3 "name": "name-for-the-webhook-subscription",
4 "data": {
5 "account": "0187c66e-e7e5-811c-b006-2232f00f426a",
6 "user": "018051aa-f7a9-a0db-2f38-6cfa325e9d69",
7 "deposit_destination": "0176e1ea-60ca-c561-eb8e-6dcdb33b1b55",
8 "direct_deposit_changed": true,
9 "type": "ach_deposit_account",
10 "flow": "update",
11 "details": null
12 }
13}#Failed
The direct_deposit_switches.failed webhook is sent when a deposit switch flow in Link could not be completed.
- #eventsarray of stringsrequired
direct_deposit_switches.failed - #namestringrequired
Your name for the webhook subscription.
- #urlstringrequired
Where you want to receive webhook delivery. This can be either a backend URL that you manage, or a URL provided by a webhook management service.
- #secretstringoptional
Optional secret used to verify webhooks.
- #eventstring
direct_deposit_switches.failed - #namestring
Name used for the webhook subscription.
- #dataobject
- #accountstring (uuid)
ID of the account.
- #userstring (uuid)
ID of the user.
- #error_codestring (enum)
The deposit switch error that occurred.
- #error_messagestring
The deposit switch error message.
- #resourceobjectoptional
1curl --request POST \
2 --url https://api.argyle.com/v2/webhooks \
3 --header 'accept: application/json' \
4 --header 'content-type: application/json' \
5 --data '{
6 "events": ["direct_deposit_switches.failed"],
7 "name": "name-for-the-webhook-subscription",
8 "url": "https://your-webhook-backend.com",
9 "secret": "optional-secret"
10 }'1{
2 "event": "direct_deposit_switches.failed",
3 "name": "name-for-the-webhook-subscription",
4 "data": {
5 "account": "0187c66e-e7e5-811c-b006-2232f00f426a",
6 "user": "018051aa-f7a9-a0db-2f38-6cfa325e9d69",
7 "error_code": "confirmation_timeout",
8 "error_message": "The user did not finish confirming the direct deposit switch."
9 }
10}