This is a one-way function; once a customer is archived, it cannot be "unarchived."
Archives a customer. Before performing this action, consider the following and contact your Helix client success manager (CSM) for details on specific use cases or implementation guidance:
When closing a Helix account and transferring the remaining balance to an external account (particularly during bulk account closures), avoid immediately archiving the customer. If the external account is closed and funds are returned, a transaction to an archived customer with a closed account may cause downstream processing issues for your program.
Best practice: Maintain the customer as active for an ample period following account closure, giving consideration a closing transaction may be returned. This allows any returned funds to be properly processed, after which they can be easily transferred using either the Helix Admin Console or the Helix API.
Error Codes
Click to expand
| Code | Message (en-US) | Notes |
|---|---|---|
| 1-60000 | Any "Common Error Code" may occur. | See Common Error Codes |
| 60001 | Customer id {0} is invalid. | |
| 67201 | One or more pending transactions exist. e.g. TransactionId={0}. | |
| 67202 | One or more accounts have a non-zero balance. e.g. AccountId={0}. | |
| 67203 | One or more accounts are not in a Closed status. e.g. AccountId={0}. | |
| 67204 | One or more cards are still active for CustomerId={0}. Those must first be archived. e.g. CardId={0}. |