Object

The table below lists the response objects received for the Presentation APIs.

Subscription APIs	Object
Create Presentation	Create Presentation Response Object
Get Presentation	Presentation Response Object
Get Presentation by Subscription Id	Get Presentation by Subscription Id Response Object
Subscription Notification	Subscription Notifications Object
Create Debit	Pre-Debit Object

Create Presentation

Shown below is a sample response returned through our Create Presentation API.

{
  "subscription_id": "v1-sub-250612062122-aa-3HLXL5",
  "presentation_id": "v1-bil-250612063111-aa-FJIBcB",
  "due_date": "2025-06-05T06:14:21.72036Z",
  "amount": {
    "value": 100,
    "currency": "INR"
  },
  "status": "CREATED",
  "merchant_presentation_reference": "9caa061f-0e50-494b-aa13-8e902b0bef03"
}

The table below lists the various parameters returned in the Create Presentation API response. This is part of the Create Presentation response object.

Parameter	Type	Description
subscription_id	`string`	Unique identifier for the subscription plan in the Pine Labs Online database. Maximum length: 50 characters. Example: `v1-sub-4405071524-aa-qlAtAf`
presentation_id	`string`	A Unique identifier for the presentation provided by the Pine Labs Online. Maximum length: 50 characters. Example: `v1-pre-4405071524-aa-qlAtAf`
due_date	`string`	The ISO 8601 UTC Timestamp is the date & time at which the payment is due. Example: `2022-09-21T17:32:28Z`
amount	`object`	An object that contains the amount details. Learn more about the `amount` child object.
status	`string`	Presentation Status. `CREATED`: The presentation request has been created successfully. `PENDING`: The request has been sent to the bank and is awaiting a response. `COMPLETED`: The presentation was successfully processed. `FAILED`: The request failed due to an issue at the bank's end. `CANCELLED`: The presentation request has been cancelled. `PAUSED`: The subscription is currently paused. `PARTIALLY_REFUNDED`: A partial refund has been issued for the presentation. `REFUNDED`: A full refund has been issued for the presentation.
merchant_presentation_reference	`string`	Unique identifier of the merchant presentation reference entered while creating a presentation. Minimum length: 1 character. Maximum length: 50 characters. Example: `1234567890`

Amount [Child Object]

The table below lists the various parameters in the amount child object. This is part of the Create Presentation response object.

Parameter	Type	Description
value	`integer`	Transaction amount is Paisa. Minimum value: `100` (₹1) Maximum value: `100000000` (₹10 lakh). Example: `1000`
currency	`String`	Type of currency. Example: INR

Get Presentation

Shown below is a sample response returned through our Get Presentation API.

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

The table below lists the various parameters returned in the Get Presentation API response. This is part of the Get Presentation response object.

Parameter	Type	Description
subscription_id	`string`	Unique identifier for the subscription in the Pine Labs Online database. Maximum length: 50 characters. Example: `v1-sub-4405071524-aa-qlAtAf`
presentation_id	`string`	A Unique identifier for the presentation provided by the Pine Labs Online. Maximum length: 50 characters. Example: `v1-pre-4405071524-aa-qlAtAf`
due_date	`string`	The ISO 8601 UTC timestamp indicating the date and time when the payment is due. Example: `2022-09-21T17:32:28Z`
amount	`object`	An object that contains the amount details. Learn more about the `amount` child object.
status	`string`	Subscription status. `CREATED`: When we have successfully received the Customer Debit request. Note: For Customer Debit with PDN controlled by Pine Labs, use our Create Presentation API. For Customer Debit with PDN Controlled by You, use our Create Debit API. `PENDING`: We have successfully sent the Debit request to the Bank and are waiting for a response. `COMPLETED`: When the Debit is successfully received. `FAILED`: When the Debit request was unsuccessful. `CANCELLED`: When we have successfully received the Cancel Subscription request. `PAUSED`: When we have successfully received the Pause subscription request. `PARTIALLY_REFUNDED`: When the partial refund is successful. `REFUNDED`: When the refund is successful.
pdn_status	`string`	Pre-debit notification status. `CREATED`: When Pine Labs Online successfully receives the request for pre-debit notification. `INITIATED`: When we have successfully sent the pre-debit notification request to the Bank. `NOTIFIED`: When the notification is delivered successfully. `FAILED`: Notification delivery attempt was unsuccessful. `CANCELLED`: Notification was stopped before completion. `PAUSED`: Notification is temporarily halted (e.g., due to subscription status). `PDN_FAILED`: Pre-debit notification failed after all retry attempts.
merchant_presentation_reference	`string`	Unique identifier of the merchant presentation reference entered while creating a presentation. Minimum length: 1 character. Maximum length: 50 characters. Example: `1234567890`

