Move available balance between ledgers

POST /transfer/ledger/distribute

Use the /transfer/ledger/distribute endpoint to move available balance between ledgers, if you have multiple. If you’re a platform, you can move funds between one of your ledgers and one of your customer’s ledger.

Request Body

Required

Defines the request schema for /transfer/ledger/distribute

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.
from_ledger_id
required, string
The Ledger to pull money from.
to_ledger_id
required, string
The Ledger to credit money to.
amount
required, string
The amount to move (decimal string with two digits of precision e.g. “10.00”). Amount must be positive.
idempotency_key
required, string
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.
description
string
An optional description for the ledger distribute operation.

Response

Defines the response schema for /transfer/ledger/distribute

Response Properties

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.