sharingEvents

List payment link sharing events

Changed on

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.
get/payment-links/{paymentLinkId}/sharing-events

Request

  • Base URL
    https://api.payroc.com/v1
  • URL
    https://api.payroc.com/v1/payment-links/{paymentLinkId}/sharing-events
  • Auth
    HTTP bearer

Path parameters

paymentLinkIdstring required

Unique identifier that we assigned to the payment link.

Query parameters

recipientNamestring

Filter results by the customer's name.

recipientEmailstring

Filter results by the customer's email address.

beforestring

Return the previous page of results before the value that you specify.

You can’t send the before parameter in the same request as the after parameter.

afterstring

Return the next page of results after the value that you specify.

You can’t send the after parameter in the same request as the before parameter.

limitinteger

Limit the maximum number of results that we return for each page.

Response

Successful request. Returns a paginated list of sharing events for the payment link.

limitinteger required

Maximum number of results that we return for each page.

countinteger required

Number of results we returned on this page.

Note: This might not be the total number of results that match your query.

hasMoreboolean required

Indicates whether there is another page of results available.

Changes