GET STARTED

RECIPIENT

FINANCIAL ACCOUNT

PAYMENT REASON

TRANSACTION

NOTE

Remove a Recipient

Delete a Recipient Account. Once deleted, accounts cannot be retrieved.

Note  Instead of deleting an account, you can temporarily suspend the account.

Endpoint

PUT /api/external/recipients/{recipientId}

Authorization Header

Basic Auth  REQUIRED

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

Path Parameters

recipientId  REQUIRED

string (UUID)

ID of the Recipient Account to be deleted.

Request Body

state  REQUIRED

string enum, value: DELETED

Recipient Account state. Specify DELETED to delete the account.

Returns

Returns 200 OK if the Recipient Account is successfully deleted.

SAMPLE REQUEST

				
					{
  "state": "DELETED"
}
				
			

SAMPLE RESPONSE

				
					{
  200 OK
}