The Bank Financial Account object represents a Financial Account that is linked to a bank account. A bank Financial Account can be owned by a Business Account, Customer, or Recipient.
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:
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:
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.
Bank Financial Account Object
{
"id": "8th32z87-3845-9810-v7gu-1f827g98swk3",
"parentId": "",
"businessAccountId": "a1d8b427-d2b2-4711-bc10-f515366bb8d6",
"name": "Checking",
"defaultFlag": true,
"state": "ACTIVE",
"currency": "USD",
"category": "EXTERNAL",
"type": "BANK",
"subtype": "CHECKING",
"maskedAccountNumber": "******6790",
"accountHolderId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"accountHolderType": "CUSTOMER",
"createdAt": "2022-06-02T19:03:00.964Z",
"updatedAt": "2022-06-02T19:03:00.964Z",
"bankAccount": {...}
}
© 2022 Rocket Financial. All rights reserved. RocketFNCL, RocketKOR, RocketBNK are trade names of Rocket Financial Inc.
Services Agreement | Privacy Policy | RocketFNCL | © 2023 by Rocket Financial Inc. All rights reserved.
Services Agreement | Privacy Policy | RocketFNCL | © 2023 by Rocket Financial Inc. All rights reserved.
Services Agreement | Privacy Policy | RocketFNCL
© 2023 by Rocket Financial Inc. All rights reserved.