List all Counterparties

GET

payments

counterparty

curl --request GET \
  --url https://api.sandbox.solidfi.com/v2/payments/counterparty \
  --header 'api-key: <api-key>'

{
  "total": 1,
  "data": [
    {
      "value": {
        "id": "ctp_8e5541c8a9e50c3af3b0daacf9175130",
        "client_id": "cli_64c6c87ee9d609f36a6f390dc378a4ce",
        "master_account_holder_id": "mah_201e02c581a098a740456c5c19fcfcd6",
        "master_account_id": "mas_743fa071316bc6beaf5dddfd05f49c30",
        "sub_account_holder_id": "sah_5ccfeef0adf0cbe2aa0980d2c9505752",
        "sub_account_id": "sub_bda1e562657c41e553104b10aad3fe70",
        "label": "Development Vendor",
        "type": "person",
        "person": {
          "first_name": "John",
          "last_name": "Doe",
          "id_type": "ssn",
          "id_number": "223902234",
          "date_of_birth": "1974-01-25",
          "phone": "+19418405843",
          "email": "john.doe@gmail.com",
          "address": {
            "line1": "123 Main St",
            "line2": "",
            "city": "New York",
            "state": "NY",
            "country": "US",
            "postal_code": "10001"
          }
        },
        "intra_account": {
          "sub_account_number": "95483674098723",
          "sub_account_id": "sub_cda1e562657c41e553104b10aad3fe70"
        },
        "ach": {
          "account_number": "98324502",
          "routing_number": "121042882",
          "account_type": "business_checking",
          "bank_name": "Wells Fargo",
          "verification_status": "pass"
        },
        "domestic_wire": {
          "account_number": "98324502",
          "routing_number": "121042882",
          "account_type": "business_checking",
          "bank_name": "Wells Fargo"
        },
        "international_wire": {
          "account_number": "920020006167511",
          "beneficiary_bank": {
            "identifier_code": "ICICINBBNRI",
            "name": "ICICI Bank",
            "address": {
              "line1": "256 Main St",
              "line2": "",
              "city": "Bengaluru",
              "state": "KA",
              "country": "IN",
              "postal_code": "900009"
            }
          },
          "correspondent_bank": {
            "identifier_code": "SCBLUS33XXX",
            "name": "STANDARD CHARTERED BANK",
            "address": {
              "line1": "1095 12th Ave",
              "line2": "",
              "city": "New York",
              "state": "NY",
              "country": "US",
              "postal_code": "10001"
            }
          }
        },
        "rtp": {
          "account_number": "98324502",
          "routing_number": "121042882",
          "account_type": "business_checking",
          "bank_name": "Wells Fargo",
          "verification_status": "pass"
        },
        "fednow": {
          "account_number": "98324502",
          "routing_number": "121042882",
          "account_type": "business_checking",
          "bank_name": "Wells Fargo",
          "verification_status": "pass"
        },
        "check": {
          "address": {
            "line1": "123 Main St",
            "line2": "",
            "city": "New York",
            "state": "NY",
            "country": "US",
            "postal_code": "10001"
          }
        },
        "debit_card": {
          "card_number": "tok_live_6GVyHuQR7aAjCZivYzLbuP_9990",
          "last4": "9990",
          "expiry_month": "10",
          "expiry_year": "2024",
          "cvv": "tok_live_6GVyHuQR7aAjCZivYzLbuP_9990",
          "address": {
            "line1": "123 Main St",
            "line2": "",
            "city": "New York",
            "state": "NY",
            "country": "US",
            "postal_code": "10001"
          },
          "pull_enabled": true,
          "push_enabled": true
        },
        "purpose": "Offshore dev center",
        "external_reference_id": "TW-9L1L2-UVV",
        "ofac": {
          "status": "pass",
          "last_updated_at": "2024-04-01T21:00:00Z"
        },
        "attachments": [
          {
            "label": "Dev Contract",
            "id": "att_a8d2b191fa0e960d8e49a4bfd320e07b",
            "created_at": "2024-04-01T21:00:00Z"
          }
        ],
        "metadata": {
          "vendor_id": "VID-0987ACR"
        },
        "status": "activated",
        "timestamps": {
          "created_at": "2024-04-01T21:00:00Z",
          "updated_at": "2024-04-01T21:00:00Z"
        }
      }
    }
  ],
  "has_more": "true",
  "starting_after": "Y2xpXzAxOGY4NjEzMDEyYjdlNTFiOTZjNmVlYWJiNmRiZTky",
  "ending_before": "Y2xpXzAxOGY4NjEzMDEyYjdlNTFiOTZjNmVlYWJiNmRiZTky"
}

