List payment links
Use this method to retrieve a paginated list of payment links for a processing terminal.
Path parameters
processingTerminalId
Unique identifier that we assigned to the terminal.
Headers
Authorization
Bearer authentication of the form Bearer <token>, where token is your auth token.
Query parameters
merchantReference
Filter results by the unique identifier that the merchant assigned to the payment link.
linkType
Filter results by the type of link. Send a value of singleUse
or multiUse
.
Allowed values:
chargeType
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.
Allowed values:
status
Filter results by the status of the payment link. Send a value of active
, completed
,deactived
, or expired
.
Allowed values:
recipientName
Filter results by the customer's name.
recipientEmail
Filter results by the customer's email address.
createdOn
Filter results by the link’s created date. Send a value in YYYY-MM-DD format.
expiresOn
Filter results by the link’s expiry date. Send a value in YYYY-MM-DD format.
before
Points to the resource identifier that you want to receive your results before. Typically, this is the first resource on the previous page.
after
Points to the resource identifier that you want to receive your results after. Typically, this is the last resource on the previous page.
limit
States the total amount of results the response is limited to.
Response
Successful request. Returns a paginated list of payment links.
limit
Maximum number of results that we return for each page.
count
Number of results that we returned.
hasMore
Indicates that further results are available.
data
Array of payment links.
links
Reference links to navigate to the previous page of results or to the next page of results.