Counterparty Resources

The following resources are used in the Counterparties API:

ACH Counterparty

The ACH Counterparty resource represents an external bank account that can receive or send ACH payments.

Key Attributes

Attribute	Type	Description
name	string	The account holder's name (individual or business).
routingNumber	string	9-digit ABA routing transit number.
accountNumber	string	Bank account number.
accountType	string	Either Checking, Savings, or Loan.
type	string	Either Business, Person, or Unknown.
permissions	string	Either CreditOnly, DebitOnly, or CreditAndDebit.
createdAt	RFC3339 Date string	The date the counterparty was created.

Relationships

Relationship	Type	Description
customer	Customer	The customer that the counterparty belongs to.

Example

{
  "type": "achCounterparty",
  "id": "8",
  "attributes": {
    "createdAt": "2020-05-13T09:07:47.645Z",
    "name": "Joe Doe",
    "routingNumber": "011000138",
    "accountNumber": "123",
    "accountType": "Checking",
    "type": "Person",
    "permissions": "CreditOnly"
  },
  "relationships": {
    "customer": {
      "data": {
        "type": "customer",
        "id": "111111"
      }
    }
  }
}

Counterparty Balance

The Counterparty Balance resource represents the balance information for a counterparty created with a Plaid processor token.

Note

Counterparty balance is only available for counterparties created with a Plaid processor token, and only when the customer is the owner of the counterparty account.

Key Attributes

Attribute	Type	Description
available	integer	The available balance (in cents) in the counterparty account.
current	integer	The current balance (in cents) in the counterparty account.

Relationships

Relationship	Type	Description
counterparty	ACH Counterparty	The counterparty this balance belongs to.
customer	Customer	The customer that owns the counterparty.

Example

{
  "type": "counterpartyBalance",
  "id": "8",
  "attributes": {
    "available": 100000,
    "current": 120000
  },
  "relationships": {
    "counterparty": {
      "data": {
        "type": "achCounterparty",
        "id": "8"
      }
    },
    "customer": {
      "data": {
        "type": "customer",
        "id": "111111"
      }
    }
  }
}

Counterparty Type (Embedded Object)

The Counterparty type is an embedded object used within payment and transaction resources to represent the other party in a financial transaction.

Attributes

Attribute	Type	Description
name	string	The name of the counterparty.
routingNumber	string	The routing number of the counterparty's bank.
accountNumber	string	The account number of the counterparty.
accountType	string	The type of account (Checking, Savings, Loan).

Related Resources

Resource	Description
ACH Payment	Payments made to/from counterparties
ACH Received Payment	Payments received from counterparties
ACH Transaction	Transaction records involving counterparties