Object

Payout to Beneficiary

Shown below is a sample response returned for a payout to beneficiary API.

{
  "clientReferenceId": "test1607-281913",
  "requestReferenceId": "req-446b28bdd4e0444ab8cc381278c0a7db",
  "paymentReferenceId": "txn-a9304bb5bdd6444782466575afd023e4",
  "beneficiaryId": "0E32EB7CB2",
  "payeeName": "Kevin",
  "accountNumber": "1234567890123",
  "branchCode": "ICICI0000139",
  "vpa": "",
  "email": "[email protected]",
  "phone": "9021221212",
  "amount": {
    "currency": "INR",
    "value": 25000
  },
  "mode": "IMPS",
  "status": "PENDING",
  "message": "Payment instruction pending to be executed",
  "scheduledAt": "",
  "remarks": "Rent",
  "_links": [
    {
      "rel": "status",
      "href": "http://pluralqa.pinepg.in:8000/payouts/v2/payments?paymentReferenceId=txn-a9304bb5bdd6444782466575afd023e4"
    }
  ]
}

The table below lists the various parameters returned in the payout to beneficiary sample response object.

Parameter	Type	Description
clientReferenceId	`string`	Unique identifier entered while creating a Payout request. Example: `test1607-281915`
requestReferenceId	`string`	Unique identifier of the payout request in Plural database. Example: `req-446b28bdd4e0444ab8cc381278c0a7db`
paymentReferenceId	`string`	Unique identifier of the payout reference in Plural database. Example: `txn-a9304bb5bdd6444782466575afd023e4`
beneficiaryId	`string`	Unique Identifier representing the beneficiary. Example: `0E32EB7CB2`
payeeName	`string`	Beneficiary name. Example: `Kevin`
accountNumber	`string`	Beneficiary bank account number. Example: `1234567890123`
branchCode	`string`	Beneficiary branch IFSC. Example: `ICICI0000139`
vpa	`string`	Beneficiary VPA handle. Example: `[email protected]`
email	`string`	Beneficiary email address. Example: `[email protected]`
phone	`string`	Beneficiary phone number. Example: `9876543210`
amount	`object`	An object that contains the payout amount details.
mode	`string`	Mode you wish to initiate a payout. Accepted values: `UPI` `IMPS` `NEFT` `RTGS`
status	`string`	Payout status. Example: `PENDING`
message	`string`	Corresponding message to the status. Example: `Payment instruction pending to be executed`
scheduledAt	`string`	Use this parameter to schedule a payout for future. The time value is in UTC. Example:
remarks	`string`	Payout remarks. Example: `Rent`
_links	`boolean`	An object that contains the payment link details.

Amount [Child Object]

The table below lists the various parameters in the amount child object. This object is part of the payout to beneficiary sample response object.

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

_Links [Child Object]

The table below lists the various parameters in the links child object. This object is part of the payout to beneficiary sample response object.

Parameter	Type	Description
rel	`string`	Relationship to the resource. Example: `status`
href	`string`	Link to access the resource. Example: `http://pluralqa.pinepg.in:8000/payouts/v2/payments?paymentReferenceId=txn-a9304bb5bdd6444782466575afd023e4`

Payout to Account Number

Shown below is a sample response returned for a payout to account number API.

{
  "clientReferenceId": "test1607-281915",
  "beneficiaryId": "0E32EB7CB2",
  "requestReferenceId": "req-6fb7b8893b724a478b0ffe308fc8f742",
  "paymentReferenceId": "txn-f642f7f6f2af4d5bb8da5de9e5f0bbc8",
  "accountNumber": "3988439646104",
  "branchCode": "NPCI0000139",
  "vpa": "",
  "email": "[email protected]",
  "phone": "9021221212",
  "amount": {
    "currency": "INR",
    "value": 250000
  },
  "mode": "IMPS",
  "status": "PENDING",
  "message": "Payment instruction pending to be executed",
  "scheduledAt": "",
  "remarks": "Success1",
  "_links": [
    {
      "rel": "status",
      "href": "http://pluralqa.pinepg.in:8000/payouts/v2/payments?paymentReferenceId=txn-f642f7f6f2af4d5bb8da5de9e5f0bbc8"
    }
  ]
}

The table below lists the various parameters returned in the payout to account number sample response object.

