Adyen Gateway Guide

Adyen fact sheet

Additional notes
Adyen defaults to immediately capturing an `authorize` request, but this is customizable 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.
Be sure to set the `attempt_3dsecure` flag to `true` in the transaction request if you are using Adyen for gateway specific 3DS authentication. If you forget to include this field on your request, you may see the following error message: 'Received unexpected 3DS authentication response, but a 3DS initiation flag was not included in the request.'
Spreedly is sending PAN data on your behalf to the Adyen integration. Please reach out to Adyen Support ([email protected] ) to have them enable the API PCI Payments Role for you to send PAN data. This is a requirement that must be completed before you can start testing payments with Adyen.
Spreedly recommends generating and using a US specific live URL prefix to point traffic to a US datacenter in order to reduce latency with the Adyen gateway. See 'Specifying a merchant subdomain' below.
Adyen requires `country` to be provided as a request parameter. If no `country` is stored with the payment method token or included in the transaction `billing_address`, Spreedly will supply `ZZ` as the country code for the transaction, per Adyen’s specifications.

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>Iu6Ctj4E4JPK25w1E4gIAhTScKl</token>
  <gateway_type>adyen</gateway_type>
  <name>Adyen</name>
  <description nil="true"/>
  <merchant_profile_key nil="true"/>
  <sub_merchant_key nil="true"/>
  <username>username</username>
  <merchant_account>12312</merchant_account>
  <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">true</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_offsite_synchronous_purchase type="boolean">false</supports_offsite_synchronous_purchase>
    <supports_offsite_synchronous_authorize type="boolean">false</supports_offsite_synchronous_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">true</supports_remove>
    <supports_fraud_review type="boolean">false</supports_fraud_review>
    <supports_network_tokenization type="boolean">true</supports_network_tokenization>
    <supports_populate_mit_fields type="boolean">true</supports_populate_mit_fields>
    <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>
  </credentials>
  <gateway_settings>
    <subdomain>123-subdomain</subdomain>
  </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>shopper_ip</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_field>splits</gateway_specific_field>
    <gateway_specific_field>tokenize_only</gateway_specific_field>
    <gateway_specific_field>recurring_contract_type</gateway_specific_field>
    <gateway_specific_field>recurring_detail_reference</gateway_specific_field>
    <gateway_specific_field>sub_merchant_id</gateway_specific_field>
    <gateway_specific_field>sub_merchant_name</gateway_specific_field>
    <gateway_specific_field>sub_merchant_street</gateway_specific_field>
    <gateway_specific_field>sub_merchant_city</gateway_specific_field>
    <gateway_specific_field>sub_merchant_state</gateway_specific_field>
    <gateway_specific_field>sub_merchant_postal_code</gateway_specific_field>
    <gateway_specific_field>sub_merchant_country</gateway_specific_field>
    <gateway_specific_field>sub_merchant_tax_id</gateway_specific_field>
    <gateway_specific_field>sub_merchant_mcc</gateway_specific_field>
    <gateway_specific_field>sub_merchant_data</gateway_specific_field>
    <gateway_specific_field>cancel_or_refund</gateway_specific_field>
    <gateway_specific_field>network_transaction_id</gateway_specific_field>
    <gateway_specific_field>verify_amount</gateway_specific_field>
    <gateway_specific_field>level_2_data</gateway_specific_field>
    <gateway_specific_field>level_3_data</gateway_specific_field>
    <gateway_specific_field>additional_data_airline</gateway_specific_field>
    <gateway_specific_field>additional_data_lodging</gateway_specific_field>
    <gateway_specific_field>manual_capture</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_method>third_party_token</payment_method>
    <payment_method>bank_account</payment_method>
  </payment_methods>
  <state>retained</state>
  <redacted type="boolean">false</redacted>
  <sandbox type="boolean">false</sandbox>
  <mode>default</mode>
  <created_at type="dateTime">2023-06-26T15:44:41Z</created_at>
  <updated_at type="dateTime">2023-06-26T15:44:41Z</updated_at>
</gateway>

ACH/Bank Account Transactions

ACH/Bank Account payments are supported for all transactions with the execption of general credit. In order to process ACH/Bank Account transactions with Adyen, special setup is required. Enable ACH payment method in your account dashboard or contact your Adyen account manager or Adyen Support if you need further assistance.

Required fields for all transactions:

Spreedly field	Adyen field
`routing_number`	`bankLocationId`
`account_number`	`bankAccountNumber`
`name`	`ownerName`
`country`	`countryCode`

Specifying a merchant subdomain

Spreedly recommends generating and using a US specific live URL prefix to point traffic to a US datacenter in order to reduce latency with the Adyen gateway. You can do so by creating a subdomain prefix in your Adyen backend and passing in the value using the subdomain gateway specific field on a call to add or update a gateway token. This will prepend the prefix value specified in the subdomain credential to Adyen’s standard live URL, allowing traffic to be routed to a subdomain provided by Adyen. This field expects a format of [hex-encoded string]-[company name] as noted in Adyen’s docs. If you do not specify a prefix then traffic is routed to Adyen’s default live URL in Europe.

Third-party 3D Secure 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.

This store operation includes Adyen’s authorization of the payment method. To store the card without performing an authorization, pass the boolean gateway specific field tokenize_only as true. This will route the request to Adyen’s storeToken endpoint, bypassing card authorization. The option to store a card without authorization is an account-specific feature and must be enabled by Adyen. Please contact your Adyen account manager or Adyen Support to enable your account if you would like to utilize the functionality of storeToken.

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
splits
tokenize_only
recurring_contract_type
recurring_detail_reference
sub_merchant_id
sub_merchant_name
sub_merchant_street
sub_merchant_city
sub_merchant_state
sub_merchant_postal_code
sub_merchant_country
sub_merchant_tax_id
sub_merchant_mcc
cancel_or_refund
network_transaction_id
verify_amount
level_2_data
level_3_data
additional_data_airline
additional_data_lodging
store
mcc
metadata
manual_capture

When adding level_2_data field pass an object with:

total_tax_amount
customer_reference

When adding level_3_data field pass an object with:

total_tax_amount
customer_reference
freight_amount
destination_state_province_code
ship_from_postal_code
order_date
destination_postal_code
destination_country_code
duty_amount
items which is an array of objects, each containing:
- description
- product_code
- commodity_code
- quantity
- unit_of_measure
- unit_price
- discount_amount
- total_amount

When adding additional_data_airline field pass an object with:

agency_invoice_number
agency_plan_name
airline_code
airline_designator_code
boarding_fee
computerized_reservation_system
customer_reference_number
document_type
flight_date
ticket_issue_address
ticket_number
travel_agency_code
travel_agency_name
passenger_name
legs which is an array of objects, each containing:
- carrier_code
- class_of_travel
- date_of_travel
- depart_airport
- depart_tax
- destination_code
- fare_base_code
- flight_number
- stop_over_code
passenger which is an object containing:
- date_of_birth
- first_name
- last_name
- telephone_number
- traveller_type

When adding additional_data_lodging field pass an object with:

check_in_date
check_out_date
customer_service_toll_free_number
fire_safety_act_indicator
folio_cash_advances
folio_number
food_beverage_charges
no_show_indicator
prepaid_expenses
property_phone_number
number_of_nights
rate
total_room_tax
total_tax
duration
market

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. When storing a payment method or transacting via a reference to a past transaction rather than with a live payment method, a recurring contract type of RECURRING will be sent by default, but may be overridden by supplying a value for recurring_contract_type.

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

When removing a card using the remove_from_gateway option, shopper_reference and recurring_detail_reference are required.

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.

The value of the Adyen field shopper_ip is passed from the top-level transaction field ip. If the ip field is left blank, then this value will default to the loopback address 127.0.0.1. To pass a nil value for the shopper_ip to Adyen, submit 'omit' as the value for the top-level ip field. For more information, see the API documentation for purchase requests.

cancel_or_refund can be used on void transactions to execute a request against the cancelOrRefund endpoint on Adyen.

The store gateway specific field is the ecommerce or point-of-sale store that is processing the payment. Please note, it’s important to use the store name exactly as Adyen has issued or it may not be recognized and could cause the transaction to fail. See Adyen’s documentation to learn more Adyen’s docs.

metadata is an object that will allow up to 20 key-value pairs per request. There are character limitations: maximum 20 characters per key, maximum 80 characters per value.

