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
Body
It's required field. Amount related to the payment. Example: 2500
It's required field. Currency related to the payment. Example: SGD
Payment method type (paynow_online , card, wechat, alipay, grabpay_direct, grabpay_paylater, shopee_pay, zip, fpx). If we don't passe, use the available methods
Buyer’s email
Buyer’s name
Buyer’s phone number
Purpose of the Payment request.
Arbitrary reference number that you can map to your internal reference number. This value cannot be edited by the customer
URL where we redirect the user after a payment. Query arguments reference (payment request id) and status are sent along
URL where our server do POST request after a payment If done
If set to true, multiple payments can be paid on a payment request link. Default value is false
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
E.g "30 mins" Other supported keys are "mins", "hours", "days"
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
true, false It's "true" or "false". If set to "true", SMS will be sent to the customer after the payment is completed. Default is false
true, false Only valid for paynow_online, qrph_netbank, doku_qris and shopee_pay if generate_qr was true
Response
Was this page helpful?