Parameter	Type	Description
clientReferenceId	`string`	Unique identifier entered while creating a Payout request. Example: `test1607-281915`
beneficiaryId	`string`	Unique Identifier representing the beneficiary. Example: `0E32EB7CB2`
requestReferenceId	`string`	Unique identifier of the payout request in Plural database. Example: `req-446b28bdd4e0444ab8cc381278c0a7db`
paymentReferenceId	`string`	Unique identifier of the payout reference in Plural database. Example: `txn-a9304bb5bdd6444782466575afd023e4`
payeeName	`string`	Beneficiary name. Example: `Kevin`
accountNumber	`string`	Beneficiary bank account number. Example: `1234567890123`
branchCode	`string`	Beneficiary branch IFSC. Example: `ICICI0000139`
vpa	`string`	Beneficiary VPA handle. Example: `[email protected]`
email	`string`	Beneficiary email address. Example: `[email protected]`
phone	`string`	Beneficiary phone number. Example: `9876543210`
amount	`object`	An object that contains the payout amount details.
mode	`string`	Mode you wish to initiate a payout. Accepted values: `UPI` `IMPS` `NEFT` `RTGS`
status	`string`	Payout status. Example: `PENDING`
message	`string`	Corresponding message to the status. Example: `Payment instruction pending to be executed`
scheduledAt	`string`	Use this parameter to schedule a payout for future. The time value is in UTC. Example:
remarks	`string`	Payout remarks. Example: `Rent`
_links	`boolean`	An object that contains the payment link details.

Amount [Child Object]

The table below lists the various parameters in the amount child object. This object is part of the payout to account number sample response object.

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

_Links [Child Object]

The table below lists the various parameters in the links child object. This object is part of the payout to account number sample response object.

Parameter	Type	Description
rel	`string`	Relationship to the resource. Example: `status`
href	`string`	Link to access the resource. Example: `http://pluralqa.pinepg.in:8000/payouts/v2/payments?paymentReferenceId=txn-a9304bb5bdd6444782466575afd023e4`

Scheduled Account Payout

Shown below is a sample response returned for a scheduled account payout API.

{
  "clientReferenceId": "test4feb0-11",
  "requestReferenceId": "req-6efea0eaabb9403ab2a2e172695f4764",
  "paymentReferenceId": "txn-7d349ed08ad041e385ee2a03ebf6cf25",
  "payeeName": "Rishendrasai",
  "accountNumber": "919000664017",
  "branchCode": "PYTM0123456",
  "vpa": "",
  "email": "[email protected]",
  "phone": "9000664017",
  "amount": {
    "currency": "INR",
    "value": 100
  },
  "mode": "IMPS",
  "status": "SCHEDULED",
  "message": "Payment instruction scheduled for execution",
  "scheduledAt": "2024-03-24T08:24:00Z",
  "remarks": "Test transaction",
  "_links": [
    {
      "rel": "status",
      "href": "http://pluralqa.pinepg.in:8000/payouts/v2/payments?paymentReferenceId=txn-7d349ed08ad041e385ee2a03ebf6cf25"
    }
  ]
}

{
  "clientReferenceId": "test4feb0-10",
  "requestReferenceId": "req-7c85bda19bf141c981b94e750c6041b6",
  "paymentReferenceId": "txn-f9e00a80a357418d908a67bd30cdbc37",
  "payeeName": "Rishendrasai",
  "accountNumber": "919000664016",
  "branchCode": "PYTM0123456",
  "vpa": "",
  "email": "[email protected]",
  "phone": "9000664016",
  "amount": {
    "currency": "INR",
    "value": 100
  },
  "mode": "IMPS",
  "status": "SCHEDULED",
  "message": "Payment instruction pending to be executed",
  "scheduledAt": "",
  "remarks": "Test transaction",
  "_links": [
    {
      "rel": "status",
      "href": "http://pluralqa.pinepg.in:8000/payouts/v2/payments?paymentReferenceId=txn-f9e00a80a357418d908a67bd30cdbc37"
    }
  ]
}

