Serialized Form

  • Package com.broadleafcommerce.adyen.domain

    • Class com.broadleafcommerce.adyen.domain.AdyenAmount

      class AdyenAmount extends Object implements Serializable
      serialVersionUID:
      1L

      • Serialized Fields

        • currency
          String currency
          The three-character ISO currency code.
        • value
          Long value
          The amount of the transaction, in minor units (e.g. $10.00 USD would have a 1000 value).

    • Class com.broadleafcommerce.adyen.domain.AdyenErrorResponse

      class AdyenErrorResponse extends Object implements Serializable
      serialVersionUID:
      1L

      • Serialized Fields

        • additionalData
          Map<String,Object> additionalData
          Contains additional information about the payment.
        • errorCode
          String errorCode
          The error code mapped to the error message.
        • errorType
          String errorType
          The category of the error.
        • message
          String message
          A short explanation of the issue.
        • pspReference
          String pspReference
          The PSP reference of the payment.
        • status
          Integer status
          The HTTP response status.

    • Class com.broadleafcommerce.adyen.domain.AdyenPaymentDetailsRequest

      class AdyenPaymentDetailsRequest extends Object implements Serializable
      serialVersionUID:
      1L

      • Serialized Fields

        • additionalAttributes
          Map<String,Object> additionalAttributes
          Contains the additional information for the request.
        • details
          Map<String,Object> details
          The details that were returned as a result of the "/payments" call.

    • Class com.broadleafcommerce.adyen.domain.AdyenPaymentMethodsRequest

      class AdyenPaymentMethodsRequest extends Object implements Serializable
      serialVersionUID:
      1L

      • Serialized Fields

        • additionalAttributes
          Map<String,Object> additionalAttributes
          Contains the additional information for the request. It is used as a "fallback" handler for all unrecognized properties from JSON content.
        • amount
          AdyenAmount amount
          The amount of the payment.
        • countryCode
          String countryCode
          shoppers country code
        • merchantAccount
          String merchantAccount
          The merchant account identifier, with which you want to process the transaction.
        • order
          PaymentMethodsRequest.AdditionalDetailsRequestOrderField order
          The order information required for partial payments.
        • shopperLocale
          String shopperLocale
          The combination of a language code and a country code to specify the language to be used in the payment.
        • shopperReference
          String shopperReference
          Required for recurring payments. Your reference to uniquely identify this shopper, for example user ID or account ID. Minimum length: 3 characters.
        • store
          String store
          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 Adyen integration) for the ecommerce or point-of-sale store that is processing the payment.

    • Class com.broadleafcommerce.adyen.domain.AdyenResponse

      class AdyenResponse extends Object implements Serializable
      serialVersionUID:
      1L

      • Serialized Fields

        • action
          Map<String,Object> action
          Action to be taken for completing the payment.
        • additionalAttributes
          Map<String,Object> additionalAttributes
          Contains the additional information from the response. It is used as a "fallback" handler for all unrecognized properties from JSON content.
        • amount
          AdyenAmount amount
          The payment amount in the transaction.
        • merchantReference
          String merchantReference
          The reference used during the "/payments" request.
        • paymentPspReference
          String paymentPspReference
          The "pspReference" of the payment.
        • pspReference
          String pspReference
          Adyen's 16-character string reference associated with the transaction/request. This value is globally unique; quote it when communicating with us about this request.
        • reference
          String reference
          The reference for the request.
        • refusalReason
          String refusalReason
          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.
        • refusalReasonCode
          String refusalReasonCode
          Code that specifies the refusal reason. For more information, see Authorisation refusal reasons.
        • resultCode
          String resultCode
          The result of the payment. For more information, see Result codes.
        • status
          String status
          Transaction status, expected to be received for capture, refund etc transactions. If not received means an error

    • Class com.broadleafcommerce.adyen.domain.AdyenStoredPaymentMethod

      class AdyenStoredPaymentMethod extends Object implements Serializable
      serialVersionUID:
      1L

      • Serialized Fields

        • brand
          String brand
          The brand of the card.
        • expiryMonth
          String expiryMonth
          The month the card expires.
        • expiryYear
          String expiryYear
          The last two digits of the year the card expires. For example, 22 for the year 2022.
        • externalResponseCode
          String externalResponseCode
          The response code returned by an external system (for example after a provisioning operation).
        • externalTokenReference
          String externalTokenReference
          The token reference of a linked token in an external system (for example a network token reference).
        • holderName
          String holderName
          The unique payment method code.
        • iban
          String iban
          The IBAN of the bank account.
        • id
          String id
          A unique identifier of this stored payment method.
        • issuerName
          String issuerName
          The name of the issuer of token or card.
        • lastFour
          String lastFour
          The last four digits of the PAN.
        • name
          String name
          The display name of the stored payment method.
        • networkTxReference
          String networkTxReference
          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 Trace ID or the Visa Transaction ID.
        • ownerName
          String ownerName
          The name of the bank account holder.
        • shopperEmail
          String shopperEmail
          The shopper’s email address.
        • shopperReference
          String shopperReference
          Your reference to uniquely identify this shopper, for example user ID or account ID. Minimum length: 3 characters. NOTE: Your reference must not include personally identifiable information (PII), for example name or email address.
        • supportedRecurringProcessingModels
          List<String> supportedRecurringProcessingModels
          Defines a recurring payment type. Allowed values:
          • Subscription – A transaction for a fixed or variable amount, which follows a fixed schedule.
          • CardOnFile – With a card-on-file (CoF) transaction, card details are stored to enable one-click or omnichannel journeys, or simply to streamline the checkout process. Any subscription not following a fixed schedule is also considered a card-on-file transaction.
          • UnscheduledCardOnFile – An unscheduled card-on-file (UCoF) transaction is a transaction that occurs on a non-fixed schedule and/or have variable amounts. For example, automatic top-ups when a cardholder's balance drops below a certain amount.

    • Class com.broadleafcommerce.adyen.domain.AdyenStoredPaymentMethodsResponse

      class AdyenStoredPaymentMethodsResponse extends Object implements Serializable
      serialVersionUID:
      1L

      • Serialized Fields

        • merchantAccount
          String merchantAccount
          The merchant account.
        • shopperReference
          String shopperReference
          The reference to uniquely identify this shopper, for example user ID or account ID. Minimum length: 3 characters.
        • storedPaymentMethods
          List<AdyenStoredPaymentMethod> storedPaymentMethods
          List of all stored payment methods.

    • Class com.broadleafcommerce.adyen.domain.AdyenWebhookRequest

      class AdyenWebhookRequest extends Object implements Serializable
      serialVersionUID:
      1L

    • Class com.broadleafcommerce.adyen.domain.CreateCheckoutSessionRequest

      class CreateCheckoutSessionRequest extends Object implements Serializable
      serialVersionUID:
      1L

      • Serialized Fields

        • additionalAmount
          AdyenAmount additionalAmount
          If you want a BIN or card verification request to use a non-zero value, assign this value to additionalAmount (while the amount must be still set to 0 to trigger BIN or card verification). Required to be in the same currency as the amount.
        • additionalAttributes
          Map<String,Object> additionalAttributes
          Contains the additional information for the request. It is used as a "fallback" handler for all unrecognized properties from JSON content.
        • amount
          AdyenAmount amount
          The amount of the payment.
        • expiresAt
          String expiresAt
          The date the session expires in ISO8601 format. When not specified, the expiry date is set to 1 hour after session creation. You cannot set the session expiry to more than 24 hours after session creation.
        • merchantAccount
          String merchantAccount
          The merchant account identifier, with which you want to process the transaction.
        • metadata
          Map<String,String> metadata
          The mandate details to initiate recurring transaction.
        • recurringProcessingModel
          String recurringProcessingModel
          used for saved payments, can be CardOnFile, Subscription, UnscheduledCardOnFile
          See Also:
        • reference
          String reference
          The reference to uniquely identify a payment.
        • returnUrl
          String returnUrl
          The URL to return to when a redirect payment is completed.
        • shopperInteraction
          String shopperInteraction
          used for saved payments, in our case Ecommerce
        • shopperReference
          String shopperReference
          Your reference to uniquely identify this shopper, for example user ID or account ID. Minimum length: 3 characters.
        • store
          String store
          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 Adyen integration) for the ecommerce or point-of-sale store that is processing the payment.
        • storePaymentMethodMode
          String storePaymentMethodMode
          used for saved payments, can be askForConsent, enabled, disabled

    • Class com.broadleafcommerce.adyen.domain.CustomerRef

      class CustomerRef extends Object implements Serializable
      serialVersionUID:
      1L

      • Serialized Fields

        • accountHierarchy
          List<String> accountHierarchy
          The hierarchy of accounts, from the root account to the account member's account.

          For example, if we have this account setup, rootAcct -> subAcct (child of rootAcct) -> subSubAcct (child of subAcct), this field would be [rootAcct, subAcct, subSubAcct]. This is useful to query all the carts that belong to the same non-root account and its sub-accounts.

        • accountId
          String accountId
          The ID of the account the customer belongs to.
        • customerId
          String customerId
          The customer's id.
        • fullName
          String fullName
          The customer's full name, if available.
        • isRegistered
          boolean isRegistered
          Defines whether or not the customer is registered. If false, then the customer is considered anonymous.
        • rootAccountId
          String rootAccountId
          The ID of the root account the account member belongs to.
        • username
          String username
          The customer's username.

    • Class com.broadleafcommerce.adyen.domain.UpdateExpressPayPalOrderResponse

      class UpdateExpressPayPalOrderResponse extends Object implements Serializable
      serialVersionUID:
      1L

      • Serialized Fields

        • additionalAttributes
          Map<String,Object> additionalAttributes
          Contains the additional information from the response. It is used as a "fallback" handler for all unrecognized properties from JSON content.
        • paymentData
          String paymentData
          The updated paymentData.
        • status
          String status
          The status of the request. This indicates whether the order was successfully updated with PayPal.

  • Package com.broadleafcommerce.adyen.domain.webhook

    • Class com.broadleafcommerce.adyen.domain.webhook.NotificationRequestItem

      class NotificationRequestItem extends Object implements Serializable

      • Serialized Fields

        • additionalData
          Map<String,String> additionalData
          This object is a generic container that can hold extra fields.
        • amount
          AdyenAmount amount
          The amount of operation this notification is about
        • eventCode
          String eventCode
          Event code of notification - authorization, capture
        • eventDate
          Date eventDate
          The time when the event was generated.
        • merchantAccountCode
          String merchantAccountCode
          The merchant account code
        • merchantReference
          String merchantReference
          The merchant reference, Your reference to uniquely identify the payment
        • operations
          List<String> operations
          The operations indicate the supported follow-up actions concerning the payment.
        • originalReference
          String originalReference
          The pspReference of the original payment
        • paymentMethod
          String paymentMethod
          The payment method used in the transaction.
        • pspReference
          String pspReference
          Reference of transaction
        • reason
          String reason
          If success = true and paymentMethod = visa, mc, or amex then this field contains the following details: Authorisation code, last 4 digits of the card, card expiry date. In case of failure, this contains information about the authorisation failure
        • success
          boolean success
          If true: The payment request was successful. If false: The payment request failed. Check the reason field for failure information.

  • Package com.broadleafcommerce.adyen.provider.exception

  • Package com.broadleafcommerce.adyen.service.requestresponse.exception

  • Package com.broadleafcommerce.adyen.web.endpoint.domain

    • Class com.broadleafcommerce.adyen.web.endpoint.domain.PaymentMethodsRequest

      class PaymentMethodsRequest extends Object implements Serializable
      serialVersionUID:
      1L

      • Serialized Fields

        • additionalAttributes
          Map<String,Object> additionalAttributes
          Contains the additional information for the request. It is used as a "fallback" handler for all unrecognized properties from JSON content.
        • amount
          javax.money.MonetaryAmount amount
          The amount of the payment.
        • countryCode
          String countryCode
          shoppers country code
        • order
          PaymentMethodsRequest.AdditionalDetailsRequestOrderField order
          The order information required for partial payments.
        • shopperLocale
          String shopperLocale
          The combination of a language code and a country code to specify the language to be used in the payment.
        • shopperReference
          String shopperReference
          Required for recurring payments. Your reference to uniquely identify this shopper, for example user ID or account ID. Minimum length: 3 characters.

    • Class com.broadleafcommerce.adyen.web.endpoint.domain.PaymentMethodsRequest.AdditionalDetailsRequestOrderField

      class AdditionalDetailsRequestOrderField extends Object implements Serializable
      serialVersionUID:
      1L

      • Serialized Fields

        • orderData
          String orderData
          The encrypted order data.
        • pspReference
          String pspReference
          The pspReference that belongs to the order.

    • Class com.broadleafcommerce.adyen.web.endpoint.domain.SessionRequest

      class SessionRequest extends Object implements Serializable
      serialVersionUID:
      1L

      • Serialized Fields

        • additionalAmount
          javax.money.MonetaryAmount additionalAmount
          If you want a BIN or card verification request to use a non-zero value, assign this value to additionalAmount (while the amount must be still set to 0 to trigger BIN or card verification). Required to be in the same currency as the amount.
        • additionalAttributes
          Map<String,Object> additionalAttributes
          Contains the additional information for the request. It is used as a "fallback" handler for all unrecognized properties from JSON content.
        • amount
          javax.money.MonetaryAmount amount
          The amount of the payment.
        • customerId
          String customerId
          The customer ID.
        • expiresAt
          String expiresAt
          The date the session expires in ISO8601 format. When not specified, the expiry date is set to 1 hour after session creation. You cannot set the session expiry to more than 24 hours after session creation.
        • metadata
          Map<String,String> metadata
          The mandate details to initiate recurring transaction.
        • recurringProcessingModel
          String recurringProcessingModel
          Specifies recurring procession model for session creation, expected to be CardOnFile, should come in pair with SessionRequest.storePaymentMethodMode other possible values: Subscription, UnscheduledCardOnFile
          See Also:
        • reference
          String reference
          The reference to uniquely identify a payment. For example, the payment owner ID (Cart ID etc).
        • returnUrl
          String returnUrl
          The URL to return to when a redirect payment is completed.
        • storePaymentMethodMode
          String storePaymentMethodMode
          Intended to be used for saved method payment logic, should come in pair with SessionRequest.recurringProcessingModel Possible values: disabled Your shopper's card details are not stored. askForConsent Drop-in enables your shopper to select whether they want their payment details to be stored. enabled Your shopper's card details are stored.