Create a shop (API token, merchant:write)

POST /v1/integration/merchants

Error

A valid request URL is required to generate request examples

200

{
  "merchant": {
    "id": "<string>",
    "name": "<string>",
    "geo": "<string>",
    "currency": "<string>",
    "discoverable": true,
    "imageUrl": "<string>"
  },
  "existing": true
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

name · string · required

geo · string · required

currency · string · required

checkout · enum<string>

Available options: api, hosted

checkoutUrl · string

allowedSchemes · string[]

feeBearer · enum<string>

Available options: buyer, merchant

taxRateBps · integer

externalRef · string

YOUR stable id for this shop. Makes creation IDEMPOTENT: a repeat POST with the same externalRef returns the existing shop (200) instead of creating a duplicate. Recommended for every integrator.

Response

200

application/json

Default Response

merchant · object · required

Show child attributes

existing · boolean