{
  "clientReferenceId": "test4feb0-10",
  "requestReferenceId": "req-7c85bda19bf141c981b94e750c6041b6",
  "paymentReferenceId": "txn-f9e00a80a357418d908a67bd30cdbc37",
  "payeeName": "Rishendrasai",
  "accountNumber": "919000664016",
  "branchCode": "PYTM0123456",
  "vpa": "",
  "email": "[email protected]",
  "phone": "9000664016",
  "amount": {
    "currency": "INR",
    "value": 100
  },
  "mode": "IMPS",
  "status": "CANCELLED",
  "message": "Payment instruction pending to be executed",
  "scheduledAt": "",
  "remarks": "Test transaction",
  "_links": [
    {
      "rel": "status",
      "href": "http://pluralqa.pinepg.in:8000/payouts/v2/payments?paymentReferenceId=txn-f9e00a80a357418d908a67bd30cdbc37"
    }
  ]
}

The table below lists the various parameters returned in the scheduled account payout sample response object.

Parameter	Type	Description
clientReferenceId	`string`	Unique identifier entered while creating a Payout request. Example: `test1607-281915`
requestReferenceId	`string`	Unique identifier of the payout request in Plural database. Example: `req-446b28bdd4e0444ab8cc381278c0a7db`
paymentReferenceId	`string`	Unique identifier of the payout reference in Plural database. Example: `txn-a9304bb5bdd6444782466575afd023e4`
payeeName	`string`	Beneficiary name. Example: `Kevin`
accountNumber	`string`	Beneficiary bank account number. Example: `1234567890123`
branchCode	`string`	Beneficiary branch IFSC. Example: `ICICI0000139`
vpa	`string`	Beneficiary VPA handle. Example: `[email protected]`
email	`string`	Beneficiary email address. Example: `[email protected]`
phone	`string`	Beneficiary phone number. Example: `9876543210`
amount	`object`	An object that contains the payout amount details.
mode	`string`	Mode you wish to initiate a payout. Accepted values: `UPI` `IMPS` `NEFT` `RTGS`
status	`string`	Payout status. Example: `PENDING`
message	`string`	Corresponding message to the status. Example: `Payment instruction pending to be executed`
scheduledAt	`string`	Use this parameter to schedule a payout for future. The time value is in UTC. Example:
remarks	`string`	Payout remarks. Example: `Rent`
_links	`boolean`	An object that contains the payment link details.

Amount [Child Object]

The table below lists the various parameters in the amount child object. This object is part of the scheduled account payout sample response object.

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

_Links [Child Object]

The table below lists the various parameters in the links child object. This object is part of the scheduled account payout sample response object.

Parameter	Type	Description
rel	`string`	Relationship to the resource. Example: `status`
href	`string`	Link to access the resource. Example: `http://pluralqa.pinepg.in:8000/payouts/v2/payments?paymentReferenceId=txn-a9304bb5bdd6444782466575afd023e4`

Update Scheduled Payout

Shown below is a sample response returned for a update scheduled payout API.

{
  "clientReferenceId": "test4feb0-10",
  "requestReferenceId": "req-7c85bda19bf141c981b94e750c6041b6",
  "paymentReferenceId": "txn-f9e00a80a357418d908a67bd30cdbc37",
  "payeeName": "Rishendrasai",
  "accountNumber": "919000664016",
  "branchCode": "PYTM0123456",
  "vpa": "",
  "email": "[email protected]",
  "phone": "9000664016",
  "amount": {
    "currency": "INR",
    "value": 100
  },
  "mode": "IMPS",
  "status": "SCHEDULED",
  "message": "Payment instruction pending to be executed",
  "scheduledAt": "",
  "remarks": "Test transaction",
  "_links": [
    {
      "rel": "status",
      "href": "http://pluralqa.pinepg.in:8000/payouts/v2/payments?paymentReferenceId=txn-f9e00a80a357418d908a67bd30cdbc37"
    }
  ]
}

The table below lists the various parameters returned in the update scheduled payout sample response object.

