Skip to main content
PUT
TypeScript

Authorizations

Authorization
string
header
required

The Venue key (trdrs_vk_sandbox_… or trdrs_vk_production_…), in preview. It belongs to one venue in one environment and carries the scopes it was created with. The venue's verified owner creates it while signed in. It works on the /api/partner/venues/{venueId} routes and, with trader:read or trader:trade, on the account, market and trading routes for the venue's own traders, each request naming its trader in x-trdrs-trader. A trdrs_sk_… key can't be used in its place. It never signs in, manages keys or reaches a trdrs user's accounts. Keep it on your server.

Headers

Idempotency-Key
string
required

A key you choose, 1 to 128 characters, that identifies this write. Send the same key when you retry it, so the write is never applied twice.

Required string length: 1 - 128

Path Parameters

venueId
string<uuid>
required

Body

application/json
enabled
boolean
required

True to show your Paper tile in your Connect.

openingBalance
integer
required

The balance in US dollars new Paper accounts open with.

Required range: 1000 <= x <= 10000000
expectedRevision
integer
required

The revision you read.

Required range: x >= 0

Response

Success. The response is sent with Cache-Control: no-store, so don't cache it.

paper
object
required

Paper in your Connect: trdrs's paper book under your name and logo. Each of your traders who opens it holds a paper account of their own on trdrs's terms, trading every product class trdrs's paper book offers from one US dollar balance.