RocketKOR

Introduction

Authentication

Sorting and Pagination

Errors

Suspend a Financial Account

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

Endpoint

PATCH /financial-accounts/{financialAccountId}

Authorization Header

Authorization: Bearer <access_token>

where <access_token> is your RocketKOR access token.

Path Parameters

financialAccountId  REQUIRED

string (UUID)

Financial Account ID.

Request Body

state  REQUIRED

string enum, values: ACTIVE, SUSPENDED

Current status of the Financial Account. Possible values are:

  • SUSPENDED  Suspend the Financial Account.
  • ACTIVE  Reactivate the Financial Account.

Returns

Returns the Financial Account details. The Card Financial Account object or Bank Financial Account object is returned, depending on whether the Financial Account is a card-based account or a bank account.

SAMPLE REQUEST

				
					{
  "state": "SUSPENDED"
}
				
			

SAMPLE RESPONSE

				
					{
  "id": "6a017f06-83a3-44b7-be6f-5e5cae4a9ed7",
  "businessAccountId": "3126c2cf-ea3a-4391-9261-4250a49dc7d3",
  "recipientId": "c6f9f46b-1244-475f-875b-aa0d3e11f68e",
  "name": "Debit Card",
  "defaultFlag": true,
  "currency": "USD",
  "state": "SUSPENDED",
  "createdAt": "2021-07-08T21:10:51.610Z",
  "updatedAt": "2021-07-08T21:10:51.610Z",
  "accountType": "EXTERNAL",
  "card": {
    "firstName": "Mark",
    "middleName": "David",
    "lastName": "Strong",
    "type": "DEBIT",
    "expiry": "2027-12",
    "billingAddress": {
      "addressLine1": "625 Queen St",
      "addressLine2": "",
      "addressLine3": "",
      "city": "Vancouver",
      "state": "BC",
      "country": "Canada",
      "postalCode": "V5K 0A1"
    },
    "cardNumber": "84563876999"
  }
}