Skip to main content
POST
TypeScript

Authorizations

Authorization
string
header
required

A partner-scoped API key (trdrs_sk_…), issued to a trdrs Connect partner firm and accepted only under /api/partner/. Same format as the firm (tenant) key, different scope: a firm API key is refused here, and this key is refused everywhere else.

Body

application/json

PartnerBalanceOpRequest. One non-trading balance move. amount is positive, in account currency — op carries the direction (debit subtracts). referenceId is your idempotency handle: a duplicate answers 409 and moves nothing.

accountNumber
string
required

A firm-issued account number.

op
enum<string>
required
Available options:
credit,
debit,
adjustment
amount
number
required

Positive, in account currency (≤10000000). The op carries the sign.

referenceId
string
required

Your idempotency handle for this operation (≤80 chars).

comment
string

Optional audit note (≤300 chars), kept on the ledger row.

Response

Recorded and applied (PartnerBalanceOpResponse)

PartnerBalanceOpResponse. The operation was recorded on the ledger and the balance moved.

recorded
boolean
required
op
enum<string>
required
Available options:
credit,
debit,
adjustment
amount
number
required