List test clocks

POST /sandbox/transfer/test_clock/list

Use the /sandbox/transfer/test_clock/list endpoint to see a list of all your test clocks in the Sandbox environment, by ascending virtual_time. Results are paginated; use the count and offset query parameters to retrieve the desired test clocks.

Request Body

Required

Defines the request schema for /sandbox/transfer/test_clock/list

Parameters

client_id
string
Your Plaid API client_id. The client_id is required and may be provided either in the PLAID-CLIENT-ID header or as part of a request body.
secret
string
Your Plaid API secret. The secret is required and may be provided either in the PLAID-SECRET header or as part of a request body.
start_virtual_time
string
The start virtual timestamp of test clocks to return. This should be in RFC 3339 format (i.e. 2019-12-06T22:35:49Z)
end_virtual_time
string
The end virtual timestamp of test clocks to return. This should be in RFC 3339 format (i.e. 2019-12-06T22:35:49Z)
count
integer
The maximum number of test clocks to return.
offset
integer
The number of test clocks to skip before returning results.

Response

Defines the response schema for /sandbox/transfer/test_clock/list

Response Properties

test_clocks
required, array[object]
test_clock_id
required, string
Plaid’s unique identifier for a test clock. This field is only populated in the Sandbox environment, and only if a test_clock_id was included in the /transfer/recurring/create request. For more details, see Simulating recurring transfers.
virtual_time
required, string
The virtual timestamp on the test clock. This will be of the form 2006-01-02T15:04:05Z.
request_id
required, string
A unique identifier for the request, which can be used for troubleshooting. This identifier, like all Plaid identifiers, is case sensitive.