Search

Are you looking for test card numbers?

Would you like to contact support?

Marketpay icon

Platforms integration and go live checklist

Understand the core integration checks you can perform before you go live.

On this page, you can find the checks that you can perform to make sure you've set up your Adyen for Platforms integration correctly before you go live.

Before you begin

The integration checklist and the go live checklist on this page assume that you have set up a test integration and that you are familiar with the Adyen for Platforms integration options and choices. If you haven't started yet, check out the Platforms quick start guide.

The choices you make have an impact how and what you should verify for your integration. Make sure that you have made a decision on how you:

Also, make sure that you are familiar with:

Integration checklist

Onboard a test sub-merchant, test a payment and test your integration before you configure your live environment, process real payments and start payouts. Follow the steps in this checklist:

Step 1: Verify your test account

Before you start your integration test, check that you have a Adyen for Platforms test account with the required web services, API keys and credentials. You can only verify your integration if these are in place.

  1. Log in to your test Customer Area with your Adyen for Platforms test account.
  2. Select your platform merchant account, and then Accounts > Users.
  3. Check that you have a web service and credentials for your platform account and one to process payments:
    1. Platform: ws_[123456]@MarketPlace.[YourPlatformAccount].
    2. Payments: ws@Company.[YourCompanyAccount].
  4. By default, the cards payment method is added to your platform test account. If you want to test other payment methods, make sure you request them first.

Step 2: Test your onboarding and KYC process

Configure KYC notifications and then sign up, onboard and perform a KYC check for a test sub-merchant to verify that your process works. Test the process that you have chosen: using a Hosted Onboarding Page or using your own onboarding flow.

Set up KYC notifications

Because the KYC process is such an important part of your platform, we strongly recommend that you set up the KYC notifications ACCOUNT_HOLDER_CREATED, ACCOUNT_HOLDER_UPDATED, ACCOUNT_HOLDER_STATUS_CHANGE and ACCOUNT_HOLDER_VERIFICATION to be able to fully verify that your onboarding process works.

Once you go live, you will use these notifications to monitor a sub-merchant's KYC verification status, so that you can take the appropriate follow-up action and communicate with sub-merchants about their onboarding status.

You have to complete the KYC verification checks in order to send payouts to a sub-merchant.

  1. Set up KYC notifications.
    Create a notification configuration for the following notification types:
    • ACCOUNT_HOLDER_CREATED
    • ACCOUNT_HOLDER_UPDATED
    • ACCOUNT_HOLDER_STATUS_CHANGE
    • ACCOUNT_HOLDER_VERIFICATION
  2. Expose an endpoint to handle notifications.
    By exposing an endpoint, you make sure that you can accept notifications.
  3. Test the KYC notifications while you test your onboarding process.
    Continue with the oboarding verification steps in using a Hosted Onboarding Page or using your own onboarding flow to verify that the KYC notifications work.

Onboard using a Hosted Onboarding Page (HOP)

Sign up, onboard and perform a KYC check for a test sub-merchant to verify that the process works.

You can use the details from the Adyen for Platforms test scenarios when you fill out the Hosted Onboarding Page.

  1. Create an account holder.
    Create an account holder with a POST /createAccountHolder request. The minimum required information depends on the country where the account holder is based, and whether you are creating an account for an individual or a business.
  2. Test your Hosted Onboarding Page.
    • Start the KYC process and get the HOP URL.
    • When you redirect the sub-merchant to your return URL, inform them of their onboarding progress based on the KYC notification webhooks you receive.
    • Look at the KYC notifications to determine if the sub-merchant is successfully onboarded, stopped the process or that you require additional information to complete the KYC verification.

You are responsible for following up on the KYC verification status and communicating with sub-merchants onboarding on your platform.

Onboard using your own KYC process

When you build your own KYC process, you need a webpage or an app that sub-merchants can use to fill out their KYC information.

To test your onboarding process, make sure that you have a webpage or an app ready to collect the required KYC information, and that you understand how to send the information to Adyen. See Build your own implementation for more information.

You can use the details from the Adyen for Platforms test scenarios when you fill out your onboarding webpage or app.

  1. Create an account holder.
    Create an account holder for with a POST /createAccountHolder request. The minimum required information depends on the country where the account holder is based, and whether you are creating an account for an individual or a business.
  2. Test your webpage or app: onboard a sub-merchant.
    • On your webpage or app, collect the relevant details based on country requirements and if the sub-merchant is an individual or a business. Send the information to Adyen with a POST /updateAccountHolder request.
    • Look at the KYC notifications to determine if the sub-merchant is successfully onboarded, stopped the process or that you require additional information to complete the KYC verification.

