Cancel a Payment Link

PUT/api/pay/v1/paymentlink/{payment_link_id}/cancel

Cancel an existing payment link by its ID.

View as Markdown Open in ChatGPT Open in Claude Open in Perplexity

Requires Bearer token. Get token →

Path Parameters

Field	Details
`payment_link_id` `string`required	Unique Pine Labs payment link identifier.

Header Parameters

Field	Details
`Request-Timestamp` `string`date-time	ISO 8601 UTC timestamp of the request. Used for idempotency and audit.
`Request-ID` `string`	Use a global unique identifier [GUID] for the request. Constraints Minimum length: 1 characterMaximum length: 50 characters

Response

Field	Details
`payment_link` `string`	The payment link URL.
`payment_link_id` `string`	Unique identifier of the payment link in the Pine Labs Online database. Constraints Maximum length: 50 characters
`status` `string`	Payment link status. Allowed values: `CREATEDCLICKEDPAYMENT_INITIATEDPROCESSEDPARTIAL_PROCESSEDEXPIREDCANCELLED`
`amount` `object`2 nested fields	Monetary amount with currency.
`value` `integer`required	Amount in the smallest currency unit (e.g., paisa for INR). Constraints Minimum value: 100Maximum value: 50000000000
`currency` `string`required	Three-letter ISO 4217 currency code. Constraints Default value: INR
`amount_due` `object`2 nested fields	Monetary amount with currency.
`order_id` `string`	Unique identifier of the order in the Pine Labs Online database.
`merchant_payment_link_reference` `string`	Unique identifier entered while creating a payment link. Constraints Minimum length: 1 characterMaximum length: 50 characters
`description` `string`	Description message against the payment link.
`expire_by` `string`date-time	Timestamp when the payment link expires.
`allowed_payment_methods` `string[]`	Payment methods offered to the customer. Constraints Allowed item values: `CARDUPIPOINTSNETBANKINGWALLETCREDIT_EMIDEBIT_EMI`
`pre_auth` `boolean`	The pre-authorization type. true: When pre-authorization is needed. false (default): When pre-authorization is not required.
`failure_callback_url` `string`nullable	URL to redirect customers to a failure page.
`is_mcc_transaction` `boolean`	Identifies the Payment Link type. true: Processed for a MCC transaction. false (default): Processed for a regular transaction.
`customer` `object`10 nested fields	Customer information for payment link.
`product_details` `PaymentLinkProductDetail[]`3 nested fields	List of products associated with the payment.
`split_info` `object`2 nested fields	Split settlement information.
`account_details` `object`1 nested field	Customer's bank account details.
`cart_coupon_discount_amount` `object`2 nested fields	Monetary amount with currency.
`merchant_metadata` `object`	Arbitrary key-value pairs for merchant use. Maximum 10 pairs, 256 characters each. Constraints Maximum properties: 10 Additional properties: string · Maximum length: 256 characters
`created_at` `string`date-time	ISO 8601 UTC Timestamp when the payment link was created.
`updated_at` `string`date-time	ISO 8601 UTC Timestamp when the payment link was last updated.

Status Codes

`200`	Payment link cancelled successfully.
`500`	An unexpected error occurred on the server.

Run

Request

curl --request PUT \
  --url https://pluraluat.v2.pinepg.in/api/pay/v1/paymentlink/pl-v1-250306082755-aa-uT0noy/cancel \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN' \
  --header 'Request-ID: a1b2c3d4-e5f6-7890-abcd-ef1234567890' \
  --header 'Request-Timestamp: 2024-10-01T10:30:00Z'

Status:

