Adyen Gateway Guide

close

Services and Compatibility

Payment Gateway Company Name:
Adyen
Services that work with Spreedly:
  • Adyen
Supported operations:
Purchase, Authorize, Capture, Refund, Void, Verify, Store
Supported payment types:
Credit Card, Apple Pay, Google Pay
3D Secure 1 Supported
Yes
3D Secure 2 Supported
Yes
Regions:
Asia Pacific, Europe, Latin America, North America
API endpoint URL:
https://pal-live.adyen.com/pal/servlet/Payment/

Authentication and Security

Specific names for credentials:
Merchant Account, Subdomain, Username, Password

Onboarding Merchants in:

Additional Notes

Adyen defaults to immediately capturing an authorize request, but this is customizeable to delayed or manual capture in your Adyen Merchant Account. Change your capture setting to manual if you intend to use authorize separately from captures.

If using Manual or Dynamic 3D Secure, your capture setting must be manual in order to use authorize or purchase requests. If you prefer to use immediate or delayed auto-capture, making an authorize request will complete in a capture.

For most gateways, a successful response from a capture or credit (refund) request indicates that the request to perform these actions has successfully been received by the gateway, not that the transaction has been successfully processed. At the card network level, these actions are queued up and performed in batches at certain intervals. If you would like to receive confirmation that the action has been successfully performed through the card network, you may set up notifications from Adyen by following the directions in the Adyen Customer Area.

Adding an Adyen gateway

To add an Adyen gateway:


curl https://core.spreedly.com/v1/gateways.xml \
  -u 'C7cRfNJGODKh4Iu5Ox3PToKjniY:4UIuWybmdythfNGPqAqyQnYha6s451ri0fYAo4p3drZUi7q2Jf4b7HKg8etDtoKJ' \
  -H 'Content-Type: application/xml' \
  -d '<gateway>
        <gateway_type>adyen</gateway_type>
        <username>username</username>
        <password>password</password>
        <merchant_account>12312</merchant_account>
        <subdomain>123-subdomain</subdomain>
      </gateway>'

