Create an Internal Financial Account

Create a new internal Financial Account for a Customer. The internal Financial Account will use the same currency as the parent Business Financial Account.

Internal Financial Accounts are issued and managed by RocketKOR.

Endpoint

POST /v1/internal-financial-accounts

Authorization Header

Authorization: Bearer <access_token>

Request Body

name REQUIRED

string, max length: 100, min length: 1

Name for the Financial Account. This is an informal name used for the account in RocketKOR.

parentId REQUIRED

string (UUID)

ID of the parent Business Financial Account. The internal Financial Account will use the same currency as this account.

defaultFlag

boolean

default: false

Whether this is the default Financial Account for transactions. If set to true, defaultFlag will be set to false for the previous default Financial Account.

currency

string, max length: 3, min length: 3

default: USD

Currency of the Financial Account. Must be an ISO 4217 alpha 3-character currency code. RocketKOR supports USD and CAD currencies.

accountHolderId REQUIRED

string (UUID)

ID of the entity that owns the Financial Account. The account holder must be a Customer Account.

accountHolderType REQUIRED

string enum, value: CUSTOMER

Type of entity referenced by the accountHolderId field. Value must be CUSTOMER.

subtype

string enum, values: CHECKING, SAVING

Financial Account subtype. BANK accounts can have a subtype of CHECKING or SAVING.

Returns

Returns the Financial Account details, including a unique ID for the account. For details, see the Internal Financial Account object.

SAMPLE REQUEST

				
					{
  "name": "ABC Internal Account",
  "parentId": "4563ee45-446e-4c6e-83d8-2d5767614a5",
  "defaultFlag": false,
  "currency": "USD",
  "accountHolderId": "91365a4a-c040-4c37-bb8a-50f46edde48b",
  "accountHolderType": "CUSTOMER",
  "subtype": "CHECKING"
}

SAMPLE RESPONSE

				
					{
  "id": "4e8eebeb-b250-434e-b4c7-21d542a9ca64",
  "parentId": "4563ee45-446e-4c6e-83d8-2d5767614a5",
  "businessAccountId": "2af56dc3-63ff-4e86-ba5b-bf6d184a103c",
  "name": "ABC Internal Account",
  "defaultFlag": "false",
  "state": "ACTIVE",
  "currency": "USD",
  "category": "INTERNAL",
  "type": "BANK",
  "subtype": "CHECKING",
  "maskedAccountNumber": "******6790",
  "accountHolderId": "91365a4a-c040-4c37-bb8a-50f46edde48b",
  "accountHolderType": "CUSTOMER",
  "createdAt": "2022-12-28T19:04:20.576Z",
  "updatedAt": "2022-12-28T19:04:20.576Z"
}