Package com.broadleafcommerce.adyen.provider.external

Class ExternalAdyenProvider

java.lang.Object
com.broadleafcommerce.adyen.provider.external.AbstractExternalProvider
com.broadleafcommerce.adyen.provider.external.ExternalAdyenProvider
All Implemented Interfaces:
AdyenProvider
public class ExternalAdyenProvider extends AbstractExternalProvider implements AdyenProvider
The default implementation of AdyenProvider.

  • Field Details

  • Constructor Details

    • ExternalAdyenProvider

      public ExternalAdyenProvider(org.springframework.web.reactive.function.client.WebClient webClient, com.fasterxml.jackson.databind.ObjectMapper objectMapper, ExternalAdyenProviderProperties providerProperties, AdyenConfigurationProperties configProperties, com.broadleafcommerce.common.extension.TypeFactory typeFactory)

  • Method Details

    • createSession

      public Map<String,Object> createSession(@NonNull @NonNull CreateCheckoutSessionRequest request, @Nullable String applicationId, @Nullable String tenantId)
      Description copied from interface: AdyenProvider
      This method is responsible for making call to create session end-point of Adyen.
      Specified by:
      createSession in interface AdyenProvider
      Parameters:
      request - The request to create a session
      applicationId - the application id
      tenantId - the tenant id
      Returns:
      the response from Adyen API.

    • getAvailablePaymentMethods

      public Map<String,Object> getAvailablePaymentMethods(@NonNull @NonNull AdyenPaymentMethodsRequest request, @Nullable String applicationId, @Nullable String tenantId)
      Description copied from interface: AdyenProvider
      Gathers a map of available payment methods that's used to inform what should be rendered by Adyen frontend components.
      Specified by:
      getAvailablePaymentMethods in interface AdyenProvider
      Parameters:
      request - Request payload describing the context in which the payment methods will be considered.
      applicationId - the application id
      tenantId - the tenant id
      Returns:
      a map of available payment methods that's used to inform what should be rendered by Adyen frontend components.

    • startTransaction

      public AdyenResponse startTransaction(@NonNull @NonNull Map<String,Object> bodyParams, @Nullable String currencyCode, @Nullable String transactionReferenceId, @Nullable String applicationId, @Nullable String tenantId)
      Description copied from interface: AdyenProvider
      Executes DefaultTransactionTypes.AUTHORIZE or DefaultTransactionTypes.AUTHORIZE_AND_CAPTURE transactions.
      Specified by:
      startTransaction in interface AdyenProvider
      Parameters:
      bodyParams - the request body
      currencyCode - The currency code for this transaction
      transactionReferenceId - - transactionReferenceId that will be used ad idempotency key for the adyen request
      applicationId - the application id
      tenantId - the tenant id
      Returns:
      the response from Adyen API

    • submitPaymentDetails

      public AdyenResponse submitPaymentDetails(@NonNull @NonNull AdyenPaymentDetailsRequest request, @Nullable String applicationId, @Nullable String tenantId)
      Description copied from interface: AdyenProvider
      Submits details for a payment created using "/payments" API. This step is only needed when no final state has been reached on the "/payments" request, for example when the shopper was redirected to another page to complete the payment.
      Specified by:
      submitPaymentDetails in interface AdyenProvider
      Parameters:
      request - the request with payment details
      applicationId - the application id
      tenantId - the tenant id
      Returns:
      the response from Adyen API

    • cancelAuthorization

      public AdyenResponse cancelAuthorization(@NonNull @NonNull String pspReference, @NonNull @NonNull Map<String,Object> bodyParams, @Nullable String currencyCode, @Nullable String transactionReferenceId, @Nullable String applicationId, @Nullable String tenantId)
      Description copied from interface: AdyenProvider
      Executes DefaultTransactionTypes.REVERSE_AUTH or DefaultTransactionTypes.REFUND transactions.
      Specified by:
      cancelAuthorization in interface AdyenProvider
      Parameters:
      pspReference - the Adyen payment reference
      bodyParams - the request body
      currencyCode - The currency code for this transaction
      transactionReferenceId - - transactionReferenceId that will be used ad idempotency key for the adyen request
      applicationId - the application id
      tenantId - the tenant id
      Returns:
      the response from Adyen API

    • capture

      public AdyenResponse capture(@NonNull @NonNull String pspReference, @NonNull @NonNull Map<String,Object> bodyParams, @Nullable String currencyCode, @Nullable String transactionReferenceId, @Nullable String applicationId, @Nullable String tenantId)
      Description copied from interface: AdyenProvider
      Executes the DefaultTransactionTypes.CAPTURE transactions.
      Specified by:
      capture in interface AdyenProvider
      Parameters:
      pspReference - the Adyen payment reference
      bodyParams - the request body
      currencyCode - The currency code for this transaction
      transactionReferenceId - - transactionReferenceId that will be used ad idempotency key for the adyen request
      applicationId - the application id
      tenantId - the tenant id
      Returns:
      the response from Adyen API

    • refund

      public AdyenResponse refund(@NonNull @NonNull String pspReference, @NonNull @NonNull Map<String,Object> bodyParams, @Nullable String currencyCode, @Nullable String transactionReferenceId, @Nullable String applicationId, @Nullable String tenantId)
      Description copied from interface: AdyenProvider
      Executes the DefaultTransactionTypes.REFUND transactions.
      Specified by:
      refund in interface AdyenProvider
      Parameters:
      pspReference - the Adyen payment reference
      bodyParams - the request body
      currencyCode - The currency code for this transaction
      transactionReferenceId - - transactionReferenceId that will be used ad idempotency key for the adyen request
      applicationId - the application id
      tenantId - the tenant id
      Returns:
      the response from Adyen API

    • updatePayPalOrder

      public UpdateExpressPayPalOrderResponse updatePayPalOrder(@NonNull @NonNull UpdateExpressPayPalOrderRequest request, @Nullable String applicationId, @Nullable String tenantId)
      Description copied from interface: AdyenProvider
      Updates the PayPal Order object to help advance the PayPal express checkout interaction.
      Specified by:
      updatePayPalOrder in interface AdyenProvider
      Parameters:
      request - Request object describing the data that is to be updated.
      applicationId - the current context's application id.
      tenantId - the current context's tenant id.
      Returns:
      The gateway's response to the update.

    • readStoredPaymentMethods

      public AdyenStoredPaymentMethodsResponse readStoredPaymentMethods(String customerReference, String merchantAccount, @Nullable String applicationId, @Nullable String tenantId)
      Description copied from interface: AdyenProvider
      Reads saved payment method from adyen for customer reference
      Specified by:
      readStoredPaymentMethods in interface AdyenProvider
      Parameters:
      customerReference - - a shopper reference that identifies customer and was used to store payment in adyen
      merchantAccount - - merchant account id/name in adyen associated with current site/shop
      applicationId - - the application id
      tenantId - - the tenant id
      Returns:
      the response from Adyen API

    • removeStoredPaymentMethod

      public void removeStoredPaymentMethod(String customerReference, String merchantAccount, String storedPaymentMethodId, @Nullable String applicationId, @Nullable String tenantId)
      Description copied from interface: AdyenProvider
      Deleates saved payment method from adyen for customer reference
      Specified by:
      removeStoredPaymentMethod in interface AdyenProvider
      Parameters:
      customerReference - - a shopper reference that identifies customer and was used to store payment in adyen
      merchantAccount - - merchant account id/name in adyen associated with current site/shop
      storedPaymentMethodId - - id of adyen stored payment method
      applicationId - - the application id
      tenantId - - the tenant id

    • getApiUrlBuilder

      protected org.springframework.web.util.UriComponentsBuilder getApiUrlBuilder()

    • getApiKey

      protected String getApiKey(@Nullable String applicationId, @Nullable String tenantId)

    • getProviderProperties

      protected ExternalAdyenProviderProperties getProviderProperties()

    • getConfigProperties

      protected AdyenConfigurationProperties getConfigProperties()

    • getTypeFactory

      protected com.broadleafcommerce.common.extension.TypeFactory getTypeFactory()