POS terminals

Generate a POS payment QR code

Generates a QR code that a customer scans with their phone to open a Kashier hosted payment page for the order, instead of presenting a card at the terminal. The response carries the QR image as a data URI. The request must be signed with a Kashier-Hash header or it is rejected with 403. The generated payment link is created in EGP.

post/v3/payment/pos/qr

Request

  • Base URL: https://test-api.kashier.io
  • URL: https://test-api.kashier.io/v3/payment/pos/qr
  • Auth: API key in header Authorization

Headers

Kashier-Hashstring required

Order hash generated from your backend using the HMAC SHA256 crypto mechanism, as described in the Kashier hashing documentation.

Request body

merchantIdstring

Merchant account number or merchant ID, e.g. YOUR_MID.

posTerminalstring

The terminal the QR is generated for.

metaDataobject

Extra key/value information to carry with the order.

newPaymentUIboolean

Open the generated link on the current payment page experience.

Response

The QR code was generated. qrUrl is a data URI holding the QR image.

qrUrlstring

The QR image as a data:image/png;base64 URI. Render it for the customer to scan.

statusstring
messagestring

Changes

No recorded changes to this operation across all 1 revision of this API.