Card authorisation types

For some schemes, you can choose an authorisation type when making a payment request. You can flag each card payment request to be handled as either a pre-authorisation or a final authorisation.

  • Pre-authorisation is used where the amount to be authorised is unknown, for example when you are unsure if the amount will be captured. It allows you to increase or decrease the authorised amount later using the /adjustAuthorisation endpoint.
  • Final authorisation is used where a final amount is agreed up front and the transaction will definitely be captured in whole. It cannot be adjusted.

For more information, refer to Adjust Authorisation.

By default, Adyen handles all card payment requests as final authorisations.

How to use authorisation types

To use this functionality, choose one of the following options:

  • Define a default authorisation flow at the merchant level for all card transactions. 
    This functionality requires additional configuration on Adyen's end. To enable it, contact the  Support Team.
  • Manually specify the authorisation type in each payment request. For this, add an authorisationType parameter to the additionalData object. For more information, refer to authorisationType.

The following example illustrates how to make a card payment request with pre-authorisaton using the /authorise endpoint.

{
    "additionalData" : {
        "authorisationType" : "PreAuth"
    },
    
    "card" : {
        "number" : "2223000048410010",
        "expiryMonth" : "8",
        "expiryYear" : "2018",
        "cvc" : "737",
        "holderName" : "Adyen Test"
    },
    
    "amount" : {
        "value" : 10000,
        "currency" : "EUR"
    },
    
    "reference" : "Your Reference Here",
    "merchantAccount" : "TestMerchant",
    "shopperEmail" : "s.hopper@test.com",
    "shopperIP" : "61.294.12.12",
    "shopperReference" : "Simon Hopper"
}
<?xml version="1.0"?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <soap:Body>
    <ns1:authorise xmlns:ns1="http://payment.services.adyen.com">
      <ns1:paymentRequest>
        <additionalData xmlns="http://payment.services.adyen.com">
          <entry xmlns="http://payment.services.adyen.com">
            <key xsi:type="xsd:string">authorisationType</key>
            <value xsi:type="xsd:string">PreAuth</value>
          </entry>
        </additionalData>        
        <amount xmlns="http://payment.services.adyen.com">
          <currency xmlns="http://common.services.adyen.com">EUR</currency>
          <value xmlns="http://common.services.adyen.com">10000</value>
        </amount>
        <card xmlns="http://payment.services.adyen.com">
          <cvc>737</cvc>
          <expiryMonth>08</expiryMonth>
          <expiryYear>2018</expiryYear>
          <holderName>Adyen Test</holderName>
          <number>2223000048410010</number>
        </card>
        <merchantAccount xmlns="http://payment.services.adyen.com">TestMerchant</merchantAccount>
        <reference xmlns="http://payment.services.adyen.com">Your Reference Here</reference>
        <shopperEmail xmlns="http://payment.services.adyen.com">s.hopper@test.com</shopperEmail>
        <shopperIP xmlns="http://payment.services.adyen.com">61.294.12.12</shopperIP>
        <shopperReference xmlns="http://payment.services.adyen.com">Simon Hopper</shopperReference>
      </ns1:paymentRequest>
    </ns1:authorise>
  </soap:Body>
</soap:Envelope>
additionalData.authorisationType=PreAuth&card.number=2223000048410010&card.expiryMonth=8&card.expiryYear=2018&card.cvc=737&card.holderName=Adyen+Test&amount.value=10000&amount.currency=EUR&reference=Your+Reference+Here&merchantAccount=TestMerchant&shopperEmail=s.hopper%40test.com&shopperIP=61.294.12.12&shopperReference=Simon+Hopper