POST /transfer/ledger/deposit
Use the /transfer/ledger/deposit
endpoint to deposit funds into Plaid Ledger.
Servers
- https://production.plaid.com
- https://sandbox.plaid.com
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 |
---|---|---|---|
network |
String | Yes |
The ACH networks used for the funds flow. For requests submitted as either Possible values:
|
description |
String | No |
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. |
client_id |
String | No |
Your Plaid API |
amount |
String | Yes |
A positive amount of how much will be deposited into ledger (decimal string with two digits of precision e.g. "5.50"). |
ledger_id |
String | No |
Specify which ledger balance to deposit to. Customers can find a list of |
funding_account_id |
String | No |
Specify which funding account to use. Customers can find a list of |
secret |
String | No |
Your Plaid API |
idempotency_key |
String | Yes |
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. |
originator_client_id |
String | No |
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. |
How to start integrating
- Add HTTP Task to your workflow definition.
- 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.
- Click Test request to test run your request to the API and see the API's response.