Serialized Form

  • Package com.broadleafcommerce.payment.service.gateway

  • Package com.broadleafcommerce.payment.service.gateway.domain

    • Class com.broadleafcommerce.payment.service.gateway.domain.CreditAccount

      class CreditAccount extends Object implements Serializable

      • Serialized Fields

        • accountNumber
          String accountNumber
          Generated code that can be used to reference the credit account.
        • alternativeOwningUserRef
          String alternativeOwningUserRef
          Describes an alternative owning user reference for the credit account, that can be used instead of the CreditAccount.owningUserRef.
        • alternativeOwningUserType
          String alternativeOwningUserType
          Describes an alternative owning user type of the credit account, that can be used instead of the CreditAccount.owningUserType.
        • attributes
          Map<String,Object> attributes
          Additional attributes associated with this credit account.
        • balance
          javax.money.MonetaryAmount balance
          The current balance for this credit account.
        • contextState
          com.broadleafcommerce.data.tracking.core.filtering.business.domain.ContextState contextState
          A subset of Tracking information to expose the context state for this object.
        • id
          String id
          The id of this credit account.
        • owningUserRef
          String owningUserRef
          The reference to the user that owns this credit account. For example, this may be a customer id, an account id, or the anonymous user's email address.
        • owningUserType
          String owningUserType
          Describes the owning user type of the credit account. For example, the credit account could belong to a customer, anonymous user or an account, therefore this value might be BLC_CUSTOMER, ANONYMOUS_USER_EMAIL, ANONYMOUS_USER_PHONE, or BLC_ACCOUNT.
        • type
          String type
          The type of this credit account. By default, it can be "STORE_CREDIT", "ACCOUNT_CREDIT" or "GIFT_CARD".
        • version
          Integer version
          The version of this credit account. Used for checking that the requested version of the credit account is up-to-date before saving changes. Required for any request which results in an update being made to the credit account. This should never be manually incremented/decremented.

    • Class com.broadleafcommerce.payment.service.gateway.domain.CreditAccountRef

      class CreditAccountRef extends Object implements Serializable
      serialVersionUID:
      1L

      • Serialized Fields

        • accountNumber
          String accountNumber
          Generated code that can be used to reference the credit account.
        • id
          String id
          The credit account's id.
        • owningUserRef
          String owningUserRef
          The reference to the user that owns this credit account. For example, this may be a customer id, an account id, or the anonymous user's email address.
        • owningUserType
          String owningUserType
          Describes the owning user type of the credit account. For example, the credit account could belong to a customer, anonymous user or an account, therefore this value might be BLC_CUSTOMER, ANONYMOUS_USER_EMAIL, ANONYMOUS_USER_PHONE, or BLC_ACCOUNT.
        • type
          String type
          The type of this credit account. By default, it can be "STORE_CREDIT", "ACCOUNT_CREDIT" or "GIFT_CARD".

    • Class com.broadleafcommerce.payment.service.gateway.domain.CreditAccountTransaction

      class CreditAccountTransaction extends Object implements Serializable

      • Serialized Fields

        • amount
          javax.money.MonetaryAmount amount
          The amount of this transaction.
        • contextState
          com.broadleafcommerce.data.tracking.core.filtering.business.domain.ContextState contextState
          A subset of Tracking information to expose the context state for this object.
        • creditAccountRef
          CreditAccountRef creditAccountRef
          The credit account reference to the credit account.
        • dateRecorded
          Instant dateRecorded
          The timestamp when this transaction response was recorded.
        • id
          String id
          The id of this transaction.
        • reason
          String reason
          The reason for this transaction. This can be a code or name.
        • reasonDescription
          String reasonDescription
          Description for the reason for this transaction.
        • requestId
          String requestId
          The id used to represent the request that produced this transaction.
        • source
          String source
          The name of the system that initiated the transaction - e.g. CART_OPERATION_SERVICES vs ORDER_OPERATION_SERVICES.
        • sourceEntityId
          String sourceEntityId
          The ID of the source entity associated with the transaction.

          For example, if CreditAccountTransaction.getSourceEntityType() is ORDER_FULFILLMENT, this would be the ID of the OrderFulfillment.

          See Also:
        • sourceEntityType
          String sourceEntityType
          The type of the source entity associated with the transaction. For example, "CHECKOUT_REQUEST" or "ORDER_FULFILLMENT".
        • sourceUserId
          String sourceUserId
          The id of user who initiated the transaction.
        • sourceUserType
          String sourceUserType
          The type of user who initiated the transaction. By default, it can be "BLC_CUSTOMER", "BLC_ACCOUNT" or "BLC_CSR".
        • transactionReferenceId
          String transactionReferenceId
          The transaction id known by the payment gateway. This reference can be used to link the request to the gateway's record of the transaction in the case that the calling application does not receive a response from the gateway.
        • type
          String type
          The type of this transaction. By default, it can be "CREDIT" or "DEBIT"

  • Package com.broadleafcommerce.payment.service.gateway.provider.exception