Archive an external account

Archive an external account by the Helix-assigned externalAccountId.

🚧Warning

Archiving is permanent and cannot be undone.

ℹ️Info

Up to 3 external accounts per customer per day can be archived. This limit resets between 12:00 AM–5:00 AM in the corresponding time zone of the 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}.
Body Params
int32
required
≥ 1
int32
required
≥ 1
int32
≥ 1

The Helix-assigned unique ID for the individual customer requesting to archive the external account. Only used when an individual is archiving an external account on behalf of a business.

Responses

Language
Credentials
Basic
base64
:
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json