POST
Deposit funds

Authorizations

Authorization
string
header
required

The end user's JWT access token, sent as Authorization: Bearer <token>.

Obtain one from POST /partner/customers or POST /partner/customers/login — both return it as token. It identifies which of your users a call is made for, and is sent alongside your X-API-Key on every authenticated endpoint.

Event discovery, categories, subcategories and scores are public and need no token.

X-API-Key
string
header
required

ISV / partner credential — public half. Required on every request.

Identifies the integration partner (ISV) making the call. Issued by Dime Trades when the ISV is onboarded and sent on every /partner/* endpoint:

  • On the two partner endpoints that create accounts or issue tokens (POST /partner/customers, POST /partner/customers/login), it is accompanied by X-API-Secret and is the only authentication — there is no user token yet.
  • On every other partner endpoint it is sent alongside the user's Authorization: Bearer <token>: the API key says which platform is calling, the bearer token says which user it is calling for.

Credentials are scoped to one or more brands; using a key with a brandId outside that scope returns 403. Staging and production keys are separate. The key identifies your platform — treat it as a backend credential.

Body

application/json
amount
number
required

Amount to deposit in dollars (USD), max 2 decimal places — 100 is $100.00 and 25.50 is $25.50. Not cents. The response echoes the same figure as amountCents.

Example:

100

Response

Deposit accepted (pending).

data
WalletTxnAck · object

Acknowledgement returned by POST /wallet/deposit and POST /wallet/withdraw (DepositFundsService / WithdrawFundsService). Both publish a wallet event to Kafka and return pending — the matching engine settles it and the ledger consumer persists the balance change asynchronously; this response never reflects the confirmed balance.

Units differ between request and response. You send amount in dollars; this acknowledgement echoes amountCents in integer cents (amount × 100, rounded). They are the same money in different units — do not compare them, and do not feed amountCents back in as amount. See Conventions → Money and units.

errors
array