<gateway>
  <token>Ko2bPlenX1skNS0pOMTRcoWFaRl</token>
  <gateway_type>adyen</gateway_type>
  <name>Adyen</name>
  <description nil="true"/>
  <username>username</username>
  <merchant_account>12312</merchant_account>
  <subdomain>123-subdomain</subdomain>
  <characteristics>
    <supports_purchase type="boolean">true</supports_purchase>
    <supports_authorize type="boolean">true</supports_authorize>
    <supports_capture type="boolean">true</supports_capture>
    <supports_credit type="boolean">true</supports_credit>
    <supports_general_credit type="boolean">false</supports_general_credit>
    <supports_void type="boolean">true</supports_void>
    <supports_adjust type="boolean">true</supports_adjust>
    <supports_verify type="boolean">true</supports_verify>
    <supports_reference_purchase type="boolean">false</supports_reference_purchase>
    <supports_purchase_via_preauthorization type="boolean">false</supports_purchase_via_preauthorization>
    <supports_offsite_purchase type="boolean">false</supports_offsite_purchase>
    <supports_offsite_authorize type="boolean">false</supports_offsite_authorize>
    <supports_3dsecure_purchase type="boolean">true</supports_3dsecure_purchase>
    <supports_3dsecure_authorize type="boolean">true</supports_3dsecure_authorize>
    <supports_3dsecure_2_mpi_purchase type="boolean">true</supports_3dsecure_2_mpi_purchase>
    <supports_3dsecure_2_mpi_authorize type="boolean">true</supports_3dsecure_2_mpi_authorize>
    <supports_store type="boolean">true</supports_store>
    <supports_remove type="boolean">false</supports_remove>
    <supports_fraud_review type="boolean">false</supports_fraud_review>
    <supports_3dsecure_2_purchase type="boolean">true</supports_3dsecure_2_purchase>
    <supports_3dsecure_2_authorize type="boolean">true</supports_3dsecure_2_authorize>
  </characteristics>
  <credentials>
    <credential>
      <name>username</name>
      <value>username</value>
    </credential>
    <credential>
      <name>merchant_account</name>
      <value>12312</value>
    </credential>
    <credential>
      <name>subdomain</name>
      <value>123-subdomain</value>
    </credential>
  </credentials>
  <gateway_settings>
  </gateway_settings>
  <gateway_specific_fields>
    <gateway_specific_field>shopper_reference</gateway_specific_field>
    <gateway_specific_field>shopper_statement</gateway_specific_field>
    <gateway_specific_field>fraud_offset</gateway_specific_field>
    <gateway_specific_field>selected_brand</gateway_specific_field>
    <gateway_specific_field>delivery_date</gateway_specific_field>
    <gateway_specific_field>merchant_order_reference</gateway_specific_field>
    <gateway_specific_field>shopper_interaction</gateway_specific_field>
    <gateway_specific_field>installments</gateway_specific_field>
    <gateway_specific_field>recurring_processing_model</gateway_specific_field>
    <gateway_specific_field>brand_override</gateway_specific_field>
    <gateway_specific_field>custom_routing_flag</gateway_specific_field>
    <gateway_specific_field>user_agent</gateway_specific_field>
    <gateway_specific_field>accept_header</gateway_specific_field>
    <gateway_specific_field>risk_data</gateway_specific_field>
    <gateway_specific_field>threed_dynamic</gateway_specific_field>
    <gateway_specific_field>idempotency_key</gateway_specific_field>
    <gateway_specific_field>device_fingerprint</gateway_specific_field>
    <gateway_specific_field>adjust_authorisation_data</gateway_specific_field>
    <gateway_specific_field>authorisation_type</gateway_specific_field>
    <gateway_specific_field>requested_test_acquirer_response_code</gateway_specific_field>
    <gateway_specific_field>update_shopper_statement</gateway_specific_field>
    <gateway_specific_field>industry_usage</gateway_specific_field>
    <gateway_specific_field>capture_delay_hours</gateway_specific_field>
  </gateway_specific_fields>
  <payment_methods>
    <payment_method>credit_card</payment_method>
    <payment_method>apple_pay</payment_method>
    <payment_method>google_pay</payment_method>
  </payment_methods>
  <state>retained</state>
  <redacted type="boolean">false</redacted>
  <created_at type="dateTime">2019-10-07T19:21:50Z</created_at>
  <updated_at type="dateTime">2019-10-07T19:21:50Z</updated_at>
</gateway>


env = Spreedly::Environment.new('C7cRfNJGODKh4Iu5Ox3PToKjniY', '4UIuWybmdythfNGPqAqyQnYha6s451ri0fYAo4p3drZUi7q2Jf4b7HKg8etDtoKJ', base_url: 'https://core.spreedly.com')
env.add_gateway(:adyen, username: "username", password: "Your password", merchant_account: "12345")


#<Spreedly::Gateway:0x00007f891f033f40
@token="Z3PGkJLaRw8juUPKbb7y9VDfEpJ",
@created_at="2018-12-11T12:15:07Z",
@updated_at="2018-12-11T12:15:07Z",
@gateway_type="adyen",
@state="retained",
@name="Adyen",
@credentials={"username"=>"username", "merchant_account"=>"12345"}>

Specifying a merchant subdomain

Note that you can optionally pass in a subdomain credential on a call to add or update a gateway. This allows traffic to be routed to the specific subdomain provided by Adyen. This field expects a format of [hex-encoded string]-[company name] as noted in Adyen’s docs.

Third-party 3D Secure 2 Auth Data

Spreedly will automatically handle the field mapping for sending third-party 3DS2 authentication data to Adyen. For more information about how to use this feature, see the 3DS2 Third-party Authentication Guide. Spreedly fields map to the relevant Adyen fields as described in the following table. Please see Adyen’s third-party 3DS2 documentation for detailed descriptions of each of these fields and when to use them.

