Interest engine

Deposit money

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

This endpoint generates the following events.

Interest deposit succeeded when deposit operation succeeds
Interest deposit failed when deposit operation fails

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.

Interest registration succeeded when deposit operation succeeds
Interest registration failed when deposit operation fails

The optional field external_account_id is only returned in the response and included in the events when present in the request.

The division fields division_id and division_code are included in the events only when a non-default division is provided. They are omitted when division_id is DEFAULT_DIVISION or the value is null.

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

post/v1/interest/deposit

Request

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

Headers

content-typestring required

Content type

authorizationstring required

Authorization

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. Must be between 1 and 64.

external_account_idstring

External account ID managed by the requester

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. Format = YYYY-MM-DD.

maturity_datestring date required

Deposit maturity date. Format = YYYY-MM-DD.

division_idstring

Division ID. When not provided, defaults to DEFAULT_DIVISION internally.

division_codestring

Optional division code. When provided, must be between 1 and 36 characters.

metadataMetadata

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

Example request

{
  "tracking_id": "41dee***************************9789",
  "account_id": "123000",
  "external_account_id": "4141",
  "interest_plan_id": "51dee***************************9786",
  "amount": 5365.5,
  "value_date": "2024-01-15",
  "maturity_date": "2025-01-15",
  "division_id": "123",
  "division_code": "DIV-001"
}

Response