Package com.broadleafcommerce.paymenttransaction.service.provider

Interface CustomerPaymentAccountProvider<P extends PaymentAccount>

All Known Implementing Classes:
ExternalCustomerPaymentAccountProvider
@Deprecated(since="1.0.2", forRemoval=true) public interface CustomerPaymentAccountProvider<P extends PaymentAccount>
Deprecated, for removal: This API element is subject to removal in a future version.
since 1.0.2, in favor of using PaymentTransactionServices to manage saved payment methods.
Provider to gather PaymentAccounts.

This provider is only registered if DefaultSavedPaymentMethodStorageLocations.BLC_CUSTOMER_SERVICES is configured to be SavedPaymentMethodConfigurationProperties.getStorageLocation().

Author:
Chris Kittrell (ckittrell)

  • Method Summary

    Modifier and Type
    Method
    Description
    PaymentAccountSummary
    createPaymentAccount(P paymentAccount, @NonNull String customerId, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Creates a PaymentAccount for a customer.
    Optional<P>
    readById(@NonNull String paymentAccountId, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Read a PaymentAccount by id.
    PaymentAccountSummary
    updatePaymentAccountLastTransactionData(@NonNull String paymentAccountId, @NonNull Instant lastTransactionDateTime, String lastTransactionResultCode, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Updates the last transaction data for a PaymentAccount.

  • Method Details

    • readById

      Optional<P> readById(@NonNull @NonNull String paymentAccountId, @Nullable com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Read a PaymentAccount by id.
      Parameters:
      paymentAccountId - the ID of paymentAccount to be gathered
      contextInfo - Context information around the multitenant state
      Returns:
      An Optional including a PaymentAccount if one could be found

    • createPaymentAccount

      PaymentAccountSummary createPaymentAccount(@NonNull P paymentAccount, @NonNull @NonNull String customerId, @Nullable com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Creates a PaymentAccount for a customer.
      Parameters:
      paymentAccount - the PaymentAccount to create
      customerId - the id of the customer that this PaymentAccount is for
      contextInfo - Context information around the multitenant state
      Returns:
      A PaymentAccountSummary containing a summary of the created PaymentAccount

    • updatePaymentAccountLastTransactionData

      PaymentAccountSummary updatePaymentAccountLastTransactionData(@NonNull @NonNull String paymentAccountId, @NonNull @NonNull Instant lastTransactionDateTime, @Nullable String lastTransactionResultCode, @Nullable com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Updates the last transaction data for a PaymentAccount.
      Parameters:
      paymentAccountId - the PaymentAccount.getId() to update the transaction data for
      lastTransactionDateTime - the PaymentAccount.getLastTransactionDateTime() to update
      lastTransactionResultCode - the PaymentAccount.getLastTransactionResultCode() to update
      contextInfo - Context information around the multitenant state
      Returns:
      A PaymentAccountSummary containing a summary of the updated PaymentAccount