Hey! These docs are for version 1.0, which is no longer officially supported. Click here for the latest version, 1.1!

Counterparty Object

A counterparty is an entity outside of your organization that you want to send or receive money from. They can be an individual or a business.

AttributeDescription
id
string
Unique identifier for the counterparty.
name
string
A human friendly name for this counterparty.
accounts
array
The accounts for this counterparty.
See Account for additional details.
email
string
The counterparty's email.
metadata
object
Additional data represented as key-value pairs. Both the key and value must be strings or integers. See Metadata.
send_remittance_advice
boolean
Send an email to the counterparty whenever an associated payment order is sent to the bank.
ledger_type
string
One of customer or vendor. This counterparty will be auto-synced to your ledger as the specified type. This requires a connected ledger and for the auto-sync counterparties setting to be enabled.
live_mode
boolean
This field will be true if this object was created with a production API key or false if created with a test API key.
{
  "id": "928db55e-6552-4aaf-96d7-10c693922b1f",
  "name": "John Smith",
  "email": "[email protected]",
  "send_remittance_advice": true,
  "metadata": {},
  "accounts": [
    {
      "id": "c8d059bc-e781-4528-9359-d46eaaa7f953",
      "account_type": null,
      "party_name": "John Smith",
      "party_type": "business",
      "party_address": null,
      "account_details": [
        {
          "id": "3036a533-53ad-4e58-ba30-33c4d75c0c57",
          "account_number": "1293291291",
          "account_number_type": null,
          "live_mode": true
        }
      ],
      "routing_details": [
        {
          "id": "e8626e0b-2687-4b0d-9f2c-68a4c29ee5f1",
          "payment_type": null,
          "routing_number": "121141822",
          "routing_number_type": "aba",
          "live_mode": true
        }
      ],
      "live_mode": true
    }
  ],
  "live_mode": true,
  "created_at": "2019-11-09T00:11:07Z",
  "updated_at": "2019-11-09T00:11:07Z"
}