No momento, esta página não está disponível em português
Default icon

Essentials onboarding

Collect your users' verification data through Adyen's Essentials onboarding page.

Onboarding your users through Essentials requires no implementation effort on your side, as they can provide the information necessary for the verification process directly to Adyen. The configuration of their merchant accounts is also done in the background. You only have to monitor their verification progress and notify your users if there are issues with the data they submitted.

Before you begin

Make sure that you have:

  • Your company account in the live environment.
  • Your server is properly configured to accept webhooks and you have subscribed to the Account data notifications in your Customer Area.
  • Agreed with your Adyen contact on your pricing plans.

Supported countries

You can use Essentials to onboard your users if they operate in the following countries:

Country Organizations Sole proprietors
Australia (beta) -white_check_mark- -white_check_mark-
Austria -white_check_mark- -white_check_mark-
Belgium -white_check_mark- -white_check_mark-
Cyprus -white_check_mark- -white_check_mark-
Czech Republic -white_check_mark- -white_check_mark-
Denmark -white_check_mark- -white_check_mark-
Estonia -white_check_mark- -white_check_mark-
Finland -white_check_mark- -white_check_mark-
France -white_check_mark- -white_check_mark-
Germany -white_check_mark- -white_check_mark-
Greece -white_check_mark- -white_check_mark-
Hungary -white_check_mark- -white_check_mark-
Ireland -white_check_mark- -white_check_mark-
Italy -white_check_mark- -white_check_mark-
Latvia -white_check_mark- -white_check_mark-
Lithuania -white_check_mark- -white_check_mark-
Luxembourg -white_check_mark- -white_check_mark-
Netherlands -white_check_mark- -white_check_mark-
Poland -white_check_mark- -white_check_mark-
Portugal -white_check_mark- -white_check_mark-
Romania -white_check_mark- -white_check_mark-
Singapore (beta) -white_check_mark- -white_check_mark-
Slovakia -white_check_mark- -white_check_mark-
Slovenia -white_check_mark- -white_check_mark-
Spain -white_check_mark- -white_check_mark-
Switzerland -white_check_mark- -white_check_mark-
United Kingdom (including Isle of Man & Jersey) -white_check_mark- -white_check_mark-
United States -white_check_mark- -white_check_mark-

Step 1: Request a merchant account

You must have the following user roles in the Customer Area:

  • Merchant admin
  • Merchant additional merchant accounts
  • Merchant standard role
  • Merchant allowed own password reset
  • View Payments
  • Merchant manage payments
  • Download reports
  • Generate reports
  • Merchant report
  • Merchant POS Terminal View role
  • Merchant user management
  • Merchant manage bank accounts
  • Merchant dispute management
  • Merchant application form
  • Merchant franchisee onboarding on test
  • Merchant review

To request a new merchant account:

  1. Log in to your live Customer Area.
  2. Go to Settings > Merchant accounts and select Request new merchant account.
  3. In the Legal entity details section, select your user's country of operation and the enter the legal name of your user's company.
  4. Select your user's sales channel.
  5. Depending on the selected sales channel, enter the address of your user's website or store details, then select Next.
  6. In the Account owner information section, enter the details of your user.
    The name you enter in the Username field will be your user's username in Essentials.
  7. In the Account details section, enter the merchant account (and store) reference to be shown in the reconciliation reports.
    The format of the merchant account reference must comply with the previously agreed on schema for your company account.
  8. Select a pricing plan, if any.
  9. Select Submit.

After the merchant account is requested, you will receive a merchant.created webhook with the merchantId of the created merchant account.

Step 2: Onboard and verify users

If your company has single sign-on enabled, your users will receive an email asking them to log in to Essentials through your platform's SSO. Otherwise, the email will contain instructions on how to set up their Essentials account.

Multiple merchant accounts for the same user

If your user's business requires it, you can create multiple merchant accounts for the same legal entity. In this case, after your user logs in to Essentials, they must associate their merchant accounts with the appropriate legal entity (organization or sole proprietorship). After all merchant accounts are assigned, they can start providing the required information.

Onboarding page

On the onboarding page we ask your user to provide information about their company, its representatives, and bank account details. When prompted, they must also upload supporting documents, for example, identity documents or bank statements. For information on the accepted document formats, see Requirements for document uploads.

Besides providing the required information about their company and its representatives, we also ask your user to sign the services agreement and a security questionnaire. By signing the security questionnaire, they agree to comply with the requirements laid down in the Payment Card Industry Data Security Standards (PCI DSS) for collecting, processing, storing, and transmitting cardholder data in a secure environment.

After your user provides the required information and signs the documents, Adyen automatically starts the verification process.

Step 3: Get verification updates

You can monitor the verification of your users in two ways:

  1. Listen to the merchant.updated webhook.
  2. Check the onboarding report in your Customer Area.

Webhook

The merchant.updated webhook provides the status of the verification: valid, invalid, or rejected. The webhook examples below show when the verification is successful and when the capability is not allowed because the verification is invalid.

When the checks are completed successfully, Adyen sends a merchant.updated webhook with:

When you receive the merchant.updated webhook with status set to Active, your users can start using Essentials to manage their account and start processing payments.

Customer Area

To view the status of the merchant accounts in your platform:

  1. Log in to your live Customer Area.
  2. Go to Reports and select Customer account onboarding status report.

If your users have completed the onboarding and the Capability status still shows errors, the information provided by your user could not be verified. You must ask them to correct their data or upload missing documents in Essentials. After the data is provided, we restart the verification process.

When the Account status changes to Active on the onboarding report page, your users can start using Essentials to manage their account and start processing payments.

Payment methods

After their merchant account becomes active, payment methods are automatically configured for your users according to the list you provided to your Adyen contact.

Payment methods that require additional parameters are currently not automatically created through the Essentials onboarding flow. To request them, please contact Support.

For the list of available payment methods, see Supported payment methods.

Payouts

If your user has only one merchant account and one bank account associated with one legal entity, payouts are automatically enabled for them after they pass the verification checks. Otherwise, they must configure their payout account in Essentials.