Headers

api-key

string

required

API key is required to call Solid APIs. You can view and manage your API keys in the Solid dashboard.

Example:

"{{api_key}}"

Query Parameters

sub_account_id

string

unique id of the sub account

Example:

"sub_bda1e562657c41e553104b10aad3fe70"

external_reference_id

string

unique id to cross-reference records with external systems

Example:

"XVH-27LGDFX"

status

enum<string>

status of counterparty

Available options:

pending_activation,

activated,

suspended,

deactivated

Example:

"activated"

limit

number

number of records to return

Example:

10

starting_after

string

A cursor for use in pagination. starting_after is an ID that defines your place in the list. For instance, if you make a list request and receive 50 records, ending with Y2xpXzAxOGY4NjEzMDEyYjdlNTFiOTZjNmVlYWJiNmRiZTky, your subsequent call can include starting_after=Y2xpXzAxOGY4NjEzMDEyYjdlNTFiOTZjNmVlYWJiNmRiZTky in order to fetch the next page of the list.

Example:

"Y2xpXzAxOGY4NjEzMDEyYjdlNTFiOTZjNmVlYWJiNmRiZTky"

ending_before

string

A cursor for use in pagination. ending_before is an ID that defines your place in the list. For instance, if you make a list request and receive 50 records, starting with Y2xpXzAxOGY4NjEzMDEyYjdlNTFiOTZjNmVlYWJiNmRiZTky, your subsequent call can include ending_before= Y2xpXzAxOGY4NjEzMDEyYjdlNTFiOTZjNmVlYWJiNmRiZTky in order to fetch the previous page of the list.

Example:

"Y2xpXzAxOGY4NjEzMDEyYjdlNTFiOTZjNmVlYWJiNmRiZTky"

Response

200

application/json

List all Counterparties

total

number

total number of records

Example:

1

data

object[]

data.id

string

unique id of the counterparty

Example:

"ctp_8e5541c8a9e50c3af3b0daacf9175130"

data.client_id

string

unique id of the client to which the counterparty belongs

Example:

"cli_64c6c87ee9d609f36a6f390dc378a4ce"

data.master_account_holder_id

string

unique id of the master account holder

Example:

"mah_201e02c581a098a740456c5c19fcfcd6"

data.master_account_id

string

unique id of the master account

Example:

"mas_743fa071316bc6beaf5dddfd05f49c30"

data.sub_account_holder_id

string

unique id of the sub account holder

Example:

"sah_5ccfeef0adf0cbe2aa0980d2c9505752"

data.sub_account_id

string

unique id of the sub account under which the counterparty was created

Example:

"sub_bda1e562657c41e553104b10aad3fe70"

data.label

string

label of the counterparty

Example:

"Development Vendor"

data.type

enum<string>

type of counterparty

Available options:

person,

business

Example:

"person"

data.person

object

data.person.first_name

string

first name of the person

Example:

"Jane"

data.person.middle_name

string

middle name of the person

Example:

"Jack"

data.person.last_name

string

last name of the person

Example:

"Doe"

data.person.id_type

enum<string>

type of identity used

Available options:

ssn,

passport,

other

Example:

"ssn"

data.person.id_number

string

if id_type is ssn, id_number must be full SSN
if id_type is passport, id_number must be passport number
if id_type is other, id_number must be unique number of the id

id_number must be unique, as in, you cannot use the same id_number for two different persons

Example:

"945678934"

data.person.date_of_birth

string

date of birth of the person (YYYY-MM-DD)

Example:

"1974-01-01"

data.person.phone

string

phone number of the person (E.164, max 16 chars, starts with +)

Example:

"+19418405843"

data.person.email

string

email of the person

Example:

"jane.doe@gmail.com"

data.person.address

object

data.person.kyc

object

data.person.idv

object

data.business

object

data.business.legal_name

string

legal name of the business

Example:

"Ace LLC"

data.business.dba

string

doing business as

Example:

"Ace Inc"

data.business.entity_type

