PATCH
/
v2
/
accounts
/
sub_account
/
{sub_account_id}
curl --request PATCH \
  --url https://api.sandbox.solidfi.com/v2/accounts/sub_account/{sub_account_id} \
  --header 'Content-Type: application/json' \
  --header 'api-key: <api-key>' \
  --data '{
  "label": "Ace PayOps"
}'
{
  "id": "sub_bda1e562657c41e553104b10aad3fe70",
  "client_id": "cli_64c6c87ee9d609f36a6f390dc378a4ce",
  "master_account_holder_id": "mah_201e02c581a098a740456c5c19fcfcd6",
  "master_account_id": "mas_743fa071316bc6beaf5dddfd05f49c30",
  "sub_account_holder_id": "sah_5ccfeef0adf0cbe2aa0980d2c9505752",
  "sub_account_holder_name": "Ace LLC",
  "label": "Payments Account",
  "type": "cash",
  "available_balance": "0.00",
  "pending_credits": "0.00",
  "pending_debits": "0.00",
  "account_number": "9540861337293709",
  "routing_number": "123321123",
  "sponsor_bank": "Sponsor Bank",
  "currency": "usd",
  "external_reference_id": "XV-H27LGD-FX",
  "purpose": "Sub account to pay offshore dev team",
  "attachments": [
    {
      "label": "contract",
      "id": "att_a8d2b191fa0e960d8e49a4bfd320e07b",
      "created_at": "2024-04-01T21:00:00Z"
    }
  ],
  "metadata": {
    "master_account_code": "001"
  },
  "status": "open",
  "timestamps": {
    "created_at": "2024-04-01T21:00:00Z",
    "updated_at": "2024-04-02T21:00:00Z",
    "deactivated_at": "2024-04-03T21: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

​
sub_account_id
string
required

Body

application/json
​
label
string
Example:

"Ace PayOps"

​
external_reference_id
string

unique id to cross-reference records with external systems

Example:

"XVH-27LGDFX"

​
purpose
string

purpose of sub account

Example:

"Sub account to pay offshore dev team"

​
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
Example:

"open"

Response

200
application/json
Update a Sub Account
​
id
string

unique id of the sub account

Example:

"sub_bda1e562657c41e553104b10aad3fe70"

​
client_id
string

unique id of the client that created the master account

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 under which the sub account was created

Example:

"mas_743fa071316bc6beaf5dddfd05f49c30"

​
sub_account_holder_id
string

unique id of the sub account holder

Example:

"sah_5ccfeef0adf0cbe2aa0980d2c9505752"

​
sub_account_holder_name
string

sub account holder name

Example:

"Ace LLC"

​
label
string

label of the sub account

Example:

"Ace payments"

​
type
enum<string>

type of the sub account

Available options:
cash,
prepaid,
checking
Example:

"cash"

​
account_number
string

account number of the sub account

Example:

"9540861337293709"

​
routing_number
string

9 digit routing number of the sub account

Example:

"123206972"

​
sponsor_bank
string

sponsor bank name

Example:

"Lewis and Clark Bank"

​
available_balance
string

available balance in the sub account

Example:

"0.00"

​
pending_credits
string

total pending credits to the sub account

Example:

"0.00"

​
pending_debits
string

total pending debits to the sub account

Example:

"0.00"

​
currency
enum<string>

currency of the sub account

Available options:
usd
Example:

"usd"

​
external_reference_id
string

unique id to cross-reference records with external systems

Example:

"XVH-27LGDFX"

​
purpose
string

purpose of sub account

Example:

"Sub account to pay offshore dev team"

​
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
Example:

"open"

​
timestamps
object