Spreedly Field Adyen Field
three_ds_version threeDSVersion
ecommerce_indicator eci
authentication_value cavv
directory_server_transaction_id dsTransID
directory_response_status directoryResponse
authentication_response_status authenticationResponse

Setup to support Store operation

In order to use Third Party Vaulting via the Store operation with Adyen, special setup is required. In your Adyen dashboard at https://ca-live.adyen.com (https://ca-test.adyen.com for testing), under the Settings tab, in the “API and Response” panel, the “Recurring details” flag must be enabled. You may instead inquire with your Adyen account manager to enable this.

Furthermore, when storing a card, you must pass a unique shopper_reference Gateway Specific Field per cardholder.

Optional Gateway Specific Fields

Spreedly supports the following gateway specific fields when transacting with a Adyen gateway:

  • shopper_reference
  • shopper_statement
  • fraud_offset
  • selected_brand
  • delivery_date
  • merchant_order_reference
  • shopper_interaction
  • installments
  • recurring_processing_model
  • brand_override
  • custom_routing_flag
  • user_agent
  • accept_header
  • risk_data
  • threed_dynamic
  • idempotency_key
  • device_fingerprint
  • capture_delay_hours

If shopper_interaction is not passed, it will be determined based on the presence of a payment CVV. You can also have shopper_interaction and recurring_processing_model defined based on Spreedly’s first class support for sending stored credential data. Learn more about how Spreedly enables seamless use of stored credentials between different gateways.

When carrying out a merchant-initiated transaction, Spreedly will pass a transaction submitted with a reason_type of unscheduled as a CardOnFile transaction. A stored credential used with any other reason_type will be passed as a Subscription transaction. These values can be replaced by providing a value for the recurring_processing_model field.

shopper_reference is required for Third-Party Vaulting via the store action, and it should be unique per cardholder.

Both user_agent and accept_header may be required when completing a 3DS transaction. To use Adyen’s Dynamic 3D Secure authentication, send the optional threed_dynamic field set to true. This must be used in combination with Spreedly’s 3DS process, by also sending the attempt_3dsecure transaction-level property set to true. Your Adyen merchant account must be enabled for Dynamic 3DS in order to use this feature. For more information and requirements, see Adyen’s docs.

You can specify certain risk-related fields in a JSON blob supplied via the risk_data field. For more information and which sub-fields are available, see Adyen’s docs.

Use an idempotency_key to retry a request multiple times, without risk of duplication. See Adyen’s documentation to learn more about how to use API idempotency.

If your Adyen integration is set to auto-capture, you may provide a value for capture_delay_hours to specify when the capture should occur.


curl https://core.spreedly.com/v1/gateways/LlkjmEk0xNkcWrNixXa1fvNoTP4/purchase.xml \
  -u 'C7cRfNJGODKh4Iu5Ox3PToKjniY:4UIuWybmdythfNGPqAqyQnYha6s451ri0fYAo4p3drZUi7q2Jf4b7HKg8etDtoKJ' \
  -H 'Content-Type: application/xml' \
  -d '<transaction>
        <payment_method_token>56wyNnSmuA6CWYP7w0MiYCVIbW6</payment_method_token>
        <amount>100</amount>
        <currency_code>USD</currency_code>
        <gateway_specific_fields>
          <adyen>
            <shopper_reference>Reference</shopper_reference>
            <shopper_statement>Statement info</shopper_statement>
            <fraud_offset>offset</fraud_offset>
            <selected_brand>brand</selected_brand>
            <delivery_date>09/10/2017</delivery_date>
            <merchant_order_reference>order_ref</merchant_order_reference>
            <shopper_interaction>interaction</shopper_interaction>
            <installments>2</installments>
            <recurring_processing_model>CardOnFile</recurring_processing_model>
            <user_agent>Mozilla/5.0 (X11; U; Linux i686; en-US; rv:1.9) Gecko/2008052912 Firefox/3.0</user_agent>
            <accept_header>text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8</accept_header>
            <risk_data><![CDATA[{"operatingSystem": "HAL9000",  "destinationLatitude": "77.641423", "destinationLongitude": "12.9503376"}]]></risk_data>
            <threed_dynamic>true</threed_dynamic>
            <idempotency_key>key</idempotency_key>
            <device_fingerprint>m7Cmrf++0cW4P6XfF7m/rA</device_fingerprint>
            <capture_delay_hours>4</capture_delay_hours>
          </adyen>
        </gateway_specific_fields>
      </transaction>'

