Platitun · API · Documents and payout details · The seller nickname

The seller nickname

PUT /api/v1/papers/nickname

Key scope: documents · changes data, the Idempotency-Key header is required

What the buyer sees you as. Letters of two alphabets, digits, hyphen and underscore, from three to twenty-four characters. A taken nickname is not given away.

Uniqueness is held by a database lock, not by a check before writing: two people pressing at once would both pass the check. That is why nick_taken can arrive even when the nickname was free a second ago.

Request fields

Field	Type	What it is
`nickname` required	`string`	The new nickname.

Response fields

Field	Type	What it is
`nickname`	`string`	What was recorded.

Refusal reasons

A rule refusal arrives as {"error":"rejected","refusal":{"kind":"…"}} with status 409. Refusals common to all endpoints are in the rules section.

Code	What happened and what to do
`nick_rule`	The nickname breaks the rule: letters of two alphabets, digits, hyphen and underscore, three to twenty-four characters.
`nick_taken`	The nickname is taken. Uniqueness is held by a database lock, so the refusal can arrive even when it was free a second ago.

Nearby in this section

GET /api/v1/papers — My seller admission
POST /api/v1/papers/offer — Accept the seller offer
PUT /api/v1/papers/status — Status and tax number
POST /api/v1/papers/registry-confirm — Confirm the name
PUT /api/v1/papers/payout — Payout details