provider plaid POST /sandbox/transfer/ledger/simulate_available
@utdk/plaid /sandbox/transfer/ledger/simulate_available
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.

Try it

Authentication
Configure credentials for The Plaid API
Gateway
The gateway proxies requests and injects credentials server-side. Configure credentials above, then enter your gateway URL.

Saved automatically to browser storage.

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

Input

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.

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.

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

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

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

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

Enter a gateway URL above to enable sending.

Code snippet
Updates live as you fill in the form above.

TypeScript

import plaid from '@utdk/plaid';

await plaid.sandboxtransferledgersimulateavailable()