Bank Financial Account Object

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.

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.

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 enum, values: EXTERNAL, INTEGRATED

Financial Account category. The following values are supported:

• EXTERNAL  Linked to an account that is issued or managed by an outside financial institution. Can only be used for transactions initiated on RocketKOR, such as send and request. Example: A debit card or bank account issued by a financial institution.
• INTEGRATED  Linked to a third-party account at a third-party institution. Can be used for any type of transaction (send, request, deposit, withdrawal, internal transfer, and so on). Example: A debit card or bank account issued on RocketKOR.

type

string enum, value: BANK

Type of Financial Account. Value must be BANK.

subtype  

string enum, values: CHECKING, SAVING

Financial Account subtype.

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. See the Bank Account object.