processorBalanceGet
The /processor/balance/get endpoint returns the real-time balance for each of an Item's accounts. While other endpoints may return a balance object, only /processor/balance/get forces the available and current balance fields to be refreshed rather than cached.
Authorization
PLAID-CLIENT-ID PLAID-SECRET Plaid-Version In: header
In: header
In: header
Request Body
application/json
The /processor/balance/get endpoint returns the real-time balance for the account associated with a given processor_token.
The current balance is the total amount of funds in the account. The available balance is the current balance less any outstanding holds or debits that have not yet posted to the account.
Note that not all institutions calculate the available balance. In the event that available balance is unavailable from the institution, Plaid will return an available balance value of null.
ProcessorBalanceGetRequest defines the request schema for /processor/balance/get
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.
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.
The processor token obtained from the Plaid integration partner. Processor tokens are in the format: processor-<environment>-<identifier>
An optional object to filter /processor/balance/get results.
Response Body
application/json
curl -X POST "https://example.com/processor/balance/get" \ -H "Content-Type: application/json" \ -d '{ "processor_token": "string" }'{ "account": { "account_id": "QKKzevvp33HxPWpoqn6rI13BxW4awNSjnw4xv", "balances": { "available": 100, "current": 110, "limit": null, "iso_currency_code": "USD", "unofficial_currency_code": null }, "mask": "0000", "name": "Plaid Checking", "official_name": "Plaid Gold Checking", "subtype": "checking", "type": "depository" }, "request_id": "1zlMf"}processorBankTransferCreate POST
Use the `/processor/bank_transfer/create` endpoint to initiate a new bank transfer as a processor
processorAuthGet POST
The `/processor/auth/get` endpoint returns the bank account and bank identification number (such as the routing number, for US accounts), for a checking or savings account that's associated with a given `processor_token`. The endpoint also returns high-level account data and balances when available.