Internal Financial Account Object

The Internal Financial Account object represents an internal Financial Account that has been created for a Customer Account.

Attributes

string (UUID)

ID assigned to the Financial Account.

parentId

string (UUID)

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

businessAccountId

string (UUID)

ID of the Business Account that contains the Financial Account.

name

string, min length: 1, max length: 100

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

category

string enum, value: INTERNAL

Financial Account category. Value must be INTERNAL.

type

string enum, value: BANK

Type of Financial Account. Value must be BANK.

subtype

string enum, values: CHECKING, SAVING

Financial Account subtype.

defaultFlag

boolean, default: false

Whether this is the default Financial Account for transactions.

currency

string, min length: 3, max length: 3, default value: USD

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

The internal account will use the same currency as the parent account.

accountHolderId

string (UUID)

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

accountHolderType

string enum, value: CUSTOMER

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

state

string enum, values: ACTIVE, SUSPENDED

Current status of the Financial Account. The following values are supported:

ACTIVE Financial Account is active.
PENDING Financial Account is being processed and is not yet active.
SUSPENDED Financial Account is inactive. Inactive Financial Accounts cannot be used in transactions.

maskedAccountNumber

string

Masked account number for the bank account.

createdBy

object

Entity that created the Financial Account.

string (UUID)

ID of the entity. Will be blank if createdBy.type is internal.

type

string enum, values: employee, service-account, internal

Type of entity. The following values are supported:

employee Team Member using the RocketKOR Portal.
service-account Service Account using APIs.
internal Internal service call.

createdAt

string (date-time), format: yyyy-MM-dd’T’HH:mm:ss.SSSz

Date and time the Financial Account was created.

updatedBy

object

Entity that last updated the Financial Account.

string (UUID)

ID of the entity. Will be blank if updatedBy.type is internal.

type

string enum, values: employee, service-account, internal

Type of entity. The following values are supported:

employee Team Member using the RocketKOR Portal.
service-account Service Account using APIs.
internal Internal service call.

updatedAt

string (date-time), format: yyyy-MM-dd’T’HH:mm:ss.SSSz

Date and time the Financial Account was last updated.

Internal Financial Account Object

				
					{
  "id": "6a46f27a-7bbc-4ba8-9e73-45c74139fd81",
  "parentId": "4563ee45-446e-4c6e-83d8-2d5767614a5",
  "businessAccountId": "2af56dc3-63ff-4e86-ba5b-bf6d184a103c",
  "name": "ABC Internal Account",
  "category": "INTERNAL",
  "type": "BANK",
  "subtype": "CHECKING",
  "defaultFlag": "false",
  "currency": "USD",
  "accountHolderId": "91365a4a-c040-4c37-bb8a-50f46edde48b",
  "accountHolderType": "CUSTOMER",
  "state": "ACTIVE",
  "maskedAccountNumber": "******6790",
  "createdBy": {
    "id": "59dff46b-03d3-449b-89bf-b8010770864f",
    "type": "employee"
  },
  "createdAt": "2021-09-20T22:09:31.947Z",
  "updatedBy": {
    "id": "59dff46b-03d3-449b-89bf-b8010770864f",
    "type": "employee"
  },
  "updatedAt": "2021-10-20T22:09:31.947Z"
}