Follow these steps to get started with your Payouts integration:
- Get in touch with us
- Scope and design your implementation
- Get your test accounts
- Access and set up your online dashboards
- Build your integration
- Test your integration
- Apply for your live account
- Configure your live account
1. Get in touch with us
Reach out to your Adyen contact to register your interest for Adyen payouts. We'll get in touch with you to learn about:
- Your business model.
- The regions or countries in which you are operating and planning to make payouts.
2. Scope and design your implementation
After your use case is defined, your Adyen contact works with you to design your implementation. The design includes determining:
- How to fund your payouts.
- How to pay out.
- What types of counterparties you can pay out to.
3. Get your test accounts
After you have designed your implementation, your Adyen contact will give you credentials for the following.
- The Transfers API: create balance accounts, transfer funds, and make payouts.
- Your test Customer Area: view insights into all payment activities and configurations for your merchant account.
- Your test Balance Platform Customer Area: manage your balance platform resources, such as balance accounts and transfer instruments.
4. Access and set up your online dashboards
After your Adyen contact sets up your test account, Adyen sends you admin credentials to log in to your Customer Area and Balance Platform Customer Area. If you are already processing payments with Adyen, you already have access to your Customer Area.
If you process payments with Adyen, you can use your Customer Area to:
- Manage all payments and payment methods.
- Manage your API credentials for payment processing.
- Generate and download payment reports for reconciliation.
In your Balance Platform Customer Area, you can:
- Manage your balance account.
- Manage your transfer instrument.
- Manage your API credentials for your balance platform.
- View details about your payouts.
- Configure webhooks to get status updates on your payouts.
- Generate and download payout reports for reconciliation.
5. Build your integration
When you have your test account and credentials, you can start building your Payouts integration.
Refer to our integration checklist, Postman collections, GitHub repo and libraries for help with the implementation process.
6. Test your integration
After you integrate with our APIs, you are responsible for testing what you built in our test environment.
We recommend that you test your integration again after you configure your live account.
7. Apply for your live account
After you have built and tested your integration in the test environment, you are ready to go live.
Reach out to your Adyen contact to take your account live.
8. Configure your live account
The setup and configuration from your test account is not replicated to your live account. You need to replicate your test account setup in the live environment.
After you configure your account on the live environment, test your integration on the live environment as well.
Follow our go-live checklist to make sure your integration is ready.