GET/
Retrieves a list of all direct deposit records for your program.
This endpoint supports pagination and field filtering.
Query parameters
| Fields | Description |
|---|---|
| user_token OR business_token string Optional | Account holder for which to return records. Pass either a user_token or business_token. Performs a non-case-sensitive match.Send a GET request to retrieve tokens from /users or /businesses.Allowable Values: Existing user or business token. |
| direct_deposit_state string Optional | Performs a case-sensitive match on the direct_deposit_state field.Allowable Values: PENDING, APPLIED, REVERSED, REJECTED |
| count integer Optional | The number of direct deposit records to retrieve. Allowable Values: Up to 100 records Default value: 5 |
| start_index integer Optional | Specifies the sort order index from which to begin returning direct deposit records. Allowable Values: Any integer |
| start_settlement_date string Optional | The beginning of the settlement date range from which to return direct deposit records. Allowable Values: Format: yyyy-mm-dd |
| end_settlement_date string Optional | The end of the settlement date range from which to return direct deposit records. Allowable Values: Format: yyyy-mm-dd |
| sort_by string Optional | The fields by which to sort. Use any fields in the view schema, or one of the system fields lastModifiedTime or createdTime. Prefix a field name with a hyphen (-) to sort in descending order. Omit the hyphen to sort in ascending order.Allowable Values: Any field in the schema |
Sample response body
JSON
{
"count": 2,
"start_index": 0,
"end_index": 1,
"is_more": false,
"data": [ {
"token": "ff035886-5a59-4e9a-86a1-dba8a7cf9c06",
"amount": 50.00,
"type": "CREDIT",
"state": "PENDING",
"settlement_date": "2019-12-06T00:00:00Z",
"state_reason": "Newly created",
"state_reason_code": "R11",
"direct_deposit_account_token": "7e9d9519-eb07-4ccd-9a6f-055547da335c",
"user_token": "3f0aa078-1db7-47cf-abf4-3a7ae7cd9e20",
"standard_entry_class_code": "WEB",
"company_name": "NEW_COMPANY",
"company_discretionary_data": "",
"company_identification": "8765432109",
"company_entry_description": "SALARY",
"individual_identification_number": "2345678901",
"individual_name": "JANE SMITH",
"created_time": "2019-012-05T20:37:40Z",
"last_modified_time": "2019-12-05T20:37:40Z"
}, {
"token": "c4ec050d-3e49-4fa4-9fea-11bc18506be3",
"amount": 25.00,
"type": "DEBIT",
"state": "APPLIED",
"settlement_date": "2019-12-07T00:00:00Z",
"state_reason": "Successfully applied",
"state_reason_code": "R11",
"direct_deposit_account_token": "7e9d9519-eb07-4ccd-9a6f-055547da326c",
"business_token": "a86c1926-30ab-41fe-8c75-ba4a0baef1fd",
"standard_entry_class_code": "WEB",
"company_name": "COMPANY_NAME",
"company_discretionary_data": "",
"company_identification": "9876543210",
"company_entry_description": "PURCHASE",
"individual_identification_number": "1234567890",
"individual_name": "JOHN SMITH",
"created_time": "2019-12-05T20:37:40Z",
"last_modified_time": "2019-12-07T20:37:40Z"
} ]
}