Adyen APIs Postman collections
Fork our Postman collections in your private workspace to start testing API calls with your own credentials.
On this page you can learn about the steps required to enable the use of business accounts for your users.
Before you start building your integration, make sure that you have designed your implementation with your Adyen implementation manager.
The integration steps are the following:
- Review your account structure
- Complete the integration checklist for Adyen for Platforms
- Test your API keys
- Set up webhooks
- Implement business account features
- Go live
Review your account structure
Before you start using business accounts, you must be familiar with the Adyen account structure. Every Adyen for Platforms integration with business accounts must have at least the following resource types:
- Company account: represents your core business entity and holds your merchant accounts.
- Merchant account: the account where we process payments for your users. You can have multiple merchant accounts.
- Balance platform: the accounting system in which you manage your users and funds.
- Account holder: specifies what your user can do in your platform, for example, receive fund transfers to their balance account and payouts to their verified transfer instrument (bank account).
- Balance account: holds the funds of your user or your platform. All financial activities in your platform, such as paying out to a bank account, happen through balance accounts.
- Legal entity: contains information about your user, for example, the legal name, address, and tax information of the organization. Adyen uses this information to perform verification checks required by payment industry regulations.
- Transfer instrument: your user's verified bank account where they can receive payouts.
- Business line: contains information about your user's line of business, including their industry and source of funds.
- Payment instrument (business account): an externally-facing resource for interacting with funds on the associated balance account. Creating a payment instrument generates an account number. Each balance account can have only one payment instrument of type bankAccount.
For details on the different account structures and example use cases, see Account structures.
Complete the integration checklist for Adyen for Platforms
Before integrating business accounts, you must complete the integration steps for either the marketplace or platform model of Adyen for Platforms.
Test your API keys
To make API requests related to business accounts, you can use the same API credentials that you generated for your marketplace or platform. If needed, you can generate your API credentials and assign roles to them in your Customer Area.
Make sure that you have the following API credentials and roles.
| API | Credential |
|---|---|
| Configuration API Transfers API |
ws@BalancePlatform.[YourBalancePlatform] Use this API credential to send funds to or receive funds from third parties, set rules to automatically approve or decline outgoimg transfers, and create resources such as account holders, balance accounts, and business accounts. |
| Legal Entity Management API | ws_[123456]@Scope.Company_[YourCompanyAccount] Use this API credential to create and manage legal entities that contain the information required for verification checks. |
Set up webhooks
Webhooks are a crucial part of your integration. Adyen sends webhooks to communicate events in your balance platform, such as if your user needs to provide additional information for onboarding, or when funds are debited or credited from their business accounts.
- Set up webhook endpoints on your server and build the logic for acknowledging webhooks.
- Configure webhooks in your Customer Area.
- Secure webhooks with HMAC signing.
Implement business account features
In addition to setting up your marketplace or platform, business accounts require you to take additional actions:
- Make sure that your users pass the additional verification checks required for business accounts.
- (Optional) Implement Adyen's authentication SDK to authenticate your user's transactions and reduce the chance of fraud.
- Learn how to make requests to send funds to or receive funds from third parties using your Adyen business accounts.
- Learn how to initiate internal direct debits between the balance accounts in your balance platform.
- (Optional) Integrate with the Adyen Open Banking Platform.
Go live
To take your business accounts integration live:
- Replicate your test account setup in your live account
The business account setup from your test account for Adyen for Platforms is not automatically replicated in your live account. - Update your code base
- Switch to live API credentials
Get your live API credentials from your Adyen contact. Use these credentials in your live account. - Switch from test to live endpoints
Change the endpoints fromtesttolive. For example,https://balanceplatform-api-test.adyen.com/to
https://balanceplatform-api-live.adyen.com/. - Run end-to-end tests
- Live API credentials: make your first live API requests to make sure that your live API credentials are working.
- Business accounts: confirm that you can create business accounts with the issueBankAccount capability
- Third-party transfers: confirm that you can send funds to and receive funds from third parties with the sendToThirdParty and receiveFromThirdParty capabilities.
- Webhooks: confirm that you can receive and accept webhooks in the live environment.