RocketKOR

Introduction

Authentication

Sorting and Pagination

Errors

Create a Recipient Bank Account

Create a bank account Financial Account for a Recipient Account.

Endpoint

POST /recipients/{recipientId}/financial-accounts/bank-accounts

Authorization Header

Authorization: Bearer <access_token>

where <access_token> is your RocketKOR access token.

Path Parameters

recipientId  REQUIRED

string (UUID)

Recipient Account ID. The Financial Account will be created for this Recipient Account.

Request Body

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. If set to true, defaultFlag will be set to false for the recipient’s 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.

bankAccount  REQUIRED

object

Details for the bank account attached to the Financial Account.

type  REQUIRED

string enum, values: CHECKING, SAVING

Type of bank account.

bankName

string

Name of the financial institution.

routingNo  REQUIRED

string, max length: 9

Routing number for the financial institution.

accountNumber  REQUIRED

string, max length: 20

Bank account number.

nameOnAccount

string, max length: 40, min length: 1

Name of the bank account owner.

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",
  "bankAccount": {
    "type": "CHECKING",
    "bankName": "CitiBank",
    "routingNo": "321171184",
    "accountNumber": "89674523",
    "nameOnAccount": "Mark Strong",
    "businessName": "GLOBAL"
  }
}
				
			

SAMPLE RESPONSE

				
					{
  "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": {
    "type": "CHECKING",
    "bankName": "CitiBank",
    "routingNo": "321171184",
    "accountNumber": "89674523",
    "nameOnAccount": "Mark Strong",
    "businessName": "GLOBAL"
  }
}