Platitun · API · The deal · Put credentials into a vault

Put credentials into a vault

POST /api/v1/orders/{id}/handover

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

A vault is a way to pass a password so it does not stay in the chat forever. The content is encrypted, read once and wiped after a while. The marketplace does not read it.

Request fields

Field	Type	What it is
`secret` required	`string`	What the buyer is to receive.

Response fields

Field	Type	What it is
`handover`	`string`	The vault id.

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
`not_found`	The record does not exist or is not yours. The ownership condition is in the database query itself, so someone else’s record looks like a missing one.
`state_moved`	The order has already moved on: the buyer cancelled, the deadline passed, or the action was done another way. Re-read the order before retrying.
`empty`	Empty text. There is nothing to send.
`vault_off`	The marketplace vault is not configured, so there is nowhere to keep secrets. That is our problem, not yours: contact support.

Nearby in this section

GET /api/v1/orders — My orders
GET /api/v1/orders/{id} — One order
POST /api/v1/orders/{id}/confirm — Take the order
POST /api/v1/orders/{id}/decline — Decline the order
POST /api/v1/orders/{id}/deliver — Mark the delivery
POST /api/v1/orders/{id}/messages — Message the buyer
GET /api/v1/orders/{id}/handover — The order vaults
POST /api/v1/orders/{id}/handover/reveal — Read the buyer’s vault
POST /api/v1/orders/{id}/dispute/reply — Answer a dispute
GET /api/v1/reviews — Reviews about me
POST /api/v1/reviews/{id}/reply — Reply to a review
GET /api/v1/complaints — My complaints
POST /api/v1/complaints — Complain about a buyer
GET /api/v1/work-mode — Work mode and presence
PUT /api/v1/work-mode — Set the work mode