Update a Counterparty

PATCH

payments

counterparty

{counterparty_id}

object

label

string

type

enum<string>

person

object

first_name

string

middle_name

string

last_name

string

id_type

enum<string>

id_number

string

date_of_birth

string

phone

string

address

object

line1

string

line2

string

city

string

state

string

country

string

postal_code

string

business

object

legal_name

string

dba

string

entity_type

enum<string>

id_type

enum<string>

id_number

string

phone

string

formation_date

string

members

array

intra_account

object

sub_account_number

string

sub_account_id

string

ach

object

account_number

string

routing_number

string

account_type

enum<string>

bank_name

string

verification_status

enum<string>

domestic_wire

object

account_number

string

routing_number

string

account_type

enum<string>

bank_name

string

international_wire

object

account_number

string

beneficiary_bank

object

identifier_code

string

name

string

address

object

line1

string

line2

string

city

string

state

string

country

string

postal_code

string

correspondent_bank

object

identifier_code

string

name

string

address

object

line1

string

line2

string

city

string

state

string

country

string

postal_code

string

rtp

object

account_number

string

routing_number

string

account_type

enum<string>

bank_name

string

verification_status

enum<string>

fednow

object

account_number

string

routing_number

string

account_type

enum<string>

bank_name

string

verification_status

enum<string>

check

object

address

object

line1

string

line2

string

city

string

state

string

country

string

postal_code

string

debit_card

object

card_number

string

last4

string

expiry_month

string

expiry_year

string

cvv

string

address

object

line1

string

line2

string

city

string

state

string

country

string

postal_code

string

pull_enabled

enum<string>

push_enabled

enum<string>

purpose

string

external_reference_id

string

metadata

object

status

enum<string>

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

Body

application/json

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

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

Response

200 - application/json

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

status

enum<string>

status of counterparty

Available options:

pending_activation,

activated,

suspended,

deactivated,

locked

timestamps

object

Retrieve a Counterparty Retrieve Bank Info

Getting Started

Master Accounts

Sub Account Holders

Sub Accounts

Counterparties

Card Holders

Cards

Transactions

Attachments

Webhooks

Simulation

Update a Counterparty

Headers

Path Parameters

Body

Response