RocketKOR

Internal Financial Account Summary Object

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

Attributes

id

string (UUID)

ID of the Financial Account.

parentId  

string (UUID)

ID of the Parent Business 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, max length: 100, min length: 1

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

defaultFlag

boolean, default: false

Whether this is the default Financial Account for transactions.

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  

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. A Financial Account is active when first created.
  • SUSPENDED  Financial Account is inactive. Inactive Financial Accounts cannot be used in transactions.

maskedAccountNumber

string

Masked account number for the bank account.

createdAt

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

Date and time the Financial Account was created.

updatedAt

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

Date and time the Financial Account was last updated.

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.

Internal Financial Account Summary Object

				
					{
  "id": "cac69d6d-66d7-49c3-8caa-2fde3b0beb44",
  "parentId": "4563ee45-446e-4c6e-83d8-2d5767614a5",
  "businessAccountId": "26b0ef39-72e9-4b0a-a183-9f1142083f03",
  "name": "Internal Checking Account",
  "defaultFlag": false,
  "currency": "USD",
  "accountHolderId": "8eb2a485-c074-40ac-a6e4-7a49e442ce45",
  "accountHolderType": "CUSTOMER",
  "state": "ACTIVE",
  "maskedAccountNumber": "******1454",
  "createdAt": "2022-07-14T21:41:28.111137Z",
  "updatedAt": "2022-07-14T21:41:28.111137Z",
  "category": "INTERNAL",
  "type": "BANK",
  "subtype": "CHECKING"
}