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.

Servers

Request headers

Name Type Required Description
Content-Type String Yes The media type of the request body.

Default value: "application/json"

Request body fields

Name Type Required Description
client_id String No

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.

webhook String No

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

ledger_id String No

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.

test_clock_id String No

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.

secret String No

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.

originator_client_id String No

Client ID of the end customer (i.e. the originator). Only applicable to Platform Payments customers.

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.