POST /transfer/ledger/distribute
Use the /transfer/ledger/distribute endpoint to move available balance between the ledgers of the platform and one of its originators.
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 |
|---|---|---|---|
description |
String | No |
An optional description for the ledger distribute operation. |
client_id |
String | No |
Your Plaid API |
to_ledger_id |
String | Yes |
The Ledger to credit money to. |
amount |
String | Yes |
The amount to move (decimal string with two digits of precision e.g. "10.00"). Amount must be positive. |
from_ledger_id |
String | Yes |
The Ledger to pull money from. |
secret |
String | No |
Your Plaid API |
idempotency_key |
String | Yes |
A unique key provided by the client, per unique ledger distribute. 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 distribute fails due to a network connection error, you can retry the request with the same idempotency key to guarantee that only a single distribute is created. |
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.