Create payment link

using Payroc;
using System.Threading.Tasks;
using Payroc.PaymentLinks;
using System.Collections.Generic;
namespace Usage;
public class Example
{
    public async Task Do() {
        var client = new BasePayrocClient(
            clientOptions: new ClientOptions {
                Environment = PayrocEnvironment.Production
            }
        );
        await client.PaymentLinks.CreateAsync(
            new CreatePaymentLinksRequest {
                ProcessingTerminalId = "1234001",
                IdempotencyKey = "8e03978e-40d5-43e8-bc93-6894a57f9324",
                Body = new CreatePaymentLinksRequestBody(
                    new MultiUsePaymentLink {
                        MerchantReference = "LinkRef6543",
                        Order = new MultiUsePaymentLinkOrder {
                            Description = "Pie It Forward charitable trust donation",
                            Charge = new MultiUsePaymentLinkOrderCharge(
                                new PromptPaymentLinkCharge {
                                    Currency = Currency.Usd
                                }
                            )
                        },
                        AuthType = MultiUsePaymentLinkAuthType.Sale,
                        PaymentMethods = new List<MultiUsePaymentLinkPaymentMethodsItem>(){
                            MultiUsePaymentLinkPaymentMethodsItem.Card,
                            MultiUsePaymentLinkPaymentMethodsItem.BankTransfer,
                        }
                        ,
                        CustomLabels = new List<CustomLabel>(){
                            new CustomLabel {
                                Element = CustomLabelElement.PaymentButton,
                                Label = "SUPPORT US"
                            },
                        }
                    }
                )
            }
        );
    }
}

{
  "type": "multiUse",
  "paymentLinkId": "JZURRJBUPS",
  "merchantReference": "LinkRef6543",
  "order": {
    "description": "Pie It Forward charitable trust donation",
    "charge": {
      "type": "prompt",
      "currency": "USD"
    }
  },
  "authType": "sale",
  "paymentMethods": [
    "card",
    "bankTransfer"
  ],
  "customLabels": [
    {
      "element": "paymentButton",
      "label": "SUPPORT US"
    }
  ],
  "assets": {
    "paymentUrl": "https://payments.payroc.com/merchant/pay-by-link?token=02ada211-ff51-4845-b0b5-e685aeb4b19d",
    "paymentButton": "<a href=\"https://payments.payroc.com/merchant/pay-by-link?token=02ada211-ff51-4845-b0b5-e685aeb4b19d\" \ntarget=\"_blank\" style=\"color: #ffffff; background-color: #6C7A89; font-size: 18px; font-family: Helvetica, Arial, sans-serif; \ntext-decoration: none; border-radius: 30px; padding: 14px 28px; display: inline-block;\">SUPPORT US</a>\n"
  },
  "status": "active",
  "createdOn": "2024-09-24"
}

Use this method to create a payment link that a customer can use to make a payment for goods or services.

The request includes the following settings:

type - Indicates whether the link can be used only once or if it can be used multiple times.
authType - Indicates whether the transaction is a sale or a pre-authorization.
paymentMethod - Indicates the payment methods that the merchant accepts.
charge - Indicates whether the merchant or the customer enters the amount for the transaction.

If your request is successful, our gateway returns a paymentLinkId, which you can use to perform follow-on actions.

Note: To share the payment link with a customer, use our Share Payment Link method.

Use this method to create a payment link that a customer can use to make a payment for goods or services. The request includes the following settings: - **type** - Indicates whether the link can be used only once or if it can be used multiple times. - **authType** - Indicates whether the transaction is a sale or a pre-authorization. - **paymentMethod** - Indicates the payment methods that the merchant accepts. - **charge** - Indicates whether the merchant or the customer enters the amount for the transaction. If your request is successful, our gateway returns a paymentLinkId, which you can use to perform follow-on actions. **Note:** To share the payment link with a customer, use our [Share Payment Link](https://docs.payroc.com/api/schema/payment-links/sharing-events/share) method.

Authentication

AuthorizationBearer

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

Path parameters

processingTerminalIdstringRequired4-50 characters

Unique identifier that we assigned to the terminal.

Request

Polymorphic object that contains payment link information.

The value of the type parameter determines which variant you should use:

multiUse - Create a link that the merchant can use to take multiple payments.
singleUse - Create a link that the merchant can use for only one payment.

Polymorphic object that contains payment link information. The value of the type parameter determines which variant you should use: - `multiUse` - Create a link that the merchant can use to take multiple payments. - `singleUse` - Create a link that the merchant can use for only one payment.

multiUseobjectRequired

singleUseobjectRequired

Response headers

locationstring or null

URI reference to created resource.

Response

Successful request. We return a polymorphic object that contains payment link information. The value of the type parameter determines which variant you should use:

multiUse - Create a link that the merchant can use to take multiple payments.
singleUse - Create a link that the merchant can use for only one payment.

Successful request. We return a polymorphic object that contains payment link information. The value of the type parameter determines which variant you should use: - `multiUse` - Create a link that the merchant can use to take multiple payments. - `singleUse` - Create a link that the merchant can use for only one payment.

multiUseobject

singleUseobject

Authentication

Path parameters

Headers

Request

Response headers

Response

Errors