Adyen PHP API Library
This is the officially supported PHP library for using Adyen's APIs.
Supported API versions
The library supports all APIs under the following services:
API | Description | Service Name | Supported version |
---|---|---|---|
Checkout API | Adyen Checkout API provides a simple and flexible way to initiate and authorise online payments. You can use the same integration for payments made with cards (including 3D Secure), mobile wallets, and local payment methods (for example, iDEAL and Sofort). | Checkout | v70 |
Payments API | A set of API endpoints that allow you to initiate, settle, and modify payments on the Adyen payments platform. You can use the API to accept card payments (including One-Click and 3D Secure), bank transfers, ewallets, and many other payment methods. | Payments | v68 |
Recurring API | The Recurring APIs allow you to manage and remove your tokens or saved payment details. Tokens should be created with validation during a payment request. | Recurring | v68 |
Payouts API | A set of API endpoints that allow you to store payout details, confirm, or decline a payout. | Payout | v68 |
Adyen BinLookup API | Endpoints for retrieving information, such as cost estimates, and 3D Secure supported version based on a given BIN. Current supported version | BinLookup | v54 |
Stored Value API | Manage both online and point-of-sale gift cards and other stored-value cards. | StoredValue | v46 |
Legal Entity Management API | The Legal Entity Management API enables you to manage legal entities that contain information required for verification | LegalEntityManagement | v3 |
Transfers API | The Transfers API provides endpoints that you can use to get information about all your transactions, move funds within your balance platform or send funds from your balance platform to a transfer instrument. | Transfers | v3 |
Balance Control API | The Balance Control API lets you transfer funds between merchant accounts that belong to the same legal entity and are under the same company account. | BalanceControl | v1 |
Data Protection API | Our Data Protection API allows you to process Subject Erasure Requests as mandated in General Data Protection Regulation (GDPR). | DataProtection | v1 |
Hosted Onboarding API | The Hosted onboarding API provides endpoints that you can use to generate links to Adyen-hosted pages, such as an onboarding page or a PCI compliance questionnaire. You can provide these links to your account holders so that they can complete their onboarding. | HostedOnboardingPages | v1 |
Account API | The Account API provides endpoints for managing account-related entities on your platform. These related entities include account holders, accounts, bank accounts, shareholders, and verification-related documents. The management operations include actions such as creation, retrieval, updating, and deletion of them. | Account | v5 |
Fund API | The Fund API provides endpoints for managing the funds in the accounts on your platform. These management operations include, for example, the transfer of funds from one account to another, the payout of funds to an account holder, and the retrieval of balances in an account. | Fund | v5 |
Terminal API (Cloud communications) | Our point-of-sale integration. | Cloud-based Terminal API | Cloud-based Terminal API |
Terminal API (Local communications) | Our point-of-sale integration. | Local-based Terminal API | Local-based Terminal API |
POS Terminal Management API | This API provides endpoints for managing your point-of-sale (POS) payment terminals. You can use the API to obtain information about a specific terminal, retrieve overviews of your terminals and stores, and assign terminals to a merchant account or store. | POSTerminalManagement | v1 |
For more information, refer to our documentation or the API Explorer.
Prerequisites
- Adyen test account
- API key. For testing, your API credential needs to have the API PCI Payments role.
- PHP 7.3 or later
- cURL with SSL support.
- The PHP extensions: ctype, curl, json, mbstring and openssl.
- See composer require list for the complete list of dependencies.
Legacy version support
If using PHP versions 7.2 or lower, download our library version 6.3.0.
Installation
You can use Composer. Follow the installation instructions if you do not already have composer installed.
composer require adyen/php-api-library
In your PHP script, make sure you include the autoloader:
require __DIR__ . '/vendor/autoload.php';
Alternatively, you can download the release on GitHub.
Using the library
General use with API key
Set up the client as a singleton resource; you'll use it for the API calls that you make to Adyen:
$client = new \Adyen\Client();
$client->setXApiKey("YOUR API KEY");
$client->setEnvironment(\Adyen\Environment::TEST);
$client->setTimeout(30);
$service = new \Adyen\Service\Checkout\PaymentsApi($client);
// Create PaymentMethod object
$paymentMethod = new CheckoutPaymentMethod();
$paymentMethod
->setType("scheme")
->setEncryptedBankAccountNumber("test_4111111111111111")
->setEncryptedExpiryMonth("test_03")
->setEncryptedExpiryYear("test_2030")
->setEncryptedSecurityCode("test_737");
// Creating Amount Object
$amount = new Amount();
$amount
->setValue(1500)
->setCurrency("EUR");
// Create the actual Payments Request
$paymentRequest = new PaymentRequest();
$paymentRequest
->setMerchantAccount("YOUR MERCHANT ACCOUNT")
->setPaymentMethod($paymentMethod)
->setAmount($amount)
->setReference("payment-test")
->setReturnUrl("https://your-company.com/...");
$result = $service->payments($paymentRequest);
General use with API key for live environment
$client = new \Adyen\Client();
$client->setXApiKey("YOUR API KEY");
$client->setEnvironment(\Adyen\Environment::LIVE, 'Your live URL prefix');
$client->setTimeout(30);
...
General use with basic auth
$client = new \Adyen\Client();
$client->setUsername("YOUR USERNAME");
$client->setPassword("YOUR PASSWORD");
$client->setEnvironment(\Adyen\Environment::TEST);
$client->setTimeout(30);
...
Instantiating the request objects through the arrayAccess implementation (for easy migration)
...
$service = new \Adyen\Service\Checkout\PaymentsApi($client);
$params = array(
'merchantAccount' => "YourMerchantAccount",
'reference' => '12345',
'amount' => array('currency' => "BRL", 'value' => 1250),
'countryCode' => "BR",
'shopperReference' => "YourUniqueShopperId",
'shopperEmail' => "[email protected]",
'shopperLocale' => "pt_BR",
'billingAddress' => array(...),
'deliveryAddress' => array(...),
);
$createPaymentLinkRequest = new CreatePaymentLinkRequest($params);
$result = $service->paymentLinks($createPaymentLinkRequest);
$paymentLink = $result->getUrl(); // or use $result['url'] if you want to use arrayAccess
Example integration
For a closer look at how our PHP library works, clone our Laravel example integration. This includes commented code, highlighting key features and concepts, and examples of API calls that can be made using the library.
Running the tests
For the test cases you need the PCI permission enabled on you account. There are no test cases for CSE because credit card data is encrypted through our javascript library. By default the test will then be skipped. If you have these permissions fill in your account details in the config/test.ini file to let the test work. To make the automatic testing cases work for your account change the credentials in the config/test.ini file.
Feedback
We value your input! Help us enhance our API Libraries and improve the integration experience by providing your feedback. Please take a moment to fill out our feedback form to share your thoughts, suggestions or ideas.
Contributing
We encourage you to contribute to this repository, so everyone can benefit from new features, bug fixes, and any other improvements. Have a look at our contributing guidelines to find out how to raise a pull request.
Support
If you have a feature request, or spotted a bug or a technical problem, create an issue here.
For other questions, contact our Support Team.
Licence
This repository is available under the MIT license.