Object

Accept Payment API

Shown below is a sample response returned in our Accept Payment API.

{
  "token": "ubrjAgbVaJVrGz67y%2fZCjCveYWNymE7ULAlOO7FCbz4%3d",
  "response_code": 1,
  "response_message": "SUCCESS",
  "redirect_url": "http://hostname:port/api/v2/process/payment?token=ubrjAgbVaJVrGz67y%2fZCjCveYWNymE7ULAlOO7FCbz4% 3d "
}

{
  "token": "S03%2fbPRIyC1A6jR%2bmmQrUeW4oQEL4vFBA722BtwavAdQuw%3d",
  "response_code": 1,
  "response_message": "SUCCESS"
}

The table below lists the various parameters returned in the Accept payment API.

Parameter	Type	Description
token	`string`	Unique token created for a transaction. Example: `S03%2fbPRIyC1A6jR%2bmmQrUeW4oQEL4vFBA722BtwavAdQuw%3d` Note: You need to pass this token in our Generate Payment Link API.
response_code	`integer`	The status of the API request. Possible value: `1`: Denotes success.
response_message	`string`	Message corresponding to the response code. Example: `SUCCESS`
redirect_url	`string`	Plural hosted checkout URL. Navigate your customers to this URL to accept payment. Example: `http\://hostname:port/api/v2/process/payment?token=ubrjAgbVaJVrGz67y%2fZCjCveYWNymE7ULAlOO7FCbz4% 3d` Note: This parameter is returned for Redirect Mode only.

Process Payment API

Shown below are the sample responses returned in our Process Payment API.

{
  "response_code": 1,
  "response_message": "SUCCESS",
  "redirect_url": "http://hostname:port/pinepg/v2/process/payment?token=848RFsu%2bRnNcSsaZdzEgkeosvCc2o5lK TV4uKJF%2fcjE%3d"
}

{
  "pg_upi_unique_request_id": "170724PLPre22116284",
  "deep_link": "upi://pay?pa=pl.pinelabs@pineaxis&pn=Pinelabs%20Private%20Limited%20dummy&am=8.00&mam=8.00&tr=SU01J2ZMXHX4PVBVASQJPBG2XW6V&tn=Payment%20for%20342027241&cu=INR&mc=7399",
  "pine_pg_transaction_id": 342027241,
  "short_link": "https://upipay.setu.co/nO6yP65XUmwh",
  "response_code": 1,
  "response_message": "SUCCESS"
}

{
  "response_code": 1,
  "response_message": "SUCCESS"
}

The table below lists the various parameters returned in the Generate payment link API.

Parameter	Type	Description
pg_upi_unique_request_id	`string`	Unique identifier of the UPI request in the plural database. Example: `170724PLPre22116284`
deep_link	`string`	Deep link returned by the acquirer. Example: `upi://pay?pa=pl.pinelabs@pineaxis&pn=Pinelabs%20Private%20Limited%20dummy&am=8.00&mam=8.00&tr=SU01J2ZMXHX4PVBVASQJPBG2XW6V&tn=Payment%20for%20342027241&cu=INR&mc=7399` Note: Navigate your customer to this URL to process payment.
pine_pg_transaction_id	`integer`	Unique identifier of the transaction in the Plural database. Example: `342027241`
short_link	`string`	Use this link to redirect your customer to a QR code page. Example: `https://upipay.setu.co/nO6yP65XUmwh`
response_code	`integer`	The status of the API request. Possible value: `1`: Denotes success.
response_message	`string`	Message corresponding to the response code. Example:`success`

📘
Note:

For UPI Intent use the link generated to navigate your customer's to accept payment.

For UPI collect we send notifications to the customer's VPA handle.

Inquiry/Refund API

Shown below is the sample responses returned in our Inquiry/Refund API.

{
  "ppc_MerchantID": "123456",
  "ppc_MerchantAccessCode": "1a39a6d4-46b7-124d-929d-21bf0e9ed123",
  "ppc_PinePGTxnStatus": "7",
  "ppc_TransactionCompletionDateTime": "17/07/2024 12:41:54 PM",
  "ppc_UniqueMerchantTxnID": "testingedgeseamless1123145432",
  "ppc_Amount": "10000",
  "ppc_TxnResponseCode": "1",
  "ppc_TxnResponseMessage": "SUCCESS",
  "ppc_PinePGTransactionID": "342048376",
  "ppc_CapturedAmount": "100",
  "ppc_RefundedAmount": "0",
  "ppc_AcquirerName": "KOTAK_SETU",
  "ppc_DIA_SECRET": "9FFA2E99D14B6357E50D9AF2CF9D01D67B03FA1020BB88A82E76C962313FC004",
  "ppc_DIA_SECRET_TYPE": "SHA256",
  "ppc_PaymentMode": "10",
  "ppc_Parent_TxnStatus": "4",
  "ppc_ParentTxnResponseCode": "1",
  "ppc_ParentTxnResponseMessage": "SUCCESS",
  "ppc_UdfField1": "",
  "ppc_UdfField2": "",
  "ppc_UdfField3": "",
  "ppc_UdfField4": "",
  "ppc_RRN": "1721200204930238149",
  "ppc_AcquirerResponseCode": "SUCCESS",
  "ppc_AcquirerResponseMessage": "SUCCESS"
}

