Create Payment Request

This endpoint creates a new payment request. This is the first step of the payment flow, once you have all the details from the user and are ready to collect payment use this API to create a payment request. Since this is a server-to-server communication, if you have a mobile or Web client that communicates with your REST API, you must have a new endpoint E.g. /create-order, or reuse an existing endpoint. This endpoint will be responsible for making the payment request API call to HitPay.

Headers

X-BUSINESS-API-KEY · string · required

Example:

"b286daabf9921b5a01a4621f026c111e046f8911feba212996c92159b98427d"

Body

application/json

amount · number · required

It's required field. Amount related to the payment. Example: 2500

Required range: 0.3 <= x <= 999999999.99

Example:

100

currency · string · required

It's required field. Currency related to the payment.

Maximum length: 3

Example:

"SGD"

payment_methods · string[]

They're available payment methods supported on your account.(Example: paynow_online , card, wechat, alipay, grabpay_direct, grabpay_paylater, shopee_pay ... etc.). If we don't pass, use the available methods

Example:

["card"]

email · string<email>

Buyer’s email

name · string

Buyer’s name

phone · string<phone>

Buyer’s phone number

wifi_terminal_id · string

It's terminal id and it's required if payment method is wifi_card_reader

staff_id · string<uuid>

It's active staff id from the dashboard

Example:

"98888a24-d6b2-430d-9063-d2be76d443cd"

location_id · string<uuid>

The active location belongs to business.

Example:

"9dd07721-d215-4947-9c79-2b8ec25f69db"

purpose · string

Purpose of the Payment request.

Maximum length: 255

reference_number · string

Arbitrary reference number that you can map to your internal reference number. This value cannot be edited by the customer

Maximum length: 255

redirect_url · string<uri>

URL where we redirect the user after a payment. Query arguments reference (payment request id) and status are sent along

Maximum length: 1028

Example:

"https://www.google.com"

webhook · string<uri>

URL where our server do POST request after a payment If done

Example:

"https://www.google.com"

allow_repeated_payments · enum<string> · default: false

If set to true, multiple payments can be paid on a payment request link. Default value is false

Available options:

true,

false

expiry_date · string

Time after which the payment link will be expired (time in SG with YYYY-MM-DD HH:mm:ss format). Applicable for repeated payments.

expires_after · string

E.g "30 mins" Other supported keys are "mins", "hours", "days"

Example:

"5 minutes"

add_admin_fee · enum<string> · default: false

If set to true, the admin fee will be included in total.

Available options:

true,

false

send_email · enum<string> · default: false

It's "true" or "false". If set to true, an email receipt will be sent to the customer after the payment is completed. Default is false

Available options:

true,

false

send_sms · enum<string> · default: true

It's "true" or "false". If set to "true", SMS will be sent to the customer after the payment is completed. Default is false

Available options:

true,

false

address · object

Show child attributes

generate_qr · boolean · default: false

Only valid for paynow_online, qrph_netbank, doku_qris and shopee_pay if generate_qr was true

Response

200

application/json

200

id · string

Example:

"974ee233-bc3e-4aac-a212-15af0d155133"

name · string

Example:

"Buyer_Name_1663650582"

email · string

Example:

"[e-mail]"

phone · string

Examples:

"[phone]"

amount · string

Examples:

"900"

currency · string

Example:

"SGD"

status · enum<string>

Available options:

pending,

completed,

failed,

expired,

canceled,

inactive

Example:

"pending"

purpose · string

Examples:

"Testing"

reference_number · string

Example:

"12345678"

payment_methods · string[]

Examples:

"card"

url · string

Example:

"https://securecheckout.sandbox.hit-pay.com/payment-request/@ban/974ee233-bc3e-4aac-a212-15af0d155133/checkout"

redirect_url · string

Example:

"https://hit-pay.postman.co/"

webhook · string

Example:

"https://hit-pay.postman.co/"

send_sms · boolean

send_email · boolean · default: true

Example:

true

sms_status · string

Example:

"pending"

email_status · string

Example:

"pending"

allow_repeated_payments · boolean · default: false

Example:

false

expiry_date · string

Example:

"2022-10-10T01:01:01"

created_at · string

Example:

"2022-09-20T13:09:42"

updated_at · string

Example:

"2022-09-20T13:09:42"

staff_id · string | null

Example:

"98888a69-2d7a-4695-811d-6df8cee30264"

business_location_id · string | null

Example:

"9dd07721-d215-4947-9c79-2b8ec25f69db"