Sign in

v51

latestOpenAPI 3.0.0raw.githubusercontent.com2026-07-313352,3122.9 MB
plaid

Simulate converting pending balance to available balance

Use the /sandbox/transfer/ledger/simulate_available endpoint to simulate converting pending balance to available balance for all originators in the Sandbox environment.

post/sandbox/transfer/ledger/simulate_available

Request body

client_idstring

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.

secretstring

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.

ledger_idstring nullable

Specify which ledger balance to simulate converting pending balance to available balance. If this field is left blank, this will default to the id of the default ledger balance.

originator_client_idstring nullable

Client ID of the end customer (i.e. the originator). Only applicable to Transfer for Platforms customers.

test_clock_idstring nullable

Plaid's unique identifier for a test clock. If provided, only the pending balance that is due before the virtual_time on the test clock will be converted.

webhookstring url

The webhook URL to which a TRANSFER_EVENTS_UPDATE webhook should be sent.

Response

OK

request_idstring required

A unique identifier for the request, which can be used for troubleshooting. This identifier, like all Plaid identifiers, is case sensitive.