Sign in

v1

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

Deposit money

Deposit amount into the specified account, and use a previously configured interest plan to calculate applicable interest rates.

This endpoint generates the following events.

The following events are applicable only to Brazil and are generated instead of the two events above when this endpoint is requested by a B3 (Brasil, Bolsa, Balcão) organization.

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

post/v1/interest/deposit

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.

account_idstring number required

Account ID

interest_plan_idstring UUID required

Interest plan ID generated during the plan's creation. Must be an alphanumeric UUID with the alphabetical characters in lowercase.

amountnumber double required

Amount to be deposited

value_datestring date required

Deposit date in YYYY-MM-DD format

maturity_datestring date required

Deposit maturity date in YYYY-MM-DD format

Example request

{
  "tracking_id": "41dee125-0876-4505-80cd-947cb6049789",
  "account_id": "123000",
  "interest_plan_id": "51dee125-0876-4505-80cd-947cb6049786",
  "amount": 5365.5,
  "value_date": "2024-01-15T00:00:00.000Z",
  "maturity_date": "2025-01-15T00:00:00.000Z",
  "has_asset_registration": {
    "document_number": "69230744018",
    "customer_name": "Lorem Ipsum",
    "customer_type": "NATURAL"
  }
}

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"
}