v1

latestOpenAPI 3.1.0Copyright Pismo2026-07-247702,7523.1 MB

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

x-program-idstring required

Program ID

content-typestring required

Content type

Authorizationstring required

Account token - an access token encoded with a Pismo account ID. Tokens can expire quickly, which can result in a "** 401 Unauthorized**" error.

account_idstring number required

Account ID

document_numberstring

Cardholder government document number. This can be from any document that identifies the cardholder such as a Tax ID, State ID, or driver's license.

external_account_cancellation_idstring required

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

{
  "account_id": "15001",
  "document_number": "7777888hh",
  "external_account_cancellation_id": "07d84f793027"
}

external_account_cancellation_idstring required

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

{
  "external_account_cancellation_id": "07d84f793027"
}