GET STARTED

RECIPIENT

FINANCIAL ACCOUNT

PAYMENT REASON

TRANSACTION

NOTE

Remove a Recipient Bank Account

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

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

Endpoint

POST /api/external/financial-accounts/{financialAccountId}

Authorization Header

Basic Auth  REQUIRED

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

Path Parameters

financialAccountId   REQUIRED

string (UUID)

ID of the Financial Account to be deleted.

Request Body

state  REQUIRED

string enum, value: DELETED

Financial Account state. Specify DELETED to delete the account.

Returns

Returns 200 OK if the Recipient Financial Account is successfully deleted.

SAMPLE REQUEST

				
					{
  "state": "DELETED"
}
				
			

SAMPLE RESPONSE

				
					{
  200 OK
}