Credit Financial Account Object

The Credit Financial Account object represents the Financial Account used as the credit account (receiver of the funds) for a transaction. The Financial Account may be a card account or a bank account.

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.

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.

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.

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.

accountType

string enum, values: INTERNAL, EXTERNAL, INTEGRATED

Type of account. The following values are supported:

INTERNAL A Financial Account that is issued and managed by RocketKOR.
EXTERNAL A Financial Account that is issued and managed by a financial institution.
INTEGRATED A Financial Account that resides inside a financial institution. The Financial Account may be managed by RocketKOR and/or the financial institution.

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.

card

object

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

bankAccount

object

Details for the bank account attached to the Financial Account. See the Bank Account object.

Credit Financial Account Object

				
					{
  "creditFinancialAccount": {
    "id": "4py56a34-4686-1539-c2ga-1a723g55dlq3",
    "businessAccountId": "4hy47a98-2453-9867-u3qa-5p347q98kim4",
    "name": "Savings",
    "defaultFlag": true,
    "currency": "USD",
    "state": "ACTIVE",
    "createdBy": {
      "id": "b6333b53-3222-4227-a71e-718b25ca3ea4",
      "type": "service-account"
    },
    "createdAt": "2021-07-08T21:10:51.610Z",
    "updatedBy": {
      "id": "b6333b53-3222-4227-a71e-718b25ca3ea4",
      "type": "service-account"
    },
    "updatedAt": "2021-07-09T21:10:51.610Z",
    "accountType": "EXTERNAL",
    "accountHolderId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "accountHolderType": "RECIPIENT",
    "card": {...},
    "bankAccount": {...}
  }
}