Skip to main content
GET
/
v1
/
payment-requests
/
{request_id}
Get Payment Request Status
curl --request GET \
  --url https://api.sandbox.hit-pay.com/v1/payment-requests/{request_id} \
  --header 'X-BUSINESS-API-KEY: <x-business-api-key>'
{
  "id": "<string>",
  "name": "<string>",
  "email": "<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": true,
  "send_email": true,
  "sms_status": "<string>",
  "email_status": "<string>",
  "allow_repeated_payments": true,
  "expiry_date": "<string>",
  "address": {
    "city": "<string>",
    "line1": "<string>",
    "line2": "<string>",
    "state": "<string>",
    "country": "<string>",
    "postal_code": "<string>"
  },
  "line_items": [
    {
      "id": "<string>",
      "sku": "<string>",
      "url": "<string>",
      "name": "<string>",
      "price": 123,
      "category": "<string>",
      "quantity": 123,
      "description": "<string>"
    }
  ],
  "created_at": "<string>",
  "updated_at": "<string>",
  "payments": [
    {
      "id": "<string>",
      "quantity": 123,
      "status": "<string>",
      "buyer_name": "<string>",
      "buyer_phone": "<string>",
      "buyer_email": "<string>",
      "currency": "<string>",
      "amount": "<string>",
      "refunded_amount": "<string>",
      "payment_type": "<string>",
      "fees": "<string>",
      "created_at": "<string>",
      "updated_at": "<string>"
    }
  ]
}

Headers

X-BUSINESS-API-KEY
string
required
Example:

"b286daabf9921b5a01a4621f026c111e046f8911feba212996c92159b98427d"

Path Parameters

request_id
string
required

It's required field

Response

200

id
string
name
string
email
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
send_email
boolean
sms_status
string
email_status
string
allow_repeated_payments
boolean
expiry_date
string
address
object
line_items
object[]
created_at
string
updated_at
string
payments
object[]