Payment Request
Get Payment Status
Payment Request
Get Payment Status
This is an optional API call, you may use this to get the status of a specific payment request.
GET
/v1/payment-requests/{request_id}
X-BUSINESS-API-KEY*
X-Requested-With
curl --request GET \
--url https://api.sandbox.hit-pay.com/v1/payment-requests/{request_id} \
--header 'X-BUSINESS-API-KEY: <x-business-api-key>'{
"status": "200",
"example": "{\n \"id\": \"974ee963-ad54-4ace-8802-1e5e724c28b5\",\n \"name\": \"Buyer_Name_1663651788\",\n \"email\": \"buyer_1663651788@gmail.com\",\n \"phone\": \"+6539393939\",\n \"amount\": \"900.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/974ee963-ad54-4ace-8802-1e5e724c28b5/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:29:48\",\n \"updated_at\": \"2022-09-20T13:29:48\"\n}"
}Authorizations
X-BUSINESS-API-KEYheaderrequired
string
Headers
X-Requested-With
Default: "XMLHttpRequest"string
Path Parameters
request_idrequired
string
It's required field
Response
200 - application/json
allow_repeated_payments
Default: trueboolean
amount
string
created_at
string
currency
string
email
string
email_status
string
expiry_date
string
id
string
name
string
payment_methods
string[]
phone
string
purpose
string
redirect_url
string
reference_number
string
send_email
Default: trueboolean
send_sms
Default: trueboolean
sms_status
string
status
string
updated_at
string
url
string
webhook
string
curl --request GET \
--url https://api.sandbox.hit-pay.com/v1/payment-requests/{request_id} \
--header 'X-BUSINESS-API-KEY: <x-business-api-key>'{
"status": "200",
"example": "{\n \"id\": \"974ee963-ad54-4ace-8802-1e5e724c28b5\",\n \"name\": \"Buyer_Name_1663651788\",\n \"email\": \"buyer_1663651788@gmail.com\",\n \"phone\": \"+6539393939\",\n \"amount\": \"900.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/974ee963-ad54-4ace-8802-1e5e724c28b5/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:29:48\",\n \"updated_at\": \"2022-09-20T13:29:48\"\n}"
}