Interest engine

Cancel account

Cancel all operations for the specified account, and withdraw the remaining balance.

This endpoint generates the following events.

Interest account cancellation succeeded when account cancellation operation succeeds
Interest account cancellation failed when account cancellation fails

For more information, refer to the Interest-bearing accounts guide.

post/v1/interest/account/cancellation

Request

Base URL
https://sandbox.pismolabs.io/interest-engine
URL
https://sandbox.pismolabs.io/interest-engine/v1/interest/account/cancellation
Auth
HTTP bearer

Headers

content-typestring required

Content type

authorizationstring required

Authorization

Request body

account_idstring number required

Account ID. Must be between 1 and 64.

external_account_cancellation_idstring required

External ID managed and used by requester to track the account cancellation request

external_account_idstring

External account ID managed by the requester

metadataMetadata

Free-form key-value metadata. The serialized JSON must not exceed 4096 bytes.

Example request

{
  "account_id": "15001",
  "external_account_cancellation_id": "07d84f793027",
  "external_account_id": "4141",
  "metadata": {
    "key": "value"
  }
}

Response