INTRODUCTION

RECIPIENT USE CASES

FINANCIAL ACCOUNT USE CASES

PAYMENT REASON USE CASES

TRANSACTION USE CASES

NOTE USE CASES

Design  /  Financial Account Use Cases  /  Remove a Recipient Financial Account

Remove a Recipient Financial Account

Overview

In this use case, we’ll walk through permanently deleting a Recipient Financial Account. This use case applies to both card and bank account Recipient Financial Accounts.

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

API Operations

Steps

Send a request to the following endpoint:

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

  • Use the {financialAccountId} path parameter to specify the ID of the Financial 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 Financial Account.

				
					{
  "state": "DELETED"
}
				
			

Sample Response

If the Recipient Account is successfully deleted, 200 OK is returned.
				
					{
   200 OK
}
				
			
ON THIS PAGE