POST
/
account
/
close
curl --request POST \
  --url https://devapi.withedge.co/gateway/api/v1/account/close \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'requestId: <requestid>' \
  --data '{
  "accountNumber": "<string>",
  "reason": "<string>",
  "close": true
}'
{
	"statusCode": 00,
	"message": "Account successfully closed",
	"data": {},
	"errors": []
}

​
Close/Re-Open Account

Use this endpoint to close or re-open a customer’s account by specifying the close parameter.

​
Additional Information

  • When the close field is passed as true, the account will be closed, updating the status to closed.
  • When the close field is passed as false, the account status will be reverted to active.

​
Request Parameters

​
requestId
string
required

A unique identifier for the request, used for idempotency.
Example: e0b9f8d0-7a57-4a67-a8b2-4d7c7b5a37c9

​
accountNumber
string
required

The customer’s account number.
Example: 5118745523

​
reason
string
required

The reason for the request.
Example: Customer requested account closure

​
close
boolean
required

Indicates the action to be taken on the account:

  • true: Close the account.
  • false: Re-open the account.
    Example: true
{
	"statusCode": 00,
	"message": "Account successfully closed",
	"data": {},
	"errors": []
}

Was this page helpful?

Sweep CollectionOverview