Deactivate Customer Account

The request deactivates a customer's account from your financial institution. Customer's accountNumber must be passed to the request body for deactivation.

PUT /api/account/v1/deactivate

You can also reactivate a customer's account. See Activate Customer API to reactivate the account.

Headers

Name
Value

Content-Type*

application/json

Authorization*

Bearer <token>

Request-Reference

{unique-reference}

Body

Name
Data Type (length)
Required
Description

accountNumber

string

Customer's account number

Here is an example request and response with a sample payload sent to the endpoint in Curl format.

Sample Request
curl --location -g --request PUT '{{baseurl}}/api/account/v1/deactivate' \
--header 'Content-Type: application/json' \
--header 'Authorization: bearer ' \
--header 'request-reference;' \
--data '{
  "accountNumber": "1000000637"
}'

Response

//request successful

Last updated