Find reference information on this page for Direct Deposit Switch (DDS) reports.
Direct Deposit Switch (DDS) reports contain financial institution information from the user’s accounts. Learn more below about the data provided from reports.
Attributes
The tables below cover the fields and descriptions from the responses.
Attribute | Type | Description |
---|---|---|
completed_at | date-time | Timestamp when report was completed |
links | array of objects | List of assets links, see Links object |
Links object
The attributes and descriptions below are for the Links object.
Attribute | Type | Description |
---|---|---|
link_id | string | Unique identifier of Link |
tracking_info | string | Additional optional identifier passed by user |
access_token | string | Access token of existing Link |
provider | object | Provider information, see Provider object |
deposit_details | object | Bank account info, for Direct Deposit Switch (DDS) and Paycheck Linked Lending (PLL), see Deposit details object |
Provider object
The values in the table below are for the Provider object.
Attribute | Type | Description |
---|---|---|
id | string | Data provider identifier |
supported_bank_account_actions | array of strings | List of supported bank account actions |
Deposit details object
View the info for the deposit details object below.
Attribute | Type | Description |
---|---|---|
account_number | string | Account number |
account_type | string | Account type, see possible values belowchecking - Checking accountsavings - Savings account |
routing_number | string | Routing number |
bank_name | string | Bank name |
deposit_type | string | Deposit type, see possible values belowentire - Entire paycheckpercent - Percentage of paycheckamount - Fixed amount from paycheck |
deposit_value | string | Deposit value |
Endpoint
The page below is for the available endpoint for DDS reports.
Example response
The JSON below is an example DDS report response.
{
"completed_at": "2022-05-04T11:30:00Z",
"links": [
{
"link_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"tracking_info": "string",
"access_token": "99dd17074ac94aa9ace2621d657c7610",
"provider": {
"id": "adp",
"supported_bank_account_actions": [
"create"
]
},
"deposit_details": {
"account_number": "16002600",
"account_type": "checking",
"routing_number": "123456789",
"bank_name": "TD Bank",
"deposit_type": "entire",
"deposit_value": "50.00"
}
}
]
}