Retrieve Plaid Ledger balance

POST /transfer/ledger/get

Use the /transfer/ledger/get endpoint to view a balance on the ledger held with Plaid.

Request Body

Required

Defines the request schema for /transfer/ledger/get

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.
ledger_id
string
Specify which ledger balance to get. 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.
originator_client_id
string
Client ID of the end customer.

Response

Defines the response schema for /transfer/ledger/get

Response Properties

ledger_id
required, string
The unique identifier of the Ledger that was returned.
balance
required, object
Information about the balance of the ledger held with Plaid.
available
required, string
The amount of this balance available for use (decimal string with two digits of precision e.g. “10.00”).
pending
required, string
The amount of pending funds that are in processing (decimal string with two digits of precision e.g. “10.00”).
name
required, string
The name of the Ledger
is_default
required, boolean
Whether this Ledger is the client’s default ledger.
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.