sharingEvents

Share payment link

Changed on

Use this method to email a payment link to a customer.

To email 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.

In the request, you must provide the recipient's name and email address.

In the response, our gateway returns a sharingEventId, which you can use to List Payment Link Sharing Events.

post/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.

Headers

Idempotency-Keystring uuid required

Unique identifier that you generate for each request. You must use the UUID v4 format for the identifier. For more information about the idempotency key, go to Idempotency.

Request body

sharingMethod'email' required

Method that the merchant uses to share the payment link.

sharingEventIdstring

Unique identifier that we assigned to the sharing event.

dateTimestring date-time

Date and time that the merchant shared the link. Our gateway returns this value in the ISO 8601 format.

merchantCopyboolean

Indicates if we send a copy of the email to the merchant. By default, we don't send a copy to the merchant.

messagestring

Message that the merchant sends with the payment link.

Response

Successful request. We return a polymorphic object that contains information about how the merchant shared a payment link.

sharingMethod'email' required

Method that the merchant uses to share the payment link.

sharingEventIdstring

Unique identifier that we assigned to the sharing event.

dateTimestring date-time

Date and time that the merchant shared the link. Our gateway returns this value in the ISO 8601 format.

merchantCopyboolean

Indicates if we send a copy of the email to the merchant. By default, we don't send a copy to the merchant.

messagestring

Message that the merchant sends with the payment link.

Changes