GET STARTED

RECIPIENT

FINANCIAL ACCOUNT

PAYMENT REASON

TRANSACTION

NOTE

Suspend a Recipient Bank Account

Suspend or unsuspend a bank account Recipient Financial Account. To make an account inactive, set state to SUSPENDED. To reactivate a suspended account, set state to ACTIVE.

Endpoint

POST /api/external/financial-accounts/{financialAccountId}

Authorization Header

Basic Auth  REQUIRED

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

Path Parameters

financialAccountId  REQUIRED

string (UUID)

ID of the Financial Account to be suspended or unsuspended.

Request Body

state  REQUIRED

string enum, values: SUSPENDED, ACTIVE

Recipient Account state. Possible values are SUSPENDED (make an account inactive) and ACTIVE (reactivate a suspended account).

Returns

Returns the Recipient Financial Account details. The following fields are returned.

name

string, max length: 40, min length: 0

Name for the Financial Account.

accountId

string (UUID)

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

defaultFlag

boolean (true, false)

Whether this the default Financial Account for transactions.

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.

type  

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  

string

Routing number for the financial institution.

nameOnAccount

string

Name of the bank account owner.

accountNumberTail

string

Last 4 digits of the bank account number.

SAMPLE REQUEST

				
					{
  "state": "SUSPENDED"
}
				
			

SAMPLE RESPONSE

				
					{
  "name": "Checking",
  "accountId": "6a017f06-83a3-44b7-be6f-5e5cae4a9ed7",
  "defaultFlag": true,
  "state": "SUSPENDED",
  "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"
  }
}