Subscription Notification

post

https://pluraluat.v2.pinepg.in/ps/api/v1/public/subscriptions/notify

Use this API to send a pre-debit notification for a given subscription ID.

Environment

Use our UAT environment endpoint for testing and for integration utilize our production endpoint.

Environment	Endpoints
User Acceptance Testing [UAT]	`https://pluraluat.v2.pinepg.in/ps/api/v1/public/subscriptions/notify`
Production [PROD]	`https://api.pluralpay.in/api/ps/v1/public/subscriptions/notify`

Body Params

subscription_id

string

required

Unique identifier for the subscription in the Pine Labs database.

Maximum length: 50 characters.

Example: v1-sub-4405071524-aa-qlAtAf

due_date

string

required

The ISO 8601 UTC Timestamp is the date & time at which the payment is due.

Example: 2022-09-21T17:32:28Z

Note: You should set the due date to 24 hours later, as we’ll also be sending the Pre-debit Notification for the presentation request.

amount

object

required

An object that contains the amount details.

merchant_presentation_reference

string

required

Unique identifier of the merchant presentation reference.

Example: 1234567890

is_merchant_retry

boolean

Indicates if merchant notifications retry is enabled.

Example: true

Possible values:

true: Set this parameter to true only when you want to retry the Notification API after a failed request. A maximum of 3 retries is allowed.
false(default): Set this parameter to false only when you don't want to retry the Notification API after a failed request.

Headers

Content-Type

string

The type of content included in the HTTP message body.

Possible value: application/json.

Authorization

string

required

Defaults to Bearer

The HTTP header where you can include your secret token for authentication.

Example: Bearer <access_token>

Note: Use the access token generated using our Generate Token API.

Request-Timestamp

string

Use ISO 8601 UTC Timestamp, to create a timestamp when the generate token is requested.

Example: 2024-07-09T07:57:08.022Z

Request-ID

string

Use a global unique identifier [GUID] for the request.

Minimum: 1 characters.
Maximum: 50 characters

Example: c17ce30f-f88e-4f81-ada1-c3b4909ed235

Responses

Language

Credentials

Header

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

Environment

200200

400400