Amount [Child Object]

The table below lists the various parameters in the amount child object. This is part of the Get Presentation response object.

Parameter	Type	Description
value	`integer`	Transaction amount is Paisa. Minimum value: `100` (₹1) Maximum value: `100000000` (₹10 lakh). Example: `1000`
currency	`String`	Type of currency. Example: INR

Get Presentation by Subscription Id

Shown below is a sample response returned through our Get Presentation by Subscription Id API.

{
  "links": {
    "first": {
      "href": "https://api.pluralpay.in/api/v1/public /{resource}/?size=10&page=0&sort=id,asc"
    },
    "self": {
      "href": "https://api.pluralpay.in/api/v1/public /{resource}/?size=10&page=0&sort=id,asc"
    },
    "next": {
      "href": "https://api.pluralpay.in/api/v1/public /{resource}/?size=10&page=0&sort=id,asc"
    },
    "last": {
      "href": "https://api.pluralpay.in/api/v1/public /{resource}/?size=10&page=0&sort=id,asc"
    }
  },
  "page": {
    "size": 10,
    "total_elements": 50,
    "total_pages": 5,
    "number": 1
  },
  "presentations": [
    {
      "subscription_id": "v1-sub-4405071524-aa-qlAtAf",
      "presentation_id": "v1-pre-4405071524-aa-qlAtAf",
      "due_date": "2022-09-21T17:32:28Z",
      "amount": {
        "value": 100,
        "currency": "INR"
      },
      "merchant_presentation_reference": "1234567890"
    }
  ]
}

The table below lists the various parameters returned in the Get Presentation by Subscription Id API response. This is part of the Get Presentation by Subscription Id object.

Parameter	Type	Description
links	`Object`	An object that contains pagination links for navigation. Learn more about the `links` child object.
page	`object`	An object that contains the page information. Learn more about the `page` child object.
presentations	`Array of Objects`	An array of object that contain presentations details. Learn more about the `presentations` child object.

links [Child object]

The table below lists the various parameters in the links child object. This is part of the Get Presentation by Subscription Id response object.

Parameter	Type	Description
first	`object`	An object that contains the URL information of the first page. Learn more about the `first` child object.
self	`object`	An object that contains the URL information of the current page. Learn more about the `self` child object.
next	`object`	An object that contains the URL information of the current page. Learn more about the `next` child object.
last	`object`	An object that contains the URL information of the current page. Learn more about the `last` child object.

First [Child Object]

The table below lists the various parameters in the first child object. This is part of the links object.

Parameter	Type	Description
href	`string`	URL of the first page. Example: `https://api.pluralpay.in/api/v1/public/subscriptions/{subscription_id}/presentations?size=10&page=0&sort=id,asc`

Self [Child Object]

The table below lists the various parameters in the self child object. This is part of the links object.

Parameter	Type	Description
href	`string`	URL of the current page. Example: `"https://api.pluralpay.in/api/v1/public/subscriptions/{subscription_id}/presentations?size=10&page=0&sort=id,asc"`

Next [Child Object]

The table below lists the various parameters in the next child object. This is part of the links object.

Parameter	Type	Description
href	`string`	URL of the next page. Example: `"https://api.pluralpay.in/api/v1/public/subscriptions/{subscription_id}/presentations?size=10&page=0&sort=id,asc"`

Last [Child Object]

The table below lists the various parameters in the last child object. This is part of the links object.

Parameter	Type	Description
href	`string`	URL of the last page. Example: `"https://api.pluralpay.in/api/v1/public/subscriptions/{subscription_id}/presentations?size=10&page=0&sort=id,asc"`

Page [Child Object]

The table below lists the various parameters in the page child object. This is part of the Get All Plan response object.

Parameter	Type	Description
size	`Integer`	Number of items per page. Example: `10`
total_elements	`Integer`	Total number of elements. Example: `50`
total_pages	`Integer`	Total number of pages. Example: `5`
number	`Integer`	Page number. Example: `1`

Presentations [Child Object]

The table below lists the various parameters in the presentations child object. This is part of the Get Presentation by Subscription Id response object

