Webhooks Notification Additional Data Structure

{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/adyen/refs/heads/main/json-structure/webhooks-notification-additional-data-structure.json",
  "description": "NotificationAdditionalData schema from Adyen API",
  "type": "object",
  "properties": {
    "PaymentAccountReference": {
      "description": "Reference of the payment account.",
      "type": "string"
    },
    "acquirerAccountCode": {
      "description": "The acquirer account code.",
      "type": "string"
    },
    "acquirerCode": {
      "description": "The acquirer code.",
      "type": "string"
    },
    "acquirerReference": {
      "description": "The acquirer reference.",
      "type": "string"
    },
    "acsRenderingType.acsInterface": {
      "description": "ACS interface. Related to 3DS.",
      "type": "string"
    },
    "acsRenderingType.acsUiTemplate": {
      "description": "ACS UI template.",
      "type": "string"
    },
    "alias": {
      "description": "Alias for this card.",
      "type": "string"
    },
    "aliasType": {
      "description": "Alias type.",
      "type": "string"
    },
    "arn": {
      "description": "Acquirer Reference Number of the dispute.",
      "type": "string"
    },
    "authCode": {
      "description": "Authcode of the scheme.",
      "type": "string"
    },
    "authenticationType": {
      "description": "3DS authentication type",
      "type": "string"
    },
    "authorisationMid": {
      "description": "Authorisation MID of the acquirer.",
      "type": "string"
    },
    "authorisedAmountCurrency": {
      "description": "The currency authorised for a dynamic zero auth request.",
      "type": "string"
    },
    "authorisedAmountValue": {
      "description": "The amount authorised for a dynamic zero auth request.",
      "type": "string"
    },
    "avsResult": {
      "description": "Address Verification Service result.",
      "type": "string"
    },
    "avsResultRaw": {
      "description": "Address Verification Service result raw.",
      "type": "string"
    },
    "bankAccountNumber": {
      "description": "The bank account number.",
      "type": "string"
    },
    "bankLocation": {
      "description": "The bank location.",
      "type": "string"
    },
    "bankLocationId": {
      "description": "The bank location ID.",
      "type": "string"
    },
    "bankName": {
      "description": "The bank name.",
      "type": "string"
    },
    "bankVerificationResult": {
      "description": "The bank verificaiton result.",
      "type": "string"
    },
    "bankVerificationResultRaw": {
      "description": "The bank verification result raw.",
      "type": "string"
    },
    "bic": {
      "description": "Business Identifier Code.",
      "type": "string"
    },
    "billingAddress.city": {
      "description": "BillingAddress: county.",
      "type": "string"
    },
    "billingAddress.houseNumberOrName": {
      "description": "BillingAddress: house number or name.",
      "type": "string"
    },
    "billingAddress.postalCode": {
      "description": "BillingAddress: postal code.",
      "type": "string"
    },
    "billingAddress.stateOrProvince": {
      "description": "BillingAddress: state or province",
      "type": "string"
    },
    "billingAddress.street": {
      "description": "BillingAddress: street",
      "type": "string"
    },
    "browserCode": {
      "description": "Browser code.",
      "type": "string"
    },
    "captureDelayHours": {
      "description": "The amount of delay after authorisation.",
      "type": "string"
    },
    "captureMerchantReference": {
      "description": "The merchant reference of the capture.",
      "type": "string"
    },
    "capturePspReference": {
      "description": "The PSP reference of the capture.",
      "type": "string"
    },
    "cardBin": {
      "description": "Card Bank Identification number.",
      "type": "string"
    },
    "cardIssuingBank": {
      "description": "Card issuing bank.",
      "type": "string"
    },
    "cardIssuingCountry": {
      "description": "Card issuing country.",
      "type": "string"
    },
    "cardIssuingCurrency": {
      "description": "Card issuing currency.",
      "type": "string"
    },
    "cardPaymentMethod": {
      "description": "Card payment method.",
      "type": "string"
    },
    "cardSchemeEnhancedDataLevel": {
      "description": "Card scheme enhanced data level.",
      "type": "string"
    },
    "cardSummary": {
      "description": "Card summary",
      "type": "string"
    },
    "cavv": {
      "description": "Secure Cardholder Authentication Verification Value.",
      "type": "string"
    },
    "cavvAlgorithm": {
      "description": "CAVV algorithm.",
      "type": "string"
    },
    "challengeCancel": {
      "description": "Information about the 3DS challenge being canceled.",
      "type": "string"
    },
    "checkoutSessionId": {
      "description": "ID of the Checkout Session.",
      "type": "string"
    },
    "cvcResult": {
      "description": "Card Verification Code result.",
      "type": "string"
    },
    "cvcResultRaw": {
      "description": "Card Verification Code result raw.",
      "type": "string"
    },
    "deliveryAddress.city": {
      "description": "Delivery address: city.",
      "type": "string"
    },
    "deliveryAddress.country": {
      "description": "Delivery address: country.",
      "type": "string"
    },
    "deliveryAddress.houseNumberOrName": {
      "description": "Delivery address: house number or name.",
      "type": "string"
    },
    "deliveryAddress.postalCode": {
      "description": "Delivery address: postal code.",
      "type": "string"
    },
    "deliveryAddress.stateOrProvince": {
      "description": "Delivery address: state or province.",
      "type": "string"
    },
    "deliveryAddress.street": {
      "description": "Delivery address: street.",
      "type": "string"
    },
    "deviceType": {
      "description": "Type of device the request was made from.",
      "type": "string"
    },
    "directdebit_GB.dateOfSignature": {
      "description": "Direct debit GB: date of signature.",
      "type": "string"
    },
    "directdebit_GB.mandateId": {
      "description": "Direct debit GB: mandate ID.",
      "type": "string"
    },
    "directdebit_GB.sequenceType": {
      "description": "Direct debit GB: sequence type.",
      "type": "string"
    },
    "directdebit_GB.serviceUserName": {
      "description": "Direct debit GB: service user name.",
      "type": "string"
    },
    "directdebit_GB.serviceUserNumber": {
      "description": "Direct debit GB: service user number.",
      "type": "string"
    },
    "eci": {
      "description": "3DS: Electronic Commerce Indicator.",
      "type": "string"
    },
    "expiryDate": {
      "description": "Expiry date of the card.",
      "type": "string"
    },
    "extraCostsCurrency": {
      "description": "Additional cost used in [BIN or card verification](https://docs.adyen.com/payment-methods/cards/bin-data-and-card-verification).",
      "type": "string"
    },
    "extraCostsValue": {
      "description": "Related additional cost value.",
      "type": "string"
    },
    "extraCostsValueGratuity": {
      "description": "Gratuity related additional cost value.",
      "type": "string"
    },
    "extraCostsValueSurcharge": {
      "description": "Surcharge related additional cost value.",
      "type": "string"
    },
    "fraudCheck-<check ID>-<name>": {
      "description": "Information on the fraud check in a dynamic format.",
      "type": "string"
    },
    "fraudManualReview": {
      "description": "Indicates if the risk check was done manually.",
      "type": "string"
    },
    "fraudOffset": {
      "description": "The fraud offset.",
      "type": "string"
    },
    "fraudResultType": {
      "description": "Result type of the fraud check.",
      "type": "string"
    },
    "fundingSource": {
      "description": "Funding source.",
      "type": "string"
    },
    "grossCurrency": {
      "description": "Chargeback gross currency.",
      "type": "string"
    },
    "grossValue": {
      "description": "Chargeback gross value.",
      "type": "string"
    },
    "iban": {
      "description": "International Bank Account Number.",
      "type": "string"
    },
    "installments.value": {
      "description": "The number of installments that the payment amount should be charged with.\n\nExample: 5\n> Only relevant for card payments in countries that support installments.",
      "type": "string"
    },
    "interactionCounter": {
      "description": "3DS interaction counter.",
      "type": "string"
    },
    "issuerComments.cardholderName": {
      "description": "Card holder name.",
      "type": "string"
    },
    "issuerCountry": {
      "description": "Country of the card issuer.",
      "type": "string"
    },
    "latestCard.bin": {
      "description": "Recurring: Latest card BIN.",
      "type": "string"
    },
    "latestCard.expiryDate": {
      "description": "Recurring: Latest card expiry date.",
      "type": "string"
    },
    "latestCard.summary": {
      "description": "Recurring: Latest card summary.",
      "type": "string"
    },
    "liabilityShift": {
      "description": "Risk liability shift.",
      "type": "string"
    },
    "metadata": {
      "additionalProperties": {
        "type": "string"
      },
      "description": "A set of key-value pairs provided in the request, prefixed with 'metadata.'. For example, 'metadata.myField: myValue'",
      "type": "object"
    },
    "networkToken.available": {
      "description": "Recurring related.",
      "type": "string"
    },
    "networkToken.bin": {
      "description": "Recurring related.",
      "type": "string"
    },
    "networkToken.tokenSummary": {
      "description": "Recurring related.",
      "type": "string"
    },
    "nfc.expire": {
      "description": "NFC related.",
      "type": "string"
    },
    "nfc.issue": {
      "description": "NFC related.",
      "type": "string"
    },
    "nfc.pin.provided": {
      "description": "NFC related.",
      "type": "string"
    },
    "nfc.uid": {
      "description": "NFC related.",
      "type": "string"
    },
    "opi.transToken": {
      "description": "Trans token related to Oracle Opera.",
      "type": "string"
    },
    "ownerCity": {
      "description": "Owner city.",
      "type": "string"
    },
    "ownerName": {
      "description": "Owner name.",
      "type": "string"
    },
    "payULatamTrazabilityCode": {
      "description": "Related to PayU in LATAM.",
      "type": "string"
    },
    "paymentLinkId": {
      "description": "ID of the Checkout payment link.",
      "type": "string"
    },
    "realtimeAccountUpdaterStatus": {
      "description": "Real time Account Update status.",
      "type": "string"
    },
    "recurring.contractTypes": {
      "description": "Recurring contract types.",
      "type": "string"
    },
    "recurring.firstPspReference": {
      "description": "Recurring first PSP reference.",
      "type": "string"
    },
    "recurring.recurringDetailReference": {
      "description": "The [token for stored payment details](https://docs.adyen.com/online-payments/tokenization/create-and-use-tokens/) to make recurring payments.",
      "type": "string"
    },
    "referred": {
      "description": "If the payment is referred, this field is set to true.\n\nThis field is unavailable if the payment is referred and is usually not returned with ecommerce transactions.\n\nExample: true",
      "type": "string"
    },
    "refusalReasonRaw": {
      "description": "Raw refusal reason received from the acquirer, where available.\n\nExample: AUTHORISED",
      "type": "string"
    },
    "retry.rescueScheduled": {
      "description": "Indicates if an auto rescue for a pyment is scheduled.",
      "type": "string"
    },
    "riskProfile": {
      "description": "Related to Risk.",
      "type": "string"
    },
    "riskProfileReference": {
      "description": "Related to Risk.",
      "type": "string"
    },
    "shopperCountry": {
      "description": "Country of the shopper.",
      "type": "string"
    },
    "shopperEmail": {
      "description": "Email of the shopper.",
      "type": "string"
    },
    "shopperIP": {
      "description": "IP of the shopper.",
      "type": "string"
    },
    "shopperInteraction": {
      "description": "The shopper interaction type of the payment request.\n\nExample: Ecommerce",
      "type": "string"
    },
    "shopperLocale": {
      "description": "The locale of the shopper.",
      "type": "string"
    },
    "shopperSocialSecurityNumber": {
      "description": "The social security number of the shopper.",
      "type": "string"
    },
    "shopperStatement": {
      "description": "The text to be shown on the shopper's bank statement.",
      "type": "string"
    },
    "shopperTelephone": {
      "description": "The telephone number of the shopper.",
      "type": "string"
    },
    "store": {
      "description": "Identifier of the store processing the transaction.",
      "type": "string"
    },
    "tenderReference": {
      "description": "Tender reference. For point-of-sale integrations only.",
      "type": "string"
    },
    "terminalId": {
      "description": "Terminal ID. For point-of-sale integrations only.",
      "type": "string"
    },
    "threeDAuthenticated": {
      "description": "A Boolean value indicating whether 3DS authentication was completed on this payment.\n\nExample: true",
      "type": "string"
    },
    "threeDAuthenticatedResponse": {
      "description": "The raw 3DS authentication result from the card issuer.\n\nExample: N",
      "type": "string"
    },
    "threeDOffered": {
      "description": "A Boolean value indicating whether 3DS was offered for this payment.\n\nExample: true",
      "type": "string"
    },
    "threeDOfferedResponse": {
      "description": "The raw enrollment result from the 3DS directory services of the card schemes.\n\nExample: Y",
      "type": "string"
    },
    "threeDSVersion": {
      "description": "The 3D Secure 2 version.",
      "type": "string"
    },
    "tokenTxVariant": {
      "description": "Payment method variant of the token/wallet payment method.",
      "type": "string"
    },
    "totalFraudScore": {
      "description": "Total fraud score from risk.",
      "type": "string"
    },
    "untokenisedCardSummary": {
      "description": "Card summary without tokenization.",
      "type": "string"
    },
    "xid": {
      "description": "The 3DS transaction ID of the 3DS session sent in notifications. 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.\n\nExample: ODgxNDc2MDg2MDExODk5MAAAAAA=",
      "type": "string"
    }
  },
  "name": "NotificationAdditionalData"
}