Set up payment location.

Set up a new payment location or update an existing one. A paymentLocation is required either way. Having a registered payment location is a prerequisite for the POS system to create payments.

POST /v1/payment-locations/{paymentLocation}/setup

cURL

Regular POS payment location

curl --request POST \
  --url https://{host}/payment/v1/payment-locations/{paymentLocation}/setup \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "storeId": "1234",
  "force": false,
  "type": "Cashier"
}
'

200

{}

Authorizations

Authorization · string · header · required

JWT Authorization header using the Bearer scheme. Example: "Authorization: Bearer {token}"

Path Parameters

paymentLocation · string · required

Unique identifier of POS in payment service. Recommended pattern is '{storeId}_{posId}'.

Maximum string length: 128

Body

application/json

The payment location details

storeId · string · required

The store identifier

Required string length: 1 - 64

type · string · required

Payment location type

Minimum string length: 1

qrCode · string | null

The qr code assigned to the payment location

Maximum string length: 64

force · boolean

Allows to re-assign the qrCode if it's already assigned to another payment location

Response

200

application/json

OK

The response is of type object.