PLplaid
plaid

Simulate a ledger withdraw event in Sandbox

Changed on

Use the /sandbox/transfer/ledger/withdraw/simulate endpoint to simulate a ledger withdraw event in the Sandbox environment.

post/sandbox/transfer/ledger/withdraw/simulate

Request

  • Base URL
    https://production.plaid.com
  • URL
    https://production.plaid.com/sandbox/transfer/ledger/withdraw/simulate
  • Auth
    API key in header PLAID-CLIENT-ID and API key in header PLAID-SECRET and API key in header Plaid-Version

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.

sweep_idstring required

Plaid's unique identifier for a sweep.

event_type'sweep.posted' | 'sweep.settled' | 'sweep.returned' | 'sweep.failed' | 'sweep.funds_available' required

The asynchronous event to be simulated. May be: sweep.posted, sweep.settled, sweep.failed, sweep.returned, or sweep.funds_available (deposits only).

An error will be returned if the event type is incompatible with the current ledger sweep status. Compatible status --> event type transitions include:

sweep.pending --> sweep.posted

sweep.pending --> sweep.failed

sweep.posted --> sweep.settled

sweep.posted --> sweep.returned

sweep.settled --> sweep.returned

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.

Changes

  • ea443cd78f6fRevision changes
    • warning

      added the new CRA_PARTNER_INSIGHTS_ERROR enum value to the response property for the response status

    • warning

      added the new CRA_REPORT_ERROR enum value to the response property for the response status

    • info

      added the new sweep.funds_available enum value to the request property

  • a1bbca018160Revision changes
    • warning

      added the new ASSETS_ERROR enum value to the response property for the response status

    • warning

      added the new CRA_MONITORING_ERROR enum value to the response property for the response status

    • warning

      added the new CREDIT_PROFILE_REPORT_ERROR enum value to the response property for the response status

    • warning

      added the new ENCOMPASS_ERROR enum value to the response property for the response status

    • warning

      added the new ENRICH_ERROR enum value to the response property for the response status

    • warning

      added the new FRAUD_INSIGHTS_ERROR enum value to the response property for the response status

    • warning

      added the new FREDDIE_MAC_ERROR enum value to the response property for the response status

    • warning

      added the new LINK_DELIVERY_ERROR enum value to the response property for the response status

    • warning

      added the new PROFILE_ERROR enum value to the response property for the response status

    • warning

      added the new RECURRING_TRANSACTIONS_ERROR enum value to the response property for the response status

    • warning

      added the new STATEMENTS_ERROR enum value to the response property for the response status

    • warning

      added the new TRANSFER_RECURRING_ERROR enum value to the response property for the response status

    • warning

      added the new TRANSFER_REFUND_ERROR enum value to the response property for the response status