<transaction>
  <on_test_gateway type="boolean">true</on_test_gateway>
  <created_at type="dateTime">2019-10-07T19:21:50Z</created_at>
  <updated_at type="dateTime">2019-10-07T19:21:50Z</updated_at>
  <succeeded type="boolean">true</succeeded>
  <state>succeeded</state>
  <token>XNtXSCySK9v0J0VBO3AbvsPl5B4</token>
  <transaction_type>Purchase</transaction_type>
  <order_id nil="true"/>
  <ip nil="true"/>
  <description nil="true"/>
  <email nil="true"/>
  <merchant_name_descriptor nil="true"/>
  <merchant_location_descriptor nil="true"/>
  <gateway_specific_fields>
    <adyen>
      <shopper_reference>Reference</shopper_reference>
      <shopper_statement>Statement info</shopper_statement>
      <fraud_offset>offset</fraud_offset>
      <selected_brand>brand</selected_brand>
      <delivery_date>09/10/2017</delivery_date>
      <merchant_order_reference>order_ref</merchant_order_reference>
      <shopper_interaction>interaction</shopper_interaction>
      <installments>2</installments>
      <recurring_processing_model>CardOnFile</recurring_processing_model>
      <user_agent>Mozilla/5.0 (X11; U; Linux i686; en-US; rv:1.9) Gecko/2008052912 Firefox/3.0</user_agent>
      <accept_header>text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8</accept_header>
      <risk_data>{"operatingSystem": "HAL9000",  "destinationLatitude": "77.641423", "destinationLongitude": "12.9503376"}</risk_data>
      <threed_dynamic>true</threed_dynamic>
      <idempotency_key>key</idempotency_key>
      <device_fingerprint>m7Cmrf++0cW4P6XfF7m/rA</device_fingerprint>
      <capture_delay_hours>4</capture_delay_hours>
    </adyen>
  </gateway_specific_fields>
  <gateway_specific_response_fields>
  </gateway_specific_response_fields>
  <gateway_transaction_id>60</gateway_transaction_id>
  <gateway_latency_ms type="integer">5</gateway_latency_ms>
  <stored_credential_initiator nil="true"/>
  <stored_credential_reason_type nil="true"/>
  <amount type="integer">100</amount>
  <currency_code>USD</currency_code>
  <retain_on_success type="boolean">false</retain_on_success>
  <payment_method_added type="boolean">false</payment_method_added>
  <message key="messages.transaction_succeeded">Succeeded!</message>
  <gateway_token>FlWwOkG3YbNpqg7i2cqHEX17xY0</gateway_token>
  <gateway_type>test</gateway_type>
  <shipping_address>
    <name>Joe Jones</name>
    <address1 nil="true"/>
    <address2 nil="true"/>
    <city nil="true"/>
    <state nil="true"/>
    <zip nil="true"/>
    <country nil="true"/>
    <phone_number nil="true"/>
  </shipping_address>
  <response>
    <success type="boolean">true</success>
    <message>Successful purchase</message>
    <avs_code nil="true"/>
    <avs_message nil="true"/>
    <cvv_code nil="true"/>
    <cvv_message nil="true"/>
    <pending type="boolean">false</pending>
    <result_unknown type="boolean">false</result_unknown>
    <error_code nil="true"/>
    <error_detail nil="true"/>
    <cancelled type="boolean">false</cancelled>
    <fraud_review nil="true"/>
    <created_at type="dateTime">2019-10-07T19:21:50Z</created_at>
    <updated_at type="dateTime">2019-10-07T19:21:50Z</updated_at>
  </response>
  <api_urls>
  </api_urls>
  <payment_method>
    <token>Nyt75JEfh3F96b8R4RigVs0EWXD</token>
    <created_at type="dateTime">2019-04-22T21:41:37Z</created_at>
    <updated_at type="dateTime">2019-09-12T19:28:23Z</updated_at>
    <email>admin@example.com</email>
    <data nil="true"/>
    <storage_state>retained</storage_state>
    <test type="boolean">true</test>
    <metadata nil="true"/>
    <callback_url nil="true"/>
    <last_four_digits>1111</last_four_digits>
    <first_six_digits>411111</first_six_digits>
    <card_type>visa</card_type>
    <first_name>Joe</first_name>
    <last_name>Jones</last_name>
    <month type="integer">3</month>
    <year type="integer">2032</year>
    <address1 nil="true"/>
    <address2 nil="true"/>
    <city nil="true"/>
    <state nil="true"/>
    <zip nil="true"/>
    <country nil="true"/>
    <phone_number nil="true"/>
    <company nil="true"/>
    <full_name>Joe Jones</full_name>
    <eligible_for_card_updater type="boolean">true</eligible_for_card_updater>
    <shipping_address1 nil="true"/>
    <shipping_address2 nil="true"/>
    <shipping_city nil="true"/>
    <shipping_state nil="true"/>
    <shipping_zip nil="true"/>
    <shipping_country nil="true"/>
    <shipping_phone_number nil="true"/>
    <payment_method_type>credit_card</payment_method_type>
    <errors>
    </errors>
    <verification_value></verification_value>
    <number>XXXX-XXXX-XXXX-1111</number>
    <fingerprint nil="true"/>
  </payment_method>
  <attempt_3dsecure type="boolean">false</attempt_3dsecure>
