Share payment link | Payroc

1	using RestSharp;
2
3	var client = new RestClient("https://api.payroc.com/v1/payment-links/JZURRJBUPS/sharing-events");
4	var request = new RestRequest(Method.POST);
5	request.AddHeader("Idempotency-Key", "8e03978e-40d5-43e8-bc93-6894a57f9324");
6	request.AddHeader("Authorization", "Bearer <token>");
7	request.AddHeader("Content-Type", "application/json");
8	request.AddParameter("application/json", "{\n \"merchantCopy\": true,\n \"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\",\n \"recipients\": [\n {\n \"email\": \"[email protected]\",\n \"name\": \"Sarah Hazel Hopper\"\n }\n ],\n \"sharingMethod\": \"email\"\n}", ParameterType.RequestBody);
9	IRestResponse response = client.Execute(request);

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

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

paymentLinkIdstringRequired=10 characters

Unique identifier that we assigned to the payment link.

Request

This endpoint expects an object.

emailobjectRequired

Object that contains the information about a sharing event that the merchant sent by email.

Response

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

emailobject

Object that contains the information about a sharing event that the merchant sent by email.

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

406

Not Acceptable Error

409

Conflict Error

415

Unsupported Media Type Error

500

Internal Server Error

Authentication

Path parameters

Headers

Request

Response

Errors