Adyen is a Dutch payment company with the status of an acquiring bank. It enables businesses to accept e-commerce, mobile, and point-of-sale payments.
In the new app
- Store API/SFTP secrets under Import › Setup › Credentials (use Create Credential).
- Attach the credential to a PSP Source under Import › Setup › Sources.
- Monitor ingestion under Import › Files.
Using the Adyen integration, all Adyen payment details and payout specifications can be imported into the Actuals platform. To achieve this, these steps need to be performed:
- Give Actuals access to Adyen as a “Partner user”
- Create a “Reporting user”
- Schedule Reports
1. Setup a Partner user
The partner user will be used by Actuals to request historical exports, edit scheduled exports and maintain the export configuration (content columns).
Prerequisites
To add Actuals as a Partner User you need these rights inside your Adyen account:
- Merchant admin user role
- Access to the company account or merchant account you want to add a partner user to
- All the roles and permissions that the partner is requesting
Adding the Partner User
In Adyen you can create users either on company account level or merchant level. By default we suggest to create Partner Users on company level. This allows Actuals to also collect for new or modified merchants that belong to the company.
Adyen provides information on how a partner user can be added: https://docs.adyen.com/account/users/partner-users/
- When creating the partner user please use e-mail address: peter.lem@actuals.io
- Grant access to these roles: “Merchant standard” and “Merchant financial”
After you created the Partner user please inform your Actuals Implementation Consultant to verify the provided access.
2. Setup a Reporting user
The reporting user will be used by Actuals to automatically download the scheduled reports when available. Just like Partner users you can also create reporting users on merchant or company account level. Actuals suggests to create a company level user.
Adding the Reporting user
To collect data from Adyen into Actuals, it is required that a report user is created in the Adyen environment. Go to menu API credentials:
- Click Add new credential and select Reporting user.
- Be sure to copy the password and to add all accounts to the user.
- As role be sure to select “Company/Merchant Report Download” role.
- If you get asked if you want an ‘API-key” or you want to use “Basic Auth”, please select “Basic Auth” authentication credentials.
- After saving, a user should be visible with an address like reporting_XXXX@Company.XXXX.
To make sure your reporting user has been created correctly you can test the user using these steps (click to expand).
- The reporting user has been created. Please add the credentials to the Actuals platform using the guide below.
Adding a credential to Actuals
To add a credential to Actuals:
- Sign in to Actuals and navigate to Import › Setup › Credentials.
- Click Create Credential.
- Provide a desired name for the credential.
As a best practice we suggest to use the combination of the application name and the account the credential is part of. For example “Adyen - European Merchant”.
- Provide the desired credential type.
- Dependent on the type you will be asked to provide one or more credential parameters.
- Click Create to add the credential.
You now successfully created the credential. Please inform your Actuals implementation consultant once you successfully added the credential in Actuals.
Schedule report
Now the users have been created we need to setup the scheduled reports. When a report has been scheduled it will be created automatically by Adyen in the specified interval.
We require two types of reports:
- Payment accounting
- Settlement details
Payment accounting report
- Go to Reports → Payment accounting → Manage report → Automatic (generate on a schedule)
- Automatic generation: On
- File type: .CSV (Comma-separated values)
- Go to column configuration and validate that besides the default columns also the columns “Creation date”, “Metadata” and “Booking date” are checked, if not please do so.
Settlement details report
- Go to Reports → Payment accounting → Manage report → Automatic (generate on a schedule)
- Automatic generation: On
- File type: .CSV (Comma-separated values)
- Go to column configuration and validate that besides the default columns also the column “Booking date” is checked, if not please do so.