# Create a Payment Link

{% embed url="<https://vimeo.com/1127706303/a6f62ddaba?fe=ci&fl=sv&share=copy>" %}

For prerequisites and additional information check the [Pay by Link](/online-payments/pay-by-link.md) documentation.

1. Log into [Verifone Central.](broken://spaces/Q3smMgXPN2Pd9t38gg1d/pages/xtNZm2bMCANroETthpG2)
2. Navigate to **Commerce** > *Payment Tools* > **Pay by Link**.

   ![Pay by link](https://verifone.cloud/sites/default/files/inline-images/1_50.jpg)
3. In the [Payment Links](/online-payments/pay-by-link/payment-links-in-verifone-central.md) page, click on the **Create Payment Link** button at the top of the page.

   ![payment links page](https://verifone.cloud/sites/default/files/inline-images/2_51.JPG)
4. The *Create Payment Link* page will be displayed. You’ll now be prompted to enter the **Payment Settings**, such as the **Amount**, **Payment Methods**, and **Customer information**.

### Payment settings <a href="#payment-settings" id="payment-settings"></a>

<div data-with-frame="true"><img src="https://verifone.cloud/sites/default/files/inline-images/PBL_0.jpg" alt="" width="375"></div>

* Select the **Organization** to which the transaction belongs. If your account is associated with only one organization, this field will pre-populate, otherwise, if it is associated with multiple organizations, you will need to select one organization from the list.

  <div data-gb-custom-block data-tag="hint" data-style="warning" class="hint hint-warning"><p>A compatible Payment Provider Contract (PPC) with an e-commerce sales channel is required to use the Pay by Link tool.</p></div>
* If the default option for **Cart information** is selected:

  * Use the left-hand side dropdown menu to select the **Currency**. If you only have one currency available, this will automatically be selected.
    * The default currency field will pre-populate as per your Organization's setup.
  * Enter the **Amount** in the righthand side field.

  <div data-gb-custom-block data-tag="hint" data-style="info" class="hint hint-info"><p>(Optional) Select the <strong>Amount &#x26; Product</strong> button to create a list of specific products the customer is purchasing.</p><ul><li>Use the<a href="/pages/pTlKO1rzCK85x1SgFK25"> <em>Product Catalog</em> </a>page to prepopulate the product details.</li><li>Enter the <em>Product description</em>, <em>Quantity</em> and <em>Price per unit</em>.</li><li>(Optional) Enter a <em>Product ID/SKU</em>. Typically, this is the Stock Keeping Unit (SKU) number.</li></ul><p>(Optional) Use the <strong>Add Product</strong> button to add more products and repeat the previous two steps.</p></div>

  <div data-with-frame="true"><img src="https://verifone.cloud/sites/default/files/inline-images/image_72.png" alt="" height="555" width="446"></div>

  <div data-gb-custom-block data-tag="hint" data-style="info" class="hint hint-info"><p>(<strong>Available for Australia and New Zealand</strong>) You can specify per product line item whether it is taxable or not, by enabling the <strong>GST</strong> (Goods and Services Taxes) toggle button.</p></div>

  <div data-with-frame="true"><img src="https://verifone.cloud/sites/default/files/inline-images/1_128.JPG" alt="" width="375"></div>
* (Optional) ([Wood Forest National Bank](/online-payments/supported-acquirers.md#woodforest-national-bank) and [Worldpay US](/online-payments/supported-acquirers.md#worldpay-us) merchants only), the following fields will be displayed:
  * **Amount is taxable**: Click the checkbox to indicate the amount of the payment that is taxable.
  * **Tax Amount**: The amount of tax to be paid on the purchase. Only displayed if the *Amount is taxable* checkbox is checked.
  * **PO Number** (Purchase Order Number): The number of the purchase as assigned by you).
* (Recommended) Enter a **Merchant Reference**. Text or a number of your choosing to help you identify the payment and link this with your order system. Also used to search for this link within the *Payment Links* page. &#x20;

  <div data-gb-custom-block data-tag="hint" data-style="info" class="hint hint-info"><p><em>Merchant Reference</em> field for Pay by Link is restricted to 50 characters.</p></div>
* (Optional) Enter an **Invoice Number**. Text or a number to help you link the payment with your invoicing system.

  <div data-gb-custom-block data-tag="hint" data-style="info" class="hint hint-info"><p> The <strong>Merchant Reference</strong> and <strong>Invoice Number</strong> can be used to <a href="/spaces/dzivQyj8aHN5Kvmx8apX/pages/S2cT0udjOyu716uUURQC">search</a> for a specific transaction in your <a href="/spaces/dzivQyj8aHN5Kvmx8apX/pages/UpqHpP1lAnC1JRjYrUiU">Orders / Transaction Reports</a>.</p></div>
* (Optional) Enter a **Sales Identifier**. Text or a number that some in-store devices also use during the transaction, allowing you to filter across your payment channels.
* Select from your available list of your **Payment Methods**. If you have only one available, this will be automatically selected for you. The payment method needs to be supported by your [acquirer](/online-payments/supported-acquirers.md).

  <div data-gb-custom-block data-tag="hint" data-style="warning" class="hint hint-warning"><p>Depending on the settings in your <a href="/spaces/Q3smMgXPN2Pd9t38gg1d/pages/bPyZ7V1fLgXFwOyS2Ndk">Payment Provider Contract (PPC)</a> you will be prompted with different fields.</p></div>

  * (if applicable) The **Payment Contract** field will be displayed only if there will be more than one available PPC for the selected organization and currency.

    <div data-with-frame="true"><figure><img src="https://verifone.cloud/sites/default/files/inline-images/2_84.JPG" alt=""><figcaption></figcaption></figure></div>
  * (For Israel) Select *Authorization* or *Preauthorization* as **Authorization Type**.
    * **Authorization** - An authorization transaction puts the customers funds on hold, which should be used for when the final amount [charged ](/online-payments/pay-by-link/payment-link-actions.md)is known.
    * **Preauthorization** – Also puts the customers funds on hold but is used for when the final amount [captured ](/online-payments/pay-by-link/payment-link-actions.md)is not known and may be less than the initial amount
  * (If applicable) Choose between *Sale* and *Standard instalment* in the **Credit term** field.
    * **Sale** - A standard payment. The sale transaction implies authorization (putting the funds on hold) and capture is done in one single step.
    * **Instalments** –Select the maximum number of payments needed.
  * (If applicable) For each wallet, choose the **SCA Compliance Type**.
    * **None** - No 3D Secure authentication will not be required.
    * **Wallet** - 3D Secure authentication will be required at the Wallet providers discretion.
    * **Force\_3DS** - 3D Secure authentication will always be required.

      <div data-with-frame="true"><figure><img src="https://verifone.cloud/sites/default/files/inline-images/3_63.JPG" alt="" width="563"><figcaption></figcaption></figure></div>
* Check the option for Enable 3D Secure authentication if required. Under the [Strong Customer Authentication](/online-payments/strong-customer-authentication-sca.md) regulations, [3D Secure](/online-payments/strong-customer-authentication-sca/3d-secure.md) is required for all regions except the United States and Canada.

  <div data-gb-custom-block data-tag="hint" data-style="warning" class="hint hint-warning"><p>For some regions where 3D Secure is mandatory, this option will be restricted to enabled.</p></div>
* The **Automatically send transaction for capture** checkbox is selected by default, enabling you to perform a sale transaction (authorization + capture). If you unselect this checkbox, you will have to manually perform the [capture ](/online-payments/pay-by-link/payment-link-actions.md)after the customer has completed the payment link.
* Enter the **Customer details**. These are required for 3D Secure, [Klarna](/online-payments/advanced-payment-methods-apms/klarna.md), [MobilePay ](/online-payments/advanced-payment-methods-apms/mobilepay.md)and [Vipps](/online-payments/advanced-payment-methods-apms/vipps.md).

  <div data-gb-custom-block data-tag="hint" data-style="info" class="hint hint-info"><p>You can use the <a href="/pages/EvKJmmAkCz4Wvd06HlbL">Customer Catalog</a> feature to prepopulate the necessary fields in the <em>Customer details</em> section.</p></div>

  * Enter the **First Name** and **Last Name**.
  * Enter the **Phone Number**. Use the dropdown menu to select the correct country code.
    * The default country field selector will pre-populate as per your Organization's setup.
  * Enter the **Email Address**. This email can also be used, later, to track the payment link. The field will be displayed as *Email (Customer)*, in the payment links list page.
  * Enter the **Identifier**. An optional identifier of the document recipient.
    * Personal ID (for individuals)
    * Tax identification number (for business)
  * Enter the **Billing Address** information
    * (UK merchants only) Do not use the state/province field.
    * The default country field selector will pre-populate as per your Organization's setup.
  * (Optional) Uncheck **The shipping address is the same as the billing address** checkbox if you need to enter a different **Shipping Address**.

Once the payment settings are completed, click on **Continue to link settings** to proceed and customize the payment link experience for your customer.

### Link settings <a href="#link-settings" id="link-settings"></a>

<div data-with-frame="true"><img src="https://verifone.cloud/sites/default/files/inline-images/1_127.JPG" alt="" width="375"></div>

* (Optional) Use the **Link Expiration** setting to control how long the payment link should remain active. The maximum is 30 days from the time you created the link. Once it expires, the customer cannot access the payment link.

  <div data-gb-custom-block data-tag="hint" data-style="info" class="hint hint-info"><p>You can disable and <a href="/pages/B0E36kQ4LmriDjEXel3v">re-enable</a> payment link’s via the <em>Payment Links</em> menu.</p></div>
* (Optional) Choose the **Preselected language** to be used in the customers checkout page.
* (Optional) Set a **Checkout theme** of your choice to personalize the Pay by Link checkout page. You can choose the *Default theme* (the default template theme provided by Verifone) or a customized theme created via the [Checkout Themes Editor.](broken://spaces/Q3smMgXPN2Pd9t38gg1d/pages/yE7fhQCJNkBNAm4KYRsS)
* (Optional) Use the **Delivery Settings** to send the payment link directly to the customer. If you didn't use this option you can always [send the payment link](/online-payments/pay-by-link/payment-link-actions.md) at a later time.

  * Use **Send link by email** to send via email. After entering the email address, the email can also be used, later, to track down the payment link. The field will be displayed as *Email (Recipient)*, in the payment links list page.
  * Use **Send link by phone** number to send via SMS text message.

  Once you have entered your desired settings, click on the **Create payment link** button to proceed.

  <div data-gb-custom-block data-tag="hint" data-style="info" class="hint hint-info"><p>You can always edit the previous payment configuration, by selecting the <strong>Back to payment settings</strong> button.  </p></div>

### Done page

A success page will be displayed confirming the Payment link was successfully created.

<div data-with-frame="true"><figure><img src="/files/9XHL0VI8p0VvFpRoUMF6" alt="" width="344"><figcaption></figcaption></figure></div>

* (Optional) The payment link can be copied to a clipboard, by pressing the **Copy link** button, allowing you to share the payment link with the customer directly through your desired channel.
* (Optional) The **Send payment link** button can be used to send the link via an SMS text message or email to the customer.

Use the **Return to Payment Links** button to go back to the *Payment Links* page.

## Payment Link details <a href="#sharing" id="sharing"></a>

1. Navigate to the *Payment Links* page, and find the payment link you wish to send.

   * The **Created time**, **Email (Recipient)**, **Email (Customer)**, **Amount**, **Merchant Reference** and **Status** will be displayed to help you identify each payment link.
   * To search for a specific payment link, select the needed identifier and click **Search**.
     * **Merchant Reference**: enter the merchant reference used when creating the payment link.
     * **Email (Customer)**: enter the email address used when creating the payment link, if the *Customer details* section was completed.
     * **Phone Number (Customer)**: enter the phone number used when creating the payment link, if the *Customer details* section was completed.
     * **First Name (Customer)**: enter the first name used when creating the payment link, if the *Customer details* section was completed.
     * **Last Name (Customer)**: enter the last name used when creating the payment link, if the *Customer details* section was completed.
   * You can also filter the displayed payment links by **Date**, **Organizations** and **Payment status**.

   <div data-with-frame="true"><img src="https://verifone.cloud/sites/default/files/inline-images/1_172.JPG" alt=""></div>
2. Confirm the details of the Payment Link and **click anywhere on its row** for the [Payment Link Details](/online-payments/pay-by-link/payment-links-in-verifone-central.md#payment-link-details) to appear.

   <figure><img src="https://verifone.cloud/sites/default/files/inline-images/2_121.JPG" alt=""><figcaption></figcaption></figure>

### Confirmation of payment <a href="#confirmation-of-payment" id="confirmation-of-payment"></a>

Navigate to the *Payment links* page and select the desired payment link to view the [Payment Link Details. ](/online-payments/pay-by-link/payment-links-in-verifone-central.md)

* The transaction can be considered successful when marked with the **Paid** [Payment Link Status](/online-payments/pay-by-link/payment-links-in-verifone-central.md).
* The history will display the **Transaction Successful** event.
* The **View Transaction Details** button can be used to be transferred to the [Orders / Transaction Reports ](broken://spaces/Q3smMgXPN2Pd9t38gg1d/pages/UpqHpP1lAnC1JRjYrUiU)page to view more detailed information about the transaction itself.

<div data-with-frame="true"><img src="https://verifone.cloud/sites/default/files/inline-images/3_68.JPG" alt="" height="732" width="400"></div>

## Using Pay by Link via the API <a href="#using-pay-by-link-via-the-api" id="using-pay-by-link-via-the-api"></a>

### Required fields

To configure [Checkout](/api-reference/open-api-references/checkout.md) for accepting Pay by Link, the following fields are required:&#x20;

* `entity_id` - This value can be found in the portal or provided to you by a Verifone employee. The Entity ID can be found in Verifone Central under *Administration → Organizations*. The 'Organization ID' listed is the Entity ID.

  <div data-with-frame="true"><img src="https://verifone.cloud/sites/default/files/inline-images/1_32.JPG" alt="" width="563"></div>
* `currency_code` - Currency code
* `amount` - Transaction amount. Transaction with zero amount value will be considered as account verification and by default implicitly capture will be set to false for an account validation transaction.
* `configurations` - Object with one or more payment method configurations
* `interaction type` - Type of checkout. Allows for distinguishing payments accepted via different channels.

If the link will be sent via email or SMS, then an additional field is required.

* `notification_methods` - The link can be sent automatically using one of the two options (email or SMS) or both of them in conjunction

Here is an example body for creating a Pay by Link:

```php
{
    "amount": 100,
    "currency_code": "NZD",
    "entity_id": "entity_id",
    "customer_details": {
        "billing": {
            "address_1": "Your_Address",
            "first_name": "First_Name",
            "last_name": "Last_Name",
            "country_code": "NZ",
            "city": "Your_City"
        },
        "entity_id": "entity_id",
"email_address": "test@gmail.com"
        },
    "configurations": {
        "card": {
            "payment_contract_id": "payment_contract_id",
            "threed_secure": {
                "enabled": true,
                "threeds_contract_id": "threeds_contract_id",
                "total_items": "01",
                "transaction_mode": "S"
            }
        }
    },
    "interaction_type": "PAYMENT_LINK",
    "notification_methods": {
        "email": {
            "email_address": "test@gmail.com"
        },
        "sms": {
            "phone_number": "+64111111111"
        }
    }
}
```

The response for creating the Payment Link will look like this:

```apache
{ "id": "string", "url": "string"}
```

### APIs used to update the transaction status <a href="#apis-used-to-update-the-transaction-status" id="apis-used-to-update-the-transaction-status"></a>

* Actions that can be performed on a transaction after it was initiated are listed in the Verifone [eCommerce](/api-reference/open-api-references/ecommerce.md) API.


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.verifone.com/online-payments/pay-by-link/create-a-payment-link.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
