Payment Link Payloads

Payment Links enable businesses to accept payments without a website or app by generating and sharing secure links via email, SMS, or social media.

The table below lists the various Webhook events available for Payment Links.

Payment Link Paid

{
  "account_id": "acc_DKoeHMNpi0nC7k",
  "contains": [
    "payment",
    "order",
    "payment_link"
  ],
  "created_at": 1596890208,
  "entity": "event",
  "event": "payment_link.paid",
  "payload": {
    "order": {
      "entity": {
        "amount": 10000,
        "amount_due": 0,
        "amount_paid": 10000,
        "attempts": 1,
        "created_at": 1596890282,
        "currency": "INR",
        "entity": "order",
        "id": "order_FOGs9Hz3ZaAjsm",
        "notes": {
          "Policy Name": "Jeevan Saral"
        },
        "offer_id": null,
        "offers": [
          "offer_FMdr9OHMx4sJTd",
          "offer_FMfpNfZzDhKWzZ"
        ],
        "receipt": "242324",
        "status": "paid"
      }
    },
    "payment": {
      "entity": {
        "acquirer_data": {
          "bank_transaction_id": "5786838"
        },
        "amount": 10000,
        "amount_refunded": 0,
        "amount_transferred": 0,
        "bank": "HDFC",
        "base_amount": 10000,
        "captured": true,
        "card_id": null,
        "contact": "+919988998899",
        "created_at": 1596890289,
        "currency": "INR",
        "description": "#FOGqq3O6E5bkml",
        "email": "gaurav.kumar@example.com",
        "entity": "payment",
        "error_code": null,
        "error_description": null,
        "error_reason": null,
        "error_source": null,
        "error_step": null,
        "fee": 236,
        "fee_bearer": "platform",
        "id": "pay_FOGsH8uHkF2FbR",
        "international": false,
        "invoice_id": null,
        "method": "netbanking",
        "notes": [],
        "order_id": "order_FOGs9Hz3ZaAjsm",
        "refund_status": null,
        "status": "captured",
        "tax": 36,
        "vpa": null,
        "wallet": null
      }
    },
    "payment_link": {
      "entity": {
        "accept_partial": false,
        "amount": 10000,
        "amount_paid": 10000,
        "callback_method": "",
        "callback_url": "",
        "cancelled_at": 0,
        "created_at": 1596890208,
        "currency": "INR",
        "customer": {
          "contact": "+919988998899",
          "email": "gaurav.kumar@example.com"
        },
        "description": "Payment Link created for policy no #222344",
        "expire_by": 1598898599,
        "expired_at": 0,
        "first_min_partial_amount": 0,
        "id": "plink_FOGqq3O6E5bkml",
        "notes": {
          "Policy Name": "Jeevan Saral"
        },
        "notify": {
          "email": true,
          "sms": true
        },
        "order_id": "order_FOGs9Hz3ZaAjsm",
        "payments": null,
        "reference_id": "242324",
        "reminder_enable": true,
        "reminders": {},
        "short_url": "https://rzp.io/i/vw4jjVn",
        "source": "",
        "source_id": "",
        "status": "paid",
        "updated_at": 1596890291,
        "user_id": "CJoeHHJLF5hsWe"
      }
    }
  }
}

Payment Link Partially Paid

{
  "account_id": "acc_DKoeHMNpi0nC7k",
  "contains": [
    "payment",
    "order",
    "payment_link"
  ],
  "created_at": 1596890514,
  "entity": "event",
  "event": "payment_link.partially_paid",
  "payload": {
    "order": {
      "entity": {
        "amount": 10000,
        "amount_due": 5000,
        "amount_paid": 5000,
        "attempts": 1,
        "created_at": 1596890536,
        "currency": "INR",
        "entity": "order",
        "id": "order_FOGwcUPfHfHmzW",
        "notes": {
          "Policy Name": "Jeevan Saral"
        },
        "offer_id": null,
        "offers": [
          "offer_FMdr9OHMx4sJTd",
          "offer_FMfpNfZzDhKWzZ"
        ],
        "receipt": "876767",
        "status": "attempted"
      }
    },
    "payment": {
      "entity": {
        "acquirer_data": {
          "rrn": "641070969475",
          "upi_transaction_id": "C9699F682E23B8121AD8C61DE1041EAE"
        },
        "amount": 5000,
        "amount_refunded": 0,
        "amount_transferred": 0,
        "bank": null,
        "base_amount": 5000,
        "captured": true,
        "card_id": null,
        "contact": "+919988998889",
        "created_at": 1596890944,
        "currency": "INR",
        "description": "#FOGwFAQyP9p5RT",
        "email": "gaurav.kumar@example.com",
        "entity": "payment",
        "error_code": null,
        "error_description": null,
        "error_reason": null,
        "error_source": null,
        "error_step": null,
        "fee": 118,
        "fee_bearer": "platform",
        "id": "pay_FOH3o1bAREIX1h",
        "international": false,
        "invoice_id": null,
        "method": "upi",
        "notes": [],
        "order_id": "order_FOGwcUPfHfHmzW",
        "refund_status": null,
        "status": "captured",
        "tax": 18,
        "vpa": "gaurav.kumar@exampleupi",
        "wallet": null
      }
    },
    "payment_link": {
      "entity": {
        "accept_partial": true,
        "amount": 10000,
        "amount_paid": 5000,
        "callback_method": "",
        "callback_url": "",
        "cancelled_at": 0,
        "created_at": 1596890514,
        "currency": "INR",
        "customer": {
          "contact": "+919988998899",
          "email": "gaurav.kumar@example.com"
        },
        "description": "Payment Link created for policy no #222344",
        "expire_by": 1598898599,
        "expired_at": 0,
        "first_min_partial_amount": 100,
        "id": "plink_FOGwFAQyP9p5RT",
        "notes": {
          "Policy Name": "Jeevan Saral"
        },
        "notify": {
          "email": true,
          "sms": true
        },
        "order_id": "order_FOGwcUPfHfHmzW",
        "payments": null,
        "reference_id": "876767",
        "reminder_enable": true,
        "reminders": {},
        "short_url": "https://rzp.io/i/t72ubmb",
        "source": "",
        "source_id": "",
        "status": "partially_paid",
        "updated_at": 1596890944,
        "user_id": "DKoeHHJLF5hsWe"
      }
    }
  }
}

