Get subaccount by ID

View as Markdown
Retrieve detailed information about a specific subaccount, including current balance and virtual banking details. **Path Parameters** | Field | Type | Required | Description | |-------|------|----------|-------------| | `subaccount_id` | UUID | Yes | ID of the subaccount to retrieve | **Response Body** | Field | Type | Description | |-------|------|-------------| | `id` | UUID | Unique identifier of the subaccount | | `name` | String | Name of the subaccount | | `account_number` | String | Account number for deposits | | `routing_number` | String | Deprecated: use `routing_numbers.ach`. Kept for backward compatibility | | `routing_numbers` | Object | Routing numbers per rail | | `routing_numbers.ach` | String | ACH routing number for ACH transfers | | `routing_numbers.wire` | String | Wire routing number for wire transfers. For JPM VRNs with separate wire config, differs from ach. For other banks, same as ach. | | `total_incoming_in_minor_units` | Integer | Total incoming funds in the smallest unit of the account's currency (settled payins + incoming moves). For USD, this is cents. | | `total_outgoing_in_minor_units` | Integer | Total outgoing funds in the smallest unit of the account's currency (settled/debited payouts + outgoing moves). For USD, this is cents. | | `created_at` | DateTime | ISO 8601 timestamp when the subaccount was created | | `updated_at` | DateTime | ISO 8601 timestamp when the subaccount was last updated | **Balance Information** The subaccount tracks two key metrics: - **Total Incoming**: Sum of all settled pay-ins and incoming moves (funds added to the subaccount) - **Total Outgoing**: Sum of all settled/debited payouts and outgoing moves (funds removed from the subaccount) All amounts are in the smallest unit of the account's currency (for USD, cents — so 150000 = $1,500.00).

Authentication

x-api-keystring

RootPay API key sent in the x-api-key header. Keys are environment-scoped: live_* for production, test_* for sandbox.

Path parameters

subaccount_idstringRequiredformat: "uuid"
The ID of the subaccount to retrieve

Response

Subaccount retrieved successfully