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.

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.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

Requested body of authorization

string
required
length between 36 and 36

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

string
required

Account ID

string
required
length between 36 and 36

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

double
required

Amount to be deposited

date
required

Deposit date. Format = YYYY-MM-DD.

date
required

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

string
length ≤ 64

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

metadata
object

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

Headers
string
required

Program ID

string
required

Tenant (organization) ID

string
required

Correlation ID

Responses

Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json