DocumentationAPI ReferenceRecipes
API Reference

Create Static QR Code

post
https://api.hips.com/v2/qrs

Creates a Static QR code for payment acceptance. Authentication Key Type: SalesChannelApiKey

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
🚧

Only use this API if you want to print your own QR stickers -OR- want to display the QR codes in a display.

If you have Hips QR stickers or any partners QR stickers; then you should NOT use this API.

Body Params

Creates a Static QR code for payment acceptance. Authentication Key Type: SalesChannelApiKey

int32
required
1 to 200

Please specify how many QR codes you want to create

boolean

Specifies if the generated QR codes shall be pre-mapped to the sales channel the API key belongs to. Pre-mapped codes has a max qty of 15

string

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

boolean

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

int32
60 to 3600
Defaults to 120

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.

int32
60 to 3600
Defaults to 300

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

string

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

string

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

string

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

string

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

string

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

string

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

string
enum

Text presets to show for customer.

Allowed:
int32
100 to 5000
Defaults to 500

Size in pixels of the generated QR code PNG

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:
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)

string

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

string

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

string

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

int32

Specify your system integrator ID if such is provided by Hips. Otherwise leave blank.

string

If you have a system integrator ID, you can use this field to add custom tokens/meta data to the QR code. Otherwise leave blank.

string

If you have a system integrator ID, you can use this field to add custom tokens/meta data to the QR code. Otherwise leave blank.

string

If you have a system integrator ID, you can use this field to add custom tokens/meta data to the QR code. Otherwise leave blank.

string

If you have a system integrator ID, you can use this field to add custom tokens/meta data to the QR code. Otherwise leave blank.

Responses

Updated about 1 year ago

Language
Credentials
Basic
base64
:
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 1 year ago