Send Subscription Notification

POST/ps/api/v1/public/subscriptions/notify

Sends a pre-debit notification for a subscription. This is used when the merchant controls the PDN (Pre-Debit Notification) process.

View as Markdown Open in ChatGPT Open in Claude Open in Perplexity

Requires Bearer token. Get token →

Header Parameters

Field	Details
`Request-Timestamp` `string`date-time	ISO 8601 UTC timestamp of the request. Used for idempotency and audit.
`Request-ID` `string`	Use a global unique identifier [GUID] for the request. Constraints Minimum length: 1 characterMaximum length: 50 characters

Request Bodyrequired

Field	Details
`subscription_id` `string`required	Unique identifier for the subscription.
`due_date` `string`requireddate-time	The ISO 8601 UTC Timestamp when the payment is due.
`amount` `object`required2 nested fields	This is the recurring mandate amount, that would be charged for each frequency. For instance 200 every month. This field is not needed if the mandate frequency is AS
`merchant_presentation_reference` `string`required	Idempotency Key. Unique identifier of the merchant presentation reference. Duplicate requests with the same `merchant_presentation_reference` will return the existing presentation instead of creating a new one. Constraints Minimum length: 1 characterMaximum length: 50 characters
`is_merchant_retry` `boolean`	Indicates whether the merchant controls the retry process.

Response

Field	Details
`subscription_id` `string`	Unique identifier for the subscription. Constraints Maximum length: 50 characters
`due_date` `string`date-time	The ISO 8601 UTC Timestamp of the date & time at which the payment is due.
`presentation_id` `string`	Unique identifier for the presentation. Constraints Maximum length: 50 characters
`amount` `object`2 nested fields	This is the recurring mandate amount, that would be charged for each frequency. For instance 200 every month. This field is not needed if the mandate frequency is AS
`value` `integer`required	Amount in the smallest currency unit (paisa for INR). Minimum ₹1 (100), maximum ₹10 lakh (100000000). Constraints Minimum value: 100Maximum value: 100000000
`currency` `string`required	Three-letter ISO 4217 currency code. Constraints Default value: INR
`merchant_presentation_reference` `string`	Unique identifier of the merchant presentation reference. Constraints Minimum length: 1 characterMaximum length: 50 characters
`pdn_status` `string`	Pre-debit notification status. Allowed values: `CREATEDINITIATEDNOTIFIEDFAILEDCANCELLEDPAUSEDPDN_FAILED`
`status` `string`	Subscription presentation status. Allowed values: `WAITING_FOR_EXECUTIONCREATEDINITIATEDNOTIFIEDFAILEDCANCELLEDPAUSEDPDN_FAILED`

Status Codes

`200`	Notification sent successfully.
`400`	The request was malformed or missing required fields.

Run

Request

curl --request POST \
  --url https://pluraluat.v2.pinepg.in/ps/api/v1/public/subscriptions/notify \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN' \
  --header 'Content-Type: application/json' \
  --header 'Request-ID: a1b2c3d4-e5f6-7890-abcd-ef1234567890' \
  --header 'Request-Timestamp: 2024-10-01T10:30:00Z' \
  --data '{
  "subscription_id": "v1-sub-4405071524-aa-qlAtAf",
  "due_date": "2024-03-15T10:30:00Z",
  "amount": {
    "value": 1000,
    "currency": "INR"
  },
  "merchant_presentation_reference": "1234567890",
  "is_merchant_retry": false
}'

Status:

{
  "subscription_id": "v1-sub-4405071524-aa-qlAtAf",
  "due_date": "2022-09-21T17:32:28Z",
  "presentation_id": "v1-pre-4405071524-aa-qlAtAf",
  "amount": {
    "value": 50000,
    "currency": "INR"
  },
  "merchant_presentation_reference": "1234567890",
  "pdn_status": "CREATED",
  "status": "WAITING_FOR_EXECUTION"
}