Design / Recipient Use Cases / Suspend or Unsuspend a Recipient

Suspend or Unsuspend a Recipient

Overview

In this use case, we’ll walk through suspending and unsuspending a Recipient Account.

A Recipient is a business or individual that you intend to conduct business with on the RocketKOR platform. A Recipient Account contains the recipient’s profile (name, contact information, and so on).

You can suspend a Recipient Account to make the account temporarily inactive, then unsuspend the account to make it active again. If a Recipient Account is suspended, the account’s Recipient Financial Accounts cannot be used in transactions.

API Operation

Suspend a Recipient

Steps

Send a request to the following endpoint:

PUT v1/recipients/{recipientId}

Include an Authorization header with your RocketKOR access token as a Bearer Token.
Use {recipientId} to specify the ID of the Recipient Account to be suspended or unsuspended.
In the request body, use the state parameter to suspend or unsuspend the account. To make an account inactive, set state to SUSPENDED. To reactivate a suspended account, set state to ACTIVE.

Sample Request

The following request would suspend a Recipient Account.

				
					{
  "state": "SUSPENDED"
}

Sample Response

If the suspend or unsuspend operation is successful, the Recipient Account details are returned. For details, see the Recipient object.

In the following example, notice that the account state has been updated to SUSPENDED.

				
					{
  "id": "6a017f06-83a3-44b7-be6f-5e5cae4a9ed7",
  "businessAccountId": "8th32z87-3845-9810-v7gu-1f827g98swk3",
  "businessRefId": "RECIP001",
  "firstName": "John",
  "middleName": "",
  "lastName": "Smith",
  "secondLastName": "",
  "email": "jsmith@xyz.com",
  "phoneNumber": "9055621258",
  "nationality": "Canadian",
  "dateOfBirth": "1970-07-08",
  "additionalInformation": "",
  "recipientType": "INDIVIDUAL",
  "businessName": "",
  "state": "SUSPENDED",
  "createdAt": "2021-07-08T20:56:35.219Z",
  "updatedAt": "2021-07-08T20:56:35.219Z",
  "requestorId": "9kj43t32-2956-2886-x7dy-6r821w39kra3"
}