PaymentResult.additionalData

The additionalData object is a generic container that can hold extra response fields. This functionality is not enabled by default. To specify additionalData that you want to receive, go to Customer Area > Account > API URLs.

When the additionalData object is enabled for your merchant account, it can be configured to return the following fields in API responses and/or payment notifications:

Field Type Returned by default Description
acquirerAccountCode String (error)

The status of the Adyen acquirer account.

Example: PayPalSandbox_TestAcquirer

Only relevant for PayPal transactions.

acquirerCode String (error)

The name of the acquirer processing the payment request.

Example: TestPmmAcquirer

acquirerReference String (error)

The reference number that can be used for reconciliation in case a non-Adyen acquirer is used for settlement.

Example: 7C9N3FNBKT9

alias String (error)

The Adyen alias of the card.

Example: H167852639363479

aliasType String (error)

The type of the card alias.

Example: Default

authCode String (error)

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.

Example: 58747

authorisedAmountCurrency String (error)

The currency of the authorised amount, as a three-character ISO currency code.

authorisedAmountValue Int (error)

Value of the amount authorised.

This amount is represented in minor units according to the following table.

avsResult String (error)

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

For possible values, see AVS.

avsResultRaw String (error)

Raw AVS result received from the acquirer, where available.

Example: 7

bic String (error)

BIC of a bank account.

Example: TESTNL01

Only relevant for SEPA Direct Debit transactions.

billingAddress.city

String (error) The billing address city passed in the payment request.

billingAddress.country

String (error)

The billing address country passed in the payment request.

Example: NL

billingAddress.houseNumberOrName

String (error) The billing address house number or name passed in the payment request.

billingAddress.postalCode

String (error)

The billing address postal code passed in the payment request.

Example: 1011 DJ

billingAddress.stateOrProvince

String (error)

The billing address state or province passed in the payment request.

Example: NH

billingAddress.street

String (error) The billing address street passed in the payment request.

cardBin

String (error)

The Bank Identification Number of a credit card, which is the first six digits of a card number.

Example: 521234

cardHolderName

String (error) The cardholder name passed in the payment request.

cardIssuingBank

String (error) The bank or the financial institution granting lines of credit through card association branded payment cards. This information can be included when available.
cardIssuingCountry String (error)

The country where the card was issued.

Example: US

cardIssuingCurrency

String (error)

The currency in which the card is issued, if this information is available.

Example: USD

cardPaymentMethod String (error)

The card payment method used for the transaction.

Example: amex

cardSummary

String (error)

The last four digits of a card number.

Returned only in case of a card payment.

cavv String (error)

The Cardholder Authentication Verification Value for the 3DS authentication session. The returned value is a Base64-encoded 20-byte array.

Example: AQIDBAUGBwgJCgsMDQ4PEBESExQ=

cavvAlgorithm String (error)

The algorithm used to generate the 3DS Cardholder Authentication Verification Value.

Example: 3

countryCode String (error)

The country code of a bank account.

Example: NL

Only relevant for SEPA Direct Debit transactions.

cvcResult String (error)

The CVC result code, which provides information about the outcome of the CVC check.

For possible cvcResult values, see CVC-CVV result testing.

cvcResultRaw String (error)

Raw CVC result received from the acquirer, where available.

Example: 1

deliveryAddress.stateOrProvince String (error)

The delivery address state or province passed in the payment request.

Example: NH

deliveryAddress.city String (error) The delivery address city passed in the payment request.
deliveryAddress.postalCode String (error)

The delivery address postal code passed in the payment request.

Example: 1011 DJ

deliveryAddress.street String (error) The delivery address street passed in the payment request.
deliveryAddress.houseNumberOrName String (error) The delivery address house number or name passed in the payment request.
deliveryAddress.country String (error)

The delivery address country passed in the payment request.

Example: NL

eci String (error)

The Electronic Commerce Indicator returned from the schemes for the 3DS payment session.

Example: 02

expiryDate String (error)

The expiry date on the card.

Example: 6/2016

Returned only in case of a card payment.

extraCostsCurrency String (error)