Payment Link Cancelled

{
  "account_id": "acc_DKoeHMNpi0nC7k",
  "contains": [
    "payment",
    "order",
    "payment_link"
  ],
  "created_at": 1596891102,
  "entity": "event",
  "event": "payment_link.cancelled",
  "payload": {
    "order": {
      "entity": null
    },
    "payment": {
      "entity": null
    },
    "payment_link": {
      "entity": {
        "accept_partial": true,
        "amount": 10000,
        "amount_paid": 0,
        "callback_method": "",
        "callback_url": "",
        "cancelled_at": 1596891110,
        "created_at": 1596891102,
        "currency": "INR",
        "customer": {
          "contact": "9988999888",
          "email": "gaurav.kumar@example.com"
        },
        "description": "Payment Link created for policy no #222344",
        "expire_by": 1598898599,
        "expired_at": 0,
        "first_min_partial_amount": 100,
        "id": "plink_FOH6af7VB1nerE",
        "notes": {
          "Policy Name": "Jeevan Saral"
        },
        "notify": {
          "email": true,
          "sms": true
        },
        "payments": [],
        "reference_id": "343422",
        "reminder_enable": true,
        "reminders": {
          "status": "failed"
        },
        "short_url": "https://rzp.io/i/iM5nHMY",
        "source": "",
        "source_id": "",
        "status": "cancelled",
        "updated_at": 1596891110,
        "user_id": "DKoeHHJLF5hsWe"
      }
    }
  }
}

Payment Link Expired

{
  "account_id": "acc_DKoeHMNpi0nC7k",
  "contains": [
    "payment",
    "order",
    "payment_link"
  ],
  "created_at": 1596891102,
  "entity": "event",
  "event": "payment_link.expired",
  "payload": {
    "order": {
      "entity": null
    },
    "payment": {
      "entity": null
    },
    "payment_link": {
      "entity": {
        "accept_partial": true,
        "amount": 10000,
        "amount_paid": 0,
        "callback_method": "",
        "callback_url": "",
        "cancelled_at": 1596891110,
        "created_at": 1596891102,
        "currency": "INR",
        "customer": {
          "contact": "9988999888",
          "email": "gaurav.kumar@example.com"
        },
        "description": "Payment Link created for policy no #222344",
        "expire_by": 1598898599,
        "expired_at": 1598898599,
        "first_min_partial_amount": 100,
        "id": "plink_FOH6af7VB1nerE",
        "notes": {
          "Policy Name": "Jeevan Saral"
        },
        "notify": {
          "email": true,
          "sms": true
        },
        "payments": [],
        "reference_id": "343422",
        "reminder_enable": true,
        "reminders": {
          "status": "failed"
        },
        "short_url": "https://rzp.io/i/iM5nHMY",
        "source": "",
        "source_id": "",
        "status": "expired",
        "updated_at": 1596891110,
        "user_id": "DKoeHHJLF5hsWe"
      }
    }
  }
}

Watch Out!

If you have changed your webhook secret, remember to use the old secret for webhook signature validation while retrying older requests. Using the new secret will lead to a signature mismatch.

Do Not Parse or Cast the Webhook Request Body

While generating a signature at your end, ensure that the webhook body is passed as an argument in the raw webhook request body. Do not parse or cast the webhook request body.