List Counterparties

List Counterparties

curl --request GET \
  --url https://api.treasuryprime.com/counterparty \
  --header 'Authorization: Basic <encoded-value>'

{
  "data": [
    {
      "ach": {
        "account_number": "<string>",
        "account_type": "<string>",
        "routing_number": "<string>"
      },
      "id": "<string>",
      "name_on_account": "<string>",
      "plaid_processor_token": "<string>",
      "userdata": {},
      "wire": {
        "account_number": "<string>",
        "address_on_account": {
          "city": "<string>",
          "country": "<string>",
          "postal_code": "<string>",
          "state": "<string>",
          "street_line_1": "<string>",
          "street_line_2": "<string>"
        },
        "bank_address": {
          "city": "<string>",
          "country": "<string>",
          "postal_code": "<string>",
          "state": "<string>",
          "street_line_1": "<string>",
          "street_line_2": "<string>"
        },
        "bank_name": "<string>",
        "routing_number": "<string>"
      }
    }
  ]
}

GET

counterparty

List Counterparties

curl --request GET \
  --url https://api.treasuryprime.com/counterparty \
  --header 'Authorization: Basic <encoded-value>'

{
  "data": [
    {
      "ach": {
        "account_number": "<string>",
        "account_type": "<string>",
        "routing_number": "<string>"
      },
      "id": "<string>",
      "name_on_account": "<string>",
      "plaid_processor_token": "<string>",
      "userdata": {},
      "wire": {
        "account_number": "<string>",
        "address_on_account": {
          "city": "<string>",
          "country": "<string>",
          "postal_code": "<string>",
          "state": "<string>",
          "street_line_1": "<string>",
          "street_line_2": "<string>"
        },
        "bank_address": {
          "city": "<string>",
          "country": "<string>",
          "postal_code": "<string>",
          "state": "<string>",
          "street_line_1": "<string>",
          "street_line_2": "<string>"
        },
        "bank_name": "<string>",
        "routing_number": "<string>"
      }
    }
  ]
}

Authorizations

Authorization

string

header

required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Query Parameters

name_on_account

string

Name of the account owner. Filterable.

page_cursor

string

Pagination cursor, value is the object ID.

page_size

integer

default:100

Limits the number of objects in the returned list, value must be a number greater than or equal to 1. Defaults to 100.

Required range: x >= 1

from_date

string

Lists the objects created on the date provided and onwards. Date must be in ISO 8601 format (“YYYY-MM-DD”).

to_date

string

Lists the objects created before the date provided. Date must be in ISO 8601 format (“YYYY-MM-DD”).

Response

200 - application/json

A dictionary with a data property that contains a list of up to page_size counterparty elements, starting after the counterparty described by page_cursor. If no more counterpartys are available, the resulting list will be empty.

data

object[]

Show child attributes

data.ach

object

Account information for use with ACH transfers

Show child attributes

data.ach.account_number

string

Bank account number for ACH use (maximum of 17 characters)

data.ach.account_type

string

Either checking or savings.

data.ach.routing_number

string

Valid 9-digit ABA routing transit number associated with the account. See the Routing Number endpoint for additional information.

data.id

string

Unique identifier for object

data.name_on_account

string

Name of the account owner. Filterable.

data.plaid_processor_token

string

Plaid processor token, exchanged for an account number and routing number

data.userdata

object

Arbitrary data the user can attach to the object

data.wire

object

Account information for use with wire transfers

Show child attributes

data.wire.account_number

string

Bank account number for wire use (maximum of 34 characters)

data.wire.address_on_account

object

Physical address associated with the account

Show child attributes

data.wire.address_on_account.city

string

City (max 18 characters)

data.wire.address_on_account.country

string

Country (ISO 3166-1 alpha-2). Defaults to US

data.wire.address_on_account.postal_code

string

Postal code (5-digit or 5+4 Zip Code for U.S. addresses)

data.wire.address_on_account.state

string

State (max 2 characters for US, max 3 characters for other countries)

data.wire.address_on_account.street_line_1

string

First line of the address (max 35 characters)

data.wire.address_on_account.street_line_2

string

Optional second line of the address (max 35 characters)

data.wire.bank_address

object

Address of the bank

Show child attributes

data.wire.bank_address.city

string

City (max 18 characters)

data.wire.bank_address.country

string

A 2 character ISO country code. Required for an international counterparty

data.wire.bank_address.postal_code

string

Postal code (5-digit or 5+4 Zip Code for U.S. addresses)

data.wire.bank_address.state

string

U.S. State (two letter abbreviation). If an international wire counterparty this is the Province or Region.

data.wire.bank_address.street_line_1

string

Street address (first line) (max 35 characters)

data.wire.bank_address.street_line_2

string

Street address (second line, if applicable) (max 35 characters)

data.wire.bank_name

string

Name of the bank

data.wire.routing_number

string

Valid 9-digit ABA routing transit number for the bank holding the account. See the Routing Number endpoint for additional information. For international wires this can be a valid BIC/SWIFT code

Update a Check Deposit Create a Counterparty

⌘I

Introduction

Account

Account Opening

Cards

Payments

Testing

Utilities

Authorizations

Query Parameters

Response