GET//
Retrieves a list of direct deposit transition records.
This endpoint supports pagination and field filtering.
Query parameters
| Fields | Description |
|---|---|
| user_or_business_token string Optional | Account holder whose transition records you want to return. Send a GET request to retrieve tokens from /users or /businesses.Allowable Values: Existing user or business token. |
| direct_deposit_token string Optional | The direct deposit credit or debit for which to return transition records. Send a GET request to retrieve tokens from /directdeposits.Allowable Values: Existing direct deposit record token. |
| states string Optional | The states for which to return transition records. To list transition records for more than one state, create a comma-delimited list. Allowable Values: APPLIED, PENDING, REVERSED, REJECTED |
Sample response body
JSON
{
"count": 5,
"start_index": 0,
"end_index": 4,
"is_more": true,
"data": [ {
"channel": "SYSTEM",
"token": "72fccea3-6b70-4636-80aa-7732f3d98e7f",
"reason": "New credit",
"type": "state.pending",
"direct_deposit_token": "ff035886-5a59-4e9a-86a1-dba8a7cf9c06",
"transaction_token": "674",
"state": "PENDING",
"created_time": "2020-04-05T20:37:40Z"
}, {
"channel": "SYSTEM",
"token": "a07a217a-4f1e-4281-abb4-954207a91814",
"reason": "Success credit immediate",
"type": "state.applied",
"direct_deposit_token": "c4ec050d-3e49-4fa4-9fea-11bc18506be3",
"transaction_token": "675",
"state": "APPLIED",
"created_time": "2020-04-05T20:37:40Z"
}, {
"channel": "SYSTEM",
"token": "56c8f7bb-2aa6-4ea5-9ecb-b78a342d4650",
"reason": "New credit",
"type": "state.pending",
"direct_deposit_token": "06da9efd-1b73-4858-b72f-433905717038",
"transaction_token": "672",
"state": "PENDING",
"created_time": "2020-04-05T20:37:39Z"
},{
"channel": "SYSTEM",
"token": "d088ba05-d683-4a31-8989-3e0aec283ab5",
"reason": "New credit",
"type": "state.pending",
"direct_deposit_token": "8566bfdc-4c97-4914-bcb8-d91de960bc53",
"transaction_token": "673",
"state": "PENDING",
"created_time": "2020-04-05T20:37:39Z"
}, {
"channel": "API",
"token": "38711d42-4286-4881-8966-45eb44d9845a",
"reason": "transition from pending",
"type": "state.applied",
"direct_deposit_token": "9d3ff191-490a-4393-a8d0-c74e705b9f37",
"transaction_token": "667",
"state": "APPLIED",
"created_time": "2020-04-05T20:37:38Z"
} ]
}