Design / Financial Account Use Cases / Recipient / Suspend or Unsuspend a Recipient Financial Account

Suspend or Unsuspend a Recipient Financial Account

Overview

In this use case, we’ll walk through suspending and unsuspending a Recipient Financial Account. You can suspend a Financial Account to make the account temporarily inactive, then unsuspend the account to make it active again. This use case applies to both card and bank account Recipient Financial Accounts.

API Operations

Suspend a Recipient Financial Account

Unsuspend a Recipient Financial Account

Steps: Suspend a Recipient Financial Account

Send a request to the following endpoint:

PUT /v1/financial-accounts/{financialAccountId}/suspend

Include an Authorization header with your RocketKOR access token as a Bearer Token.
Use {financialAccountId} to specify the ID of the Financial Account to be suspended.
Request body is not required.

Steps: Unsuspend a Recipient Financial Account

Send a request to the following endpoint:

PUT /v1/financial-accounts/{financialAccountId}/unsuspend

Include an Authorization header with your RocketKOR access token as a Bearer Token.
Use {financialAccountId} to specify the ID of the Financial Account to be unsuspended.
Request body is not required.

Sample Response

If the suspend or unsuspend operation is successful, a 200 response is returned.

				
					{
  200 Financial Account suspended
}