Parameter	Type	Description
clientReferenceId	`string`	Unique identifier entered while creating a Payout request. Example: `test1607-281915`
requestReferenceId	`string`	Unique identifier of the payout request in Plural database. Example: `req-446b28bdd4e0444ab8cc381278c0a7db`
paymentReferenceId	`string`	Unique identifier of the payout reference in Plural database. Example: `txn-a9304bb5bdd6444782466575afd023e4`
payeeName	`string`	Beneficiary name. Example: `Kevin`
accountNumber	`string`	Beneficiary bank account number. Example: `1234567890123`
branchCode	`string`	Beneficiary branch IFSC. Example: `ICICI0000139`
vpa	`string`	Beneficiary VPA handle. Example: `[email protected]`
email	`string`	Beneficiary email address. Example: `[email protected]`
phone	`string`	Beneficiary phone number. Example: `9876543210`
amount	`object`	An object that contains the payout amount details.
mode	`string`	Mode you wish to initiate a payout. Accepted values: `UPI` `IMPS` `NEFT` `RTGS`
status	`string`	Payout status. Example: `PENDING`
message	`string`	Corresponding message to the status. Example: `Payment instruction pending to be executed`
scheduledAt	`string`	Use this parameter to schedule a payout for future. The time value is in UTC. Example:
remarks	`string`	Payout remarks. Example: `Rent`
_links	`boolean`	An object that contains the payment link details.

Amount [Child Object]

The table below lists the various parameters in the amount child object. This object is part of the update scheduled payout sample response object.

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

_Links [Child Object]

The table below lists the various parameters in the links child object. This object is part of the update scheduled payout sample response object.

Parameter	Type	Description
rel	`string`	Relationship to the resource. Example: `status`
href	`string`	Link to access the resource. Example: `http://pluralqa.pinepg.in:8000/payouts/v2/payments?paymentReferenceId=txn-a9304bb5bdd6444782466575afd023e4`

Cancel Scheduled Payout

Shown below is a sample response returned for a cancel scheduled payout API.

{
  "clientReferenceId": "test4feb0-10",
  "requestReferenceId": "req-7c85bda19bf141c981b94e750c6041b6",
  "paymentReferenceId": "txn-f9e00a80a357418d908a67bd30cdbc37",
  "payeeName": "Rishendrasai",
  "accountNumber": "919000664016",
  "branchCode": "PYTM0123456",
  "vpa": "",
  "email": "[email protected]",
  "phone": "9000664016",
  "amount": {
    "currency": "INR",
    "value": 100
  },
  "mode": "IMPS",
  "status": "CANCELLED",
  "message": "Payment instruction pending to be executed",
  "scheduledAt": "",
  "remarks": "Test transaction",
  "_links": [
    {
      "rel": "status",
      "href": "http://pluralqa.pinepg.in:8000/payouts/v2/payments?paymentReferenceId=txn-f9e00a80a357418d908a67bd30cdbc37"
    }
  ]
}

The table below lists the various parameters returned in the cancel scheduled payout sample response object.

Parameter	Type	Description
clientReferenceId	`string`	Unique identifier entered while creating a Payout request. Example: `test1607-281915`
requestReferenceId	`string`	Unique identifier of the payout request in Plural database. Example: `req-446b28bdd4e0444ab8cc381278c0a7db`
paymentReferenceId	`string`	Unique identifier of the payout reference in Plural database. Example: `txn-a9304bb5bdd6444782466575afd023e4`
payeeName	`string`	Beneficiary name. Example: `Kevin`
accountNumber	`string`	Beneficiary bank account number. Example: `1234567890123`
branchCode	`string`	Beneficiary branch IFSC. Example: `ICICI0000139`
vpa	`string`	Beneficiary VPA handle. Example: `[email protected]`
email	`string`	Beneficiary email address. Example: `[email protected]`
phone	`string`	Beneficiary phone number. Example: `9876543210`
amount	`object`	An object that contains the payout amount details.
mode	`string`	Mode you wish to initiate a payout. Accepted values: `UPI` `IMPS` `NEFT` `RTGS`
status	`string`	Payout status. Example: `PENDING`
message	`string`	Corresponding message to the status. Example: `Payment instruction pending to be executed`
scheduledAt	`string`	Use this parameter to schedule a payout for future. The time value is in UTC. Example:
remarks	`string`	Payout remarks. Example: `Rent`
_links	`boolean`	An object that contains the payment link details.

Amount [Child Object]

The table below lists the various parameters in the amount child object. This object is part of the cancel scheduled payout sample response object.

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

_Links [Child Object]

The table below lists the various parameters in the links child object. This object is part of the cancel scheduled payout sample response object.

Parameter	Type	Description
rel	`string`	Relationship to the resource. Example: `status`
href	`string`	Link to access the resource. Example: `http://pluralqa.pinepg.in:8000/payouts/v2/payments?paymentReferenceId=txn-a9304bb5bdd6444782466575afd023e4`