The optional manual_capture can be used to enable manual capture for that transaction without changing the capture settings for your merchant account. After the payment is authorised, the amount is not captured until you send a manual capture request. See Adyen’s documentation to learn more.

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>
            <splits>
              <amount>
                <value>50</value>
              </amount>
              <type>Commission</type>
              <account>631472006</account>
            </splits>
            <splits>
              <amount>
                <value>50</value>
              </amount>
              <type>MarketPlace</type>
              <account>163298747</account>
              <reference>QXhlbFN0b2x0ZW5iZXJnCg</reference>
            </splits>
            <recurring_contract_type>ONECLICK</recurring_contract_type>
            <sub_merchant_id>abcd1234efg</sub_merchant_id>
            <sub_merchant_name>Buy Things Here</sub_merchant_name>
            <sub_merchant_street>123 Merchant St</sub_merchant_street>
            <sub_merchant_city>Merchant City</sub_merchant_city>
            <sub_merchant_state>MS</sub_merchant_state>
            <sub_merchant_postal_code>12345</sub_merchant_postal_code>
            <sub_merchant_country>USA</sub_merchant_country>
            <sub_merchant_tax_id>1234567890</sub_merchant_tax_id>
            <sub_merchant_mcc>abcdefg123456</sub_merchant_mcc>
            <cancel_or_refund>true</cancel_or_refund>
            <network_transaction_id>858435661128555</network_transaction_id>
            <verify_amount>500</verify_amount>
            <additional_data_airline>
              <agency_invoice_number>BAC123</agency_invoice_number>
              <agency_plan_name>plan name</agency_plan_name>
              <airline_code>434234</airline_code>
              <airline_designator_code>1234</airline_designator_code>
              <boarding_fee>100</boarding_fee>
              <computerized_reservation_system>abcd</computerized_reservation_system>
              <customer_reference_number>asdf1234</customer_reference_number>
              <document_type>cc</document_type>
              <flight_date>2023-09-08</flight_date>
              <ticket_issue_address>abcqwer</ticket_issue_address>
              <ticket_number>ABCASDF</ticket_number>
              <travel_agency_code>ASDF</travel_agency_code>
              <travel_agency_name>hopper</travel_agency_name>
              <passenger_name>Joe Doe</passenger_name>
              <legs type="array">
                <leg>
	                <carrier_code>KL</carrier_code>
  	              <class_of_travel>F</class_of_travel>
                </leg>
              </legs>
              <passenger>
                <first_name>Joe</first_name>
                <last_name>Doe</last_name>
                <telephone_number>432211111</telephone_number>
              </passenger>
            </additional_data_airline>
            <additional_data_lodging>
              <check_in_date>20230822</check_in_date>
              <check_out_date>20230830</check_out_date>
              <customer_service_toll_free_number>234234</customer_service_toll_free_number>
              <fire_safety_act_indicator>abc123</fire_safety_act_indicator>
              <folio_cash_advances>1234667</folio_cash_advances>
              <folio_number>32343</folio_number>
              <food_beverage_charges>1234</food_beverage_charges>
              <no_show_indicator>Y</no_show_indicator>
              <prepaid_expenses>100</prepaid_expenses>
              <property_phone_number>54545454</property_phone_number>
              <number_of_nights>5</number_of_nights>
              <rate>100</rate>
              <total_room_tax>1000</total_room_tax>
              <total_tax>100</total_tax>
              <duration>2</duration>
              <market>H</market>
            </additional_data_lodging>
            <store>Sample Store</store>
            <mcc>4121</mcc>
            <metadata>
              <some_field>some_value</some_field>
              <other_field>other_value</other_field>
            </metadata>
            <manual_capture>true</manual_capture>
          </adyen>
        </gateway_specific_fields>
      </transaction>'

