GET//
Retrieves a direct deposit record. Include the token path parameter to indicate the direct deposit record to retrieve.
A direct deposit record stores the details corresponding to a single direct deposit action, such as the type (debit or credit), amount, and associated dates and times.
URL path parameters
| Fields | Description |
|---|---|
| token string Required | Unique identifier of the direct deposit record to retrieve. Send a GET request to /directdeposits to retrieve direct deposit tokens.Allowable Values: Existing direct deposit record token. |
Response body
| Fields | Description |
|---|---|
| token string Returned | Unique identifier of the direct deposit record. Allowable Values: Existing direct deposit record token. |
| amount decimal Returned | Amount being debited or credited. Allowable Values: Existing amount in 0.00 decimal format. |
| type string Returned | Whether funds are being debited from or credited to the account. Allowable Values: DEBIT, CREDIT |
| state string Returned | Current status of the direct deposit record. Allowable Values: PENDING, APPLIED, REVERSED, REJECTED |
| settlement_date string Returned | Date when the credit or debit is applied. Allowable Values: Format: yyyy-mm-ddThh:mm:ssZ |
| state_reason string Returned | Explanation of why the direct deposit record is in the current state. Allowable Values: 255 char max |
| state_reason_code string Returned | A standard 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. |
| direct_deposit_account_token string Returned | Unique identifier of the affected deposit account. Allowable Values: 36 char max |
| user_token OR business_token string Returned | Unique identifier of the user or business associated with the direct deposit record. Allowable Values: Existing user or business token. |
| standard_entry_class_code string 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 |
| company_name string Returned | Name of the direct deposit originator. Allowable Values: 16 char max |
| company_discretionary_data string Returned | Company-specific data provided by the direct deposit originator. Allowable Values: 20 char max |
| company_identification string Returned | Alphanumeric code that identifies the direct deposit originator. Allowable Values: 10 char max |
| company_entry_description string Returned | Description of the purpose of the direct deposit. Allowable Values: 10 char max |
| individual_identification_number string 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. |
| individual_name string Returned | Identity of the direct deposit recipient. Allowable Values: 22 char max |
Sample response body
JSON
{
"token": "00acce2b-cead-45ab-9417-f8a62326c0d5",
"amount": 50.00,
"type": "DEBIT",
"state": "PENDING",
"settlement_date": "2019-12-31T00:00:00Z",
"state_reason": "Newly created",
"state_reason_code": "R11",
"direct_deposit_account_token": "7e9d9519-eb07-4ccd-9a6f-055547da326c",
"user_token": "my_user",
"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-12T21:02:37Z",
"last_modified_time": "2019-12-12T21:02:37Z"
}