Skip to main content
PATCH
/
v2
/
accounts
/
sub_account
/
{sub_account_id}
Update a Sub Account
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
Example:

Path Parameters

​
sub_account_id
string
required

Body

application/json
​
label
string
Example:
​
external_reference_id
string
Example:
​
purpose
string
Example:
​
metadata
object
​
status
enum<string>
Available options:
open,
closed,
credit_blocked,
debit_blocked,
blocked
Example:

Response

​
id
string
Example:
​
client_id
string
Example:
​
master_account_holder_id
string
Example:
​
master_account_id
string
Example:
​
sub_account_holder_id
string
Example:
​
sub_account_holder_name
string
Example:
​
label
string
Example:
​
type
enum<string>
Available options:
cash,
prepaid,
checking
Example:
​
account_number
string
Example:
​
routing_number
string
Example:
​
sponsor_bank
string
Example:
​
available_balance
string
Example:
​
pending_credits
string
Example:
​
pending_debits
string
Example:
​
currency
enum<string>
Available options:
usd
Example:
​
external_reference_id
string
Example:
​
purpose
string
Example:
​
attachments
object[]
​
metadata
object
​
status
enum<string>
Available options:
open,
closed,
credit_blocked,
debit_blocked,
blocked,
locked
Example:
​
timestamps
object