Search

Are you looking for test card numbers?

Would you like to contact support?

Default icon

Payment links through the Customer Area

Learn how to create payment links through the Customer Area.

Release notes

Creating payment links through the Customer Area requires no development work, and allows you to accept most payment methods, except for buy now, pay later payment methods. You can view the status of payment links within your Customer Area, and get payment notifications sent to your email.

Using payment links to accept payments works as follows:

  1. Create a payment link.
  2. Send the payment link to your shopper.
  3. Get updates about the payment.

On this page, you'll also learn how to implement additional use cases such as:

Before you begin

If you haven't done so already, set up your Adyen test account. When you have your test account:

Check your API permissions

Check that you have the API permissions to create payment links:

  1. Log in to your Customer Area.
  2. Go to Developers > API credentials, and select the API credential ws@Company.[YourCompanyAccount].
  3. In the Roles and Associated Accounts pane, check that the credential has the following role:
    • Checkout webservice role

If your API credential does not have this role, contact your admin user.

Check your Customer Area user permissions

Check that you have the user permissions to create payment links:

  1. Log in to your Customer Area.
  2. Go to Account > Users.
  3. Select the user who will be creating payment links.
    This opens a page with the details for this user.
  4. In the Roles and Associated Accounts pane, check that the user has the following user role:
    • Pay by Link Interface

If the user does not have this role, contact your admin user.

Add payment methods to your account

If you haven't done so already, add payment methods to your merchant account. To see which payment methods are supported when you create payment links through the Customer Area, refer to Supported payment methods.

  1. Log in to your Customer Area.
  2. Switch to your merchant account.
  3. Go to Account > Payment methods.
  4. Select Add payment methods.
  5. Start entering the name of the payment method, then select it from the drop-down list.
  6. Select Submit.

Step 1: Create a payment link

To create a payment link:

  1. Log in to your Customer Area.
  2. Switch to your merchant account.
  3. Go to Pay by Link > Payment links
  4. Select Create payment link.
  5. Fill out the form with the payment information, specifying the following under Transaction details:

    Field name Required Description
    Choose theme Select a theme to customize the appearance of the payment page. If you don't choose a theme here, the payment page is shown according to the default theme.
    Merchant reference -white_check_mark- Your order number. You can use this to identify and reconcile the payment in your own system.
    Amount -white_check_mark- Payment currency and value.
    Description Describe what the shopper is paying for. This description will be visible on the payment page.
    Shopper country -white_check_mark- We use this to tailor the list of payment methods available to your shopper.
    Shopper reference -white_check_mark- Required if you want to tokenize your shopper's payment details for subscriptions: your unique identifier for the shopper.
    Language Select the language of the payment page. By default, this is the language of the shopper's browser locale.
    Link type Select Single use if you want the link to be non-reusable or Open (for multiple payments) for a reusable payment link. Single use is selected by default.
    Link validity Select the validity period of the payment link. This can be a maximum of 70 days from the time you create the link. 24 hours is selected by default.
  6. Under Additional details, you can optionally choose to either:

    • Ask the shopper to fill in their personal details such as name, email, or address.
    • Manually enter shopper details if you have collected these already. If a payment method requires these details, the shopper is no longer asked to provide them on the payment page.
  7. Select Create payment link. The next page confirms the payment link was created.

Step 2: Send the payment link to your shopper

  1. On the payment link confirmation page, select Copy link.

    Below is an example payment link.

    https://test.adyen.link/PL45D0F79183A4CCA2
  2. Send the payment link to your shopper.

When the shopper selects the link, they are redirected to the Adyen-hosted payment form. The shopper can choose to pay with any payment method available in the Shopper country you provided in the form.

Step 3: Get updates about the payment

After the shopper completes the payment, you can check the payment result in your Customer Area, under TransactionsPayments.

To keep track of the payment, you can also get payment updates sent to your email, and view payment links in your Customer Area.

Alternatively, you can set up notification webhooks to get payment updates sent to your server. This requires development work.

Get payment updates to your email

To get payment status updates sent to email addresses:

  1. Log in to your Customer Area.
  2. Switch to your merchant account.
  3. Go to Pay by Link > Settings.
  4. Under Email notifications, enter one or more email addresses to receive updates for payment links manually created under this merchant account. To add more addresses, select the Enter key after each one.

When a payment has been completed, you receive an email that contains information about the payment, including the Merchant reference, PSP reference, and payment method.

To view payment links in your Customer Area:

  1. Log in to your Customer Area.
  2. Select Pay by Link > Payment Links.

You'll see a list of active and inactive payment links created through the Customer Area. An active payment link is a payment link that can be used to make a payment.

An inactive link has a Status of either:

  • Completed: The payment has been authorized. If you have enabled manual capture on your merchant account, you also need to capture the payment.
  • Payment pending: The final result of the payment is not yet known.
  • Expired: The payment link has expired.

Payment links are available in this table up to 70 days from when they were created.

Tokenize payment details

You should always ask for your customer's consent before tokenizing their card for future payments.

When creating payment links through Customer Area, we only support storing payment details for recurring payments and not for one-off payments. To store your shopper's payment details for subsequent one-off payments, use the Pay by Link API.

To tokenize the shopper's payment details for recurring payments, enable a setting in your account.

  1. Log in to your Customer Area.
  2. Switch to your merchant account.
  3. Go to Account > Checkout settings.
  4. Go to Tokenization.
  5. Make sure that the Recurring toggle is turned on.

When the shopper wants you to store their payment details, follow the instructions on creating a payment link, and additionally make sure to include the Shopper reference.

Customize the payment page

You can customize:

  • Which payment methods are shown on the payment page, and in which order.
  • The appearance of the payment page, using themes.

Payment methods

The payment methods are ordered by popularity, the most popular payment methods in the shopper's country appearing at the top. You can configure which payment methods are rendered (and in which order) based on the shopper's country.

To configure these settings, you must have the Change payment methods user role.

  1. Log in to your Customer Area.
  2. Go to Account > Checkout settings.
  3. Select a Shopper country.
  4. Drag the payment methods into the order you want them to appear to shoppers in this country.
  5. To hide a payment method from shoppers in this country, drag it to the Other configured payment methods box.

Themes

Themes allow you to specify a background image and a brand logo to customize the appearance of the payment page. If you create several themes, you can choose a theme when you create the payment link.

Create a new theme

To create a theme, you must have one of the following user roles:

  • Merchant admin
  • Pay by Link Settings

To create a new theme:

  1. Log in to your Customer Area.
  2. Go to Pay by Link > Themes.
  3. Select Create a new theme
  4. Enter a Theme name. This name is visible to the user creating the payment link in the Customer Area.
  5. Enter a Display name. This name is visible to the shopper.
  6. Upload a brand logo.
  7. Upload a background image.
  8. Enter a background color. This color is used instead of the background image if the shopper's internet connection is too slow.
  9. If you want this to be the default theme for all payment links, select Set as default.
  10. Select Create.

Test and go live

Before going live, use our list of test cards and other payment methods to test your integration. We recommend testing each payment method that you intend to offer to your shoppers.

You can check the test payments in your Customer Area, under TransactionsPayments.

When you are ready to go live, you need to:

  1. Apply for a live account.
  2. Configure your live account
  3. Submit a request to add payment methods in your live Customer Area .
  4. Add your terms and conditions to your live Customer Area.

See also