<transaction>
  <on_test_gateway type="boolean">true</on_test_gateway>
  <created_at type="dateTime">2023-09-18T17:53:22Z</created_at>
  <updated_at type="dateTime">2023-09-18T17:53:22Z</updated_at>
  <succeeded type="boolean">true</succeeded>
  <state>succeeded</state>
  <token>DzWxY2oorCtYU7a9Sgyaol4tMIJ</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"/>
  <merchant_profile_key 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>
      <splits type="array">
        <split>
          <amount>
            <value>50</value>
          </amount>
          <type>Commission</type>
          <account>631472006</account>
        </split>
        <split>
          <amount>
            <value>50</value>
          </amount>
          <type>MarketPlace</type>
          <account>163298747</account>
          <reference>QXhlbFN0b2x0ZW5iZXJnCg</reference>
        </split>
      </splits>
      <recurring_contract_type>ONECLICK</recurring_contract_type>
      <sub_merchant_id>abcd1234efg</sub_merchant_id>
      <sub_merchant_name>Buy Things Here</sub_merchant_name>
      <sub_merchant_street>123 Merchant St</sub_merchant_street>
      <sub_merchant_city>Merchant City</sub_merchant_city>
      <sub_merchant_state>MS</sub_merchant_state>
      <sub_merchant_postal_code>12345</sub_merchant_postal_code>
      <sub_merchant_country>USA</sub_merchant_country>
      <sub_merchant_tax_id>1234567890</sub_merchant_tax_id>
      <sub_merchant_mcc>abcdefg123456</sub_merchant_mcc>
      <cancel_or_refund>true</cancel_or_refund>
      <network_transaction_id>858435661128555</network_transaction_id>
      <verify_amount>500</verify_amount>
      <additional_data_airline>
        <agency_invoice_number>BAC123</agency_invoice_number>
        <agency_plan_name>plan name</agency_plan_name>
        <airline_code>434234</airline_code>
        <airline_designator_code>1234</airline_designator_code>
        <boarding_fee>100</boarding_fee>
        <computerized_reservation_system>abcd</computerized_reservation_system>
        <customer_reference_number>asdf1234</customer_reference_number>
        <document_type>cc</document_type>
        <flight_date>2023-09-08</flight_date>
        <ticket_issue_address>abcqwer</ticket_issue_address>
        <ticket_number>ABCASDF</ticket_number>
        <travel_agency_code>ASDF</travel_agency_code>
        <travel_agency_name>hopper</travel_agency_name>
        <passenger_name>Joe Doe</passenger_name>
        <legs type="array">
          <leg>
            <carrier_code>KL</carrier_code>
            <class_of_travel>F</class_of_travel>
          </leg>
        </legs>
        <passenger>
          <first_name>Joe</first_name>
          <last_name>Doe</last_name>
          <telephone_number>432211111</telephone_number>
        </passenger>
      </additional_data_airline>
      <additional_data_lodging>
        <check_in_date>20230822</check_in_date>
        <check_out_date>20230830</check_out_date>
        <customer_service_toll_free_number>234234</customer_service_toll_free_number>
        <fire_safety_act_indicator>abc123</fire_safety_act_indicator>
        <folio_cash_advances>1234667</folio_cash_advances>
        <folio_number>32343</folio_number>
        <food_beverage_charges>1234</food_beverage_charges>
        <no_show_indicator>Y</no_show_indicator>
        <prepaid_expenses>100</prepaid_expenses>
        <property_phone_number>54545454</property_phone_number>
        <number_of_nights>5</number_of_nights>
        <rate>100</rate>
        <total_room_tax>1000</total_room_tax>
        <total_tax>100</total_tax>
        <duration>2</duration>
        <market>H</market>
      </additional_data_lodging>
      <store>Sample Store</store>
      <mcc>4121</mcc>
      <metadata>
        <some_field>some_value</some_field>
        <other_field>other_value</other_field>
      </metadata>
      <manual_capture>true</manual_capture>
    </adyen>
  </gateway_specific_fields>
  <gateway_specific_response_fields>
  </gateway_specific_response_fields>
  <gateway_transaction_id>48</gateway_transaction_id>
  <sub_merchant_key nil="true"/>
  <gateway_latency_ms type="integer">1</gateway_latency_ms>
  <warning nil="true"/>
  <application_id nil="true"/>
  <amount type="integer">100</amount>
  <local_amount nil="true"/>
  <currency_code>USD</currency_code>
  <retain_on_success type="boolean">false</retain_on_success>
  <payment_method_added type="boolean">false</payment_method_added>
  <smart_routed type="boolean">false</smart_routed>
  <stored_credential_initiator nil="true"/>
  <stored_credential_reason_type nil="true"/>
  <stored_credential_alternate_gateway nil="true"/>
  <populate_mit_fields type="boolean">false</populate_mit_fields>
  <message key="messages.transaction_succeeded">Succeeded!</message>
  <gateway_token>T11bJAANtTWnxl36GYjKWvbNK0g</gateway_token>
  <gateway_type>test</gateway_type>
  <shipping_address>
    <name>Newfirst Newlast</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">2023-09-18T17:53:22Z</created_at>
    <updated_at type="dateTime">2023-09-18T17:53:22Z</updated_at>
  </response>
  <api_urls>
  </api_urls>
  <payment_method>
    <token>1rpKvP8zOUhj4Y9EDrIoIYQzzD5</token>
    <created_at type="dateTime">2017-06-26T17:04:38Z</created_at>
    <updated_at type="dateTime">2023-09-18T15:43:06Z</updated_at>
    <email>[email protected]</email>
    <data>
      <my_payment_method_identifier>448</my_payment_method_identifier>
      <extra_stuff>
        <some_other_things>Can be anything really</some_other_things>
      </extra_stuff>
    </data>
    <storage_state>retained</storage_state>
    <test type="boolean">true</test>
    <metadata>
      <key>string value</key>
    </metadata>
    <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>Newfirst</first_name>
    <last_name>Newlast</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>Newfirst Newlast</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"/>
    <issuer_identification_number nil="true"/>
    <click_to_pay type="boolean">false</click_to_pay>
    <managed nil="true"/>
    <payment_method_type>credit_card</payment_method_type>
    <stored_credential_usage>
      <test>
        <original_network_transaction_id>37be5367d6dbe4a88c9d</original_network_transaction_id>
        <network_transaction_id>37be5367d6dbe4a88c9d</network_transaction_id>
      </test>
    </stored_credential_usage>
    <errors>
    </errors>
    <verification_value></verification_value>
    <number>XXXX-XXXX-XXXX-1111</number>
    <fingerprint>e3cef43464fc832f6e04f187df25af497994</fingerprint>
  </payment_method>
  <attempt_3dsecure type="boolean">false</attempt_3dsecure>
