client/v1/customer/close

[POST] client/v1/customer/close

Close customer account

Sometimes it is necessary to close a customer's account for various reasons. The close endpoint allows client admin to close a customer's account permanently. A closed account will be able to access statements, view balances, and view payment details. A closed account will not be able to send and receive payments. In order to close a customer account the account balance must be 0. Once customer account has been closed it cannot be reopened - the customer will have to create a new account.

Example [POST] Request

{{avenu_base_url}}/client/v1/customer/close

{
    "customerAccountNumber": "",
    "close": "",
    "reason": "" 
}

Input Parameters

Parameter	Format	Required	Notes
"customerAccountNumber"	String	Y	Customer account number - indicates which customer account to close
"close"	Boolean	Y	Only accepts "true", and once closed the account cannot be reopened
"reason"	String	Y	Reason for closing the account

Example Response

{
    "customerAccountNumber": "",
    "status": "",
    "reason": ""
}