Skip to main content

POS API

API Docs (Production)

important

For full OpenAPI reference and live testing, see https://api.blikk.tech/pos/docs.

Service Purpose​

This API powers Blikk's Point-of-sale systems integrations with various POS system providers. Provides endpoints for creating payments with items, cancelling payments, and creating refunds.

Contact​

For implementation help or questions, contact hello@blikk.tech

Endpoints​

Production environment​

URL: https://api.blikk.tech/pos

Staging environment​

URL: https://stage.blikk.tech/pos
API-Key: Please contact Blikk for the API key
Pos-Id: any value will work for our staging environment
tip

You can pick whatever Pos-Id you want when creating a new payment on our staging environment. The payment that you create will then be available either via the QR-code you receive in response to the creation POST request or via the following URL https://stage.app.blikk.tech/payment?type=pos&id=<Pos-Id>.

caution

On our production environment the Pos-Id is equally important as your API key. It is used to identify the terminal that is making the request and must be a valid value.

Status Lifecycle​

StatusRecommended Translation
DRAFTSkannaðu Blikk QR kóðann til að ganga frá greiðslu
PENDINGBeðið eftir heimild…
SCA_REQUIREDBeðið eftir heimild…
SCA_COMPLETEBeðið eftir heimild…
SUCCESSGreiðsla tókst
ERRORVilla við greiðslu
REJECTEDVilla við greiðslu
CANCELLEDHætt var við greiðslu

Payment Item Model​

FieldDescription
idstring Unique id for this item
namestring The name of the product being sold
quantityint How many products of this item is being sold
unitPricestring The unit price of item
vatstring The percentage of the VAT on this product (e.g. 24)
skustring The product's SKU.
upcstring The product's UPC.
descriptionstring All additional details on product

Security Notes​

Keep credentials server-side only. Do not embed API keys in frontend code, mobile binaries, logs, screenshots, or support tickets.