Quick Start Guide

Get ready to start accepting payments with Adyen. Request a test account.

Make a card payment

Set up an account

Log in the Adyen Customer Area (CA) to retrieve a password of your ws user that can submit API calls.
1. Go to Settings > Users.
2. Filter the list of users by System.
3. Select ws@Company.YourCompany and generate a new password (make a note of your password).
4. Make a note of your Hosted Client Encryption Token to include the encryption library in the following steps.

Set up your payment page

Set up your HTML payment form, making sure that the form includes the mandatory fields as shown in the example. See Card integration to know more.

<form method="POST" action="#handler" id="adyen-encrypted-form">
    <input type="text" size="20" autocomplete="off" data-encrypted-name="number" />
    <input type="text" size="20" autocomplete="off" data-encrypted-name="holderName" />
    <input type="text" size="2" maxlength="2" autocomplete="off" data-encrypted-name="expiryMonth" />
    <input type="text" size="4" maxlength="4" autocomplete="off" data-encrypted-name="expiryYear" />
    <input type="text" size="4" maxlength="4" autocomplete="off" data-encrypted-name="cvc" />
    <input type="hidden" value="generate-this-server-side" data-encrypted-name="generationtime" />
    <input type="submit" value="Pay" />
</form>

Replace #handler to your payment handler URL of your server.

Include the JS encryption library and enrich your payment form

Your public encryption key and library are Adyen hosted and you have a unique URL to use when loading the JavaScript in your payment page.
This URL must contain your unique Hosted Client Encryption Token that you copied when setting up your account, as shown in the example below.

In the JavaScript file, enrich your payment form using a require call, so that the credit card information is encrypted before the request reaches your servers.

<script type="text/javascript" src="https://test.adyen.com/hpp/cse/js/[your Hosted Client Encryption Token].shtml"></script>
<script type="text/javascript">
// The form element to encrypt.
var form    = document.getElementById('adyen-encrypted-form');
// See adyen.encrypt.simple.html for details on the options to use
var options = {}; 

// Create the form.
// Note that the method is on the Adyen object, not the adyen.encrypt object.
adyen.createEncryptedForm( form, options); 
</script>

Submit payment to our Test end point

After the shopper has submitted your payment form, and before it reaches your server, the script automatically adds the encrypted data to the form. During testing use one of our Test Card Numbers.
Make sure that you include this encrypted data in the server-to-server API call, together with all Payment request fields as seen in the example below.

While submitting payments from your server, include your valid credentials and specify the Content-Type header as shown in the example.

curl -u "[email protected]":"YourWsPassword" \
   -H "Content-Type: application/json" \
   -X POST \
   --data \
   '{
       "additionalData": {
           "card.encrypted.json":"adyenjs_0_1_4p1$..."
       },
     
       "amount" : {
           "value" : 20000,
           "currency" : "EUR"
       },
     
       "reference" : ["Your Reference Here"],
       "merchantAccount" : ["TestMerchant"]
   }'\
   https://pal-test.adyen.com/pal/servlet/Payment/v18/authorise

Capture payment (optional)

After submitting the payment, you receive the Payment responses that includes a PSP reference (eg. 9914430855683260).
This PSP reference uniquely identifies each payment and can be used later for Modifications EE like capture, cancel or refund the payment.

Below is the server-to-server API request to capture the full amount (200 EUR) that was authorised for the payment in the example above.

curl -u "[email protected]":"YourWsPassword" \
     -H "Content-Type: application/json" \
     -X POST --data \
     '{
         "merchantAccount" : ["TestMerchant"],
         "modificationAmount" : {
              "value" : [20000],
              "currency" : ["EUR"]
           },
         
           "originalReference" : ["9914430855683260"],
           "reference" : ["YourModificationReference"]
      }' \
      https://pal-test.adyen.com/pal/servlet/Payment/v18/capture

Accept our notifications

Adyen uses Notifications EE to keep you updated about actions (e.g. authorise a payment) you performed on our system.
Set up a server to accept all our notifications.

Add local payment methods

Set up a list of local payment methods

Create a new skin and configure the local payment methods.
HPP HMAC calculation to be used when calculating your payment request's signature.

Retrieve a list of local payment methods

After you know the amount your shopper needs to pay, calculate HPP HMAC calculation for your request.

Make a server-to-server call to our directory endpoint (Directory lookup endpoints) with all the fields, as shown in the example to retrieve the available local payment methods.

HPP payment fields in the example ( currencyCode, merchantAccount, paymentAmount, skinCode, merchantReference, sessionValidity and merchantSig), except countryCode, are mandatory.

curl --data \
     'countryCode=DE&currencyCode=EUR&merchantAccount=TestMerchant&merchantReference=Test_directory_lookup&paymentAmount=2000&sessionValidity=2015-12-25T10%3A31%3A06Z&skinCode=sH9qpMyS&merchantSig=94AwPXSxs0ECicXi1UDdKEmdzHQ6rf7EF9CC%2FzUO5Tg%3D' \
     https://test.adyen.com/hpp/directory.shtml

Parse the response

The response returns the available payments methods for your shopper as a JSON object.

Now you can present this list of local payment methods to your shopper.

{
   "paymentMethods":[
      {
         "brandCode":"ideal",
         "name":"iDEAL",
         "issuers":[
            {
               "issuerId":"1121",
               "name":"Test Issuer"
            },
            {
               "issuerId":"1152",
               "name":"Test Issuer 3"
            },
            {
               "issuerId":"1151",
               "name":"Test Issuer 2"
            }
         ]
      },
      {
         "brandCode":"sepadirectdebit",
         "name":"SEPA Direct Debit"
      },
      {
         "brandCode":"moneybookers",
         "name":"Moneybookers"
      },
      {
         "brandCode":"klarna",
         "name":"Klarna Invoice"
      },
      {
         "brandCode":"afterpay_default",
         "name":"AfterPay Invoice"
      },
      {
         "brandCode":"boku",
         "name":"Boku"
      },
      {
         "brandCode":"paysafecard",
         "name":"Paysafecard"
      },
      {
         "brandCode":"paypal",
         "name":"PayPal"
      }
   ]
}

