Processor API Documentation

Overview

Introduction

Welcome to Plaid! Here you’ll find comprehensive information for integrating with Plaid's Processor API endpoints. This documentation is meant to complement the primary API docs. If you have not read those yet, it may be helpful to do so before jumping in.

API Host

https://sandbox.plaid.com (Sandbox)
https://development.plaid.com (Development)
https://production.plaid.com (Production)

The Sandbox environment is unrestricted and supports only test Items. The Development environment supports up to 100 live Items. All testing should be done in our Sandbox and Development environments. All requests to Production will be billed. When you’re getting ready to launch into Production, please request Production API access via the Dashboard.

Product access endpoints:

/processor/auth/get
/processor/balance/get

Processor endpoints

Auth

The /processor/auth/get endpoint returns the account and routing number for a checking or savings account that's associated with a given processor_token.

Field Required?
client_id
String
yes
secret
String
yes
processor_token
String
yes

Retrieve Auth

POST /processor/auth/get

Retrieve Auth request

curl -X POST https://sandbox.plaid.com/processor/auth/get \
-H 'content-type: application/json' \
-d '{
  "client_id": String,
  "secret": String,
  "processor_token": String
}'

Retrieve Auth response

http code 200
{
  "account": {
     "account_id": "QKKzevvp33HxPWpoqn6rI13BxW4awNSjnw4xv",
     "balances": {
       "available": 100,
       "current": 110,
       "limit": null
     },
     "mask": "0000",
     "name": "Plaid Checking",
     "official_name": "Plaid Gold Checking",
     "subtype": "checking",
     "type": "depository"
  },
  "numbers": {
    "account": "1111222233330000",
    "account_id": "vzeNDwK7KQIm4yEog683uElbp9GRLEFXGK98D",
    "routing": "011401533",
    "wire_routing": "021000021"
  },
  "item": {object},
  "request_id": "1zlMf"
}

Balance

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.

Field Required?
client_id
String
yes
secret
String
yes
processor_token
String
yes

Retrieve Balance

POST /processor/balance/get

Retrieve Balance request

curl -X POST https://sandbox.plaid.com/processor/balance/get \
-H 'content-type: application/json' \
-d '{
  "client_id": String,
  "secret": String,
  "processor_token": String
}'

Retrieve Balance response

http code 200
{
  "account": {
     "account_id": "QKKzevvp33HxPWpoqn6rI13BxW4awNSjnw4xv",
     "balances": {
       "available": 100,
       "current": 110,
       "limit": null
     },
     "mask": "0000",
     "name": "Plaid Checking",
     "official_name": "Plaid Gold Checking",
     "subtype": "checking",
     "type": "depository"
  },
  "item": {object},
  "request_id": "1zlMf"
}

Errors

Processor Errors

Processor API endpoints may return any of the standard API errors. There are some processor-specific error codes documented below:

Error code Notes
INVALID_PROCESSOR_TOKEN
HTTP 400
Processor tokens are in the format:

processor-<environment>-<identifier>

This error can happen when the processor_token is invalid, from a different API environment, or has been deleted.