Target Deposit Destinations
Encrypt a target deposit destination to a ddsConfig
used to initialize a deposit switch in Link.
Target deposit destinations contain the bank account details used in a deposit switch. For user privacy and security, sensitive banking information must be encrypted before being passed to your Link initialization when adding deposit switching flows.
#Encrypt to ddsConfig
Encrypts a target deposit destination object, which includes:
- Bank account identifying information.
- How much of the user's paycheck should be allocated to the bank account.
Returns an encrypted_config
whose value can be used with the ddsConfig
Link initialization parameter. When a ddsConfig
is present in a Link initialization, the user will be presented with a deposit switch flow after they initially connect an account, or when they return to a previously connected account.
- #—objectrequired
A target deposit destination.
Visit our deposit switching guide for more information and examples of different configurations, such as how to receive the entirety of the user's paycheck.
Example request body#
1{ 2 "ach_deposit_account": { 3 "bank_name": "YellowHorizon", 4 "routing_number": "084101234", 5 "account_number": "9483746361234", 6 "account_type": "checking" 7 }, 8 "amount_allocation": { 9 "value": "177", 10 "min_value": "177", 11 "max_value": "177" 12 } 13}
1curl --request POST \
2 --url https://api.argyle.com/v2/target-deposit-destinations \
3 --header 'accept: application/json' \
4 --header 'content-type: application/json' \
5 --data '{
6 "ach_deposit_account": {
7 "bank_name": "YellowHorizon",
8 "routing_number": "084101234",
9 "account_number": "9483746361234",
10 "account_type": "checking"
11 },
12 "amount_allocation": {
13 "value": "177",
14 "min_value": "177",
15 "max_value": "177"
16 }
17 }'
1{
2 "encrypted_config": "CiUAzxhtkjHVbbvqqaQCFy3u2lrK3w4rUIVeDUk+TAMTSuRubh9yEqoGAGPMAvpCp4gw5zwCkvkh9voNq7Env6awey2nowAdlInrQg/vXwyHEO/MJEsygELdNyU+RbEaEN86/Y7XMMpMtBObD/lPCaY/md8eO1A6Ij5n9Lh1vYMqzU6IqhNka2j3jvJ/7N2qI4pyYyZJS1Q115Z5NkB6wc6xAgkJozD11VwL9D+7cDzPKPKZFg/xE4Rz/psSyCzbO6EVv2NFIXY5FvtqYwKBetTxLYNigdO25WWaDLYM5gOnjhBsKD+BU2XalWnvKcTb3yesW3e4iDcp8zTjiSrpcLL5IhrdFFFHt5LOPwlRjJ1RTv6mhZudhgY2DZMAr2ajP/L3gPMMG5wmhcybC7BJiG7D7j78biZZtUzXgaXRdboMKBvm9MB1ZmWIDqFtfCi2kf6TykJOq6eXiI5dMOsvfg+wk/5qrmrFr/5birijwMUscDZ6XRQO1vy/JMdBlqZHUSySv+meMvobULj+PmNj3o6JaYJzi/DzpUK/kaNI6xIg+Ia92nbAyF+HUEQ+r+n7ZrYIU85W00JaXm0ba3cal7V6IUnCwh2V22oN51GX33UlPAsAjSAWAOJpQHOLXi7DeFr+V/FvnjLHvO/U17Ybsm6gI7tvC4lR6SPhZNXayNiCVAjGzjoy151O9i7+mBCbqWjfTZLOj3p9QMVrkYixJobDJ4B2MZdQB0HG7wDZvKqK2IIVZBEfuVQX94Ltt+Sui8kHqRw5Z03QCC7yLxlFWMkXe1yCdnK3B6wboqTpfJE/4FcnqlWp0pOpQhrBSg6A2D15UFQbQU6vi9Z1zqSP0N8zlR/zyGV9gxZwrqH9eEjNyZZezBCRlMrsfNI2HgwrgzeZW1KIBISEmArMCY4m0q8K644d2L6XPEjwLYLZ+Iy4MejN/SdCjzvX6CWfSdErQPNzXit7Y1exepKsWzmo6X26jlvfcYvtdI9nfP8hyaVouwL3RTWeah0SkGfN5MUxugap7LQc464LPvqb0NBJOT9dJb887/Maw0pXn8iOgS+dHLSUW9TIkOuS9So0F8VB/QHY/Tv31yOmpEbWL9y7Lql/D33QIeRgpjEbJUQJ00XZ2fzY"
3}