Archive a customer

post

https://sandbox-api.helix.q2.com/customer/archive

Archive a customer by the Helix-assigned customerId.

🚧Warning
Archiving is permanent and cannot be undone.

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.

Body Params

customerId

int32

required

≥ 1

archiveReason

string

enum

Defaults to Other

FirstPartyFraud: When someone uses his/her own identity to obtain products and services with no intent to fulfill their payment obligation.
ThirdPartyFraud: When someone uses a stolen identity to commit fraud. Refers to fraud that is committed without the knowledge of the person whose identity is used to commit the fraud.
SyntheticIdFraud: When someone uses a possible combination of real and phony attributes, including possible real attributes that don’t correlate to each other, in order to assemble a phony identity. This information is then used to open fraudulent accounts and/or obtain goods and services.
AccountTakeoverFraud: When someone uses another person's account information to make purchases or withdraw money and often involves changing credentials and/or personal profile information.
NonActivity: Non-Activity.
BankDiscretion: Bank chose to archive for a non-fraud reason
Other: Default value. Providing a detailed reason is strongly encouraged as it informs and improves fraud detection mechanisms.

Responses

200A pared down customer object