List payment links
Use this method to retrieve a paginated list of payment links linked to a processing terminal.
Note: If you want to view a specific payment link and you have its paymentLinkId, use our Retrieve Payment Link 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
Headers
Bearer authentication of the form Bearer <token>
, where token is your auth token.
Query parameters
Filter results by the type of link. Send a value of singleUse
or multiUse
.
Filter results by the user that entered the amount. Send one of the following values:
prompt
- Customer entered the amount.preset
- Merchant entered the amount.
Filter results by the status of the payment link. Send a value of active
, completed
,deactived
, or expired
.
Filter results by the link’s created date. Send a value in YYYY-MM-DD format.
Filter results by the link’s expiry date. Send a value in YYYY-MM-DD format.
Response
Successful request. Returns a paginated list of payment links.