Submit the payment request

After your shopper has selected the local payment method, POST the payment request including the brandCode and issuerId (if available) of the selected payment method.
HPP HMAC calculation of your payment request and include it in your payment form.
POST your request to our skipDetails endpoint (HPP endpoints).

Finally, your shopper is redirected to the selected local method to finalize the payment.

<html>
   <body>
      <form method="post" action="https://test.adyen.com/hpp/skipDetails.shtml" id="adyenForm" name="adyenForm" target="_parent">
         <input type="hidden" name="merchantSig" value="3iWDU/V5RMtdaiZC4YRIpoX9/v0=" />
         <input type="hidden" name="sessionValidity" value="2016-10-11T10:30:00Z" />
         <input type="hidden" name="shopperLocale" value="en_GB" />
         <input type="hidden" name="merchantAccount" value="TestMerchant" />
         <input type="hidden" name="paymentAmount" value="10000" />
         <input type="hidden" name="currencyCode" value="GBP" />
         <input type="hidden" name="skinCode" value="4aD37dJA" />
         <input type="hidden" name="merchantReference" value="Internet order 12345" />
         <input type="hidden" name="brandCode" value="ideal" />
         <input type="hidden" name="issuerId" value="1121" />
         <input type="submit" value="Send" />
         <input type="reset" />
      </form>
   </body>
</html>

Enable recurring payments

Set up Account

Set up your account as described before.
Review the list of payment methods that Supported payment methods.

Submit initial payment

An initial payment is required to Creating a recurring contract that stores payment details of a shopper.

Set up a normal card/alternative payment request as described above, but now add three new mandatory fields shopperEmail, shopperReference and recurringContract to the API call or your payment form.

curl -u "[email protected]":"YourWsPassword" \
   -H "Content-Type: application/json" \
   -X POST --data \
   '{
       "additionalData": {
          "card.encrypted.json":"adyenjs_0_1_4p1$..."
       },
       "amount" : {
           "value" : 20000,
           "currency" : "EUR"
       },
       "reference" : "Your Reference Here",
       "merchantAccount" : "TestMerchant",
       "shopperEmail" : "[email protected]",
       "shopperReference" : "Simon Hopper",
       "recurring" : {
          "contract" : "RECURRING"
       }
   }' \
   https://pal-test.adyen.com/pal/servlet/Payment/v18/authorise

<html>
   <body>
      <form method="post" action="https://test.adyen.com/hpp/details.shtml" id="adyenForm" name="adyenForm" target="_parent">
         <input type="hidden" name="orderData" value="H4sIAAAAAAAAALMpSUzKSVVIzkksLrZVyk9RsuPlsikpApMZdi6pxclFmQUlmfl5Cjb6QAEFkGhgaWJeSWZJJZKQY25+aV4JRACoVR9qAoRMsTNUcMlMzyxJzFFwTsxNLUpU0Hg5e/fTrtkvVux5NnvH06UTn29pebKn8dnStY8bV2sCtaeAjE2BOatIyc4Qq6CBgYK7U4ACWA7TWpjKJCW7kHyg5diMwBBLUoAYrIfdbH1weNkBACLpJjE3AQAA">
         <input type="hidden" name="merchantSig" value="3iWDU/V5RMtdaiZC4YRIpoX9/v0=" />
         <input type="hidden" name="sessionValidity" value="2014-10-11T10:30:00Z" />
         <input type="hidden" name="shipBeforeDate" value="2014-10-20" />
         <input type="hidden" name="shopperLocale" value="en_GB" />
         <input type="hidden" name="merchantAccount" value="TestMerchant" />
         <input type="hidden" name="paymentAmount" value="20000" />
         <input type="hidden" name="currencyCode" value="EUR" />
         <input type="hidden" name="skinCode" value="4aD37dJA" />
         <input type="hidden" name="merchantReference" value="Internet order 12345" />
         <input type="hidden" name="shopperEmail" value="[email protected]" />
         <input type="hidden" name="shopperReference" value="Simon Hopper" />
         <input type="hidden" name="recurringContract" value="RECURRING" />
 
         <input type="submit" value="Send" />
         <input type="reset" />
      </form>
   </body>
</html>

Submit the subsequent recurring payments

After the first payment is authorized, you do not need to include the payment details of your shopper in future payments again.

While submitting a Recurring payment, make sure to include shopperEmail, shopperReference, recurringContract, selectedRecurringDetailReference , shopperInteraction.

curl -u "[email protected]":"YourWsPassword" \
   -H "Content-Type: application/json" \
   -X POST --data \
   '{
       "amount" : {
           "value" : 20000,
           "currency" : "EUR"
       },
       "reference" : "Your Reference Here",
       "merchantAccount" : "TestMerchant",
       "shopperEmail" : "[email protected]",
       "shopperReference" : "Simon Hopper",
       "selectedRecurringDetailReference" : "LATEST",
       "shopperInteraction" : "ContAuth",
       "recurring" : {
          "contract" : "RECURRING"
       }
   }' \
   https://pal-test.adyen.com/pal/servlet/Payment/v18/authorise

Want to go live with Adyen? Complete your integration and apply for a live account.

Manuals

Third-party integrations

PayPal
Open Invoice

Advanced features

Account updater, Batches
Dispute API, Migration, Payout
Recurring, Reporting, RevenueProtect
Test cards