Card Financial Account Object

The Card Financial Account object represents an external Financial Account that is linked to a card, such as a debit card or credit card.

Attributes

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, 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.

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:

ACTIVE Financial Account is active.
PENDING Financial Account is being processed and is not yet active.
SUSPENDED Financial Account is inactive. Inactive Financial Accounts cannot be used in transactions.

maskedAccountNumber

string

Masked card number for the issued card.

createdBy

object

Entity that created the Financial Account.

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:

employee Team Member using the RocketKOR Portal.
service-account Service Account using APIs.
internal Internal service call.

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.

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:

employee Team Member using the RocketKOR Portal.
service-account Service Account using APIs.
internal Internal service call.

updatedAt

string (date-time), 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.

Card Financial Account Object

				
					{
  "id": "6a017f06-83a3-44b7-be6f-5e5cae4a9ed7",
  "businessAccountId": "c937109c-6077-4b4e-8d28-c6768e3546c5",
  "name": "Debit Card",
  "category": "EXTERNAL",
  "type": "CARD",
  "subtype": "DEBIT",
  "defaultFlag": true,
  "currency": "USD",
  "accountHolderId": "8c8c5119-3abd-42e8-8b37-f8eaaa4afacb",
  "accountHolderType": "CUSTOMER",
  "state": "ACTIVE",
  "maskedAccountNumber": "******4242",
  "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",
  "card": {...}
}