Get a Counterparty
Get a Counterparty by id.
Authorizations
Token from POST /auth/token
Path Parameters
Counterparty ID (ctp_ prefix).
Response
The request has succeeded.
A third party a customer transacts with — an entry in the customer's address book. Counterparties will own External Accounts (registered payment destinations) in a later slice.
Registered address. Required since v0.11 — always present in responses.
Public TypeID, e.g. txn_01h455vb4pex5vsknk084sn02q; legacy UUID suffixes are accepted until non-v7 rows are retired.
^[a-z]+_([0-9a-hjkmnp-tv-z]{26}|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12})$counterparty Public TypeID, e.g. txn_01h455vb4pex5vsknk084sn02q; legacy UUID suffixes are accepted until non-v7 rows are retired.
^[a-z]+_([0-9a-hjkmnp-tv-z]{26}|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12})$Lifecycle of a counterparty. rejected is reserved for create-time
compliance screening (not yet active); deleted marks a soft-deleted
record that remains readable by id.
active, rejected, deleted Set when status = rejected.
Single-line display name, read-only and server-composed: businessName
for a business, or firstName + " " + lastName for an individual.
It is the same string that appears in party.name. Write the structured
fields; read this one.
Determines which structured name fields apply. Optional on reads only for rows created before v0.13 that have not been classified yet.
individual, business Given name — present when entityType is individual and the row has
structured name fields. Echoed back exactly as supplied.
Family name — present when entityType is individual and the row has
structured name fields. Echoed back exactly as supplied.
Registered legal name — present when entityType is business and the
row has structured name fields. Echoed back exactly as supplied.
ISO 3166-1 alpha-2.