GET STARTED

RECIPIENT

FINANCIAL ACCOUNT

PAYMENT REASON

TRANSACTION

NOTE

Create a Recipient Bank Account

Create a bank account Financial Account for a Recipient Account.

Endpoint

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

Authorization Header

Basic Auth  REQUIRED

username is your API key ID and password is your API key secret.

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: 40, min length: 0

Name for the Financial Account.

defaultFlag

boolean (true, false)

Whether this the default Financial Account for transactions.

bankAccount  REQUIRED

object

Details for the bank account.

type  REQUIRED

string enum, values: CHECKING, SAVING

Type of bank account.

businessName

string

Business name as it appears on the bank account.

bankName

string

Name of the financial institution.

routingNo  REQUIRED

string

Routing number for the financial institution.

nameOnAccount

string

Name of the bank account owner.

accountNumber  REQUIRED

string

Bank account number.

Returns

Returns the Financial Account details, including a unique ID for the account. The request body and the following fields are returned.

accountId

string (UUID)

ID of the account that owns the Financial Account. This could be a Recipient Account or a Business Account.

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.

financialInstitutionId

string (UUID)

Unique ID for the financial institution. This is an internal ID used by RocketKOR.

financialInstitutionName

string, max length: 40, min length: 0

Name of the financial institution for the bank account.

ledgerIds

array of strings (UUID)

Accounting ledgers associated with the Financial Account.

bankAccount  

object

Details for the bank account.

id

string (UUID)

Unique ID assigned to the bank account.

token

string (UUID)

Random alphanumeric token for the bank account details.

accountNumberTail

string

Last 4 digits of the bank account number.

SAMPLE REQUEST

				
					{
  "name": "Checking",
  "defaultFlag": true,
  "bankAccount": {
    "type": "CHECKING",
    "businessName": "GLOBAL",
    "bankName": "CitiBank",
    "routingNo": "321171184",
    "nameOnAccount": "Mark Strong",
    "accountNumber": "89674523"
  }
}
				
			

SAMPLE RESPONSE

				
					{
  "name": "Checking",
  "accountId": "6a017f06-83a3-44b7-be6f-5e5cae4a9ed7",
  "defaultFlag": true,
  "state": "ACTIVE",
  "financialInstitutionId": "4py56a34-4686-1539-c2ga-1a723g55dlq3",
  "financialInstitutionName": "CitiBank",
  "ledgerIds": [
    "3fa85f64-5717-4562-b3fc-2c963f66afa6"
  ],
  "bankAccount": {
    "id": "8th32z87-3845-9810-v7gu-1f827g98swk3",
    "token": "7wu45p35-2178-3098-x6wg-2s749k37alk2",
    "type": "CHECKING",
    "businessName": "GLOBAL",
    "bankName": "CitiBank",
    "routingNo": "321171184",
    "nameOnAccount": "Mark Strong",
    "accountNumberTail": "4523"
  }
}