Example Requests

These are sample payloads that can be used when creating a counterparty.

Creating a simple Counterparty

The following request will create a counterparty with just a name and a single account.

{
  "name": "Kenner, Bach & Ledeen",
  "accounts": [
    {
      "account_type": "checking",
      "routing_details": [
        {
          "routing_number_type": "aba",
          "routing_number": "026009593"
        }
      ],
      "account_details": [
        {
          "account_number": "123456789"
        }
      ]
    }
  ]
}

If your counterparty has two different routing numbers (e.g. separate wire/ACH routing instructions), multiple routing_details can be specified with different payment_type values.

{
  "name": "Kenner, Bach & Ledeen",
  "accounts": [
    {
      "account_type": "checking",
      "routing_details": [
        {
          "routing_number_type": "aba",
          "routing_number": "026009593",
          "payment_type": "wire"
        },
        {
          "routing_number_type": "aba",
          "routing_number": "011400495",
          "payment_type": "ach"
        }
      ],
      "account_details": [
        {
          "account_number": "123456789"
        }
      ]
    }
  ]
}

If you are trying to wire money to a counterparty, you'll need an address, which you can include with their account information.

{
  "name": "John Smith",
  "accounts": [
    {
      "account_type": "checking",
      "party_type": "individual",
      "routing_details": [
        {
          "routing_number_type": "aba",
          "routing_number": "026009593",
          "payment_type": "wire"
        }
      ],
      "account_details": [
        {
          "account_number": "123456789"
        }
      ],
      "party_address": {
        "line1": "3rd Floor",
        "locality": "Tampa",
        "region": "FL",
        "postal_code": "33610",
        "country": "USA"
      }
    }
  ]
}

Creating a Counterparty with a Canadian routing number

To use a Canadian routing number, simply pass ca_cpa as the routing_number_type and use the EFT format of the routing_number. The format is a leading zero followed by the 3 digit financial institution number followed followed by the 5 digit branch number. For the example, the routing number 000494480 is a leading 0 followed by 004 (TD Bank) followed by 94480 (a specific TD branch in Vancouver).

{
  "name": "Kenner, Bach & Ledeen",
  "accounts": [
    {
      "account_type": "checking",
      "routing_details": [
        {
          "routing_number_type": "ca_cpa",
          "routing_number": "000494480",
        },
      ],
      "account_details": [
        {
          "account_number": "123456789"
        }
      ]
    }
  ]
}

Creating a Counterparty with an Australian routing number

To use a Australian routing number, simply pass au_bsb as the routing_number_type and use the BSB format of the routing_number. The format is six digits long, comprising of a 2 digit financial institution number, a 1 digit code identifying which state the branch is in, and 3 digits denoting the branch address.

{
  "name": "Kenner, Bach & Ledeen",
  "accounts": [
    {
      "account_type": "checking",
      "routing_details": [
        {
          "routing_number_type": "au_bsb",
          "routing_number": "062903",
        },
      ],
      "account_details": [
        {
          "account_number": "123456789"
        }
      ]
    }
  ]
}

Creating a Counterparty with a Plaid token

To use a Plaid token, simply pass it into the account you are creating instead of account_details and routing_details

{
  "name": "John Smith",
  "accounts": [
    {
      "plaid_processor_token": "processor-sandbox-91aafea8-c4d0-4477-b471-e1884989de3a"
    }
  ]
}

Creating a Counterparty without an account

If you do not know your Counterparty's account information, you can still create a counterparty record and add an account later.

{
  "name": "Kenner, Bach & Ledeen",
  "email": "[email protected]"
}