Simulate converting pending balance to available balance

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.

Request Body

Required

Defines the request schema for /sandbox/transfer/ledger/simulate_available

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.
ledger_id
string
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.
originator_client_id
string
Client ID of the end customer (i.e. the originator). Only applicable to Platform Payments customers.
test_clock_id
string
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.
webhook
string
The webhook URL to which a TRANSFER_EVENTS_UPDATE webhook should be sent.

Response

Defines the response schema for /sandbox/transfer/ledger/simulate_available

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.