The Bank Financial Account object represents an external or integrated Financial Account that is linked to a bank account.
id
string (UUID)
ID of the Financial 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, values: EXTERNAL, INTEGRATED
Financial Account category. The following values are supported:
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.
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.
state
string enum, values: ACTIVE, SUSPENDED
Current status of the Financial Account. The following values are supported:
maskedAccountNumber
string
Masked account number for the bank account.
createdBy
object
Entity that created the Financial Account.
id
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:
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.
id
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:
updatedAt
string (date-time), 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. See the Bank Account object.
Bank Financial Account Object
{
"id": "8th32z87-3845-9810-v7gu-1f827g98swk3",
"businessAccountId": "a1d8b427-d2b2-4711-bc10-f515366bb8d6",
"name": "Checking",
"category": "EXTERNAL",
"type": "BANK",
"subtype": "CHECKING",
"defaultFlag": true,
"currency": "USD",
"maskedAccountNumber": "******6790",
"accountHolderId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"accountHolderType": "CUSTOMER",
"state": "ACTIVE",
"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",
"bankAccount": {...}
}
Step into the future of Finance with RocketKOR! Simplify payments, banking, lending, and data analytics using our versatile KOR Platform.
A Rocket Financial Inc. company
@ 2023 RocketKOR, Inc. All rights reserved.