Bank Financial Account Object

id

string (UUID)

Unique ID assigned to the Financial Account.

parentId

string (UUID)

ID of the parent Business Financial Account.

businessAccountId

string (UUID)

ID of the Business Account that owns 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.

state

string enum, values: ACTIVE, SUSPENDED

Current status of the Financial Account. Possible values are:

• 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.

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.

category

string, values: INTERNAL, EXTERNAL, INTEGRATED

Financial Account category. Possible values are:

• INTERNAL  A Financial Account that is issued and managed by RocketKOR.
• EXTERNAL  A Financial Account that is issued and managed by a financial institution.
• INTEGRATED  A Financial Account that resides inside a financial institution. The Financial Account may be managed by RocketKOR and/or the financial institution.

type

string enum, values: BANK

Type of Financial Account.

subtype

string enum, values: CHECKING, SAVING

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

maskedAccountNumber

string

Masked account number for the bank account.

accountHolderId

string (UUID)

ID of the entity that owns the Financial Account. The account holder can be a Customer or Recipient.

accountHolderType

string enum, values: CUSTOMER, RECIPIENT

Type of entity referenced by the accountHolderId field.

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.

bankAccount

object

Details for the bank account attached to the Financial Account. For details, see the Bank Account object.