Sign in
Payments

Create an authorisation

Creates a payment with a unique reference (pspReference) and attempts to obtain an authorisation hold. For cards, this amount can be captured or cancelled later. Non-card payment methods typically don't support this and will automatically capture as part of the authorisation.

This endpoint is inactive and is no longer supported for new integrations.

  • If you are building a new integration, use the Checkout API /payments endpoint instead.
  • If you have an existing integration using this endpoint, reach out to your Adyen contact and migrate to the Checkout API.

The Checkout API enables your online payments integration to accept all supported payment methods, use the latest features, and access more benefits.

post/authorise

Request body

additionalDataobject

This field contains additional data, which may be required for a particular payment request.

The additionalData object consists of entries, each of which includes the key and value.

captureDelayHoursinteger

The delay between the authorisation and scheduled auto-capture, specified in hours.

dateOfBirthstring date

The shopper's date of birth.

Format ISO-8601: YYYY-MM-DD

deliveryDatestring date-time

The date and time the purchased goods should be delivered.

Format ISO 8601: YYYY-MM-DDThh:mm:ss.sssTZD

Example: 2017-07-17T13:42:40.428+01:00

deviceFingerprintstring

A string containing the shopper's device fingerprint. For more information, refer to Device fingerprinting.

entityType'NaturalPerson' | 'CompanyName'

The type of the entity the payment is processed for.

fraudOffsetinteger

An integer value that is added to the normal fraud score. The value can be either positive or negative.

mccstring

The merchant category code (MCC) is a four-digit number, which relates to a particular market segment. This code reflects the predominant activity that is conducted by the merchant.

merchantAccountstring required

The merchant account identifier, with which you want to process the transaction.

merchantOrderReferencestring

This reference allows linking multiple transactions to each other for reporting purposes (i.e. order auth-rate). The reference should be unique per billing cycle. The same merchant order reference should never be reused after the first authorised attempt. If used, this field should be supplied for all incoming authorisations.

We strongly recommend you send the merchantOrderReference value to benefit from linking payment requests when authorisation retries take place. In addition, we recommend you provide retry.orderAttemptNumber, retry.chainAttemptNumber, and retry.skipRetry values in PaymentRequest.additionalData.

metadataobject

Metadata consists of entries, each of which includes a key and a value. Limits:

  • Maximum 20 key-value pairs per request. When exceeding, the "177" error occurs: "Metadata size exceeds limit".
  • Maximum 20 characters per key.
  • Maximum 80 characters per value.
nationalitystring

The two-character country code of the shopper's nationality.

orderReferencestring

When you are doing multiple partial (gift card) payments, this is the pspReference of the first payment. We use this to link the multiple payments to each other. As your own reference for linking multiple payments, use the merchantOrderReferenceinstead.

referencestring required

The reference to uniquely identify a payment. This reference is used in all communication with you about the payment status. We recommend using a unique value per payment; however, it is not a requirement. If you need to provide multiple references for a transaction, separate them with hyphens ("-"). Maximum length: 80 characters.

selectedBrandstring

Some payment methods require defining a value for this field to specify how to process the transaction.

For the Bancontact payment method, it can be set to:

  • maestro (default), to be processed like a Maestro card, or
  • bcmc, to be processed like a Bancontact card.
selectedRecurringDetailReferencestring

The recurringDetailReference you want to use for this payment. The value LATEST can be used to select the most recently stored recurring detail.

sessionIdstring

A session ID used to identify a payment session.

shopperEmailstring

The shopper's email address. We recommend that you provide this data, as it is used in velocity fraud checks. > Required for Visa and JCB transactions that require 3D Secure 2 authentication if you did not include the telephoneNumber.

shopperIPstring

The shopper's IP address. We recommend that you provide this data, as it is used in a number of risk checks (for instance, number of payment attempts or location-based checks).

Required for Visa and JCB transactions that require 3D Secure 2 authentication for all web and mobile integrations, if you did not include the shopperEmail. For native mobile integrations, the field is required to support cases where authentication is routed to the redirect flow. This field is also mandatory for some merchants depending on your business model. For more information, contact Support.

shopperInteraction'Ecommerce' | 'ContAuth' | 'Moto' | 'POS'

Specifies the sales channel, through which the shopper gives their card details, and whether the shopper is a returning customer. For the web service API, Adyen assumes Ecommerce shopper interaction by default.