{
  "ppc_MerchantID": "123456",
  "ppc_MerchantAccessCode": "1a39a6d4-46b7-124d-929d-21bf0e9ed123",
  "ppc_PinePGTxnStatus": "1",
  "ppc_TransactionCompletionDateTime": "01/08/2024 10:25:07 AM",
  "ppc_UniqueMerchantTxnID": "Refund_1",
  "ppc_Amount": "100",
  "ppc_TxnResponseCode": "2",
  "ppc_TxnResponseMessage": "REFUND PROCESS INITIATED",
  "ppc_PinePGTransactionID": "0",
  "ppc_CapturedAmount": "0",
  "ppc_RefundedAmount": "0",
  "ppc_ParentTxnResponseCode": "1",
  "ppc_Parent_TxnStatus": "4",
  "ppc_ParentTxnResponseMessage": "SUCCESS",
  "ppc_DIA_SECRET": "EE3844A2B85588D20AA173269BCC4F3375ABDEE8631CFF1366B271FABB47AE6F",
  "ppc_DIA_SECRET_TYPE": "SHA256"
}

The table below lists the various parameters returned in the Inquiry/Refund API.

Parameter	Type	Description
ppc_MerchantID	`string`	Unique identifier of the merchant in Plural database. Example: `123456`
ppc_MerchantAccessCode	`string`	Unique access code of the merchant in Plural database. Example: `1a39a6d4-46b7-124d-929d-21bf0e9ed123` Note: The access key shared while onboarding if not received contact our Integration team.
ppc_PinePGTxnStatus	`string`	The status of the transaction. Example: `7` Note: Please refer to the Pine PG transaction status table to know the status.
ppc_TransactionCompletionDateTime	`string`	The date and time at which the transaction was completed. Example: `17/07/2024 12:41:54 PM`
ppc_UniqueMerchantTxnID	`string`	Unique merchant transaction ID. Example: `1234567890` Note: You must use the transaction ID passed in the accept payment API request.
ppc_Amount	`string`	The total transaction amount against the payment recieved. Example: `10000`
ppc_TxnResponseCode	`string`	The response status of the transaction. Example: `1` Note: Please refer to the Pine PG transaction status table to know the status.
ppc_TxnResponseMessage	`string`	Message corresponding to the response status of the transaction. Example: `SUCCESS`
ppc_PinePGTransactionID	`string`	Unique transaction ID generated by Plural against an Order ID. Example: `342048376`
ppc_CapturedAmount	`string`	The total amount captured. Example: `100`
ppc_RefundedAmount	`string`	The total amount refunded. Example: `0`
ppc_AcquirerName	`string`	The acquirer name for this transaction. Example: `KOTAK_SETU`
ppc_DIA_SECRET	`string`	HashMap secret key generated using the request payload and the secret key. Example: `9FFA2E99D14B6357E50D9AF2CF9D01D67B03FA1020BB88A82E76C962313FC004`
ppc_DIA_SECRET_TYPE	`string`	HashMap secret generation type. Accepted values: `SHA256` `MD5`
ppc_PaymentMode	`string`	Payment mode selected for the particular transaction. Example: `10`: For UPI.
ppc_Parent_TxnStatus	`string`	The status code of the purchase transaction. Example: `4`
ppc_ParentTxnResponseCode	`string`	The response code for the purchase transaction. Example: `1`
ppc_ParentTxnResponseMessage	`string`	Message corresponding to the status and response code. Example: `SUCCESS`
ppc_UdfField1	`string`	User defined field1. Example: `DD`
ppc_UdfField2	`string`	User defined field2. Example: `XOF`
ppc_UdfField3	`string`	User defined field3. Example: `XOA`
ppc_UdfField4	`string`	User defined field4. Example: `ASD`
ppc_RRN	`string`	Unique Retrieval Reference Number of the transaction. Example: `1721200204930238149`
ppc_AcquirerResponseCode	`string`	The response code received from the acquirer. Example: `SUCCESS`
ppc_AcquirerResponseMessage	`string`	Message corresponding to the acquirer code. Example: `SUCCESS`

Accept Payment API

Process Payment API

📘Note:

Inquiry/Refund API

📘
Note: