Share payment link

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.

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.

Idempotency-KeystringRequiredformat: "uuid"

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

This endpoint expects an object.
Share via emailobjectRequired

Response

Successful request. We shared the payment link.
Share via emailobject

Errors