</transaction>

In addition to the above list of gateway specific fields, the generic Spreedly fields for shipping_address map to the Adyen deliveryAddress fields. In order to send an Adyen deliveryAddress, the shipping_address fields can be specified either when creating a new payment method or as part of a transaction request. Note that the Spreedly field address1 maps to the Adyen field street, while address2 maps to houseNumberOrName.

Gateway specific response fields

A Purchase response from Adyen gateway should contain the authorization_reference, auth_code, card_payment_method, and funding_source 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.

Some optional gateway_specific_response_fields are: merchant_advice_code, acquirer_code, payment_method_brand, payment_method_variant, acquirer, acquirer_account, fraud_result_type, fraud_manual_review, fraud_result, issuer_country, refusal_reason_raw, and recurring_detail_reference.

Some of these optional fields, for example fraud_result_type, fraud_manual_review, fraud_result, refusal_reason_raw and recurring_detail_reference will only appear in responses if you have enabled these fields on your Adyen account using Adyen’s admin UI. For more information, please consult Adyen’s documentation or contact Adyen support.

In rare instances, you could receive a transient_error. This is a temporary error that has no side effects and can be retried. For example, it could come from a race condition of sending two payment requests with the same idempotency key at the same time. One will end up being processed while the other will return a transient error. Please refer to Adyen's documentation for more details.

For example, a Purchase 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>
       <card_payment_method>VISA</card_payment_method>
       <funding_source>CREDIT</funding_source>
       <merchant_advice_code>03 : Do not try again</merchant_advice_code>
       <acquirer_code>TestPmmAcquirer</acquirer_code>
       <payment_method_brand>visa</payment_method_brand>
       <payment_method_variant>visadebit</payment_method_variant>
       <acquirer>Acquirer</acquirer>
       <acquirer_account>AcquirerAccount</acquirer_account>
       <fraud_result_type>GREEN</fraud_result_type>
       <fraud_manual_review>false</fraud_manual_review>
       <fraud_result>
         <accountScore>10</accountScore>
         <results>
           <FraudCheckResult>
             <accountScore>10</accountScore>
             <checkId>1</checkId>
             <name>PaymentDetailRefCheck</name>
           </FraudCheckResult>
         </results>
       </fraud_result>
       <issuer_country>US</issuer_country>
       <refusal_reason_raw>00 : Approved or completed successfully</refusal_reason_raw>
       <recurring_detail_reference>ABC123</recurring_detail_reference>
       <transient_error>true</transient_error>
     </adyen>
  </gateway_specific_response_fields>
</transaction>

A successful Store response should contain a recurring_detail_reference.

To request any gateway_specific_fields or gateway_specific_response_fields, please contact Support with your request and the gateway documentation for the fields of interest.

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.