JUjustifi
Sub Accounts

List Sub Accounts

List the sub accounts for your platform. This endpoint supports pagination. Note: By default, all sub accounts which are not archived will be returned. To list archived sub accounts, use the optional status parameter set to archived

get/sub_accounts

Request

Query parameters

status'created' | 'submitted' | 'information_needed' | 'rejected' | 'enabled' | 'disabled' | 'archived'

Return accounts with specific status

business_idstring

Filter accounts associated with a business record

Headers

Authorizationstring required

the access_token value returned from the JustiFi oauth/token endpoint (be sure to append Bearer before the token)

Response

Successfully list sub accounts

idnumber

the object id

typestring

the object type, or array of objects

Example response

{
  "id": 1,
  "type": "array",
  "data": [
    {
      "id": "acc_xyz",
      "name": "The Shire Haberdashery",
      "account_type": "live",
      "status": "enabled",
      "currency": "usd",
      "platform_account_id": "acc_xyz",
      "payout_account_id": "ba_xyz",
      "business_id": "biz_xyz",
      "related_accounts": {
        "live_account_id": "acc_xyz",
        "test_account_id": "acc_xyz"
      },
      "payments_activated_on": "2021-01-15T12:00:00Z",
      "created_at": "2021-01-01T12:00:00Z",
      "updated_at": "2021-01-01T12:00:00Z"
    }
  ],
  "page_info": {
    "end_cursor": "WyIyMDIyLTAyLTA4IDE5OjUyOjM3LjEwNDE3MzAwMCIsIjY4MDliYTU5LTYxYjctNDg3MS05YWFiLWE2Y2MyNmY3M2M1ZCJd",
    "start_cursor": "WyIyMDIyLTAyLTA4IDIwOjAxOjU4LjEyMDIzMjAwMCIsIjU5ZTFjNGI1LWFlOWQtNDIyZC04MTVkLWNjNzQ5NzdlYmFjYSJd"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.