Advance a test clock

POST /sandbox/transfer/test_clock/advance

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

A test clock object represents an independent timeline and has a virtual_time field indicating the current timestamp of the timeline. A test clock can be advanced by incrementing virtual_time, but may never go back to a lower virtual_time.

If a test clock is advanced, we will simulate the changes that ought to occur during the time that elapsed.

For example, a client creates a weekly recurring transfer with a test clock set at t. When the client advances the test clock by setting virtual_time = t + 15 days, 2 new originations should be created, along with the webhook events.

The advancement of the test clock from its current virtual_time should be limited such that there are no more than 20 originations resulting from the advance operation on each recurring_transfer associated with the test_clock.

For example, if the recurring transfer associated with this test clock originates once every 4 weeks, you can advance the virtual_time up to 80 weeks on each API call.

Request Body

Required

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

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.
new_virtual_time
required, string
The virtual timestamp on the test clock. This will be of the form 2006-01-02T15:04:05Z.

Response

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

Response Properties

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.