This field has the following possible values:

  • Ecommerce - Online transactions where the cardholder is present (online). For better authorisation rates, we recommend sending the card security code (CSC) along with the request.
  • ContAuth - Card on file and/or subscription transactions, where the cardholder is known to the merchant (returning customer). If the shopper is present (online), you can supply also the CSC to improve authorisation (one-click payment).
  • Moto - Mail-order and telephone-order transactions where the shopper is in contact with the merchant via email or telephone.
  • POS - Point-of-sale transactions where the shopper is physically present to make a payment using a secure payment terminal.
shopperLocalestring

The language for the payment. The value combines the two-letter ISO 639-1 language code with the ISO 3166-1 alpha-2 country code. For example, nl-NL.

When using Drop-in/Components, the specified language appears if your front-end global configuration does not set the locale.

shopperReferencestring

Required for recurring payments. Your reference to uniquely identify this shopper, for example user ID or account ID. The value is case-sensitive and must be at least three characters.

Your reference must not include personally identifiable information (PII) such as name or email address.

shopperStatementstring

The text to be shown on the shopper's bank statement. We recommend sending a maximum of 22 characters, otherwise banks might truncate the string. Allowed characters: a-z, A-Z, 0-9, spaces, and special characters . , ' _ - ? + * /.

socialSecurityNumberstring

The shopper's social security number.

storestring

Required for Adyen for Platforms integrations if you are a platform model. This is your reference (on balance platform) or the storeReference (in the classic integration) for the ecommerce or point-of-sale store that is processing the payment.

telephoneNumberstring

The shopper's telephone number. The phone number must include a plus sign (+) and a country code (1-3 digits), followed by the number (4-15 digits). If the value you provide does not follow the guidelines, we do not submit it for authentication.

Required for Visa and JCB transactions that require 3D Secure 2 authentication, if you did not include the shopperEmail.

totalsGroupstring

The reference value to aggregate sales totals in reporting. When not specified, the store field is used (if available).

Response

OK - the request has succeeded.

additionalDataobject

Contains additional information about the payment. Some data fields are included only if you select them first: Go to Customer Area > Developers > Additional data.

authCodestring

Authorisation code:

  • When the payment is authorised successfully, this field holds the authorisation code for the payment.
  • When the payment is not authorised, this field is empty.
dccSignaturestring

Cryptographic signature used to verify dccQuote.

This value only applies if you have implemented Dynamic Currency Conversion. For more information, contact Support.

issuerUrlstring

The URL to direct the shopper to.

In case of SecurePlus, do not redirect a shopper to this URL.

mdstring

The payment session.

paRequeststring

The 3D request data for the issuer.

If the value is CUPSecurePlus-CollectSMSVerificationCode, collect an SMS code from the shopper and pass it in the /authorise3D request. For more information, see 3D Secure.

pspReferencestring

Adyen's 16-character reference associated with the transaction/request. This value is globally unique; quote it when communicating with us about this request.

refusalReasonstring

If the payment's authorisation is refused or an error occurs during authorisation, this field holds Adyen's mapped reason for the refusal or a description of the error. When a transaction fails, the authorisation response includes resultCode and refusalReason values.

For more information, see Refusal reasons.

resultCode'AuthenticationFinished' | 'AuthenticationNotRequired' | 'Authorised' | 'Cancelled' | 'ChallengeShopper' | 'Error' | 'IdentifyShopper' | 'PartiallyAuthorised' | 'Pending' | 'PresentToShopper' | 'Received' | 'RedirectShopper' | 'Refused' | 'Success'

The result of the payment. For more information, see Result codes.