The currency of the extra amount charged due to additional amounts set in the skin used in the HPP payment request.

Example: EUR

extraCostsValue String (error) The value of the extra amount charged due to additional amounts set in the skin used in the HPP payment request. The amount is in minor units.

fraudCheck-[nn]-
[Fraud Check name]

String (error) The fraud score due to a particular fraud check. The fraud check name is found in the key of the key-value pair.
fundingSource String (error)

Information regarding the funding type of the card.

The possible return values are:

  • CHARGE
  • CREDIT
  • DEBIT
  • PREPAID
  • DEFFERED_DEBIT

This functionality requires additional configuration on Adyen's end. To enable it, contact the  Support Team.

For receiving this field in the notification, enable Include Funding Source in Notifications > Additional settings.


fundsAvailability Enum (error)

Indicates availability of funds.

Visa:

  • "I" (fast funds are supported)
  • "N" (otherwise)

Mastercard:

  • "I" (product type is Prepaid or Debit, or issuing country is in CEE/HGEM list)
  • "N" (otherwise)

Returned when you verify a card BIN or estimate costs, and only if payoutEligible is different from "N" or "U".

inferredRefusalReason String (error)
Provides the more granular indication of why a transaction was refused.
When a transaction fails with either “Refused", “Restricted Card", "Transaction Not Permitted”, “Not supported” or "DeclinedNon Generic" refusalReason from the issuer, Adyen cross references its PSP-wide data for extra insight into the refusal reason.
If an inferred refusal reason is available, the inferredRefusalReason field is populated and the refusalReason is set to "Not Supported".

Possible values:

  • 3D Secure Mandated
  • ContAuth Not Supported
  • CVC Mandated
  • Ecommerce Not Allowed
  • Crossborder Not Supported
  • Card Updated
  • Low Authrate Bin
  • Non-reloadable prepaid card
installments.value String (error)

The number of installments that the payment amount should be charged with.

Example: 5

Only relevant for card payments in countries that support installments.

issuerCountry String (error)

The issuing country of the card based on the BIN list that Adyen maintains.

Example: JP

ownerName String (error)

The owner name of a bank account.

Only relevant for SEPA Direct Debit transactions.

paymentAccountReference String (error) The Payment Account Reference (PAR) value links a network token with the underlying primary account number (PAN). The PAR value consists of 29 uppercase alphanumeric characters.
paymentMethodVariant String (error)

The Adyen sub-variant of the payment method used for the payment request.

For more information, refer to PaymentMethodVariant.

Example: mcpro

payoutEligible Enum (error)

Indicates whether a payout is eligible or not for this card.

Visa:

  • "Y"
  • "N"

Mastercard:

  • "Y" (domestic and cross-border)
  • "D" (only domestic)
  • "N" (no MoneySend)
  • "U" (unknown)

Returned when you verify a card BIN or estimate costs, and only if payoutEligible is different from "N" or "U".

paypalPayerStatus String (error)

The status of the buyer's PayPal account.

Example: unverified

Only relevant for PayPal transactions.

paypalPayerResidenceCountry String (error)

The buyer's country of residence.

Example: NL

Only relevant for PayPal transactions.

paypalPayerId String (error)

The buyer's PayPal ID.

Example: LF5HCWWBRV2KL

Only relevant for PayPal transactions.

paypalEmail String (error)

The buyer's PayPal account email address.

Example: paypaltest@adyen.com

Only relevant for PayPal transactions.

paypalProtectionEligibility String (error)

The eligibility for PayPal Seller Protection for this payment.

Example: Ineligible

Only relevant for PayPal transactions.

realtimeAccountUpdaterStatus String (error)

The response code from the Real Time Account Updater service.

Possible return values are:

  • CardChanged
  • CardExpiryChanged
  • CloseAccount
  • ContactCardAccountHolder
recurring.firstPspReference String (error)

The pspReference of the first recurring payment that created the recurring detail.

This functionality requires additional configuration on Adyen's end. To enable it, contact the  Support Team.

recurring.recurringDetailReference String (error)

