Skip to main content
POST
https://devapi.withedge.co/gateway/api/v1
/
account
/
bank
/
freeze
Freeze/Unfreeze Account
curl --request POST \
  --url https://devapi.withedge.co/gateway/api/v1/account/bank/freeze \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'requestId: <requestid>' \
  --data '
{
  "accountNumber": "<string>",
  "reason": "<string>",
  "freeze": true
}
'
{
	"statusCode": 00,
	"message": "Account successdully frozen",
	"data": {},
	"errors": []
}

​
Freeze/Unfreeze Account

Use this endpoint to freeze or unfreeze a customer’s account. The freeze field determines whether the account will be frozen or reverted to active status.

​
Additional Information

  • When the freeze field is passed as true, the account will be frozen, updating the status to inactive.
  • When the freeze 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 account number for which the freeze or unfreeze action is to be performed.
Example: 5118745523
​
reason
string
required
The reason for the freeze or unfreeze request.
Example: Suspicious activity detected
​
freeze
boolean
required
Indicates the action to be taken on the account:
  • true: Freeze the account.
  • false: Unfreeze the account.
    Example: true
{
	"statusCode": 00,
	"message": "Account successdully frozen",
	"data": {},
	"errors": []
}