Deposit funds into a Plaid Ledger balance

POST /transfer/ledger/deposit

Use the /transfer/ledger/deposit endpoint to deposit funds into Plaid Ledger.

Request Body

Required

Defines the request schema for /transfer/ledger/deposit

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.
originator_client_id
string
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.
funding_account_id
string
Specify which funding account to use. Customers can find a list of funding_account_ids in the Accounts page of the Plaid Dashboard, under the “Account ID” column. If this field is left blank, the funding account associated with the specified Ledger will be used. If an originator_client_id is specified, the funding_account_id must belong to the specified originator.
ledger_id
string
Specify which ledger balance to deposit to. Customers can find a list of ledger_ids in the Accounts page of your Plaid Dashboard. If this field is left blank, this will default to id of the default ledger balance.
amount
required, string
A positive amount of how much will be deposited into ledger (decimal string with two digits of precision e.g. “5.50”).
description
string
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.
idempotency_key
required, string
A unique key provided by the client, per unique ledger deposit. 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 deposit fails due to a network connection error, you can retry the request with the same idempotency key to guarantee that only a single deposit is created.
network
required, string
The ACH networks used for the funds flow. For requests submitted as either ach or same-day-ach the cutoff for Same Day ACH is 3:30 PM Eastern Time and the cutoff for Standard ACH transfers is 8:30 PM Eastern Time. It is recommended to submit a request at least 15 minutes before the cutoff time in order to ensure that it will be processed before the cutoff. Any request that is indicated as same-day-ach and that misses the Same Day ACH cutoff, but is submitted in time for the Standard ACH cutoff, will be sent over Standard ACH rails and will not incur same-day charges.

Response

Defines the response schema for /transfer/ledger/deposit

Response Properties

sweep
required, object
Describes a sweep of funds to / from the sweep account. A sweep is associated with many sweep events (events of type swept or return_swept) which can be retrieved by invoking the /transfer/event/list endpoint with the corresponding sweep_id. swept events occur when the transfer amount is credited or debited from your sweep account, depending on the type of the transfer. return_swept events occur when a transfer is returned and Plaid undoes the credit or debit. The total sum of the swept and return_swept events is equal to the amount of the sweep Plaid creates and matches the amount of the entry on your sweep account ledger.
id
required, string
Identifier of the sweep.
funding_account_id
required, string
The id of the funding account to use, available in the Plaid Dashboard. This determines which of your business checking accounts will be credited or debited.
ledger_id
string
Plaid’s unique identifier for a Plaid Ledger Balance.
created
required, string
The datetime when the sweep occurred, in RFC 3339 format.
amount
required, string
Signed decimal amount of the sweep as it appears on your sweep account ledger (e.g. “-10.00”) If amount is not present, the sweep was net-settled to zero and outstanding debits and credits between the sweep account and Plaid are balanced.
iso_currency_code
required, string
The currency of the sweep, e.g. “USD”.
settled
required, string
The date when the sweep settled, in the YYYY-MM-DD format.
expected_funds_available_date
string
The expected date when funds from a ledger deposit will be made available and can be withdrawn from the associated ledger balance. Only applies to deposits. This will be of the form YYYY-MM-DD.
status
string
The status of a sweep transfer "pending" - The sweep is currently pending "posted" - The sweep has been posted "settled" - The sweep has settled. This is the terminal state of a successful credit sweep. "returned" - The sweep has been returned. This is the terminal state of a returned sweep. Returns of a sweep are extremely rare, since sweeps are money movement between your own bank account and your own Ledger. "funds_available" - Funds from the sweep have been released from hold and applied to the ledger’s available balance. (Only applicable to deposits.) This is the terminal state of a successful deposit sweep. "failed" - The sweep has failed. This is the terminal state of a failed sweep.
trigger
string
The trigger of the sweep "manual" - The sweep is created manually by the customer "incoming" - The sweep is created by incoming funds flow (e.g. Incoming Wire) "balance_threshold" - The sweep is created by balance threshold setting "automatic_aggregate" - The sweep is created by the Plaid automatic aggregation process. These funds did not pass through the Plaid Ledger balance.
description
string
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.
network_trace_id
string
The trace identifier for the transfer based on its network. This will only be set after the transfer has posted. For ach or same-day-ach transfers, this is the ACH trace number. For rtp transfers, this is the Transaction Identification number. For wire transfers, this is the IMAD (Input Message Accountability Data) number.
failure_reason
object
The failure reason if the status for a sweep is "failed" or "returned". Null value otherwise.
failure_code
string
The failure code, e.g. R01. A failure code will be provided if and only if the sweep status is returned. See ACH return codes for a full listing of ACH return codes and RTP/RfP error codes for RTP error codes.
description
string
A human-readable description of the reason for the failure or reversal.
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.