Archive an external account

Archives an external account, meaning it can not be used in future transfers. An external account cannot be archived while it has pending transactions.


This is a one-way function; once an external account is archived, it cannot be "unarchived." Additionally, there is a limit of 3 external accounts that can be archived per customer, per day. This limit resets to 0 daily between midnight and 5:00 AM in the corresponding Time Zone of your Bank of Record.

Error Codes

Click to expand
CodeMessage (en-US)Notes
1-60000Any "Common Error Code" may occur.See Common Error Codes
62501Invalid external account id '{0}'.
62502Unable to deactivate an external account that is not in a Verified status.
62503Unable to deactivate an external account for a customer who has a pending
transaction or any account with a non-zero balance.
62505Unable to archive as there are outstanding transactions.
62506Unable to archive an external account whose status is {0}.
62618requestingCustomerId '{request.requestingCustomerId}' does not have permission to manage external accounts for customerId '{request.customerId}'
Click Try It! to start a request and see the response here!