GET
/
v2
/
payments
/
counterparty
/
{counterparty_id}

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.

Path Parameters

counterparty_id
string
required

Response

200 - application/json
id
string

unique id of the counterparty

client_id
string

unique id of the client to which the counterparty belongs

master_account_holder_id
string

unique id of the master account holder

master_account_id
string

unique id of the master account

sub_account_holder_id
string

unique id of the sub account holder

sub_account_id
string

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

label
string

label of the counterparty

type
enum<string>

type of counterparty

Available options:
person,
business
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

external_reference_id
string

unique id to cross-reference records with external systems

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
timestamps
object
Create a CounterpartyUpdate a Counterparty