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

Create Presentation

Shown below is a sample response returned through our Create 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"
  },
  "merchant_presentation_reference": "1234567890"
}

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 plural database. Maximum length: 50 characters. Example: `v1-sub-4405071524-aa-qlAtAf`
presentation_id	`string`	A Unique identifier for the presentation provided by the Plural. 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.
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"
  },
  "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 plan in the plural database. Maximum length: 50 characters. Example: `v1-sub-4405071524-aa-qlAtAf`
presentation_id	`string`	A Unique identifier for the presentation provided by the Plural. 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 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 plan in the plural database. Maximum length: 50 characters. Example: `v1-sub-4405071524-aa-qlAtAf
presentation_id	`string`	A Unique identifier for the presentation provided by the Plural. 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