Get a test clock

POST /sandbox/transfer/test_clock/get

Use the /sandbox/transfer/test_clock/get endpoint to get a test_clock in the Sandbox environment.

Request Body

Required

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

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.
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.

Response

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

Response Properties

test_clock
required, object
Defines the test clock for a transfer.
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.