GET
/
v2
/
payments
/
counterparty
/
{counterparty_id}
Retrieve a Counterparty
curl --request GET \
  --url https://api.sandbox.solidfi.com/v2/payments/counterparty/{counterparty_id} \
  --header 'api-key: <api-key>'
{
  "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"
  }
}

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}}"

Path Parameters

​
counterparty_id
string
required

Response

Retrieve a Counterparty

​
id
string

unique id of the counterparty

Example:

"ctp_8e5541c8a9e50c3af3b0daacf9175130"

​
client_id
string

unique id of the client to which the counterparty belongs

Example:

"cli_64c6c87ee9d609f36a6f390dc378a4ce"

​
master_account_holder_id
string

unique id of the master account holder

Example:

"mah_201e02c581a098a740456c5c19fcfcd6"

​
master_account_id
string

unique id of the master account

Example:

"mas_743fa071316bc6beaf5dddfd05f49c30"

​
sub_account_holder_id
string

unique id of the sub account holder

Example:

"sah_5ccfeef0adf0cbe2aa0980d2c9505752"

​
sub_account_id
string

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

Example:

"sub_bda1e562657c41e553104b10aad3fe70"

​
label
string

label of the counterparty

Example:

"Development Vendor"

​
type
enum<string>

type of counterparty

Available options:
person,
business
Example:

"person"

​
person
object
​
business
object
​
intra_account
object
​
ach
object
​
domestic_wire
object
​
international_wire
object
​
rtp
object
​
fednow
object
​
check
object
​
debit_card
object
​
purpose
string

purpose of counterparty

Example:

"Offshore dev center"

​
external_reference_id
string

unique id to cross-reference records with external systems

Example:

"TW-9L1L2-UVV"

​
ofac
object
​
attachments
object[]
​
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": ""}

​
status
enum<string>

status of counterparty

Available options:
pending_activation,
activated,
suspended,
deactivated,
locked
Example:

"activated"

​
timestamps
object