SchemaPaymentsPayment LinksSharing Events

List payment link sharing events

Use this method to return a paginated list of sharing events for a payment link. A sharing event occurs when a merchant shares a payment link with a customer.

To list the sharing events for a payment link, you need its paymentLinkId. Our gateway returned the paymentLinkId in the response of the Create Payment Link method.

Note: If you don’t have the paymentLinkId, use our List Payment Links method to search for the payment link.

Use query parameters to filter the list of results that we return, for example, to search for links sent to a specific customer.

Our gateway returns the following information for each sharing event in the list:

  • Customer that the merchant sent the link to.
  • Date that the merchant sent the link.

Path parameters

paymentLinkIdstringRequired=10 characters
Unique identifier that we assigned to the payment link.

Headers

AuthorizationstringRequired

Bearer authentication of the form Bearer <token>, where token is your auth token.

Query parameters

recipientNamestringOptional>=1 character<=48 characters
Filter results by the customer's name.
recipientEmailstringOptional>=6 characters<=128 characters
Filter results by the customer's email address.
beforestringOptional
Points to the resource identifier that you want to receive your results before. Typically, this is the first resource on the previous page.
afterstringOptional
Points to the resource identifier that you want to receive your results after. Typically, this is the last resource on the previous page.
limitintegerOptional<=100Defaults to 10
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.

limitdouble
Maximum number of results that we return for each page.
countdouble
Number of results that we returned.
hasMoreboolean
Indicates that further results are available.
datalist of objects
Array of sharing events for the payment link.

Errors