</transaction>


env = Spreedly::Environment.new('C7cRfNJGODKh4Iu5Ox3PToKjniY', '4UIuWybmdythfNGPqAqyQnYha6s451ri0fYAo4p3drZUi7q2Jf4b7HKg8etDtoKJ', base_url: 'https://core.spreedly.com')
env.purchase_on_gateway("LlkjmEk0xNkcWrNixXa1fvNoTP4", "56wyNnSmuA6CWYP7w0MiYCVIbW6", 4432,
  gateway_specific_fields: {
    adyen: {
      shopper_reference: "shopper_reference",
      fraud_offset: "offset",
      selected_brand: "brand",
      delivery_date: "09/20/2017",
      merchant_order_reference: "order_reference",
      shopper_interaction: "interaction",
      installments: 2,
      recurring_processing_model: "CardOnFile",
      user_agent: "Mozilla/5.0 (X11; U; Linux i686; en-US; rv:1.9) Gecko/2008052912 Firefox/3.0",
      accept_header: "text/html,application/xhtml+xml,application/xml;q=0.9,/;q=0.8"
    }
  }
)


#<Spreedly::Purchase:0x00007fb0da817738
@token="7PIrCz2PZOMM38MpdIcM1gqvQDR",
@created_at="2018-12-11T12:22:06Z",
@updated_at="2018-12-11T12:22:06Z",
@state="succeeded",
@message="Succeeded!",
@succeeded="true",
@order_id="",
@ip="",
@description="",
@gateway_token="T11bJAANtTWnxl36GYjKWvbNK0g",
@gateway_transaction_id="56",
@email="",
@merchant_name_descriptor="",
@merchant_location_descriptor="",
@on_test_gateway="true",
@currency_code="USD",
@amount="4432",
@response,=
#<Spreedly::Response:0x00007fb0d80c4140
@success="true",
@pending="false",
@cancelled="false",
@fraud_review="",
@created_at="2018-12-11T12:22:06Z",
@updated_at="2018-12-11T12:22:06Z",
@message="Successful purchase",
@avs_code="",
@avs_message="",
@cvv_code="",
@cvv_message="",
@error_code="",
@error_detail="">,
@shipping_address,=
#<Spreedly::ShippingAddress:0x00007fb0d80477f8
@name="Newfirst Newlast",
@address1="",
@address2="",
@city="",
@state="",
@zip="",
@country="",
@phone_number="">,
@gateway_specific_fields={:adyen=>{:shopper_reference=>"shopper_reference", :fraud_offset=>"offset", :selected_brand=>"brand", :delivery_date=>"09/20/2017", :merchant_order_reference=>"order_reference", :shopper_interaction=>"interaction", :installments=>"2", :recurring_processing_model=>"CardOnFile", :user_agent=>"Mozilla/5.0 (X11; U; Linux i686; en-US; rv:1.9) Gecko/2008052912 Firefox/3.0", :accept_header=>"text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8"}},
@payment_method,=
#<Spreedly::CreditCard:0x00007fb0d800f038
@token="1rpKvP8zOUhj4Y9EDrIoIYQzzD5",
@created_at="2017-06-26T17:04:38Z",
@updated_at="2018-12-11T12:21:41Z",
@email="joey@example.com",
@storage_state="retained",
@data="<my_payment_method_identifier>448</my_payment_method_identifier>\n      <extra_stuff>\n        <some_other_things>Can be anything really</some_other_things>\n      </extra_stuff>",
@first_name="Newfirst",
@last_name="Newlast",
@full_name="Newfirst Newlast",
@month="3",
@year="2032",
@number="XXXX-XXXX-XXXX-1111",
@last_four_digits="1111",
@first_six_digits="411111",
@card_type="visa",
@verification_value="",
@address1="",
@address2="",
@city="",
@state="",
@zip="",
@country="",
@phone_number="",
@company="",
@fingerprint="e3cef43464fc832f6e04f187df25af497994",
@eligible_for_card_updater="",
@errors=[]>>

