Payment Request

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.

POST

payment-requests

curl --request POST \
  --url https://api.sandbox.hit-pay.com/v1/payment-requests \
  --header 'Content-Type: application/json' \
  --header 'X-BUSINESS-API-KEY: <x-business-api-key>' \
  --data '{
  "amount": 100,
  "currency": "SGD",
  "payment_methods": [
    "<string>"
  ],
  "email": "jsmith@example.com",
  "name": "<string>",
  "phone": "<string>",
  "wifi_terminal_id": "<string>",
  "staff_id": "98888a24-d6b2-430d-9063-d2be76d443cd",
  "business_location_id": "9dd07721-d215-4947-9c79-2b8ec25f69db",
  "purpose": "<string>",
  "reference_number": "<string>",
  "redirect_url": "https://www.google.com",
  "webhook": "https://www.google.com",
  "allow_repeated_payments": "false",
  "expiry_date": "<string>",
  "expires_after": "5 minutes",
  "add_admin_fee": "false",
  "send_email": "false",
  "send_sms": "true",
  "address": {
    "line1": "<string>",
    "line2": "<string>",
    "city": "<string>",
    "country": "<string>",
    "state": "<string>",
    "postal_code": "<string>"
  },
  "generate_qr": false
}'

"{\n    \"id\": \"974ee233-bc3e-4aac-a212-15af0d155133\",\n    \"name\": \"Buyer_Name_1663650582\",\n    \"email\": \"buyer_1663650582@gmail.com\",\n    \"phone\": \"+6539393939\",\n    \"amount\": \"900,000.00\",\n    \"currency\": \"SGD\",\n    \"status\": \"pending\",\n    \"purpose\": \"Testing\",\n    \"reference_number\": \"12345678\",\n    \"payment_methods\": [\n        \"card\"\n    ],\n    \"url\": \"https://securecheckout.sandbox.hit-pay.com/payment-request/@ban/974ee233-bc3e-4aac-a212-15af0d155133/checkout\",\n    \"redirect_url\": \"https://hit-pay.postman.co/\",\n    \"webhook\": \"https://hit-pay.postman.co/\",\n    \"send_sms\": true,\n    \"send_email\": true,\n    \"sms_status\": \"pending\",\n    \"email_status\": \"pending\",\n    \"allow_repeated_payments\": false,\n    \"expiry_date\": \"2022-10-10T01:01:01\",\n    \"created_at\": \"2022-09-20T13:09:42\",\n    \"updated_at\": \"2022-09-20T13:09:42\"\n}"

Headers

X-BUSINESS-API-KEY

string

required

Body

application/json

amount

number

required

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

Required range: 0.3 < x < 999999999.99

currency

string

required

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

Maximum length: 3

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

string

Buyer’s email

name

string

Buyer’s name

phone

string

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

It's active staff id from the dashboard

business_location_id

string

The active location belongs to business.

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

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

Maximum length: 1028

webhook

string

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

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. Default is Null

expires_after

string

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

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

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

string

name

string

phone

string

amount

string

currency

string

status

string

purpose

string

reference_number

string

payment_methods

string[]

url

string

redirect_url

string

webhook

string

send_sms

boolean

default:

true

send_email

boolean

default:

true

sms_status

string

email_status

string

allow_repeated_payments

boolean

default:

true

expiry_date

string

created_at

string

updated_at

string

staff_id

string | null

business_location_id

string | null

Was this page helpful?

Payout Network Get Payment Requests

curl --request POST \
  --url https://api.sandbox.hit-pay.com/v1/payment-requests \
  --header 'Content-Type: application/json' \
  --header 'X-BUSINESS-API-KEY: <x-business-api-key>' \
  --data '{
  "amount": 100,
  "currency": "SGD",
  "payment_methods": [
    "<string>"
  ],
  "email": "jsmith@example.com",
  "name": "<string>",
  "phone": "<string>",
  "wifi_terminal_id": "<string>",
  "staff_id": "98888a24-d6b2-430d-9063-d2be76d443cd",
  "business_location_id": "9dd07721-d215-4947-9c79-2b8ec25f69db",
  "purpose": "<string>",
  "reference_number": "<string>",
  "redirect_url": "https://www.google.com",
  "webhook": "https://www.google.com",
  "allow_repeated_payments": "false",
  "expiry_date": "<string>",
  "expires_after": "5 minutes",
  "add_admin_fee": "false",
  "send_email": "false",
  "send_sms": "true",
  "address": {
    "line1": "<string>",
    "line2": "<string>",
    "city": "<string>",
    "country": "<string>",
    "state": "<string>",
    "postal_code": "<string>"
  },
  "generate_qr": false
}'

"{\n    \"id\": \"974ee233-bc3e-4aac-a212-15af0d155133\",\n    \"name\": \"Buyer_Name_1663650582\",\n    \"email\": \"buyer_1663650582@gmail.com\",\n    \"phone\": \"+6539393939\",\n    \"amount\": \"900,000.00\",\n    \"currency\": \"SGD\",\n    \"status\": \"pending\",\n    \"purpose\": \"Testing\",\n    \"reference_number\": \"12345678\",\n    \"payment_methods\": [\n        \"card\"\n    ],\n    \"url\": \"https://securecheckout.sandbox.hit-pay.com/payment-request/@ban/974ee233-bc3e-4aac-a212-15af0d155133/checkout\",\n    \"redirect_url\": \"https://hit-pay.postman.co/\",\n    \"webhook\": \"https://hit-pay.postman.co/\",\n    \"send_sms\": true,\n    \"send_email\": true,\n    \"sms_status\": \"pending\",\n    \"email_status\": \"pending\",\n    \"allow_repeated_payments\": false,\n    \"expiry_date\": \"2022-10-10T01:01:01\",\n    \"created_at\": \"2022-09-20T13:09:42\",\n    \"updated_at\": \"2022-09-20T13:09:42\"\n}"

Guides

API References

Create Payment Request

Headers

Body

Response