Skip to main content
POST
/
v1
/
static_qr
Create a Static QR
curl --request POST \
  --url https://api.hit-pay.com/v1/static_qr \
  --header 'Content-Type: application/json' \
  --header 'X-BUSINESS-API-KEY: <x-business-api-key>' \
  --data '
{
  "name": "<string>",
  "payment_provider_method": "paynow_online",
  "device_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "location_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "amount": 10.99,
  "currency": "sgd"
}
'
{
  "id": "<string>",
  "name": "<string>",
  "reference": "<string>",
  "payment_provider": "<string>",
  "payment_provider_method": "<string>",
  "amount": 123,
  "currency": "<string>",
  "payment_provider_method_logos": [
    {
      "sm": "<string>",
      "md": "<string>",
      "lg": "<string>",
      "svg": "<string>",
      "svg_square": "<string>",
      "png_square": "<string>",
      "method": "<string>",
      "iconName": "<string>",
      "displayName": "<string>"
    }
  ],
  "payment_provider_method_main_logo": {
    "sm": "<string>",
    "md": "<string>",
    "lg": "<string>",
    "svg": "<string>",
    "svg_square": "<string>",
    "png_square": "<string>",
    "method": "<string>",
    "iconName": "<string>",
    "displayName": "<string>"
  },
  "created_by": {
    "id": "<string>",
    "display_name": "<string>",
    "first_name": "<string>",
    "last_name": "<string>"
  },
  "location_id": "<string>",
  "location": {
    "name": "<string>",
    "address": "<string>"
  },
  "device_id": "<unknown>",
  "device": "<unknown>",
  "qr_value": "<string>",
  "created_at": "<string>",
  "updated_at": "<string>"
}

Headers

​
X-BUSINESS-API-KEY
string
required
Example:

"b286daabf9921b5a01a4621f026c111e046f8911feba212996c92159b98427d"

Body

application/json
​
name
string
required

Static QR name

Maximum string length: 255
​
payment_provider_method
enum<string>
required

The payment provider method that the static QR will use. The available methods: paynow_online, upi_qr, qrph_netbank

Available options:
paynow_online,
upi_qr,
qrph_netbank
​
device_id
string<uuid>

The device id that the static QR will use.

​
location_id
string<uuid>

The active location id that the static QR will use.

​
amount
number

The amount for static QR.

Required range: x >= 0
Example:

10.99

​
currency
string

The currency for static QR. It's required field if the amount is present.

Maximum string length: 3
Example:

"sgd"

Response

201 - application/json

201

​
id
string
required
​
name
string
required
​
reference
string
required
​
payment_provider
string
required
​
payment_provider_method
string
required
​
amount
number
required
​
currency
string
required
​
payment_provider_method_logos
object[]
required
​
created_by
object
required
​
location_id
string | null
required
​
location
object
required
​
device_id
any
required
​
device
any
required
​
qr_value
string
required
​
created_at
string
required
​
updated_at
string
required