The Bank Account Summary object represents basic details for an external or integrated Financial Account that is linked to a bank account.
id
string (UUID)
ID of the Financial Account.
parentId
string (UUID)
ID of the Parent Financial 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 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.
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, 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.
bankAccount
object
Details for the bank account attached to the Financial Account. See the Bank Account object.
Bank Account Summary Object
{
"id": "1bb964b2-9825-46d8-ba77-ac64079bc72d",
"parentId": "",
"businessAccountId": "26b0ef39-72e9-4b0a-a183-9f1142083f03",
"name": "Checking Account",
"defaultFlag": false,
"currency": "USD",
"accountHolderId": "8eb2a485-c074-40ac-a6e4-7a49e442ce45",
"accountHolderType": "CUSTOMER",
"state": "ACTIVE",
"maskedAccountNumber": "******6790",
"createdAt": "2022-07-14T21:41:28.111137Z",
"updatedAt": "2022-07-14T21:41:28.111137Z",
"category": "EXTERNAL",
"type": "BANK",
"subtype": "CHECKING",
"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.