Payment responses

Go to API playground

If the message passes validation, a risk analysis is performed. Depending on the outcome, an authorisation is attempted. You receive a response with the following fields:

 

Name Type Returned by default Description
pspReference
String (tick)

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

resultCode
String (tick)

The outcome of the payment. The possible values are:

  • Authorised
  • Refused
  • Error
  • Cancelled
  • Received
  • RedirectShopper
authCode String

(tick)

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.
refusalReason
String (error)
When the payment is not authorised, it is refused, or if an error occurs, this field holds Adyen's mapped reason for the refusal or a description of the error.
  • The additionalData object can include standard, as well as acquirer raw data.
    You can implement the additionalData object to include extra fields and receive additional information in your response.
  • When a payment authorisation response includes resultCode and refusalReason, the transaction failed or was declined.
    Check their values for further details about any issues that affected the operation.

additionalData payment responses

This functionality is not enabled by default, as it requires additional configuration on Adyen's end. Contact the  Adyen Support Team to request enabling it for you.

The additionalData object is a generic container that can hold extra fields.

Standard additionalData

When the additionalData object is enabled for your merchant account, it can be configured to return the following fields:

Name Type Returned by default Example value Description
authCode String (tick) 58747

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.

cvcResult String (tick)

For possible cvcResult values,

see the CVC/CCV table below.

The CVC result code of the payment. It provides information about the outcome of the CVC check.

avsResult String (tick)

For possible avsResult values,

see the AVS result values table below.

The AVS result code of the payment. It provides information about the outcome of the AVS check.

referred String (tick) true/false

Returned if the payment is referred, this field is set to true.

This fields is unavailable if the payment is referred and is usually not returned with Ecommerce transactions.

cardSummary String (tick) 1111

Returns last 4 digits of a credit card number.

Returned only in the case of a card payment.

expiryDate String (tick) 6/2016

Returns expiry date of the credit card returned.

Returned only in the case of a card payment.

refusalReasonRaw String (error) AUTHORISED Returns raw authorisation or refusal reason from the acquirers.

inferredRefusalReason

String (error) “3D Secure Mandated”
Provides a best indication of why a transaction was refused. When a transaction fails with either “Refused”, “Restricted Card”, “Transaction Not Permitted”, “Not supported” or "Declined Non Generic" refusalReason from the issuer, Adyen cross references it's PSP wide data for extra insight into the refusal reason. If an inferred refusal reason is available the inferredRefusalReason field will be populated and the refusalReason will be set to "Not Supported".

Possible values:

  • 3D Secure Mandated
  • ContAuth Not Supported
  • CVC Mandated
  • Ecommerce Not Allowed
  • Crossborder Not Supported
avsResultRaw String (error) 7 Returns raw AVS result from the acquirers.
cvcResultRaw String (error) 1 Returns raw CVC check result from the acquirers.
acquirerCode String (error) TestPmmAcquirer Returns the name of the acquirer processing the payment request.
hmacSignature String (error)

9u5B7JSCTLKN3W5LQWIBIod

XXPx4MHWgkO%2Fl9qOmFRE%3D

Returns optional HMAC signature generated based on the HMAC key generated for each notification endpoint in the Adyen Customer Area (CA) → Settings → Server Communication → Additional Settings.