enum<string>

entity type of the business

Available options:

sole_proprietor,

single_member_llc,

limited_liability_company,

general_partnership,

unlisted_corporation,

publicly_traded_corporation,

association,

non_profit,

government_organization,

revocable_trust,

irrevocable_trust,

estate,

professional_association,

limited_partnership,

limited_liability_partnership,

professional_corporation

Example:

"limited_liability_company"

data.business.id_type

enum<string>

type of the business identity used

Available options:

ein,

other

Example:

"ein"

data.business.id_number

string

if id_type is ssn, id_number must be full SSN
if id_type is ein, id_number must be ein number
if id_type is other, id_number must be unique number of the id

id_number must be unique, as in, you cannot use the same id_number for two different businesses

Example:

"187654321"

data.business.phone

string

phone number of the business (E.164, max 16 chars, starts with +)

Example:

"16604491146"

data.business.email

string

email of the business

Example:

"support@ace.com"

data.business.formation_date

string

date business was formed (YYYY-MM-DD)

Example:

"2018-02-18"

data.business.address

object

data.business.kyb

object

data.business.members

object[]

data.business.members.first_name

string

first name of the person

Example:

"Jane"

data.business.members.middle_name

string

middle name of the person

Example:

"Jack"

data.business.members.last_name

string

last name of the person

Example:

"Doe"

data.business.members.id_type

enum<string>

type of identity used

Available options:

ssn,

passport,

other

Example:

"ssn"

data.business.members.id_number

string

if id_type is ssn, id_number must be full SSN
if id_type is passport, id_number must be passport number
if id_type is other, id_number must be unique number of the id

id_number must be unique, as in, you cannot use the same id_number for two different persons

Example:

"945678934"

data.business.members.date_of_birth

string

date of birth of the person (YYYY-MM-DD)

Example:

"1974-01-01"

data.business.members.phone

string

phone number of the person (E.164, max 16 chars, starts with +)

Example:

"+19418405843"

data.business.members.email

string

email of the person

Example:

"jane.doe@gmail.com"

data.business.members.address

object

data.business.members.ownership

number

ownership percentage in the business

Example:

50.59

data.business.members.title

string

title of the member in the business

Example:

"CEO"

data.business.members.control_person

enum<string>

true if this member is the control person of the business

Available options:

true,

false

Example:

"true"

data.business.members.kyc

object

data.intra_account

object

data.ach

object

data.domestic_wire

object

data.international_wire

object

data.international_wire.account_number

string

bank account number of the counterparty

Example:

"920020006167511"

data.international_wire.beneficiary_bank

object

data.international_wire.correspondent_bank

object

data.rtp

object

data.fednow

object

data.check

object

data.debit_card

object

data.purpose

string

purpose of counterparty

Example:

"Offshore dev center"

data.external_reference_id

string

unique id to cross-reference records with external systems

Example:

"TW-9L1L2-UVV"

data.ofac

object

data.attachments

object[]

data.metadata

object

Metadata takes free-form key-value pairs. You may send metadata when you create an object (POST) and when updating the object (PATCH). If you would like to remove metadata that is already on an object, you can unset it by passing in the key-value pair with an empty string, like this: {"key": ""}

data.status

enum<string>

status of counterparty

Available options:

pending_activation,

activated,

suspended,

deactivated,

locked

Example:

"activated"

data.timestamps

object

has_more

enum<string>

if there are more records to iterate or not

Available options:

true,

false

Example:

"true"

starting_after

string

Example:

"Y2xpXzAxOGY4NjEzMDEyYjdlNTFiOTZjNmVlYWJiNmRiZTky"

ending_before

string

Example:

"Y2xpXzAxOGY4NjEzMDEyYjdlNTFiOTZjNmVlYWJiNmRiZTky"

Update a Sub Account Create a Counterparty

curl --request GET \
  --url https://api.sandbox.solidfi.com/v2/payments/counterparty \
  --header 'api-key: <api-key>'

