--- title: "List all payment links" method: GET path: "/link" tags: ["Pay By Link"] --- # List all payment links `GET /link` List all the payment links. **Required scope:** link:read ## Query parameters - `cursor` string - `limit` number - `id` string - `amount` string - `customer_name` string - `email` string - `phone_number` string - `created_at` string - `modified_at` string - `expiration_time` string - `payment_method[]` string - `status[]` string ## Response `200` OK - object - `metadata` MetadataCursor, required — An object containing additional information about the response. It includes details that help manage and navigate the retrieved data. - `next_cursor` string, required — Provides the cursor for the next set of records. This value should be used as the cursor parameter in subsequent requests to continue paginating through the data. If the cursor is an empty string or null, it indicates that there are no more results. To retrieve all available results, continue making subsequent requests until next_cursor is empty or null. - `count` number, required — The total number of records in the current response. This field indicates the number of items returned in the current set of results. - `data` LinkGetResponseObject[], required - `id` string, uuid — A unique identifier for the resource. While typically formatted as a UUID (Universally Unique Identifier), it can also be in other formats as defined by the user. This field ensures the resource can be distinctly recognized and referenced. - `created_at` string, date-time — String with the date on which this Pay By Link was created. - `modified_at` string, date-time — String with the date on which this Pay By Link was modified. - `expiration_time` string, date-time — The last possible time to make the payment. - `type` 'SINGLE' | 'FREQUENT' | 'SUBSCRIPTION' - `communication_channels` string[] — The communication channels specifies where the final customer link should be forwarded. - `customer` CustomerResponse — The Customer object contains detailed information about the customer required to create a pay-by-link. - `name` string, required — The full name of the customer. This field is used to identify the customer and personalize interactions. It typically includes the customer's first name and last name. - `email` string, email, required — The email address of the customer. This field is used for communication purposes, including sending transaction confirmations, receipts, and other notifications related to the customer's activities. - `phone` string, required — The contact phone number of the customer, excluding the country code indicator (e.g., "+351"). This field is used for communication purposes. If the payment method is MB WAY, the phone_number is required and is used to send the MB WAY push notification. - `payment` object - `methods` string[] — All the payment methods available to create a pay-by-link payment. - `capture` CaptureResponse - `descriptive` string — A customizable text field for users to input some descriptive associated with this capture operation. - `key` string — A customizable text field for users to input their own identifier for the resource. This can be any string that helps the user uniquely identify or reference the resource in their own system. - `single` SingleResponse — Single object with all the fields necessary after creating a Pay-by-Link request. - `requested_amount` string, required — String representing the monetary amount requested for the transaction. This field is formatted as a double, and will be rounded to two decimal places. - `frequent` FrequentResponse — Frequent object with all the fields necessary after creating a Pay-by-Link request. - `minimum_amount` string, required — Minimum value available to create a Pay-by-link request. - `maximum_amount` string, required — Maximum value available to create a Pay-by-link request. - `unlimited_payments` boolean, required — Determines whether payments can be unlimited. - `subscription` SubscriptionResponse — Subscription object with all the fields necessary after creating a Pay-by-Link request. - `frequency` '1D' | '1W' | '2W' | '1M' | '2M' | '3M' | '4M' | '6M' | '1Y' | '2Y' | '3Y', required — Determines how often the subscription payment is made. - `maximum_captures` integer — Determines the maximum number of captures for this subscription. **It's only required when no expiration_time is set.** - `start_time` string, required — Determines the start date of billing cycles for this subscription. This date must be always in the future. - `capture_now` boolean — Determines whether an immediate capture is performed. If this value is true, an immediate capture will be performed and the second capture will be on the date entered in the start_time field. - `retries` integer — Number of retries in each payment cycle. The chosen frequency will define the max number of possible retries. - `failover` boolean — After all retries failed, the payment cycle can have another try with another single method. - `expiration_time` string, date-time — RFC3339 formatted time for the subscription expiration date. - `url` string, url — Link that redirects to the Easypay checkout payment page. - `image` string, url — Link that redirects to a QR code to access the payment checkout page. - `status` 'ACTIVE' | 'EXPIRED' | 'DISABLED' | 'FINALIZED' ## Other responses - `400` — Bad Request - `403` — Forbidden - `500` — Internal Server Error --- [API](https://skmtc.net/easypay/apis/easypay-payments-api.md) · [All operations](https://skmtc.net/easypay/apis/easypay-payments-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/easypay/easypay-payments-api/versions/cdf25a9ad7b2/schema)