PATCH
/
v2
/
accounts
/
sub_account
/
{sub_account_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

sub_account_id
string
required

Body

application/json
label
string
external_reference_id
string

unique id to cross-reference records with external systems

purpose
string

purpose of sub account

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 sub account

Available options:
open,
closed,
credit_blocked,
debit_blocked,
blocked

Response

200 - application/json
id
string

unique id of the sub account

client_id
string

unique id of the client that created the master account

master_account_holder_id
string

unique id of the master account holder

master_account_id
string

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

sub_account_holder_id
string

unique id of the sub account holder

sub_account_holder_name
string

sub account holder name

label
string

label of the sub account

type
enum<string>

type of the sub account

Available options:
cash,
prepaid,
checking
account_number
string

account number of the sub account

routing_number
string

9 digit routing number of the sub account

sponsor_bank
string

sponsor bank name

available_balance
string

available balance in the sub account

pending_credits
string

total pending credits to the sub account

pending_debits
string

total pending debits to the sub account

currency
enum<string>

currency of the sub account

Available options:
usd
external_reference_id
string

unique id to cross-reference records with external systems

purpose
string

purpose of sub account

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 sub account

Available options:
open,
closed,
credit_blocked,
debit_blocked,
blocked,
locked
timestamps
object