Gateway specific response fields

A Purchase response from Adyen gateway should contain the authorization_reference and auth_code fields, which you can find in the gateway_specific_response_fields. The authorization_reference is the pspReference of the Authorization call portion of the Purchase request. For example, a transaction could have something like this:

<transaction>
  <token>LgpTNGjsWQs9DwdxcbreUVz0R8p</token>
  <transaction_type>Purchase</transaction_type>
  <gateway_specific_response_fields>
     <adyen>
       <authorization_reference>1234567890</authorization_reference>
       <auth_code>123456</auth_code>
     </adyen>
  </gateway_specific_response_fields>
</transaction>

3DS exemptions

There are a few different ways to request exemptions on Adyen. If you use Adyen’s Dynamic 3D Secure service, you may pass the threed_dynamic field in order to utilize the custom rules you have set up. Otherwise, Adyen will attempt to automatically apply for relevant exemptions using their Authentication Engine. Regardless of which approach you take, there are a few cases where you will need to set specific fields in order to correctly mark your transaction, as outlined below:

MOTO

For any MOTO transaction, pass in the field shopper_interaction set to Moto.

MIT

Merchant initiated transactions are considered out-of-scope by default. By properly setting the shopper_interaction and recurring_processing_model, you can ensure that your recurring transactions have the best chance of being marked as such. Pass the appropriate values for these fields as defined here, or check out Spreedly’s implementation of stored credentials. Note: Make sure that your account is configured to send back the networkTxReference when initiating a new recurring transaction. You can do this by going into your Adyen account and selecting API URLs > Additional Data Settings > Network Transaction Reference, or contacting Adyen support.