The reference that uniquely identifies the recurring detail.

This functionality requires additional configuration on Adyen's end. To enable it, contact the  Support Team.

referred Boolean (error)

If the payment is referred, this field is set to true.

This field is unavailable if the payment is referred and is usually not returned with ecommerce transactions.

Example: true

refusalReasonRaw String (error)

Raw refusal reason received from the acquirer, where available.

Example: AUTHORISED

sepadirectdebit.dateOfSignature String (error)

The transaction signature date.

Format: yyyy-MM-dd

Only relevant for SEPA Direct Debit transactions.

sepadirectdebit.mandateId String (error)

Its value corresponds to the  pspReference value of the transaction.

Only relevant for SEPA Direct Debit transactions.


sepadirectdebit.sequenceType String (error)

This field can take one of the following values:

  • OneOff: (OOFF) Direct debit instruction to initiate exactly one direct debit transaction.
  • First(FRST) Initial/first collection in a series of direct debit instructions.
  • Recurring: (RCUR) Direct debit instruction to carry out regular direct debit transactions initiated by the creditor.
  • Final: (FNAL) Last/final collection in a series of direct debit instructions.

Example: OOFF

Only relevant for SEPA Direct Debit transactions.

shopperInteraction String (error)

The shopper interaction type of the payment request.

Example: Ecommerce

shopperReference String (error)

The shopperReference passed in the payment request.

Example: AdyenTestShopperXX

terminalId String (error)

The terminal ID used in a point-of-sale payment.

Example: 06022622

threeDAuthenticated Boolean (error)

A Boolean value indicating whether 3DS authentication was completed on this payment.

Example: true

threeDAuthenticatedResponse String (error)

The raw 3DS authentication result from the card issuer.

Example: N

threeDOffered Boolean (error)

A Boolean value indicating whether 3DS was offered for this payment.

Example: true

threeDOfferedResponse String (error)

The raw enrollment result from the 3DS directory services of the card schemes.

Example: Y

xid String (error)

The 3DS transaction ID of the 3DS session. The value is Base64-encoded and is returned for transactions with directoryResponse 'N' or 'Y'.

Example:

ODgxNDc2MDg2MDExODk5MAAAAAA=

mcBankNetReferenceNumber String (error)

The mcBankNetReferenceNumber is a minimum of six characters and a maximum of nine characters long.

Contact Support Team to enable this field.

visaTransactionId String (error)

The visaTransactionId has a fixed length of 15 numeric characters.

Contact Support Team to enable this field.

receiptFreeText
String (error) Message to the merchant to be displayed on Terminal/shopper.

installmentPaymentData
.installmentType

String

(tick)

Type of installment. The value of installmentType should be IssuerFinanced.

installmentPaymentData
.paymentOptions

String

(tick)

Possible values:

  • PayInInstallmentsOnly
  • PayInFullOnly
  • PayInFullOrInstallments

installmentPaymentData.option_<Nr>
.numberOfInstallments

Integer

(error)

Total number of installments possible for this payment.

installmentPaymentData.option_<Nr>
.interestRate

Double

(error)

Interest rate for the installment period.

installmentPaymentData.option_<Nr>
.
installmentFee

Integer

(error)

Installment fee amount in minor units.

installmentPaymentData.option_<Nr>
.annualPercentageRate

Double

(error)

Annual interest rate.

installmentPaymentData.option_<Nr>
.firstInstallmentAmount

Integer

(error)

First Installment Amount in minor units.

installmentPaymentData.option_<Nr>
.subsequentInstallmentAmount

Integer

(error)

Subsequent Installment Amount in minor units.

installmentPaymentData.option_<Nr>
.minimumNumberOfInstallments

Integer

(error)

Maximum number of installments possible for this payment.

installmentPaymentData.option_<Nr>
.maximumNumberOfInstallments

Integer

(error)

Minimum number of installments possible for this payment.

installmentPaymentData.option_<Nr>
.totalAmountDue

Integer (error)

Total amount in minor units.

<Nr> refers to the specific installment option. Options are incremented based on the number of installment options supplied by the Issuer.