Possible values:

  • AuthenticationFinished – The payment has been successfully authenticated with 3D Secure 2. Returned for 3D Secure 2 authentication-only transactions.
  • AuthenticationNotRequired – The transaction does not require 3D Secure authentication. Returned for standalone authentication-only integrations.
  • Authorised – The payment was successfully authorised. This state serves as an indicator to proceed with the delivery of goods and services. This is a final state.
  • Cancelled – Indicates the payment has been cancelled (either by the shopper or the merchant) before processing was completed. This is a final state.
  • ChallengeShopper – The issuer requires further shopper interaction before the payment can be authenticated. Returned for 3D Secure 2 transactions.
  • Error – There was an error when the payment was being processed. The reason is given in the refusalReason field. This is a final state.
  • IdentifyShopper – The issuer requires the shopper's device fingerprint before the payment can be authenticated. Returned for 3D Secure 2 transactions.
  • PartiallyAuthorised – The payment has been authorised for a partial amount. This happens for card payments when the merchant supports Partial Authorisations and the cardholder has insufficient funds.
  • Pending – Indicates that it is not possible to obtain the final status of the payment. This can happen if the systems providing final status information for the payment are unavailable, or if the shopper needs to take further action to complete the payment.
  • PresentToShopper – Indicates that the response contains additional information that you need to present to a shopper, so that they can use it to complete a payment.
  • Received – Indicates the payment has successfully been received by Adyen, and will be processed. This is the initial state for all payments.
  • RedirectShopper – Indicates the shopper should be redirected to an external web page or app to complete the authorisation.
  • Refused – Indicates the payment was refused. The reason is given in the refusalReason field. This is a final state.

Changes

