Skip to main content

Manage wallets

To manage a wallet lifecycle, use POST /ledger/v2/wallets/{walletId}/actions.

You can execute the following actions:

  • TERMINATE: Permanently terminates the wallet. This action cannot be reversed. The wallet balance must be zero (0) before termination. For fiat wallets, the linked ledgers are also closed, and the associated Virtual Account is removed. Crypto wallets do not use that mechanism.
  • BLOCK: Temporarily blocks a wallet and prevents activity.
  • UNBLOCK: Removes a previously applied block.

In the payload, specify the action value and include a non-empty comment describing why the action is being performed.

{
"action": "BLOCK",
"comment": "Temporarily blocked during compliance review."
}

If successful, the endpoint returns 204 No Content.

Common error scenarios:

  • 400 Bad Request: for example, if you attempt to run TERMINATE when the wallet has a non-zero balance.
  • 409 Conflict: for example, if you attempt to run BLOCK or UNBLOCK on a wallet that is already terminated.
Was this page helpful?