--- title: "List payment links" method: GET path: "/processing-terminals/{processingTerminalId}/payment-links" tags: ["paymentLinks"] --- # List payment links `GET /processing-terminals/{processingTerminalId}/payment-links` Use this method to return a [paginated](https://docs.payroc.com/api/pagination) list of payment links linked to a processing terminal. **Note:** If you want to view the details of a specific payment link and you have its paymentLinkId, use our [Retrieve Payment Link](https://docs.payroc.com/api/schema/payment-links/retrieve) method. Use query parameters to filter the list of results that we return, for example, to search for only active links or multi-use links. Our gateway returns the following information about each payment link in the list: - **type** - Indicates whether the link can be used only once or if it can be used multiple times. - **authType** - Indicates whether the transaction is a sale or a pre-authorization. - **paymentMethods** - Indicates the payment method that the merchant accepts. - **charge** - Indicates whether the merchant or the customer enters the amount for the transaction. - **status** - Indicates if the payment link is active. For each payment link, we also return a paymentLinkId, which you can use for follow-on actions. ## Path parameters - `processingTerminalId` string, required ## Query parameters - `merchantReference` string - `linkType` 'multiUse' | 'singleUse' - `chargeType` 'preset' | 'prompt' - `status` 'active' | 'completed' | 'deactivated' | 'expired' - `recipientName` string - `recipientEmail` string - `createdOn` string, date - `expiresOn` string, date - `before` string - `after` string - `limit` integer ## Headers - `Authorization` string, required ## Response `200` Successful request. Returns a [paginated](https://docs.payroc.com/api/pagination) list of payment links. - PaymentLinkPaginatedList - `limit` integer, required — Maximum number of results that we return for each page. - `count` integer, required — Number of results we returned on this page. **Note:** This might not be the total number of results that match your query. - `hasMore` boolean, required — Indicates whether there is another page of results available. - `links` Link[] — Reference links to navigate to the previous page of results or to the next page of results. - `rel` string, required — Indicates the relationship between the current resource and the target resource. - `method` string, required — HTTP method that you need to use with the target resource. - `href` string, required — URL of the target resource. - `data` PaymentLinkPaginatedListDataItems[], required — Array of polymorphic objects that contains payment link information. The value of the type parameter determines which variant you should use: - 'multiUse' - Create a link that the merchant can use to take multiple payments. - 'singleUse' - Create a link that the merchant can use for only one payment. - union - MultiUsePaymentLink — Object that contains information about a multi-use payment link. - `type` 'multiUse', required — Type of link. The merchant can use a multi-use link to take multiple payments. - `paymentLinkId` string — Unique identifier that we assigned to the payment link. - `merchantReference` string, required — Unique identifier that the merchant assigned to the payment. - `order` MultiUsePaymentLinkOrder, required — Object that contains information about the order. - `description` string — A brief description of the transaction. - `charge` union, required — Polymorphic object that indicates who enters the amount for the payment link. The value of the type parameter determines which variant you should use: - `prompt` - Customer enters the amount. - `preset` - Merchant sets the amount. - PromptPaymentLinkCharge — Object that contains information about the charge when the customer enters the amount of the transaction. - … - PresetPaymentLinkCharge — Object that contains information about the charge when the merchant enters the amount of the transaction. - … - `authType` 'sale' | 'preAuthorization', required — Type of transaction. - `paymentMethods` MultiUsePaymentLinkPaymentMethodsItems[], required — Payment methods that the merchant accepts. **Note:** If a payment is a pre-authorization, the customer must pay by card. - `customLabels` CustomLabel[] — Array of customLabel objects. **Note:** You can change the label of the payment button only. - `element` 'paymentButton' — Element that you want to provide a custom label for. - `label` string — Custom label to display on the element. - `assets` PaymentLinkAssets — Object that contains shareable assets for the payment link. - `paymentUrl` string, required — URL of the payment link. - `paymentButton` string, html, required — HTML code for the payment link. You can embed the HTML code in the merchant's website. - `status` 'active' | 'completed' | 'deactivated' | 'expired' — Status of the payment link. The value is one of the following: - `active` - Payment link is active. - `completed` - Customer has paid. - `deactivated` - Merchant has deactivated the link. - `expired` - Payment link has expired. - `createdOn` string, date — Date that the merchant created the link. The format of this value is **YYYY-MM-DD**. - `expiresOn` string, date — Last date that the customer can use the payment link. The format of this value is **YYYY-MM-DD**. **Note:** If you don't provide an expiration date, the default expiration period applies. You can change the default expiration period on the Self-Care Portal. - `credentialOnFile` CredentialOnFile — Object that contains information about saving the customer’s payment details. - `tokenize` boolean — Indicates if our gateway should tokenize the customer’s payment details as part of the transaction. - `mitAgreement` 'unscheduled' | 'recurring' | 'installment' — Indicates how the merchant can use the customer’s card details, as agreed by the customer: - `unscheduled` - Transactions for a fixed or variable amount that are run at a certain pre-defined event. - `recurring` - Transactions for a fixed amount that are run at regular intervals, for example, monthly. Recurring transactions don’t have a fixed duration and run until the customer cancels the agreement. - `installment` - Transactions for a fixed amount that are run at regular intervals, for example, monthly. Installment transactions have a fixed duration. **Note:** If you send a value for **mitAgreement**, you must send the **standingInstructions** object in the **paymentOrder** object. - SingleUsePaymentLink — Object that contains information about a single-use payment link. - `type` 'singleUse', required — Type of link. The merchant can use this link for only one payment. - `paymentLinkId` string — Unique identifier that we assigned to the payment link. - `merchantReference` string, required — Unique identifier that the merchant assigned to the payment. - `order` SingleUsePaymentLinkOrder, required — Object that contains information about the order. - `orderId` string, required — Unique identifier that the merchant assigned to the order. - `description` string — A brief description of the transaction. - `charge` union, required — Polymorphic object that indicates who enters the amount for the payment link. The value of the type parameter determines which variant you should use: - `prompt` - Customer enters the amount. - `preset` - Merchant sets the amount. - PromptPaymentLinkCharge — Object that contains information about the charge when the customer enters the amount of the transaction. - … - PresetPaymentLinkCharge — Object that contains information about the charge when the merchant enters the amount of the transaction. - … - `authType` 'sale' | 'preAuthorization', required — Type of transaction. - `paymentMethods` SingleUsePaymentLinkPaymentMethodsItems[], required — Payment methods that the merchant accepts. **Note:** If the payment is a pre-authorization, the customer must pay by card. - `customLabels` CustomLabel[] — Array of customLabel objects. **Note:** You can change the label of the payment button only. - `element` 'paymentButton' — Element that you want to provide a custom label for. - `label` string — Custom label to display on the element. - `assets` PaymentLinkAssets — Object that contains shareable assets for the payment link. - `paymentUrl` string, required — URL of the payment link. - `paymentButton` string, html, required — HTML code for the payment link. You can embed the HTML code in the merchant's website. - `status` 'active' | 'completed' | 'deactivated' | 'expired' — Status of the payment link. The value is one of the following: - `active` - Payment link is active. - `completed` - Customer has paid. - `deactivated` - Merchant has deactivated the link. - `expired` - Payment link has expired. - `createdOn` string, date — Date that the merchant created the link. The format of this value is **YYYY-MM-DD**. - `expiresOn` string, date, required — Last date that the customer can use the payment link. The format of this value is **YYYY-MM-DD**. - `credentialOnFile` CredentialOnFile — Object that contains information about saving the customer’s payment details. - `tokenize` boolean — Indicates if our gateway should tokenize the customer’s payment details as part of the transaction. - `mitAgreement` 'unscheduled' | 'recurring' | 'installment' — Indicates how the merchant can use the customer’s card details, as agreed by the customer: - `unscheduled` - Transactions for a fixed or variable amount that are run at a certain pre-defined event. - `recurring` - Transactions for a fixed amount that are run at regular intervals, for example, monthly. Recurring transactions don’t have a fixed duration and run until the customer cancels the agreement. - `installment` - Transactions for a fixed amount that are run at regular intervals, for example, monthly. Installment transactions have a fixed duration. **Note:** If you send a value for **mitAgreement**, you must send the **standingInstructions** object in the **paymentOrder** object. ## Other responses - `400` — Invalid request - `401` — Identity could not be verified - `403` — Do not have permissions to perform this action - `404` — Resource not found - `406` — Not acceptable - `500` — An error has occured --- [API](https://skmtc.dev/payroc/apis/schema.md) · [All operations](https://skmtc.dev/payroc/apis/schema/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/payroc/schema/revisions/1d9d3e305945/schema)