Lifecycle

Since a payment link is created, it is a live entity with a specific state. Based on actions to a payment link, it can transition from one state to another (e.g. from ready when the link is created to paid when the link is paid by a customer).

The following diagram depicts the lifecycle of a payment link.

Payment link lifecycle diagram

Status

Description

READY

The link has been created and ready for consumption.

PAID

The link has been consumed by a customer and payment was successful. It cannot be consumed.

CANCELLED

The link has been cancelled by the merchant. It cannot be consumed.

DECLINEDBYCUSTOMER

The link has been consumed and declined by the customer. It cannot be consumed.

EXPIRED

The link has expired. It cannot be consumed.

PENDING

Payment takes some extra time to be processed. It cannot be consumed.

Updated about a year ago


Lifecycle


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.


Top