Skip to main content
GET
/
pg
/
subscriptions
/
{subscription_id}
/
payments
Get Subscription Payments
curl --request GET \
  --url https://api.example.com/pg/subscriptions/{subscription_id}/payments/
{
  "success": true,
  "message": "Subscription payments fetched successfully",
  "data": [
    {
      "payment_id": "dpr_abc123",
      "order_id": "ord_xyz789",
      "reference_id": "SUBPAY-sub123-cf456",
      "amount": 1000.00,
      "currency": "INR",
      "status": "CAPTURED",
      "payment_type": "RECURRING",
      "mop_type": "UPI",
      "bank_ref_num": "BANK123456",
      "status_message": null,
      "created_at": "2025-03-20T10:30:00Z",
      "payment_completed_at": "2025-03-20T10:30:05Z"
    }
  ]
}
Fetch all payments from the internal system associated with the given subscription. Available for all payment gateways and all environments (including production).

​
Path Parameters

​
subscription_id
string
required
The unique identifier (uid) of the subscription.

​
Response Fields

​
payment_id
string
Unique identifier of the payment request.
​
order_id
string
Unique identifier of the associated order.
​
reference_id
string
Merchant-facing reference ID for the order.
​
amount
number
Payment amount in the billing currency (e.g., INR).
​
currency
string
ISO 4217 currency code (e.g., INR).
​
status
string
Payment status. One of:
  • PENDING — Payment is pending
  • CAPTURED — Payment was successfully captured
  • FAILED — Payment failed
  • INVALID — Payment is invalid
​
payment_type
string
Type of payment. One of:
  • REGULAR — One-time payment
  • RECURRING — Recurring subscription payment
  • MANDATE — Mandate/authorization payment
​
mop_type
string
Mode of payment. One of: CREDIT_CARD, DEBIT_CARD, UPI, NET_BANKING, WALLET, QR, EMI, BNPL, CARD, VBA_TRANSFER.
​
bank_ref_num
string
Bank reference number for the transaction.
​
status_message
string
Additional status message or failure reason.
​
created_at
string
ISO 8601 timestamp when the payment record was created.
​
payment_completed_at
string
ISO 8601 timestamp when the payment was completed at the gateway.
{
  "success": true,
  "message": "Subscription payments fetched successfully",
  "data": [
    {
      "payment_id": "dpr_abc123",
      "order_id": "ord_xyz789",
      "reference_id": "SUBPAY-sub123-cf456",
      "amount": 1000.00,
      "currency": "INR",
      "status": "CAPTURED",
      "payment_type": "RECURRING",
      "mop_type": "UPI",
      "bank_ref_num": "BANK123456",
      "status_message": null,
      "created_at": "2025-03-20T10:30:00Z",
      "payment_completed_at": "2025-03-20T10:30:05Z"
    }
  ]
}