acquirerReference String (error) 7C9N3FNBKT9 Returns reference number that can be used for reconciliation in case a non-Adyen acquirer is used for settlement.
ownerName String (error) A. Klaassen Only relevant for SEPA Direct Debit transactions Returns owner name of bank account.
countryCode String (error) NL Only relevant for SEPA Direct Debit transactions Returns country code of bank account.
bic String (error) TESTNL01 Only relevant for SEPA Direct Debit transactions Returns BIC of bank account.
iban String (error) NL13TEST0123456789 Only relevant for SEPA Direct Debit transactions Returns IBAN of bank account.
deliveryAddress.stateOrProvince String (error) NH Returns delivery address state or province passed in the payment request.
deliveryAddress.city String (error) Amsterdam Returns delivery address city passed in the payment request.
deliveryAddress.postalCode String (error) 1011 DJ Returns delivery address postal code passed in the payment request.
deliveryAddress.street String (error) Simon Carmiggeltstraat Returns delivery address street passed in the payment request.
deliveryAddress.houseNumberOrName String (error) 6-50 Returns delivery address house number or name passed in the payment request.
deliveryAddress.country String (error) NL Returns delivery address country passed in the payment request.
extraCostsCurrency String (error) EUR Returns currency of extra amount charged due to additional amounts set in the skin used in the HPP payment request.
extraCostsValue String (error) 150 Returns amount of extra amount charged due to additional amounts set in the skin used in the HPP payment request. Amount is in minor units.
installments.value String (error) 5 Returns the number of installments that the payment amount will be charged with. Only relevant for card payments in countries that support installments. 
paypalPayerStatus String (error) unverified Only relevant for Paypal transactions. Returns the status of the Paypal Buyer Paypal Account.
paypalPayerResidenceCountry String (error) US Only relevant for Paypal transactions. Returns the status of the Paypal Buyer country of residence.
acquirerAccountCode String (error) PayPalSandbox_TestAcquirer Only relevant for Paypal transactions. Returns the status of the Adyen acquirer account.
paypalPayerId String (error) LF5HCWWBRV2KL Only relevant for Paypal transactions. Returns the Paypal PayerID.
paypalEmail String (error) paypaltest@adyen.com Only relevant for Paypal transactions. Returns the Paypal Buyer account's email address.
paypalProtectionEligibility String (error) Ineligible Only relevant for Paypal transactions. Returns the eligibility for Paypal Seller Protection for this payment.
terminalId String (error) 06022622 Returns the terminal ID used in a Point-of-Sale payment.
shopperReference String (error) AdyenTestShopperXX Returns the shopperReference passed in the payment request.
shopperInteraction String (error) Ecommerce Returns the shopper interaction type of the payment request.
paymentMethodVariant String (error) mcpro Returns the Adyen sub-variant of the payment method used for the payment request.
fraudCheck-[nn]-[Fraud Check name] String (error) 20 Returns the fraud score due to a particular fraud check. Name of the fraud check is found in the key of the key-value pair.
alias String (error) H167852639363479 Returns the Adyen alias of the card.
aliasType String (error) Default Returns the type of the card alias.
cardBin String (error) 521234 Returns the Bank Identification Number of a credit card, which is the first six digits of a card number.
cardHolderName String (error) Test Cardholder Returns the Cardholder name passed in the payment request.
issuerCountry String (error) JP Returns the issuing country of the card based on the BIN list that Adyen maintains.
threeDOffered Boolean (error) true Returns a boolean value indicating whether 3DS was offered for this payment.
threeDAuthenticated Boolean (error) true Returns a boolean value indicating whether 3DS authentication was completed on this payment.
threeDOfferedResponse String (error) Y Returns the raw enrolment result from the 3DS directory services of the card schemes.
threeDAuthenticatedResponse String (error) N Returns the raw 3DS authentication result from the card issuer.
fundingSource String (error) DEBIT Returns information regarding the funding type of the card.
cardIssuingCurrency String (error) USD Returns the currency in which the card is issued, if information is available.
cardIssuingBank String (error)

American_Express

_US_Consumer

Returns the name of the bank that issued the card.
cavv String (error)

AQIDBAUGBw

gJCgsMDQ4PEBESExQ=

Returns the Cardholder Authentication Verification Value for the 3DS authentication session. Value returned is a Base64 encoded 20-byte byteArray.
xid String (error)

ODgxNDc2MDg2

MDExODk5MAAAAAA=

Returns the 3DS transaction ID of the 3DS session. Value is Base64 encoded and will be returned for transactions with directoryResponse 'N' or 'Y'.
cavvAlgorithm String (error) 3 Returns the algorithm used to generate the 3DS Cardholder Authentication Verification Value. 
eci String (error) 02 Returns the Electronic Commerce Indicator returned from the schemes for the 3DS payment session.

CVC/CVV result values

0 Unknown
1 Matches
2 Doesn't match
3 Not checked
4 No CVC/CVV provided, but was required
5 Issuer not certifed for CVC/CVV
6 No CVC/CVV provided

AVS result values

0 Unknown
1 Address matches, postal code doesn't
2 Neither postal code nor address match
3 AVS unavailable
4 AVS not supported for this card type
5 No AVS data provided
6 Postal code matches, address doesn't match
7 Both postal code and address match
8 Address not checked, postal code unknown
9 Address matches, postal code unknown
10 Address doesn't match, postal code unknown
11 Postal code not checked, address unknown
12 Address matches, postal code not checked
13 Address doesn't match, postal code not checked
14 Postal code matches, address unknown
15 Postal code matches, address not checked
16 Postal code doesn't match, address unknown
17 Postal code doesn't match, address not checked
18 Neither postal code nor address were checked
19 Name and postal code matches
20 Name, address and postal code matches
21 Name and address matches
22 Name matches
23 Postal code matches, name doesn't match
24 Both postal code and address matches, name doesn't match
25 Address matches, name doesn't match
26 Neither postal code, address nor name matches

Acquirer additionalData

Payment response: acquirer additionalData fields

This functionality is not enabled by default, as it requires additional configuration on Adyen's end. Contact the  Adyen Support Team to request enabling it for you.

Where available, you can choose to receive the raw results we receive from the acquirer. Once this feature is set up for you, the the additionalData object in the API response includes the additional fields described below.

Whether any values are returned depends on the data we receive from the acquirer.

Name Type Returned by default Description
cvcResultRaw String (tick) Raw CVC result received from the acquirer, where available.
avsResultRaw String (tick) Raw AVS result received from the acquirer, where available.
refusalReasonRaw String (tick) Raw refusal reason received from the acquirer, where available.