{
  "total": 1,
  "data": [
    {
      "value": {
        "id": "ctp_8e5541c8a9e50c3af3b0daacf9175130",
        "client_id": "cli_64c6c87ee9d609f36a6f390dc378a4ce",
        "master_account_holder_id": "mah_201e02c581a098a740456c5c19fcfcd6",
        "master_account_id": "mas_743fa071316bc6beaf5dddfd05f49c30",
        "sub_account_holder_id": "sah_5ccfeef0adf0cbe2aa0980d2c9505752",
        "sub_account_id": "sub_bda1e562657c41e553104b10aad3fe70",
        "label": "Development Vendor",
        "type": "person",
        "person": {
          "first_name": "John",
          "last_name": "Doe",
          "id_type": "ssn",
          "id_number": "223902234",
          "date_of_birth": "1974-01-25",
          "phone": "+19418405843",
          "email": "john.doe@gmail.com",
          "address": {
            "line1": "123 Main St",
            "line2": "",
            "city": "New York",
            "state": "NY",
            "country": "US",
            "postal_code": "10001"
          }
        },
        "intra_account": {
          "sub_account_number": "95483674098723",
          "sub_account_id": "sub_cda1e562657c41e553104b10aad3fe70"
        },
        "ach": {
          "account_number": "98324502",
          "routing_number": "121042882",
          "account_type": "business_checking",
          "bank_name": "Wells Fargo",
          "verification_status": "pass"
        },
        "domestic_wire": {
          "account_number": "98324502",
          "routing_number": "121042882",
          "account_type": "business_checking",
          "bank_name": "Wells Fargo"
        },
        "international_wire": {
          "account_number": "920020006167511",
          "beneficiary_bank": {
            "identifier_code": "ICICINBBNRI",
            "name": "ICICI Bank",
            "address": {
              "line1": "256 Main St",
              "line2": "",
              "city": "Bengaluru",
              "state": "KA",
              "country": "IN",
              "postal_code": "900009"
            }
          },
          "correspondent_bank": {
            "identifier_code": "SCBLUS33XXX",
            "name": "STANDARD CHARTERED BANK",
            "address": {
              "line1": "1095 12th Ave",
              "line2": "",
              "city": "New York",
              "state": "NY",
              "country": "US",
              "postal_code": "10001"
            }
          }
        },
        "rtp": {
          "account_number": "98324502",
          "routing_number": "121042882",
          "account_type": "business_checking",
          "bank_name": "Wells Fargo",
          "verification_status": "pass"
        },
        "fednow": {
          "account_number": "98324502",
          "routing_number": "121042882",
          "account_type": "business_checking",
          "bank_name": "Wells Fargo",
          "verification_status": "pass"
        },
        "check": {
          "address": {
            "line1": "123 Main St",
            "line2": "",
            "city": "New York",
            "state": "NY",
            "country": "US",
            "postal_code": "10001"
          }
        },
        "debit_card": {
          "card_number": "tok_live_6GVyHuQR7aAjCZivYzLbuP_9990",
          "last4": "9990",
          "expiry_month": "10",
          "expiry_year": "2024",
          "cvv": "tok_live_6GVyHuQR7aAjCZivYzLbuP_9990",
          "address": {
            "line1": "123 Main St",
            "line2": "",
            "city": "New York",
            "state": "NY",
            "country": "US",
            "postal_code": "10001"
          },
          "pull_enabled": true,
          "push_enabled": true
        },
        "purpose": "Offshore dev center",
        "external_reference_id": "TW-9L1L2-UVV",
        "ofac": {
          "status": "pass",
          "last_updated_at": "2024-04-01T21:00:00Z"
        },
        "attachments": [
          {
            "label": "Dev Contract",
            "id": "att_a8d2b191fa0e960d8e49a4bfd320e07b",
            "created_at": "2024-04-01T21:00:00Z"
          }
        ],
        "metadata": {
          "vendor_id": "VID-0987ACR"
        },
        "status": "activated",
        "timestamps": {
          "created_at": "2024-04-01T21:00:00Z",
          "updated_at": "2024-04-01T21:00:00Z"
        }
      }
    }
  ],
  "has_more": "true",
  "starting_after": "Y2xpXzAxOGY4NjEzMDEyYjdlNTFiOTZjNmVlYWJiNmRiZTky",
  "ending_before": "Y2xpXzAxOGY4NjEzMDEyYjdlNTFiOTZjNmVlYWJiNmRiZTky"
}

Getting Started

Master Accounts

Sub Account Holders

Sub Accounts

Counterparties

Card Holders

Cards

Transactions

Attachments

Webhooks

Simulation

List all Counterparties

Headers

Query Parameters

Response