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.

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 in YYYY-MM-DD format.

date
required

Deposit maturity date in YYYY-MM-DD format

has_asset_registration
object

Applicable only to Brazil. Contains information required for asset registration. When provided, all three fields are required: customer_name, customer_type, and document_name.

Headers
string
required

Program ID

string
required

Content type

string
required

Authorization

Responses

400

Bad request

401

Unauthorized

404

Not found

500

Internal server error

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