Skip to navigation

Rename a subaccount

View as Markdown

Renames an existing subaccount by updating its display name.

Path Parameters

FieldTypeRequiredDescription
subaccount_idUUIDYesID of the subaccount to rename

Request Body

FieldTypeRequiredDescriptionValidation Rules
nameStringYesNew display name of the subaccountMust be between 1 and 100 characters

Response Body

FieldTypeDescription
idUUIDUnique identifier of the subaccount
nameStringUpdated subaccount name
account_numberStringAccount number for deposits
routing_numberStringDeprecated: use routing_numbers.ach. Kept for backward compatibility
routing_numbersObjectRouting numbers per rail
routing_numbers.achStringACH routing number for ACH transfers
routing_numbers.wireStringWire routing number for wire transfers
total_incoming_in_minor_unitsIntegerTotal incoming funds in the smallest unit of the account’s currency
total_outgoing_in_minor_unitsIntegerTotal outgoing funds in the smallest unit of the account’s currency
created_atDateTimeISO 8601 timestamp when the subaccount was created
updated_atDateTimeISO 8601 timestamp when the subaccount was last updated

Notes

  • Subaccount name values are allowed to duplicate within the same entity.
  • If name is unchanged, the endpoint is idempotent and returns 200 with the current subaccount state.

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 rename

Request

This endpoint expects an object.
namestringRequired1-100 characters
New display name of the subaccount

Response

Subaccount renamed successfully