Design / Recipient Use Cases / Remove a Recipient Account

Remove a Recipient Account

Overview

In this use case, we’ll walk through permanently deleting a Recipient Account.

Important Be careful when deleting accounts. Once deleted, accounts cannot be retrieved. Instead of deleting an account, you can temporarily suspend the account.

API Operation

Remove Recipient Account

Steps

Send a request to the following endpoint:

PUT /api/external/recipients/{recipientId}

Use the {recipientId} path parameter to specify the ID of the Recipient Account to be deleted.
In the request body, set the state parameter to DELETED.
Include a Basic Auth Authorization header where the username is your API key ID and the password is your API key secret.

Sample Request

The following request would delete a Recipient Account.

				
					{
  "state": "DELETED"
}

Sample Response

If the Recipient Account is successfully deleted, 200 OK is returned.