Add a Bank Account

Add an external bank account for a Customer or Recipient.

Endpoint

POST /v1/external-bank-accounts

Authorization Header

Authorization: Bearer <access_token>

Request Body

name REQUIRED

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. If set to true, defaultFlag will be set to false for the previous default Financial Account.

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.

accountHolderId REQUIRED

string (UUID)

ID of the entity that owns the Financial Account. The account holder can be a Customer or Recipient.

accountHolderType REQUIRED

string enum, values: CUSTOMER, RECIPIENT

Type of entity referenced by the accountHolderId field.

subtype REQUIRED

string enum, values: CHECKING, SAVING

Financial Account subtype. BANK accounts can have a subtype of CHECKING or SAVING.

bankAccount REQUIRED

object

Details for the bank account attached to the Financial Account.

bankName

string

Name of the financial institution.

nameOnAccount

string, max length: 40, min length: 1

Name of the bank account owner.

accountNumber REQUIRED

string, max length: 20

Bank account number.

routingNo REQUIRED

string, max length: 9

Routing number for the financial institution.

businessName

string, max length: 40, min length: 1

Business name as it appears on the bank account.

Returns

Returns the Financial Account details, including a unique ID for the account. For details, see the Bank Financial Account object.

SAMPLE REQUEST

				
					{
  "name": "Checking",
  "defaultFlag": true,
  "currency": "USD",
  "accountHolderId": "91365a4a-c040-4c37-bb8a-50f46edde48b",
  "accountHolderType": "CUSTOMER",
  "subtype": "CHECKING",
  "bankAccount": {
    "bankName": "CitiBank",
    "nameOnAccount": "Mark Strong",
    "accountNumber": "89674523",
    "routingNo": "321171184",
    "businessName": "GLOBAL"
  }
}

SAMPLE RESPONSE

				
					{
  "id": "8th32z87-3845-9810-v7gu-1f827g98swk3",
  "parentId": "",
  "businessAccountId": "a1d8b427-d2b2-4711-bc10-f515366bb8d6",
  "name": "Checking",
  "defaultFlag": true,
  "state": "ACTIVE",
  "currency": "USD",
  "category": "EXTERNAL",
  "type": "BANK",
  "subtype": "CHECKING",
  "maskedAccountNumber": "******4523",
  "accountHolderId": "91365a4a-c040-4c37-bb8a-50f46edde48b",
  "accountHolderType": "CUSTOMER",
  "createdAt": "2022-06-02T19:03:00.964Z",
  "updatedAt": "2022-06-02T19:03:00.964Z",
  "bankAccount": {
    "bankName": "CitiBank",
    "nameOnAccount": "Mark Strong",
    "accountNumberTail": "4523",
    "routingNo": "321171184",
    "businessName": "GLOBAL"
  }
}