Withdraw funds from a Plaid Ledger balance
Use the /transfer/ledger/withdraw endpoint to withdraw funds from a Plaid Ledger balance.
Request body
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.
Client ID of the customer that owns the Ledger balance. This is so Plaid knows which of your customers to payout or collect funds. Only applicable for Platform customers. Do not include if you’re paying out to yourself.
Specify which funding account linked to this Plaid Ledger to use. Customers can find a list of funding_account_ids in the Accounts page of your Plaid Dashboard, under the "Account ID" column. If this field is left blank, this will default to the default funding_account_id specified during onboarding. If an originator_client_id is specified, the funding_account_id must belong to the specified originator, and if funding_account_id is left blank, the originator's default funding_account_id will be used.
A positive amount of how much will be withdrawn from the ledger balance (decimal string with two digits of precision e.g. "5.50").
The description of the deposit that will be passed to the receiving bank (up to 10 characters). Note that banks utilize this field differently, and may or may not show it on the bank statement.
A unique key provided by the client, per unique ledger withdraw. Maximum of 50 characters.
The API supports idempotency for safely retrying the request without accidentally performing the same operation twice. For example, if a request to create a ledger withdraw fails due to a network connection error, you can retry the request with the same idempotency key to guarantee that only a single withdraw is created.
The network or rails used for the transfer.
For transfers submitted as ach, the next-day cutoff is 5:30 PM Eastern Time.
For transfers submitted as same-day-ach, the same-day cutoff is 3:30 PM Eastern Time. If the transfer is submitted after this cutoff but before the next-day cutoff, it will be sent over next-day rails and will not incur same-day charges; this will apply to both legs of the transfer if applicable.
For transfers submitted as rtp, Plaid will automatically route between Real Time Payment rail by TCH or FedNow rails as necessary. If a transfer is submitted as rtp and the counterparty account is not eligible for RTP, the /transfer/authorization/create request will fail with an INVALID_FIELD error code. To pre-check to determine whether a counterparty account can support RTP, call /transfer/capabilities/get before calling /transfer/authorization/create.
Response
OK
A unique identifier for the request, which can be used for troubleshooting. This identifier, like all Plaid identifiers, is case sensitive.