List payment link sharing events.
Use this method to retrieve a paginated list of sharing events for a payment link. A sharing event occurs when a merchant shares a payment link with a customer.
Path parameters
paymentLinkId
Unique identifier that we assigned to the payment link.
Headers
Authorization
Bearer authentication of the form Bearer <token>, where token is your auth token.
Query parameters
recipientName
Filter results by the customer's name.
recipientEmail
Filter results by the customer's email address.
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 sharing events for the payment link.
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 link sharing events.
links
Reference links to navigate to the previous page of results, or to the next page of results.