Parameter	Type	Description
subscription_id	`string`	Unique identifier for the subscription in the Pine Labs Online database. Maximum length: 50 characters. Example: `v1-sub-4405071524-aa-qlAtAf
presentation_id	`string`	A Unique identifier for the presentation provided by the Pine Labs Online. Maximum length: 50 characters. Example: `v1-pre-4405071524-aa-qlAtAf`
due_date	`string`	The ISO 8601 UTC timestamp indicating the date and time when the payment is due. Example: `2022-09-21T17:32:28Z`
amount	`object`	An object that contains the amount details. Learn more about the `amount` child object.
merchant_presentation_reference	`string`	Unique identifier of the merchant presentation reference entered while creating a presentation. Minimum length: 1 character. Maximum length: 50 characters. Example: `1234567890`

Amount [Child Object]

The table below lists the various parameters in the amount child object. This is part of the presentations object.

Parameter	Type	Description
value	`integer`	Transaction amount is Paisa. Minimum value: `100` (₹1) Maximum value: `100000000` (₹10 lakh). Example: `1000`
currency	`String`	Type of currency. Example: INR

Subscription Notification

Shown below is a sample response returned through our Subscription Notification API.

{
  "subscription_id": "v1-sub-4405071524-aa-qlAtAf",
  "presentation_id": "v1-pre-4405071524-aa-qlAtAf",
  "amount": {
    "value": 50000,
    "currency": "INR"
  },
  "merchant_presentation_reference": "1234567890",
  "status": "NOTIFIED"
}

The table below lists the various parameters returned in the Subscription Notification API response object.

Parameter	Type	Description
subscription_id	`string`	Unique identifier for the subscription in the Pine Labs Online database. Maximum length: 50 characters. Example: `v1-sub-4405071524-aa-qlAtAf`
presentation_id	`string`	A Unique identifier for the presentation provided by the Pine Labs Online. Maximum length: 50 characters. Example: `v1-pre-4405071524-aa-qlAtAf`
amount	`object`	An object that contains the amount details. Learn more about the `amount` child object.
merchant_presentation_reference	`string`	Unique identifier of the merchant presentation reference entered while creating a presentation. Minimum length: 1 character. Maximum length: 50 characters. Example: `1234567890`
status	`string`	Subscription notification status. Possible values: `CREATED`: When Pine Labs Online successfully receives the request for pre-debit notification. `INITIATED`: When we have successfully sent the pre-debit notification request to the Bank. `NOTIFIED`: When the notification is delivered successfully. `FAILED`: Notification delivery attempt was unsuccessful. `CANCELLED`: When we cancel the pre-debit notification request to the Bank. `PAUSED`: Notification is temporarily halted (e.g., due to subscription status). `PDN_FAILED`: Pre-debit notification failed after all retry attempts.

Amount [Child Object]

The table below lists the various parameters in the amount child object. This is part of the Create Presentation response object.

Parameter	Type	Description
value	`integer`	Transaction amount is Paisa. Minimum value: `100` (₹1) Maximum value: `100000000` (₹10 lakh). Example: `1000`
currency	`String`	Type of currency. Example: `INR`

Create Debit

Shown below is a sample response returned through our Create Debit API.

{
  "subscription_id": "v1-sub-4405071524-aa-qlAtAf",
  "presentation_id": "v1-pre-4405071524-aa-qlAtAf",
  "due_date": "2024-03-15T10:30:00Z",
  "amount": {
    "value": 50000,
    "currency": "INR"
  },
  "merchant_presentation_reference": "1234567890",
  "status": "CREATED"
}

The table below lists the various parameters returned in the Create Debit API response object.

Parameter	Type	Description
subscription_id	`string`	Unique identifier for the subscription in the Pine Labs Online database. Maximum length: 50 characters. Example: `v1-sub-4405071524-aa-qlAtAf`
presentation_id	`string`	A Unique identifier for the presentation provided by the Pine Labs Online. Maximum length: 50 characters. Example: `v1-pre-4405071524-aa-qlAtAf`
due_date	`string`	The ISO 8601 UTC timestamp indicating the date and time when the payment is due. Example: `2022-09-21T17:32:28Z`
amount	`object`	An object that contains the amount details. Learn more about the `amount` child object.
merchant_presentation_reference	`string`	Unique identifier of the merchant presentation reference entered while creating a presentation. Minimum length: 1 character. Maximum length: 50 characters. Example: `1234567890`
status	`string`	Debit status. Possible values: `CREATED`

Amount [Child Object]

The table below lists the various parameters in the amount child object. This is part of the Create Debit response object.

Parameter	Type	Description
value	`integer`	Transaction amount is Paisa. Minimum value: `100` (₹1) Maximum value: `100000000` (₹10 lakh). Example: `1000`
currency	`String`	Type of currency. Example: `INR`