Savings Accounts

Map a business' main account to a savings account

Maps a business' savings account to its main (checking) account and then triggers the remaining steps for savings account onboarding. The business may only transfer money to and from their savings account using the main account mapped by this request.

post/v1/businesses/{business_id}/deposit_accounts/{account_id}/mappings

Path parameters

business_idstring required

Unique ID of a business.

account_idstring required

Unique ID of a Solaris account.

Request body

main_account_idstring required

ID of the main account.

deposit_type'SAVINGS_ACCOUNT' required

The account type.

referencestring uuid required

UUID to use as an idempotency reference for the transaction.

Example request

{
  "main_account_id": "148c29b85992b8772eb7ddd518490110cacc",
  "reference": "162ddd7e-790c-5963-908f-4cedfd30f9a1"
}

Response

The mapping was successfully created, and the savings account onboarding process has started.

idstring required

ID of the mapping between the main account and the savings account.

main_account_idstring required

ID of the main account.

status'OPENED' | 'TAX_REGISTERED' | 'ACTIVE' | 'INACTIVE' | 'FAILED'

The current status of the savings account.

deposit_type'SAVINGS_ACCOUNT' required

The account type.

referencestring uuid required

UUID to use as an idempotency reference for the transaction.

Example response

{
  "id": "d222a0b8-07ea-49be-83c1-68719be286e8",
  "main_account_id": "148c29b85992b8772eb7ddd518490110cacc",
  "reference": "162ddd7e-790c-5963-908f-4cedfd30f9a1"
}