---
updatedAt: 2026-07-28T19:43:09.000Z
---

Fetch the complete documentation index at: https://developers.pismo.io/pismo-docs/llms.txt. Use this file to discover all available pages before exploring further.

# Withdraw money

Withdraw amount from an account.

This endpoint generates the following events.
- [Interest withdrawal succeeded](https://developers.pismo.io/events/docs/interest-engine-interest-withdrawal-success-1) when withdrawal operation succeeds
- [Interest withdrawal failed](https://developers.pismo.io/events/docs/interest-engine-interest-withdrawal-failure-1) when withdrawal operation fails

For more information, refer to the [Interest-bearing accounts](doc:interest-bearing-accounts) guide.


# OpenAPI definition

```json
{
  "openapi": "3.1.0",
  "info": {
    "title": "Banking - Interest operations",
    "version": "1.0.0",
    "description": "API to handle interest bearing account operations",
    "contact": {
      "name": "API Support",
      "url": "https://developers.pismolabs.io/pismo-docs/docs/support"
    },
    "license": {
      "name": "Copyright Pismo"
    }
  },
  "servers": [
    {
      "url": "https://sandbox.pismolabs.io/interest-engine",
      "description": "Sandbox API server for integration"
    }
  ],
  "tags": [
    {
      "name": "Interest engine",
      "description": "Endpoints for handling interest bearing account operations"
    }
  ],
  "components": {
    "parameters": {
      "Authorization": {
        "name": "authorization",
        "in": "header",
        "description": "Authorization",
        "required": true,
        "example": "Bearer <access-token>",
        "schema": {
          "type": "string"
        }
      },
      "ContentType": {
        "name": "content-type",
        "in": "header",
        "description": "Content type",
        "required": true,
        "example": "application/json",
        "schema": {
          "type": "string"
        }
      },
      "XProgramId": {
        "name": "x-program-id",
        "in": "header",
        "description": "Program ID",
        "required": true,
        "example": "1233",
        "schema": {
          "type": "string"
        }
      },
      "XTenant": {
        "name": "x-tenant",
        "in": "header",
        "description": "Tenant (organization) ID",
        "required": true,
        "example": "1",
        "schema": {
          "type": "string"
        }
      },
      "XCid": {
        "name": "x-cid",
        "in": "header",
        "description": "Correlation ID",
        "required": true,
        "example": "8f3a1...e5f60",
        "schema": {
          "type": "string"
        }
      }
    },
    "schemas": {
      "AccountId": {
        "type": "string",
        "format": "number",
        "description": "Account ID",
        "example": "15001"
      },
      "DepositAmount": {
        "type": "number",
        "format": "double",
        "exclusiveMinimum": 0,
        "description": "Amount to be deposited",
        "example": 550.35
      },
      "ErrorResponse": {
        "type": "object",
        "description": "Standard error payload generated by the global exception handler.\n`message` is a single string for most errors and an array of strings when multiple bean-validation or request-binding errors occur in the same request.\n",
        "additionalProperties": false,
        "required": [
          "message"
        ],
        "properties": {
          "message": {
            "oneOf": [
              {
                "type": "string"
              },
              {
                "type": "array",
                "items": {
                  "type": "string"
                }
              }
            ]
          }
        },
        "example": {
          "message": "interest account not found"
        }
      },
      "InterestWithdrawalRequest": {
        "title": "InterestWithdrawalRequest",
        "type": "object",
        "properties": {
          "tracking_id": {
            "$ref": "#/components/schemas/TrackingId"
          },
          "account_id": {
            "$ref": "#/components/schemas/AccountId"
          },
          "amount": {
            "$ref": "#/components/schemas/DepositAmount"
          },
          "withdrawal_date": {
            "$ref": "#/components/schemas/WithdrawalDate"
          },
          "metadata": {
            "$ref": "#/components/schemas/Metadata"
          }
        },
        "required": [
          "tracking_id",
          "account_id",
          "amount",
          "withdrawal_date"
        ],
        "example": {
          "tracking_id": "41dee125-0876-4505-80cd-947cb6049789",
          "account_id": "123000",
          "amount": 5365.5,
          "withdrawal_date": "2024-01-15"
        }
      },
      "InterestWithdrawalResponse": {
        "title": "InterestWithdralResponse",
        "type": "object",
        "properties": {
          "tracking_id": {
            "$ref": "#/components/schemas/TrackingId"
          }
        },
        "required": [
          "tracking_id"
        ]
      },
      "Metadata": {
        "type": "object",
        "additionalProperties": true,
        "description": "Free-form key-value metadata. The serialized JSON must not exceed 4096 bytes.",
        "example": {
          "key": "value"
        }
      },
      "TrackingId": {
        "type": "string",
        "format": "UUID",
        "minLength": 36,
        "maxLength": 36,
        "description": "Tracking ID for the operation to ensure idempotence. Must be an alphanumeric UUID with the alphabetical characters in lowercase.",
        "example": "07d84f79-3027-47bd-b628-65528ccc8fb2"
      },
      "WithdrawalDate": {
        "type": "string",
        "format": "date",
        "description": "Deposit date. Format = YYYY-MM-DD.",
        "example": "2024-04-15"
      }
    },
    "securitySchemes": {
      "BearerAuth": {
        "type": "http",
        "scheme": "bearer",
        "bearerFormat": "JWT"
      }
    },
    "responses": {
      "400BadRequest": {
        "description": "Bad request",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/ErrorResponse"
            },
            "examples": {
              "validation": {
                "summary": "Bean validation or binding errors",
                "value": {
                  "message": [
                    "fixed_interest_rate must be informed",
                    "margin_rate must be positive"
                  ]
                }
              },
              "requestBody": {
                "summary": "invalid or missing request value",
                "value": {
                  "message": "Failed to process your request. Validate the fields in your request."
                }
              },
              "tenantHeader": {
                "summary": "Tenant header missing or malformed",
                "value": {
                  "message": "x-tenant header is missing or malformed"
                }
              }
            }
          }
        }
      },
      "401Unauthorized": {
        "description": "Unauthorized access",
        "content": {
          "application/json": {
            "schema": {
              "properties": {
                "message": {
                  "type": "string",
                  "example": "You cannot access this resource"
                }
              }
            }
          }
        }
      },
      "404NotFound": {
        "description": "Not found",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/ErrorResponse"
            },
            "examples": {
              "interestAccountNotFound": {
                "summary": "Interest account not found",
                "value": {
                  "message": "interest account not found"
                }
              },
              "interestPlanNotFound": {
                "summary": "Interest plan not found",
                "value": {
                  "message": "Interest plan not found"
                }
              },
              "benchmarkNotFound": {
                "summary": "Benchmark not found",
                "value": {
                  "message": "benchmark not found"
                }
              }
            }
          }
        }
      },
      "500InternalServerError": {
        "description": "Internal server error",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/ErrorResponse"
            },
            "example": {
              "message": "Failed to process your request"
            }
          }
        }
      }
    }
  },
  "security": [
    {
      "BearerAuth": []
    }
  ],
  "paths": {
    "/v1/interest/withdrawal": {
      "post": {
        "summary": "Withdraw money",
        "description": "Withdraw amount from an account.\n\nThis endpoint generates the following events.\n- [Interest withdrawal succeeded](https://developers.pismo.io/events/docs/interest-engine-interest-withdrawal-success-1) when withdrawal operation succeeds\n- [Interest withdrawal failed](https://developers.pismo.io/events/docs/interest-engine-interest-withdrawal-failure-1) when withdrawal operation fails\n\nFor more information, refer to the [Interest-bearing accounts](https://developers.pismo.io/pismo-docs/docs/interest-bearing-accounts) guide.\n",
        "tags": [
          "Interest engine"
        ],
        "operationId": "post-v1-interest-withdrawal",
        "parameters": [
          {
            "$ref": "#/components/parameters/XProgramId"
          },
          {
            "$ref": "#/components/parameters/XTenant"
          },
          {
            "$ref": "#/components/parameters/XCid"
          },
          {
            "$ref": "#/components/parameters/ContentType"
          },
          {
            "$ref": "#/components/parameters/Authorization"
          }
        ],
        "requestBody": {
          "description": "Requested body of authorization",
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/InterestWithdrawalRequest"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/InterestWithdrawalResponse"
                }
              }
            }
          },
          "400": {
            "$ref": "#/components/responses/400BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/401Unauthorized"
          },
          "404": {
            "$ref": "#/components/responses/404NotFound"
          },
          "500": {
            "$ref": "#/components/responses/500InternalServerError"
          }
        }
      }
    }
  }
}
```