GET/
Return a list of direct deposits.
URL query parameters
| Fields | Description |
|---|---|
| count integer Optional | Number of direct deposits to retrieve. Allowable Values: 100 max |
| user_token string Optional | Unique identifier of the user. Pass either a user_token or a business_token, not both.Send a GET request to /users to retrieve user tokens.Allowable Values: 1–36 chars |
| business_token string Optional | Unique identifier of the business. Pass either a user_token or a business_token, not both.Send a GET request to /businesses to retrieve business tokens.Allowable Values: 1–36 chars |
| direct_deposit_state string Optional | Direct deposit state. Allowable Values: PENDING, REVERSED, APPLIED, REJECTED |
| start_settlement_date string Optional | Beginning of the settlement date range from which to return direct deposit records. Allowable Values: string Format: yyyy-mm-dd |
| end_settlement_date string Optional | End of the settlement date range from which to return direct deposit records. Allowable Values: string Format: yyyy-mm-dd |
| start_index integer Optional | Sort order index of the first resource in the returned array. This field is returned if there are resources in your returned array. Allowable Values: Any integer |
| sort_by string Optional | Fields by which to sort. Use any fields in the resource model, 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: createdTime, lastModifiedTime, settlementDate |
Response body
| Fields | Description |
|---|---|
| count integer Conditionally returned | Number of direct deposit transitions to retrieve. Allowable Values: 100 max |
| data array of objects Conditionally returned | List of direct deposits. Allowable Values: 100 max |
| data[].amount decimal Conditionally returned | Amount being debited or credited. Allowable Values: number Format: 0.00 |
| data[].business_token string Conditionally returned | Unique identifier of the business associated with the direct deposit record. Allowable Values: Existing business token |
| data[].company_discretionary_data string Conditionally returned | Company-specific data provided by the direct deposit originator. Allowable Values: 20 char max |
| data[].company_entry_description string Conditionally returned | Description of the purpose of the direct deposit. Allowable Values: 10 char max |
| data[].company_identification string Conditionally returned | Alphanumeric code that identifies the direct deposit originator. Allowable Values: 10 char max |
| data[].company_name string Conditionally returned | Name of the direct deposit originator. Allowable Values: 16 char max |
| data[].created_time datetime Conditionally returned | Date and time when the direct deposit record was created. Allowable Values: string Format: yyyy-mm-ddThh:mm:ssZ |
| data[].direct_deposit_account_token string Conditionally returned | Unique identifier of the affected deposit account. Allowable Values: 36 char max |
| data[].individual_identification_number string Conditionally returned | Accounting number by which the recipient is known to the direct deposit originator. Allowable Values: 15 or 22 char max, depending on the value of standard_entry_class_code |
| data[].individual_name string Conditionally returned | Identity of the direct deposit recipient. Allowable Values: 22 char max |
| data[].last_modified_time datetime Conditionally returned | Date and time when the direct deposit record was last updated. Allowable Values: string Format: yyyy-mm-ddThh:mm:ssZ |
| data[].settlement_date datetime Conditionally returned | Date and time when the credit or debit is applied. Allowable Values: string Format: yyyy-mm-ddThh:mm:ssZ |
| data[].standard_entry_class_code string Conditionally returned | Three-letter code identifying the type of entry. Allowable Values: ACK, ADV, ARC, ATX, BOC, CCD, CIE, COR, CTX, DNE, ENR, IAT, MTE, POP, POS, PPD, RCK, SHR, TEL, TRC, TRX, WEB, XCK |
| data[].state string Conditionally returned | Current status of the direct deposit record. Allowable Values: PENDING, APPLIED, REVERSED, REJECTED |
| data[].state_reason string Conditionally returned | Explanation of why the direct deposit record is in the current state. Allowable Values: 255 char max |
| data[].state_reason_code string Conditionally returned | Standardized code describing the reason for the current state. Allowable Values: See ACHR return reason codes for the full list of supported codes and the grace period associated with each. |
| data[].token string Conditionally returned | Unique identifier of the direct deposit record. Allowable Values: 36 char max |
| data[].type string Conditionally returned | Whether funds are being debited from or credited to the account. Allowable Values: CREDIT, DEBIT |
| data[].user_token string Conditionally returned | Unique identifier of the user or business associated with the direct deposit record. Allowable Values: Existing user token |
| data[].trace_number string Conditionally returned | 15-digit number used to track inbound and outbound ACH transfers. Allowable Values: 15 char max |
| data[].early_direct_deposit string Conditionally returned | Boolean value that indicates whether this is a qualifying early pay transaction. If the early pay feature is not enabled for this program, this value will always be false.Allowable Values: true, false |
| data[].originator_status_code string Conditionally returned | Numeric value that identifies the originator of the direct deposit record: - 1: Originator is not a US federal government entity. - 2: Originator is a US federal government entity, such as the IRS. Allowable Values: 1, 2 |
| end_index integer Conditionally returned | Sort order index of the last resource in the returned array. This field is returned if there are resources in your returned array. Allowable Values: Any integer |
| is_more boolean Conditionally returned | A value of true indicates that more unreturned resources exist.A value of false indicates that no more unreturned resources exist.This field is returned if there are resources in your returned array. Allowable Values: true, false |
| start_index integer Conditionally returned | Sort order index of the first resource in the returned array. This field is returned if there are resources in your returned array. Allowable Values: Any integer |