You are responsible for following up on the KYC verification status and communicating with sub-merchants onboarding on your platform.

Step 3: Processing payments

When a customer pays on your platform, you can automatically split these funds between multiple accounts. With every payment, capture, or refund you can customize the split between any number of accounts and amounts including your own Liable Account. How you want to split your payments, and at what stage in the payment - immediately at authorisation or later at capture - is your decision. For more information, see processing payments.

  1. Provide split information
    Provide an array of splits objects in the /payments call.

  2. Check if split payments work
    Test a split payment with your preferred way of splitting with a test card number. To check what happens to the payment, see payment statuses.

We recommend to test the following:

Step 4: Verify payouts

To be able to perform payouts, sub-merchants have to pass the KYC verification checks and you have to know the accountCode and, for manual payouts, the accountHolderCode. Your platform account (Liable Account) also has its own codes. For more information, see payouts and accounts.

  1. Test a one-off payout
    Use the test sub-merchant you onboarded and make a POST /payoutAccountHolder request.
  2. Verify the payout
    Check that you get a successful 200 response to confirm that the payout is successful.

You can also set up and test notifcations for payouts, see the next step.

Step 5: Set up and test notifications

Because the requests you send to the Platforms API are asynchronous, you have to set up notification webhooks to know the final result of the request. In step 2, you set up and tested the essential KYC verifications. In this step, you verify any other notifications that you want to use.

You configure notification webhooks to be able to get notifications of:

  • The KYC process, as mentioned earlier.
  • Status changes of your accounts and account holders, as mentioned earlier.
  • Fund management: notifications of payouts, transfers and refunds.
  • Availability of reports.

For more information, see Notifications.

  1. Create a notification configuration.
    Configure a notification configuration for the notifications that you want to receive.
  2. Test your notification configuration.
    Follow the steps in the documentation to test your notification configuration.

Go live checklist

After you have built out and tested your Adyen for Platforms integration, you will want to go live. When you are ready, follow these steps:

  1. Request your account to be taken live
    Make sure that you have signed the Adyen for Platforms contract to get a live account. Your sales or account manager will help you with this process.
  2. Access the live Customer Area
    We create a live platform merchant account for you with the necessary web services. Once you get an email confirmation that your account is ready, use the live credentials to log in to the live Customer Area.
  3. Update account settings
    When your account is taken live, some settings are copied over, but you need to update the settings for the following:
    • Notifications
    • Report subscriptions
    • API responses
    • Shopper statements for payouts and payments, aligned with your sales or account manager.
    • Recurring payment details (if applicable)
  4. Set up risk configurations
    It's important that risk management is set up to handle live transactions, including selecting a risk profile that best matches your business.
  5. Add a platform payout account
    Provide information for the payout account where you want to receive payments for the platform merchant account.
  6. Request additional payment methods
    Review the payment methods in your platform merchant account. Based on where your platform is located, you will have some default payment methods that are ready for use. You can add more payment methods. Once your platform is live, onboarded and verified sub-merchants can offer all the payment methods that you add to your platform merchant account.
  7. Update code base
    Update your code base and platform merchant account settings.
    • Switch to live API credentials
      Generate new API keys for your web services on your live account. Copy these keys to your live platform.
    • Switch your test endpoints to your live, custom URLs
      Change the Platforms API endpoints that you used to test your integration to live endpoints.
      For example, to change the Account API from test to live, change https://cal-test.adyen.com/cal/services/Account/v5 to https://cal-live.adyen.com/cal/services/Account/v5.
      Also change the payment endpoints to live.
  8. End-to-end test
    Ensure your platform can handle the entire payment lifecycle from authorization and refusals through payout and reconciliation. We suggest testing the following:

    • Payments:

      • Test the happy flow by making payments with real cards, and payments with real details for other payment methods that you support.
      • Test non-happy payment flows to ensure your integration can handle errors and refusal reasons.
      • Test the 3D Secure flow, if you implemented that.

    • Payment modifications, like cancelling and refunding.
    • Notification webhooks: Confirm you are able to acknowledge any notification type with an [accepted] response, to prevent notifications being queued.
    • Order handling.
    • Bank statements: Verify that payments appear correctly on the shopper's bank statement.
    • Payouts: Confirm you can onboard merchants, perform KYC verification checks and can send and receive payouts.
    • Reconciliation: Confirm your system completes the reconciliation process.

See also