Object

Overview of the Pay by Link APIs response.

Create Payment Link API

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

{
  "RESPONSE_CODE": 1,
  "RESPONSE_MESSAGE": "SUCCESS",
  "PAYMENT_URL": "https://pyn.onl/PLUTUS/m81hnc1",
  "PAYMENT_LINK_ID": 5275034
}

The table below lists the various parameters returned in the Create Payment Link API.

ParameterTypeDescription
RESPONSE_CODEintegerThe Response Code of the API request.

Possible value:
  • 1: SUCCESS.
  • -1: FAILURE.
  • -2: INVALID AMOUNT.
  • -3: INVALID MERCHANT_ID.
  • -4: INVALID PRODUCT DESCRIPTION.
  • -5: INVALID CUSTOMER EMAIL ID.
  • -6: INVALID CUSTOMER MOBILE NO.
  • -7: INVALID PRODUCT_CODE.
  • -8: INVALID MERCHANT_ACCESS_CODE.
  • -9: INVALID MERCHANT ID ACCESS CODE.
  • -10: BRAND_EMI_NOT_ENABLED_AND_PRODUCT_CODE_PRESENT_IN_REQUEST.
  • -11: EITHER PRODUCT_CODE NOT PRESENT OR MAPPING NOT PRESENT WITH MERCHANT.
RESPONSE_MESSAGEstringMessage corresponding to the response code.

Example: SUCCESS
PAYMENT_URLstringPlural Payment URL. Navigate your customers to this URL to do the payment.

Example: https://pyn.onl/PLUTUS/m81hnc1
PAYMENT_LINK_IDInt64Payment ID which comes in response parameter of create payment link API

Resend Payment Link API

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

{
  "RESPONSE_CODE": 1,
  "RESPONSE_MESSAGE": "SUCCESS"
}

The table below lists the various parameters returned in the Resend Payment Link API.

ParameterTypeDescription
RESPONSE_CODEintegerThe Response Code of the API request.

Possible value:
  • 1: SUCCESS.
  • -1: FAILURE.
  • -2: INVALID AMOUNT.
  • -3: INVALID MERCHANT_ID.
  • -4: INVALID PRODUCT DESCRIPTION.
  • -5: INVALID CUSTOMER EMAIL ID.
  • -6: INVALID CUSTOMER MOBILE NO.
  • -7: INVALID PRODUCT_CODE.
  • -8: INVALID MERCHANT_ACCESS_CODE.
  • -9: INVALID MERCHANT ID ACCESS CODE.
  • -10: BRAND_EMI_NOT_ENABLED_AND_PRODUCT_CODE_PRESENT_IN_REQUEST.
  • -11: EITHER PRODUCT_CODE NOT PRESENT OR MAPPING NOT PRESENT WITH MERCHANT.
RESPONSE_MESSAGEstringMessage corresponding to the response code.

Example: SUCCESS

Get Payment Status API

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

{
  "RESPONSE_CODE": 1,
  "RESPONSE_MESSAGE": "SUCCESS",
  "PAYMENT_MODE": 3,
  "PINE_PG_TRANSACTION_ID": 14619963,
  "ACQUIRER_NAME": "BILLDESK",
  "REFERENCE_NO": "0123",
  "AMOUNT": 50000,
  "TXN_STATUS": "7",
  "REFUND_AMOUNT": "0",
  "PARENT_TXN_STATUS": "4",
  "ACQUIRER_RESPONSE_CODE": "0300",
  "ACQUIRER_RESPONSE_MESSAGE": "DEFAULT"
}

The table below lists the various parameters returned in the Get Payment Status API.

ParameterTypeDescription
RESPONSE_CODEintegerThe Response Code of the API request.

Possible value:
  • 1: SUCCESS.
  • -1: FAILURE.
  • -2: INVALID AMOUNT.
  • -3: INVALID MERCHANT_ID.
  • -4: INVALID PRODUCT DESCRIPTION.
  • -5: INVALID CUSTOMER EMAIL ID.
  • -6: INVALID CUSTOMER MOBILE NO.
  • -7: INVALID PRODUCT_CODE.
  • -8: INVALID MERCHANT_ACCESS_CODE.
  • -9: INVALID MERCHANT ID ACCESS CODE.
  • -10: BRAND_EMI_NOT_ENABLED_AND_PRODUCT_CODE_PRESENT_IN_REQUEST.
  • -11: EITHER PRODUCT_CODE NOT PRESENT OR MAPPING NOT PRESENT WITH MERCHANT.
RESPONSE_MESSAGEstringMessage corresponding to the response code.

Example: SUCCESS
PAYMENT_MODEstringThe payment mode you prefer to accept payment.

Accepted values:
  • 1: CREDIT/DEBIT CARD
  • 3: NET BANKING
  • 4:CREDIT EMI
  • 10: UPI
  • 11: WALLET
  • 14: DEBIT EMI
  • 16: PREBOOKING
  • 17: BNPL/FLEXIPAY
  • 19: Cardless EMI
  • 20: PBP (Paybypoints)
PINE_PG_TRANSACTION_IDstringUnique transaction ID generated by Plural against an Order ID.
Example: 12345678
ACQUIRER_NAMEstringThe acquirer's name for this transaction.

Example: BILLDESK
REFERENCE_NOstringReference number of merchant which is maintained by pine labs.
(Max length is 100)
Example: ABCDEFG
AMOUNTInt64Amount in Paisa.
  • Minimum value: 100 (₹1)
  • Maximum value: 100000000 (₹10 lakh)
Example: 1100
TXN_STATUSstringThe status of the transaction.
Note: Please refer to the Pine PG transaction status table to know the status.
REFUND_AMOUNTInt64The total amount refunded.

Example: 0
PARENT_TXN_STATUSintegerThe status code of the purchase transaction.

Example: 4
ACQUIRER_RESPONSE_CODEstringThe response code received from the acquirer.

Example: 1234
ACQUIRER_RESPONSE_MESSAGEstringMessage corresponding to the acquirer code.

Example: DEFAULT