RocketKOR

Introduction

Authentication

Sorting and Pagination

Errors

Bank Financial Account Object

The Bank Financial Account object represents a bank account Financial Account. A bank Financial Account can be linked to a Business Account or a Recipient Account.

Attributes

id

string (UUID)

Unique ID assigned to the Financial Account.

businessAccountId

string (UUID)

ID of the Business Account that owns the Financial Account.

recipientId

string (UUID)

ID of the Recipient 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 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 (account is active) and SUSPENDED (account is inactive). A Financial Account is ACTIVE when first created.

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

Type of account. Possible values are:

  • INTERNAL  RocketKOR Financial Acccounts
  • EXTERNAL  Bank and card accounts issued by a financial institution

bankAccount

object

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

The Bank Financial Account Object

				
					{
  "id": "8th32z87-3845-9810-v7gu-1f827g98swk3",
  "businessAccountId": "a1d8b427-d2b2-4711-bc10-f515366bb8d6",
  "recipientId": "32a16a41-54ee-435b-87d9-137fd30946b3",
  "name": "Checking",
  "defaultFlag": true,
  "currency": "USD",
  "state": "ACTIVE",
  "createdAt": "2022-06-02T19:03:00.964Z",
  "updatedAt": "2022-06-02T19:03:00.964Z",
  "accountType": "EXTERNAL",
  "bankAccount": {...}
}