Changed in 8 of the 51 revisions of this API.68721

  • v25e00aa24758de2See the full diff
    • ○

      added the new EXTERNAL enum value to the request property /

      request-property-enum-value-added

    • ○

      added the new ONECLICK,RECURRING enum value to the request property /

      request-property-enum-value-added

  • v25eadd9ac0d3ba1See the full diff
    • ○

      added the new optional request property /

      new-optional-request-property

  • v25218a5d52514c2See the full diff
    • ●

      the / request property's maxLength was set to 80

      request-property-max-length-set

    • ●

      the / request property's maxLength was set to 80

      request-property-max-length-set

  • v2520a3cbd5c8052See the full diff
    • ○

      added the new AMEXTOKENSERVICE enum value to the request property /

      request-property-enum-value-added

    • ○

      added the new TOKEN_SHARING enum value to the request property /

      request-property-enum-value-added

  • v25c9a74d0baf5b12See the full diff
    • ●

      added the new PartiallyAuthorised enum value to the response property for the response status

      response-property-enum-value-added

    • ○

      api tag Payments added

      api-tag-added

    • ○

      api tag General removed

      api-tag-removed

  • v25ef74e7195bb443See the full diff
    • ▲

      the // response's property type changed from object to no type for status

      response-property-type-changed

    • ▲

      removed the required property /// from the response with the status

      response-required-property-removed

    • ▲

      removed the required property /// from the response with the status

      response-required-property-removed

    • ▲

      removed the required property /// from the response with the status

      response-required-property-removed

    • ○

      the request property / became optional

      request-property-became-optional

    • ○

      the request property / became optional

      request-property-became-optional

    • ○

      added the optional property /// to the response with the status

      response-optional-property-added

  • v256522ce018f70284See the full diff
    • ▲

      the request's body type changed from no type to object

      request-body-type-changed

    • ▲

      the request property type changed from no type to object

      request-property-type-changed

    • ▲

      the request property type changed from no type to object

      request-property-type-changed

    • ▲

      the request property type changed from no type to object

      request-property-type-changed

    • ▲

      the request property type changed from no type to object

      request-property-type-changed

    • ▲

      the request property type changed from no type to object

      request-property-type-changed

    • ▲

      the request property type changed from no type to object

      request-property-type-changed

    • ▲

      the request property format changed from date-time to date

      request-property-type-changed

    • ▲

      the request property type changed from no type to object

      request-property-type-changed

    • ▲

      the / request property type changed from no type to object

      request-property-type-changed

    • ▲

      the / request property type changed from no type to object

      request-property-type-changed

    • ▲

      the / request property type changed from no type to object

      request-property-type-changed

    • ▲

      the / request property type changed from no type to object

      request-property-type-changed

    • ▲

      the request property type changed from no type to object

      request-property-type-changed

    • ▲

      the request property type changed from no type to object

      request-property-type-changed

    • ▲

      the request property type changed from no type to object

      request-property-type-changed

    • ▲

      the request property type changed from no type to object

      request-property-type-changed

    • ▲

      the request property type changed from no type to object

      request-property-type-changed

    • ▲

      the request property type changed from no type to object

      request-property-type-changed

    • ▲

      the response's body type changed from no type to object for status

      response-body-type-changed

    • ▲

      the response's body type changed from no type to object for status

      response-body-type-changed

    • ▲

      the response's body type changed from no type to object for status

      response-body-type-changed

    • ▲

      the response's body type changed from no type to object for status

      response-body-type-changed

    • ▲

      the response's body type changed from no type to object for status

      response-body-type-changed

    • ▲

      the response's body type changed from no type to object for status

      response-body-type-changed

    • ▲

      the response's property type changed from no type to object for status

      response-property-type-changed

    • ▲

      the response's property type changed from no type to object for status

      response-property-type-changed

    • ▲

      the // response's property type changed from no type to object for status

      response-property-type-changed

    • ○

      the request property / became optional

      request-property-became-optional

    • ○

      the request property / became optional

      request-property-became-optional

    • ○

      the / request property's minLength was decreased from 10 to 0

      request-property-min-length-decreased

    • ○

      the / request property's minLength was decreased from 10 to 0

      request-property-min-length-decreased

  • v25da6633eb75e13647See the full diff
    • ▲

      the request's body type changed from object to no type

      request-body-type-changed

    • ▲

      the request property / became required

      request-property-became-required

    • ▲

      the request property / became required

      request-property-became-required

    • ▲

      the request property / became required

      request-property-became-required

    • ▲

      the request property / became required

      request-property-became-required

    • ▲

      removed the enum value AMEXTOKENSERVICE of the request property /

      request-property-enum-value-removed

    • ▲

      removed the enum value EXTERNAL of the request property /

      request-property-enum-value-removed

    • ▲

      removed the enum value ONECLICK,RECURRING of the request property /

      request-property-enum-value-removed

    • ▲

      removed the enum value TOKEN_SHARING of the request property /

      request-property-enum-value-removed

    • ▲

      the / request property's minLength was increased from 0 to 10

      request-property-min-length-increased

    • ▲

      the / request property's minLength was increased from 0 to 10

      request-property-min-length-increased

    • ▲

      the request property type changed from object to no type

      request-property-type-changed

    • ▲

      the request property type changed from object to no type

      request-property-type-changed

    • ▲

      the request property type changed from object to no type

      request-property-type-changed

    • ▲

      the request property type changed from object to no type

      request-property-type-changed

    • ▲

      the request property type changed from object to no type

      request-property-type-changed

    • ▲

      the request property type changed from object to no type

      request-property-type-changed

    • ▲

      the request property type changed from object to no type

      request-property-type-changed

    • ▲

      the / request property type changed from object to no type

      request-property-type-changed

    • ▲

      the / request property type changed from object to no type

      request-property-type-changed

    • ▲

      the / request property type changed from object to no type

      request-property-type-changed

    • ▲

      the / request property type changed from object to no type

      request-property-type-changed

    • ▲

      the request property type changed from object to no type

      request-property-type-changed

    • ▲

      the request property type changed from object to no type

      request-property-type-changed

    • ▲

      the request property type changed from object to no type

      request-property-type-changed

    • ▲

      the request property type changed from object to no type

      request-property-type-changed

    • ▲

      the request property type changed from object to no type

      request-property-type-changed

    • ▲

      the request property type changed from object to no type

      request-property-type-changed

    • ▲

      the response's body type changed from object to no type for status

      response-body-type-changed

    • ▲

      the response's body type changed from object to no type for status

      response-body-type-changed

    • ▲

      the response's body type changed from object to no type for status

      response-body-type-changed

    • ▲

      the response's body type changed from object to no type for status

      response-body-type-changed

    • ▲

      the response's body type changed from object to no type for status

      response-body-type-changed

    • ▲

      the response's body type changed from object to no type for status

      response-body-type-changed

    • ▲

      the response's property type changed from object to no type for status

      response-property-type-changed

    • ▲

      the response's property type changed from object to no type for status

      response-property-type-changed

    • ●

      the / request property's maxLength was set to 50

      request-property-max-length-set

    • ●

      the / request property's maxLength was set to 50

      request-property-max-length-set

    • ●

      removed the request property /

      request-property-removed

    • ●

      removed the optional property /// from the response with the status

      response-optional-property-removed

    • ○

      api tag General added

      api-tag-added

    • ○

      api tag Payments removed

      api-tag-removed

    • ○

      the request property format was generalized from date to date-time

      request-property-type-generalized

    • ○

      removed the PartiallyAuthorised enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      added the required property /// to the response with the status

      response-required-property-added

    • ○

      added the required property /// to the response with the status

      response-required-property-added

    • ○

      added the required property /// to the response with the status

      response-required-property-added

    This revision also has 3 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog