client/v1/customer/suspend
[POST] client/v1/customer/suspend
Suspend a customer's account
Sometimes it is necessary to suspend a customer's account for various security reasons. The suspend endpoint will allow client admin to control this status of a customer's account. A suspended account will be able to access statements, view balances, and view payment details. A suspended account will not be able to initiate or receive payments. A customer account will automatically be suspended if a return ACH payment is completed for that customer with one of the following return codes: R02, R03, R04, R05, R07, R08, R10, R11.
Example [POST] Request
{{avenu_base_url}}/client/v1/customer/suspend
{
"customerAccountNumber": "",
"suspend": true,
"reason": ""
}
Input Parameters
Parameter | Format | Required | Notes |
---|---|---|---|
"customerAccountNumber" | String | Y | Customer account number - indicates which customer account to suspend / unsuspend |
"suspend" | Boolean | Y | True or False, whether to suspend / unsuspend a customer |
"reason" | String | Y | Reason for suspension / unsuspension |
Example Response
{
"customerAccountNumber": "",
"status": "",
"reason": ""
}
Updated about 1 month ago