Connect a Static QR Code

patch

https://api.hips.com/v2/qrs/{code_token}

Connect a Static QR code to a sales channel for payment acceptance. Authentication Key Type: SalesChannelApiKey

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

code_token

string

required

Please specify the unique QR code token that identifies the QR code that you want to connect to the sales channel associated with used API keys.

Body Params

Connect a Static QR code to a sales channel for payment acceptance. Authentication Key Type: SalesChannelApiKey

qr_start_webhook_url

string

Webhook URL. This url will be posted to when the QR code is scanned by a customer.

allow_tip

boolean

Specifies if the generated QR codes shall accept and prompt for tipping by the customer. Maximum 20% markup on the original order value.

order_timeout_seconds

int32

60 to 3600

Timeout value in seconds for how long the customer maximum will have to wait from scanning a QR code to the Create Order API call occurs.

payment_timeout_seconds

int32

60 to 3600

Timeout value in seconds for how long the customer can wait to complete the payment of the order.

order_wait_text_local

string

Text in local language to show customer while they wait for create order, example: Please choose your product on the vending machine.

order_wait_text_english

string

Text in English to show customer while they wait for create order, example: Please choose your product on the vending machine.

order_wait_icon

string

Waiting icon to show the customer (FontAwesome 5) Example: fab fa-hips

order_timeout_text_local

string

Text in local language to show customer when session times out, example: Sorry, no connection to the machine, please call 12345.

order_timeout_text_english

string

Text in English to show customer while session times out, example: Sorry, no connection to the machine, please call 12345.

order_timeout_icon

string

Timeout icon to show the customer (FontAwesome 5) Example: fas fa-clock

customer_text_preset_type

string

enum

Text presets to show for customer.

Allowed:

qr_code_px_size

int32

100 to 5000

Defaults to 500

Size in pixels of the generated QR code PNG

status

string

enum

Set the status of the QR code. Example online it accept business at the QR code. Or offline to reject business when the QR is scanned.

Allowed:

qr_code_b64_png_generation

boolean

Set to true if you wish that a PNG of the QR shall be generated. Default false

asynchronous

boolean

Specifies if the generated QR codes shall accept more than one request at the same time. This is default set to false which requires a new request to complete before a new can be sent (recommended)

qr_checkout_image_uri

string

Image that should be visible at top of QR checkout page. Max height will be scaled down to 60px, recommended image height > 120px.

qr_checkout_background_color_hex

string

Specify checkout background color, in HEX, example: #ffffff for white.

qr_checkout_text_color_hex

string

Specify checkout text color, in HEX, example: #ffffff for white.

Responses

200Connect a Static QR code to a sales channel for payment acceptance. Authentication Key Type: SalesChannelApiKey

403Restricted

405Error connecting code