Card 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, value: EXTERNAL

Financial Account category. Value must be EXTERNAL.

type

string enum, value: CARD

Type of Financial Account. Value must be CARD.

subtype  

string enum, values: DEBIT, CREDIT, PREPAID

Type of card.

maskedAccountNumber

string

Masked card number for the issued card.

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.

card

object

Details for the card attached to the Financial Account. See the Card object.