---
title: "Get Payment Request Status"
method: GET
path: "/v1/payment-requests/{request_id}"
---

# Get Payment Request Status

`GET /v1/payment-requests/{request_id}`

This endpoint is to  get the status of a specific payment request.

## Path parameters

- `request_id` string, uuid, required

## Headers

- `X-BUSINESS-API-KEY` string, required

## Response `200`

200

- object
  - `id` string
  - `name` string
  - `email` string
  - `phone` string
  - `amount` string
  - `currency` string
  - `status` 'pending' | 'completed' | 'failed' | 'expired' | 'canceled' | 'inactive' — The status of the payment request. The value can be pending, completed, failed, expired, canceled or inactive. `pending`: Default when a payment request is created: open for payment. `failed`: Payment did not complete successfully. `completed`: Payment succeeded, the request is treated as paid.(unless allow_repeated_payments applies). `expired`: No longer payable because time ran out when either expiry_date or expires_after is set.. `canceled`: Manually or systematically voided (e.g. terminal flow canceling a pending request). `inactive`: Payment link deactivated by the merchant.
  - `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
    - `city` string, required
    - `line1` string, required
    - `line2` string, required
    - `state` string, required
    - `country` string, required
    - `postal_code` string, required
  - `line_items` object[]
    - `id` string, required
    - `sku` string, required
    - `url` string, required
    - `name` string, required
    - `price` number, required
    - `category` string, required
    - `quantity` number, required
    - `description` string, required
  - `created_at` string
  - `updated_at` string
  - `payments` object[]
    - `id` string
    - `quantity` number
    - `status` 'pending' | 'requires_payment_method' | 'requires_customer_action' | 'succeeded_manually' | 'failed' | 'canceled' | 'void' | 'succeeded' | 'refunded' | 'partially_refunded'
    - `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

## Other responses

- `404` — 404

---

[API](https://skmtc.net/hitpayapp/apis/hitpay-api.md) · [All operations](https://skmtc.net/hitpayapp/apis/hitpay-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/hitpayapp/hitpay-api/versions/6aae1a736990/schema)