Search docs

Are you looking for test card numbers?

Would you like to contact support?

Start searching Adyen's documentation...

  Documentation

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 -x-

The status of the Adyen acquirer account.

Example: PayPalSandbox_TestAcquirer

Only relevant for PayPal transactions.

acquirerCode String -x-

The name of the acquirer processing the payment request.

Example: TestPmmAcquirer

acquirerReference String -x-

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

Example: 7C9N3FNBKT9

alias String -x-

The Adyen alias of the card.

Example: H167852639363479

aliasType String -x-

The type of the card alias.

Example: Default

authCode String -x-

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 -x-

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

authorisedAmountValue Int -x-

Value of the amount authorised.

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

avsResult String -x-

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

For possible values, see AVS.

avsResultRaw String -x-

Raw AVS result received from the acquirer, where available. Example: 7

bic String -x-

BIC of a bank account.

Example: TESTNL01

billingAddress.city

String -x- The billing address city passed in the payment request.

billingAddress.country

String -x-

The billing address country passed in the payment request.

Example: NL

billingAddress.houseNumberOrName

String -x- The billing address house number or name passed in the payment request.

billingAddress.postalCode

String -x-

The billing address postal code passed in the payment request.

Example: 1011 DJ

billingAddress.stateOrProvince

String -x-

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

Example: NH

billingAddress.street

String -x- The billing address street passed in the payment request.

cardBin

String -x-

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

Example: 521234

cardHolderName

String -x- The cardholder name passed in the payment request.

cardIssuingBank

String -x- 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 -x-

The country where the card was issued.

Example: US

cardIssuingCurrency

String -x-

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

Example: USD

cardPaymentMethod String -x-

The card payment method used for the transaction.

Example: amex

cardSummary

String -x-

The last four digits of a card number.

Returned only in case of a card payment.

cavv String -x-

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

Example: AQIDBAUGBwgJCgsMDQ4PEBESExQ=

cavvAlgorithm String -x-

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

Example: 3

countryCode String -x-

The country code of a bank account.

Example: NL

cvcResult String -x-

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 -x-

Raw CVC result received from the acquirer, where available. Example: 1

deliveryAddress.stateOrProvince String -x-

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

Example: NH

deliveryAddress.city String -x- The delivery address city passed in the payment request.
deliveryAddress.postalCode String -x-

The delivery address postal code passed in the payment request.

Example: 1011 DJ

deliveryAddress.street String -x- The delivery address street passed in the payment request.
deliveryAddress.houseNumberOrName String -x- The delivery address house number or name passed in the payment request.
deliveryAddress.country String -x-

The delivery address country passed in the payment request.

Example: NL

eci String -x-

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

Example: 02

expiryDate String -x-

The expiry date on the card.

Example: 6/2016

Returned only in case of a card payment.

extraCostsCurrency String -x-

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 -x- 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 -x- 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 -x-

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 -x-

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 "Y" or "D".
inferredRefusalReason String -x- 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 -x-

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 -x-

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

Example: JP

networkTxReference String -x-

Returned in the response if you are not tokenizing with Adyen and are using the Merchant-initiated transactions (MIT) framework from Mastercard or Visa.

This contains either the Mastercard Banknet Reference number or the Visa Transaction ID.

ownerName String -x-

The owner name of a bank account.

paymentAccountReference String -x- 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 -x-

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

For more information, refer to PaymentMethodVariant.

Example: mcpro

payoutEligible Enum -x-

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)
paypalPayerStatus String -x-

The status of the buyer's PayPal account.

Example: unverified

Only relevant for PayPal transactions.

paypalPayerResidenceCountry String -x-

The buyer's country of residence.

Example: NL

Only relevant for PayPal transactions.

paypalPayerId String -x-

The buyer's PayPal ID.

Example: LF5HCWWBRV2KL

Only relevant for PayPal transactions.

paypalEmail String -x-

The buyer's PayPal account email address.

Example: paypaltest@adyen.com

Only relevant for PayPal transactions.

paypalProtectionEligibility String -x-

The eligibility for PayPal Seller Protection for this payment.

Example: Ineligible

Only relevant for PayPal transactions.

realtimeAccountUpdaterStatus String -x-

The response code from the Real Time Account Updater service.

Possible return values are:

  • CardChanged
  • CardExpiryChanged
  • CloseAccount
  • ContactCardAccountHolder
recurring.firstPspReference String -x-

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 -x-

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 -x-

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 -x-

Raw refusal reason received from the acquirer, where available.

Example: AUTHORISED

sepadirectdebit.dateOfSignature String -x-

The transaction signature date.

Format: yyyy-MM-dd

sepadirectdebit.mandateId String -x-

Its value corresponds to the  pspReference value of the transaction.


sepadirectdebit.sequenceType String -x-

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

shopperInteraction String -x-

The shopper interaction type of the payment request.

Example: Ecommerce

shopperReference String -x-

The shopperReference passed in the payment request.

Example: AdyenTestShopperXX

terminalId String -x-

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

Example: 06022622

threeDAuthenticated Boolean -x-

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

threeDAuthenticatedResponse String -x-

The raw 3DS authentication result from the card issuer.

Example: N

threeDOffered Boolean -x-

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

threeDOfferedResponse String -x-

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

Example: Y

xid String -x-

The 3DS transaction ID of the 3DS session sent in notifications (webhooks) . The value is Base64-encoded and is returned for transactions with directoryResponse 'N' or 'Y'. If you want to submit the xid in your 3D Secure 1 request, use the mpiData.xid field.

Example:

ODgxNDc2MDg2MDExODk5MAAAAAA=

mcBankNetReferenceNumber String -x-

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

Contact Support Team to enable this field.

visaTransactionId String -x-

The visaTransactionId has a fixed length of 15 numeric characters.

Contact Support Team to enable this field.

receiptFreeText String -x- Message to the merchant to be displayed on Terminal/shopper.

installmentPaymentData.installmentType

String

-white_check_mark-

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

installmentPaymentData.paymentOptions

String

-white_check_mark-

Possible values:

  • PayInInstallmentsOnly
  • PayInFullOnly
  • PayInFullOrInstallments

installmentPaymentData.option_ .numberOfInstallments

Integer

-x-

Total number of installments possible for this payment.

installmentPaymentData.option_ .interestRate

Double

-x-

Interest rate for the installment period.

installmentPaymentData.option_ .installmentFee

Integer

-x-

Installment fee amount in minor units.

installmentPaymentData.option_.annualPercentageRate

Double

-x-

Annual interest rate.

installmentPaymentData.option_ .firstInstallmentAmount

Integer

-x-

First Installment Amount in minor units.

installmentPaymentData.option_ .subsequentInstallmentAmount

Integer

-x-

Subsequent Installment Amount in minor units.

installmentPaymentData.option_ .minimumNumberOfInstallments

Integer

-x-

Maximum number of installments possible for this payment.

installmentPaymentData.option_ .maximumNumberOfInstallments

Integer

-x-

Minimum number of installments possible for this payment.

installmentPaymentData.option_ .totalAmountDue

Integer -x-

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.