Share payment link | Payroc

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.

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](https://docs.payroc.com/api/schema/payments/payment-links/create) method. **Note:** If you don't have the paymentLinkId, use our [List Payment Links](https://docs.payroc.com/api/schema/payments/payment-links/list) 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](https://docs.payroc.com/api/schema/payments/payment-links/sharing-events/list).

1	import requests
2
3	url = "https://api.payroc.com/v1/payment-links/JZURRJBUPS/sharing-events"
4
5	headers = {
6	"Idempotency-Key": "8e03978e-40d5-43e8-bc93-6894a57f9324",
7	"Authorization": "Bearer <token>",
8	"Content-Type": "application/json"
9	}
10
11	response = requests.post(url, headers=headers)
12
13	print(response.json())

1	{
2	"sharingMethod": "email",
3	"sharingEventId": "GTZH5WVXK9",
4	"dateTime": "2024-07-02T15:30:00Z",
5	"message": "Dear Sarah,\n\nYou can pay for your order via the link below.\n",
6	"recipients": [
7	{
8	"name": "Sarah Hazel Hopper",
9	"email": "[email protected]"
10	}
11	]
12	}

Authentication

Path parameters

Headers

Request

Response

Errors