Sign in

v1

latestOpenAPI 3.1.0Copyright Pismo2026-07-247702,7523.1 MB
Interest engine

Withdraw money

Withdraw amount from an account.

This endpoint generates the following events.

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

post/v1/interest/withdrawal

Headers

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.

Request body

tracking_idstring UUID required

Tracking ID for the operation to ensure idempotence. Must be an alphanumeric UUID with the alphabetical characters in lowercase.

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.

account_idstring number required

Account ID

amountnumber double required

Amount to be deposited

withdrawal_datestring date required

Deposit date. Format = YYYY-MM-DD.

Example request

{
  "tracking_id": "41dee125-0876-4505-80cd-947cb6049789",
  "document_number": "69230744018",
  "account_id": "123000",
  "amount": 5365.5,
  "withdrawal_date": "2024-01-15T00:00:00.000Z"
}

Response

OK

tracking_idstring UUID required

Tracking ID for the operation to ensure idempotence. Must be an alphanumeric UUID with the alphabetical characters in lowercase.

Example response

{
  "tracking_id": "07d84f79-3027-47bd-b628-65528ccc8fb2"
}