Debit Financial Account Object

The Debit Financial Account object represents the Financial Account used as the debit account (source of the funds) for a transaction. The Financial Account may be a card-based account or a bank account.

Attributes

string (UUID)

Unique ID assigned to the Financial Account.

businessAccountId

string (UUID)

ID of the Business Account that owns the Financial Account.

name

string, max length: 100, min length: 1

Name for the Financial Account.

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.

state

string enum, values: ACTIVE, SUSPENDED

Current status of the Financial Account. Possible values are:

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.

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.

accountType

string enum, values: INTERNAL, EXTERNAL, INTEGRATED

Type of account. Possible values are:

INTERNAL A Financial Account issued and managed by RocketKOR, such as a Wallet.
EXTERNAL A bank or card account issued and managed by a financial institution.
INTEGRATED A bank or card account that resides inside a financial institution and is managed by RocketKOR.

accountHolderId REQUIRED

string (UUID)

ID of the entity that owns the Financial Account. Applies to EXTERNAL Financial Accounts owned by a Recipient or Customer.

accountHolderType

string enum, values: RECIPIENT, CUSTOMER

Type of entity referenced by the accountHolderId field. Applies to EXTERNAL Financial Accounts owned by a Recipient or Customer.

card

object

Details for the card attached to the Financial Account. For details, see the Card object.

bankAccount

object

Details for the bank account attached to the Financial Account. For details, see the Bank Account object.

Debit Financial Account Object

				
					{
  "debitFinancialAccount": {
    "id": "4py56a34-4686-1539-c2ga-1a723g55dlq3",
    "businessAccountId": "4hy47a98-2453-9867-u3qa-5p347q98kim4",
    "name": "Savings",
    "defaultFlag": true,
    "currency": "USD",
    "state": "ACTIVE",
    "createdAt": "2021-07-08T21:10:51.610Z",
    "updatedAt": "2021-07-08T21:10:51.610Z",
    "accountType": "EXTERNAL",
    "accountHolderId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "accountHolderType": "RECIPIENT",
    "card": {...},
    "bankAccount": {...}
  }
}