Share payment link | Payroc

1	using Payroc;
2	using System.Threading.Tasks;
3	using Payroc.PaymentLinks.SharingEvents;
4	using System.Collections.Generic;
5
6	namespace Usage;
7
8	public class Example
9	{
10	public async Task Do() {
11	var client = new PayrocClient();
12
13	await client.PaymentLinks.SharingEvents.ShareAsync(
14	new ShareSharingEventsRequest {
15	PaymentLinkId = "JZURRJBUPS",
16	IdempotencyKey = "8e03978e-40d5-43e8-bc93-6894a57f9324",
17	Body = new PaymentLinkEmailShareEvent {
18	SharingMethod = PaymentLinkEmailShareEventSharingMethod.Email,
19	MerchantCopy = true,
20	Message = "Dear Sarah,\n\nYour insurance is expiring this month.\nPlease, pay the renewal fee by the end of the month to renew it.\n",
21	Recipients = new List<PaymentLinkEmailRecipient>(){
22	new PaymentLinkEmailRecipient {
23	Name = "Sarah Hazel Hopper",
24	Email = "[email protected]"
25	},
26	}
27
28	}
29	}
30	);
31	}
32
33	}

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	}

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

Authentication

Path parameters

Headers

Request

Response

Errors