Search

Are you looking for test card numbers?

Would you like to contact support?

Online-payment icon

Pay by Link

Start accepting payments with an Adyen-hosted payment form.

Pay by Link is our hosted payment form solution that provides a flexible, secure, and easy way for your shoppers to pay with popular payment methods.

Use Pay by Link and redirect your shoppers to an Adyen-hosted form if you want the fastest way to accept payments, if you don't want to host your own payment form, or if you're still building your website or app. Pay by Link is also ideal for businesses that accept orders through other channels, such as email or social media.

To use Pay by Link, you need to provide payment information such as amount and currency, and we'll generate a payment link that you can give to your shopper. You can create a payment link either through:

  • Customer Area: Create payment links through a UI in your Customer Area. No server-side configuration or API calls are required.
  • API: Submit an API request and get the payment link from the response.

For a list of payment methods supported through Pay by Link, refer to Supported payment methods.

If you are new to integrating with Adyen, see our Online payments page for an overview of integration options and available features.

How it works

When a shopper places an order, create a payment link, and send it to your shopper. When they select the link, they are redirected to an Adyen-hosted payment form where they can choose to pay with their preferred payment method. After the shopper pays, you receive the payment result through notification webhooks.

You can customize the look and feel of the payment form by adding your display name, your brand logo, and a background color.

By default, payment links are valid within 24 hours. You can change the validity of the payment links, up to a maximum of 30 days from the time it was created.

Before you begin

  1. Add payment methods to your test Customer Area.
  2. Set up your notification webhooks to know the payment result.
  3. Depending on how you want to create payment links, make sure that you have the required roles enabled in your Customer Area:

    Create payment links  Required Web service user role Required Customer Area user role
    Through Customer Area Pay by Link Payments Processing (for your default web service user)

    To enable this role, contact our Support Team.
    Enable Pay by Link Interface

    Ask your Admin user to enable this role. If this is not available for your Admin user, contact our Support Team.
    Through API Pay by Link Payments Processing

    To enable this role, contact our Support Team.
    Not applicable

Customize the payment form

Before you start sending out payment links, customize the payment form with your brand name, logo, and a background image.

  1. Log in to your Customer Area.
  2. Select Account. Under Configure, select Pay by Link.
  3. Select the web service user.
  4. Add a display name, upload a brand logo, and set a background color or image.

You will receive a confirmation that the payment form has been updated.

  1. Log in to you Customer Area.
  2. Select Transactions. Under Actions, select Pay by Link.
  3. Fill out the form with the payment information, specifying:

    • Merchant reference: Your order number.
    • Shopper country
    • Amount: Payment currency and value.
    • Description: Optional. Describe what the shopper is paying for.
    • Link validity: The validity period of the payment link. This can be up to a maximum of 30 days.

    You can also fill out other optional fields such as:

    • Shopper reference: Your unique shopper ID. Used for recurring payments.
    • Shopper email: Your shopper's email address.
    • Billing address
    • Delivery address

  4. The next page confirms if the payment link has been successfully created. Select Copy payment link and send the link to your shopper.


When the shopper selects the link, they are redirected to the Adyen-hosted payment form.

  1. Make a POST /paymentLinks request, specifying:

    • reference : Your order number.
    • amount: Object that contains the payment value (in minor units) and currency. For more information, see Currency codes.
    • countryCode: The shopper country.
    • merchantAccount: Your merchant account.
    • expiresAt: Optional Expiry date and time in ISO 8601 format. For example, 2019-11-23T12:25:28Z. Maximum expiry date that you can set is 30 days from when the payment link is created. If this parameter is not included in the request, the payment link expires within 24 hours by default.

    For voucher and open invoice payment methods such as Boleto Bancario or AfterPay, the shopper needs to provide their billing and delivery addresses. If you already have this information, include the billingAddress and deliveryAddress objects in the request. Otherwise, Pay by Link will collect these information from the shopper on the payment page.

    For more information on the parameters that you can submit in the request, refer to /paymentLinks in API Explorer.

    curl https://checkout-test.adyen.com/v51/paymentLinks \
    -H "x-API-key: YOUR_X-API-KEY" \
    -H "content-type: application/json" \
    -d '{
      "reference": "YOUR_ORDER_NUMBER",
      "amount": {
        "value": 12500,
        "currency": "BRL"
      },
      "{hint:Description of what the shopper is paying for}description{/hint}": "Dark Green Boots Style #X220",
      "countryCode": "BR",
      "merchantAccount": "YOUR_MERCHANT_ACCOUNT",
      "shopperReference": "YOUR_UNIQUE_SHOPPER_ID",
      "shopperEmail": "test@email.com",
      "shopperLocale": "pt_BR",
      "{hint:Additional for voucher and open invoice}billingAddress{/hint}": {
        "street": "Roque Petroni Jr",
        "postalCode": "59000060",
        "city": "São Paulo",
        "houseNumberOrName": "999",
        "country": "BR",
        "stateOrProvince": "SP"
      },
      "{hint:Additional for voucher and open invoice}deliveryAddress{/hint}": {
        "street": "Roque Petroni Jr",
        "postalCode": "59000060",
        "city": "São Paulo",
        "houseNumberOrName": "999",
        "country": "BR",
        "stateOrProvince": "SP"
      },
      "expiresAt": "2019-12-14T10:05:29Z"
    }'

    When a payment link is successfully created, you receive a response containing the following information:

    • url: The payment link that you should send to your shopper.
    • expiresAt: Date and time when the payment link expires.
    {
        "amount": {
            "currency": "BRL",
            "value": 12500
        },
        "expiresAt": "2019-12-14T10:05:29Z",
        "reference": "YOUR_ORDER_NUMBER",
        "url": "https://checkoutshopper-test.adyen.com/checkoutshopper/payByLink.shtml?d=..."
    }
  2. Send the payment link to your shopper. When the shopper selects the link, they are redirected to the Adyen-hosted payment form.

Supported payment methods

The following payment methods are supported through Pay by Link. If you have questions about payment methods not on the list below or those that do not have linked pages, contact our Support Team.

Next steps