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",
  "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

Example:

"b286daabf9921b5a01a4621f026c111e046f8911feba212996c92159b98427d"

Body

application/json

Response

200

application/json

200

The response is of type object.

Payout APIs 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",
  "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