{
  "payment_link": "https://shortener.v2.pinepg.in/PLUTUS/3rh4jtd",
  "payment_link_id": "pl-v1-250306082755-aa-uT0noy",
  "status": "CREATED",
  "amount": {
    "value": 50000,
    "currency": "INR"
  },
  "amount_due": {
    "value": 50000,
    "currency": "INR"
  },
  "order_id": "v1-250131113650-aa-TUzeRY",
  "merchant_payment_link_reference": "link_ref",
  "description": "Order Payment Link",
  "expire_by": "2024-04-30T08:01:32Z",
  "allowed_payment_methods": [
    "NETBANKING"
  ],
  "pre_auth": false,
  "failure_callback_url": null,
  "is_mcc_transaction": true,
  "customer": {
    "email_id": "kevin.bob@example.com",
    "first_name": "Kevin",
    "last_name": "Bob",
    "customer_id": "123456",
    "mobile_number": "9876543210",
    "country_code": "91",
    "billing_address": {
      "address1": "10 Downing Street Westminster London",
      "address2": "Oxford Street Westminster London",
      "address3": "Baker Street Westminster London",
      "pincode": "51524036",
      "city": "Westminster",
      "state": "Westminster",
      "country": "London"
    },
    "shipping_address": {
      "address1": "10 Downing Street Westminster London",
      "address2": "Oxford Street Westminster London",
      "address3": "Baker Street Westminster London",
      "pincode": "51524036",
      "city": "Westminster",
      "state": "Westminster",
      "country": "London"
    },
    "merchant_customer_reference": "customer_reference",
    "gstin": "27AAEPM1234C1Z5"
  },
  "product_details": [
    {
      "product_code": "redmi_10",
      "product_amount": {
        "value": 50000,
        "currency": "INR"
      },
      "product_coupon_discount_amount": {
        "value": 50000,
        "currency": "INR"
      }
    }
  ],
  "split_info": {
    "split_type": "AMOUNT",
    "split_details": [
      {
        "split_merchant_id": "111302",
        "merchant_settlement_reference": "5206071124-aa-mpLhF3-cc-l",
        "split_settlement_id": "71124-aa-mpLhF3-cc-l",
        "amount": {
          "value": 50000,
          "currency": "INR"
        },
        "on_hold": true,
        "status": "RELEASED",
        "updated_at": "2024-07-09T07:57:08.022Z"
      }
    ]
  },
  "account_details": {
    "bank_details": {
      "account_number": "500000004545",
      "ifsc_code": "BANK0000123",
      "bank_name": "Example Bank"
    }
  },
  "cart_coupon_discount_amount": {
    "value": 50000,
    "currency": "INR"
  },
  "merchant_metadata": {
    "clientId": "DD",
    "transactionReferenceNo": "pine-1223",
    "merchantId": "1234",
    "tid": "9000990",
    "acquirerName": "HDFC_FSS",
    "isOfferDisplayRequired": "true",
    "OfferData": "UHJvZHVjdF9Db2RlPSIgIiZQcm9kdWN0X05hbWU9IiImUGF5bWVudF9Nb2RlPUJhbmsgRU1JJkNhcmRfVHlwZT1EZWJpdCBDYXJkJkJhbmtfTmFtZT1IREZDIERlYml0JkVNSV9UZW51cmU9NiZJbnRlcmVzdF9SYXRlPTkuMCZJbnRlcmVzdF9BbW91bnQ9MTM4MTQwJk1vbnRobHlfSW5zdGFsbG1lbnQ9ODk0NjkwJkF1dGhvcml6YXRpb25fQW1vdW50PTEwMCZMb2FuX2Jvb2tpbmdfQW1vdW50PTUyMzAwMDAmSW50ZXJlc3RfQ2FzaGJhY2tfQW1vdW50PTAmSW50ZXJlc3RfQ2FzaGJhY2tfVHlwZT1EZWZlcnJlZCZBZGRpdGlvbmFsX0Nhc2hiYWNrPSIiJkFkZGl0aW9uYWxfQ2FzaGJhY2tfVHlwZT0iIiZEZXNjcmlwdGlvbj1CYW5rIEVNSSZQcm9kdWN0X1ZhbHVlPTUyMzAwMDA",
    "tenant_id": "PGATPOS",
    "is_offer_validation_required": "true"
  },
  "created_at": "2024-07-09T07:57:08.022Z",
  "updated_at": "2024-07-09T07:57:08.022Z"
}