Payment link webhook specifications

Payment link notifications sent to your webhook URI registered in Console.

There are two situations where the Payments v3 API sends a webhook notification for a payment link:

When a payment is created through a payment link.
When a payment link is disabled.

Learn more about the lifecycle of payment links and considerations when you configure webhooks.

payment_link_payment_created

This table displays the different fields you receive in the payment_link_payment_created webhook notification:

Field	Type	Description
`type`	string	The type of the event, in this case `payment_link_payment_created`.
`event_version`	integer	The version of the event schema.
`event_id`	string	The unique ID of the event.
`payment_link_id`	string	The unique ID for the payment link.
`payment`	object	Information about the payment created through the payment link. Includes two fields: - `id`: The unique ID for the payment, independent of the payment link. - `created_at`: The date and time at which the payment was created.

{
  "type": "payment_link_payment_created",
  "event_version": 1,
  "event_id": "b8d4dda0-ff2c-4d77-a6da-4615e4bad941",
  "payment_link_id": "aKiW35RWSyF",
  "payment": {
    "id": "60c0a60ed8d7-4e5b-ac79-401b1d8a8633",
    "created_at": "2021-12-25T15:00:00.000Z"
  }
}

payment_link_disabled

This table displays the different fields you receive in the payment_link_disabled webhook notification:

Field	Type	Description
`type`	String	The type of the event, in this case `payment_link_disabled`.
`event_version`	Integer	The version of the event schema.
`event_id`	String	The unique ID of the event.
`payment_link_id`	String	The unique ID for the payment link.
`disabled_reason`	Any	The reason that the payment link was disabled. Can be one of two reasons: - `expired`: The time specified in `expires_at` at payment link creation has passed. - `fulfilled`: The payment created through the payment link was completed successfully.
`disabled_at`	String	An RFC-3339 timestamp that says the date and time the payment link was disabled at.

{
"type": "payment_link_disabled",
"event_version": 1,
"event_id": "b8d4dda0-ff2c-4d77-a6da-4615e4bad941",
"payment_link_id": "aKiW35RWSyF",
"disabled_reason": "expired",
"disabled_at": "2021-12-25T15:00:00.000Z"
}

Updated 4 months ago