Package com.adyen.model.management

Class SplitConfigurationLogic

  • public class SplitConfigurationLogic
extends Object
    SplitConfigurationLogic

    • Constructor Detail

      • SplitConfigurationLogic

        public SplitConfigurationLogic()

    • Method Detail

      • acquiringFees

        public SplitConfigurationLogic acquiringFees​(SplitConfigurationLogic.AcquiringFeesEnum acquiringFees)
        Deducts the acquiring fees (the aggregated amount of interchange and scheme fee) from the specified balance account. Possible values: **deductFromLiableAccount**, **deductFromOneBalanceAccount**.
        Parameters:
        acquiringFees -
        Returns:
        the current SplitConfigurationLogic instance, allowing for method chaining

      • getAcquiringFees

        public SplitConfigurationLogic.AcquiringFeesEnum getAcquiringFees()
        Deducts the acquiring fees (the aggregated amount of interchange and scheme fee) from the specified balance account. Possible values: **deductFromLiableAccount**, **deductFromOneBalanceAccount**.
        Returns:
        acquiringFees

      • setAcquiringFees

        public void setAcquiringFees​(SplitConfigurationLogic.AcquiringFeesEnum acquiringFees)
        Deducts the acquiring fees (the aggregated amount of interchange and scheme fee) from the specified balance account. Possible values: **deductFromLiableAccount**, **deductFromOneBalanceAccount**.
        Parameters:
        acquiringFees -

      • additionalCommission

        public SplitConfigurationLogic additionalCommission​(AdditionalCommission additionalCommission)
        additionalCommission
        Parameters:
        additionalCommission -
        Returns:
        the current SplitConfigurationLogic instance, allowing for method chaining

      • getAdditionalCommission

        public AdditionalCommission getAdditionalCommission()
        additionalCommission
        Returns:
        additionalCommission

      • setAdditionalCommission

        public void setAdditionalCommission​(AdditionalCommission additionalCommission)
        additionalCommission
        Parameters:
        additionalCommission -

      • adyenCommission

        public SplitConfigurationLogic adyenCommission​(SplitConfigurationLogic.AdyenCommissionEnum adyenCommission)
        Deducts the transaction fee due to Adyen under [blended rates](https://www.adyen.com/knowledge-hub/guides/payments-training-guide/get-the-best-from-your-card-processing) from the specified balance account. Possible values: **deductFromLiableAccount**, **deductFromOneBalanceAccount**.
        Parameters:
        adyenCommission -
        Returns:
        the current SplitConfigurationLogic instance, allowing for method chaining

      • getAdyenCommission

        public SplitConfigurationLogic.AdyenCommissionEnum getAdyenCommission()
        Deducts the transaction fee due to Adyen under [blended rates](https://www.adyen.com/knowledge-hub/guides/payments-training-guide/get-the-best-from-your-card-processing) from the specified balance account. Possible values: **deductFromLiableAccount**, **deductFromOneBalanceAccount**.
        Returns:
        adyenCommission

      • setAdyenCommission

        public void setAdyenCommission​(SplitConfigurationLogic.AdyenCommissionEnum adyenCommission)
        Deducts the transaction fee due to Adyen under [blended rates](https://www.adyen.com/knowledge-hub/guides/payments-training-guide/get-the-best-from-your-card-processing) from the specified balance account. Possible values: **deductFromLiableAccount**, **deductFromOneBalanceAccount**.
        Parameters:
        adyenCommission -

      • adyenFees

        public SplitConfigurationLogic adyenFees​(SplitConfigurationLogic.AdyenFeesEnum adyenFees)
        Deducts the fees due to Adyen (markup or commission) from the specified balance account. Possible values: **deductFromLiableAccount**, **deductFromOneBalanceAccount**.
        Parameters:
        adyenFees -
        Returns:
        the current SplitConfigurationLogic instance, allowing for method chaining

      • getAdyenFees

        public SplitConfigurationLogic.AdyenFeesEnum getAdyenFees()
        Deducts the fees due to Adyen (markup or commission) from the specified balance account. Possible values: **deductFromLiableAccount**, **deductFromOneBalanceAccount**.
        Returns:
        adyenFees

      • setAdyenFees

        public void setAdyenFees​(SplitConfigurationLogic.AdyenFeesEnum adyenFees)
        Deducts the fees due to Adyen (markup or commission) from the specified balance account. Possible values: **deductFromLiableAccount**, **deductFromOneBalanceAccount**.
        Parameters:
        adyenFees -

      • adyenMarkup

        public SplitConfigurationLogic adyenMarkup​(SplitConfigurationLogic.AdyenMarkupEnum adyenMarkup)
        Deducts the transaction fee due to Adyen under [Interchange ++ pricing](https://www.adyen.com/what-is-interchange) from the specified balance account. Possible values: **deductFromLiableAccount**, **deductFromOneBalanceAccount**.
        Parameters:
        adyenMarkup -
        Returns:
        the current SplitConfigurationLogic instance, allowing for method chaining

      • getAdyenMarkup

        public SplitConfigurationLogic.AdyenMarkupEnum getAdyenMarkup()
        Deducts the transaction fee due to Adyen under [Interchange ++ pricing](https://www.adyen.com/what-is-interchange) from the specified balance account. Possible values: **deductFromLiableAccount**, **deductFromOneBalanceAccount**.
        Returns:
        adyenMarkup

      • setAdyenMarkup

        public void setAdyenMarkup​(SplitConfigurationLogic.AdyenMarkupEnum adyenMarkup)
        Deducts the transaction fee due to Adyen under [Interchange ++ pricing](https://www.adyen.com/what-is-interchange) from the specified balance account. Possible values: **deductFromLiableAccount**, **deductFromOneBalanceAccount**.
        Parameters:
        adyenMarkup -

      • chargeback

        public SplitConfigurationLogic chargeback​(SplitConfigurationLogic.ChargebackEnum chargeback)
        Specifies how and from which balance account(s) to deduct the chargeback amount. Possible values: **deductFromLiableAccount**, **deductFromOneBalanceAccount**, **deductAccordingToSplitRatio**.
        Parameters:
        chargeback -
        Returns:
        the current SplitConfigurationLogic instance, allowing for method chaining

      • getChargeback

        public SplitConfigurationLogic.ChargebackEnum getChargeback()
        Specifies how and from which balance account(s) to deduct the chargeback amount. Possible values: **deductFromLiableAccount**, **deductFromOneBalanceAccount**, **deductAccordingToSplitRatio**.
        Returns:
        chargeback

      • setChargeback

        public void setChargeback​(SplitConfigurationLogic.ChargebackEnum chargeback)
        Specifies how and from which balance account(s) to deduct the chargeback amount. Possible values: **deductFromLiableAccount**, **deductFromOneBalanceAccount**, **deductAccordingToSplitRatio**.
        Parameters:
        chargeback -

      • chargebackCostAllocation

        public SplitConfigurationLogic chargebackCostAllocation​(SplitConfigurationLogic.ChargebackCostAllocationEnum chargebackCostAllocation)
        Deducts the chargeback costs from the specified balance account. Possible values: **deductFromLiableAccount**, **deductFromOneBalanceAccount**
        Parameters:
        chargebackCostAllocation -
        Returns:
        the current SplitConfigurationLogic instance, allowing for method chaining

      • getChargebackCostAllocation

        public SplitConfigurationLogic.ChargebackCostAllocationEnum getChargebackCostAllocation()
        Deducts the chargeback costs from the specified balance account. Possible values: **deductFromLiableAccount**, **deductFromOneBalanceAccount**
        Returns:
        chargebackCostAllocation

      • setChargebackCostAllocation

        public void setChargebackCostAllocation​(SplitConfigurationLogic.ChargebackCostAllocationEnum chargebackCostAllocation)
        Deducts the chargeback costs from the specified balance account. Possible values: **deductFromLiableAccount**, **deductFromOneBalanceAccount**
        Parameters:
        chargebackCostAllocation -

      • commission

        public SplitConfigurationLogic commission​(Commission commission)
        commission
        Parameters:
        commission -
        Returns:
        the current SplitConfigurationLogic instance, allowing for method chaining

      • getCommission

        public Commission getCommission()
        commission
        Returns:
        commission

      • setCommission

        public void setCommission​(Commission commission)
        commission
        Parameters:
        commission -

      • interchange

        public SplitConfigurationLogic interchange​(SplitConfigurationLogic.InterchangeEnum interchange)
        Deducts the interchange fee from specified balance account. Possible values: **deductFromLiableAccount**, **deductFromOneBalanceAccount**.
        Parameters:
        interchange -
        Returns:
        the current SplitConfigurationLogic instance, allowing for method chaining

      • getInterchange

        public SplitConfigurationLogic.InterchangeEnum getInterchange()
        Deducts the interchange fee from specified balance account. Possible values: **deductFromLiableAccount**, **deductFromOneBalanceAccount**.
        Returns:
        interchange

      • setInterchange

        public void setInterchange​(SplitConfigurationLogic.InterchangeEnum interchange)
        Deducts the interchange fee from specified balance account. Possible values: **deductFromLiableAccount**, **deductFromOneBalanceAccount**.
        Parameters:
        interchange -

      • paymentFee

        public SplitConfigurationLogic paymentFee​(SplitConfigurationLogic.PaymentFeeEnum paymentFee)
        Deducts all transaction fees incurred by the payment from the specified balance account. The transaction fees include the acquiring fees (interchange and scheme fee), and the fees due to Adyen (markup or commission). You can book any and all these fees to different balance account by specifying other transaction fee parameters in your split configuration profile: - [`adyenCommission`](https://docs.adyen.com/api-explorer/Management/latest/post/merchants/(merchantId)/splitConfigurations#request-rules-splitLogic-adyenCommission): The transaction fee due to Adyen under [blended rates](https://www.adyen.com/knowledge-hub/interchange-fees-explained#interchange-vs-blended). - [`adyenMarkup`](https://docs.adyen.com/api-explorer/Management/latest/post/merchants/(merchantId)/splitConfigurations#request-rules-splitLogic-adyenMarkup): The transaction fee due to Adyen under [Interchange ++ pricing](https://www.adyen.com/knowledge-hub/interchange-fees-explained#interchange-vs-blended). - [`schemeFee`](https://docs.adyen.com/api-explorer/Management/latest/post/merchants/(merchantId)/splitConfigurations#request-rules-splitLogic-schemeFee): The fee paid to the card scheme for using their network. - [`interchange`](https://docs.adyen.com/api-explorer/Management/latest/post/merchants/(merchantId)/splitConfigurations#request-rules-splitLogic-interchange): The fee paid to the issuer for each payment transaction made with the card network. - [`adyenFees`](https://docs.adyen.com/api-explorer/Management/latest/post/merchants/(merchantId)/splitConfigurations#request-rules-splitLogic-adyenFees): The aggregated amount of Adyen's commission and markup. - [`acquiringFees`](https://docs.adyen.com/api-explorer/Management/latest/post/merchants/(merchantId)/splitConfigurations#request-rules-splitLogic-acquiringFees): The aggregated amount of the interchange and scheme fees. If you don't include at least one transaction fee type in the `splitLogic` object, Adyen updates the payment request with the `paymentFee` parameter, booking all transaction fees to your platform's liable balance account. Possible values: **deductFromLiableAccount**, **deductFromOneBalanceAccount**.
        Parameters:
        paymentFee -
        Returns:
        the current SplitConfigurationLogic instance, allowing for method chaining

      • getPaymentFee

        public SplitConfigurationLogic.PaymentFeeEnum getPaymentFee()
        Deducts all transaction fees incurred by the payment from the specified balance account. The transaction fees include the acquiring fees (interchange and scheme fee), and the fees due to Adyen (markup or commission). You can book any and all these fees to different balance account by specifying other transaction fee parameters in your split configuration profile: - [`adyenCommission`](https://docs.adyen.com/api-explorer/Management/latest/post/merchants/(merchantId)/splitConfigurations#request-rules-splitLogic-adyenCommission): The transaction fee due to Adyen under [blended rates](https://www.adyen.com/knowledge-hub/interchange-fees-explained#interchange-vs-blended). - [`adyenMarkup`](https://docs.adyen.com/api-explorer/Management/latest/post/merchants/(merchantId)/splitConfigurations#request-rules-splitLogic-adyenMarkup): The transaction fee due to Adyen under [Interchange ++ pricing](https://www.adyen.com/knowledge-hub/interchange-fees-explained#interchange-vs-blended). - [`schemeFee`](https://docs.adyen.com/api-explorer/Management/latest/post/merchants/(merchantId)/splitConfigurations#request-rules-splitLogic-schemeFee): The fee paid to the card scheme for using their network. - [`interchange`](https://docs.adyen.com/api-explorer/Management/latest/post/merchants/(merchantId)/splitConfigurations#request-rules-splitLogic-interchange): The fee paid to the issuer for each payment transaction made with the card network. - [`adyenFees`](https://docs.adyen.com/api-explorer/Management/latest/post/merchants/(merchantId)/splitConfigurations#request-rules-splitLogic-adyenFees): The aggregated amount of Adyen's commission and markup. - [`acquiringFees`](https://docs.adyen.com/api-explorer/Management/latest/post/merchants/(merchantId)/splitConfigurations#request-rules-splitLogic-acquiringFees): The aggregated amount of the interchange and scheme fees. If you don't include at least one transaction fee type in the `splitLogic` object, Adyen updates the payment request with the `paymentFee` parameter, booking all transaction fees to your platform's liable balance account. Possible values: **deductFromLiableAccount**, **deductFromOneBalanceAccount**.
        Returns:
        paymentFee

      • setPaymentFee

        public void setPaymentFee​(SplitConfigurationLogic.PaymentFeeEnum paymentFee)
        Deducts all transaction fees incurred by the payment from the specified balance account. The transaction fees include the acquiring fees (interchange and scheme fee), and the fees due to Adyen (markup or commission). You can book any and all these fees to different balance account by specifying other transaction fee parameters in your split configuration profile: - [`adyenCommission`](https://docs.adyen.com/api-explorer/Management/latest/post/merchants/(merchantId)/splitConfigurations#request-rules-splitLogic-adyenCommission): The transaction fee due to Adyen under [blended rates](https://www.adyen.com/knowledge-hub/interchange-fees-explained#interchange-vs-blended). - [`adyenMarkup`](https://docs.adyen.com/api-explorer/Management/latest/post/merchants/(merchantId)/splitConfigurations#request-rules-splitLogic-adyenMarkup): The transaction fee due to Adyen under [Interchange ++ pricing](https://www.adyen.com/knowledge-hub/interchange-fees-explained#interchange-vs-blended). - [`schemeFee`](https://docs.adyen.com/api-explorer/Management/latest/post/merchants/(merchantId)/splitConfigurations#request-rules-splitLogic-schemeFee): The fee paid to the card scheme for using their network. - [`interchange`](https://docs.adyen.com/api-explorer/Management/latest/post/merchants/(merchantId)/splitConfigurations#request-rules-splitLogic-interchange): The fee paid to the issuer for each payment transaction made with the card network. - [`adyenFees`](https://docs.adyen.com/api-explorer/Management/latest/post/merchants/(merchantId)/splitConfigurations#request-rules-splitLogic-adyenFees): The aggregated amount of Adyen's commission and markup. - [`acquiringFees`](https://docs.adyen.com/api-explorer/Management/latest/post/merchants/(merchantId)/splitConfigurations#request-rules-splitLogic-acquiringFees): The aggregated amount of the interchange and scheme fees. If you don't include at least one transaction fee type in the `splitLogic` object, Adyen updates the payment request with the `paymentFee` parameter, booking all transaction fees to your platform's liable balance account. Possible values: **deductFromLiableAccount**, **deductFromOneBalanceAccount**.
        Parameters:
        paymentFee -

      • refund

        public SplitConfigurationLogic refund​(SplitConfigurationLogic.RefundEnum refund)
        Specifies how and from which balance account(s) to deduct the refund amount. Possible values: **deductFromLiableAccount**, **deductFromOneBalanceAccount**, **deductAccordingToSplitRatio**
        Parameters:
        refund -
        Returns:
        the current SplitConfigurationLogic instance, allowing for method chaining

      • getRefund

        public SplitConfigurationLogic.RefundEnum getRefund()
        Specifies how and from which balance account(s) to deduct the refund amount. Possible values: **deductFromLiableAccount**, **deductFromOneBalanceAccount**, **deductAccordingToSplitRatio**
        Returns:
        refund

      • setRefund

        public void setRefund​(SplitConfigurationLogic.RefundEnum refund)
        Specifies how and from which balance account(s) to deduct the refund amount. Possible values: **deductFromLiableAccount**, **deductFromOneBalanceAccount**, **deductAccordingToSplitRatio**
        Parameters:
        refund -

      • refundCostAllocation

        public SplitConfigurationLogic refundCostAllocation​(SplitConfigurationLogic.RefundCostAllocationEnum refundCostAllocation)
        Deducts the refund costs from the specified balance account. Possible values: **deductFromLiableAccount**, **deductFromOneBalanceAccount**
        Parameters:
        refundCostAllocation -
        Returns:
        the current SplitConfigurationLogic instance, allowing for method chaining

      • getRefundCostAllocation

        public SplitConfigurationLogic.RefundCostAllocationEnum getRefundCostAllocation()
        Deducts the refund costs from the specified balance account. Possible values: **deductFromLiableAccount**, **deductFromOneBalanceAccount**
        Returns:
        refundCostAllocation

      • setRefundCostAllocation

        public void setRefundCostAllocation​(SplitConfigurationLogic.RefundCostAllocationEnum refundCostAllocation)
        Deducts the refund costs from the specified balance account. Possible values: **deductFromLiableAccount**, **deductFromOneBalanceAccount**
        Parameters:
        refundCostAllocation -

      • remainder

        public SplitConfigurationLogic remainder​(SplitConfigurationLogic.RemainderEnum remainder)
        Books the amount left over after currency conversion to the specified balance account. Possible values: **addToLiableAccount**, **addToOneBalanceAccount**.
        Parameters:
        remainder -
        Returns:
        the current SplitConfigurationLogic instance, allowing for method chaining

      • getRemainder

        public SplitConfigurationLogic.RemainderEnum getRemainder()
        Books the amount left over after currency conversion to the specified balance account. Possible values: **addToLiableAccount**, **addToOneBalanceAccount**.
        Returns:
        remainder

      • setRemainder

        public void setRemainder​(SplitConfigurationLogic.RemainderEnum remainder)
        Books the amount left over after currency conversion to the specified balance account. Possible values: **addToLiableAccount**, **addToOneBalanceAccount**.
        Parameters:
        remainder -

      • schemeFee

        public SplitConfigurationLogic schemeFee​(SplitConfigurationLogic.SchemeFeeEnum schemeFee)
        Deducts the scheme fee from the specified balance account. Possible values: **deductFromLiableAccount**, **deductFromOneBalanceAccount**.
        Parameters:
        schemeFee -
        Returns:
        the current SplitConfigurationLogic instance, allowing for method chaining

      • getSchemeFee

        public SplitConfigurationLogic.SchemeFeeEnum getSchemeFee()
        Deducts the scheme fee from the specified balance account. Possible values: **deductFromLiableAccount**, **deductFromOneBalanceAccount**.
        Returns:
        schemeFee

      • setSchemeFee

        public void setSchemeFee​(SplitConfigurationLogic.SchemeFeeEnum schemeFee)
        Deducts the scheme fee from the specified balance account. Possible values: **deductFromLiableAccount**, **deductFromOneBalanceAccount**.
        Parameters:
        schemeFee -

      • splitLogicId

        public SplitConfigurationLogic splitLogicId​(String splitLogicId)
        Unique identifier of the collection of split instructions that are applied when the rule conditions are met.
        Parameters:
        splitLogicId -
        Returns:
        the current SplitConfigurationLogic instance, allowing for method chaining

      • getSplitLogicId

        public String getSplitLogicId()
        Unique identifier of the collection of split instructions that are applied when the rule conditions are met.
        Returns:
        splitLogicId

      • setSplitLogicId

        public void setSplitLogicId​(String splitLogicId)
        Unique identifier of the collection of split instructions that are applied when the rule conditions are met.
        Parameters:
        splitLogicId -

      • surcharge

        public SplitConfigurationLogic surcharge​(SplitConfigurationLogic.SurchargeEnum surcharge)
        Books the surcharge amount to the specified balance account. Possible values: **addToLiableAccount**, **addToOneBalanceAccount**
        Parameters:
        surcharge -
        Returns:
        the current SplitConfigurationLogic instance, allowing for method chaining

      • getSurcharge

        public SplitConfigurationLogic.SurchargeEnum getSurcharge()
        Books the surcharge amount to the specified balance account. Possible values: **addToLiableAccount**, **addToOneBalanceAccount**
        Returns:
        surcharge

      • setSurcharge

        public void setSurcharge​(SplitConfigurationLogic.SurchargeEnum surcharge)
        Books the surcharge amount to the specified balance account. Possible values: **addToLiableAccount**, **addToOneBalanceAccount**
        Parameters:
        surcharge -

      • tip

        public SplitConfigurationLogic tip​(SplitConfigurationLogic.TipEnum tip)
        Books the tips (gratuity) to the specified balance account. Possible values: **addToLiableAccount**, **addToOneBalanceAccount**.
        Parameters:
        tip -
        Returns:
        the current SplitConfigurationLogic instance, allowing for method chaining

      • getTip

        public SplitConfigurationLogic.TipEnum getTip()
        Books the tips (gratuity) to the specified balance account. Possible values: **addToLiableAccount**, **addToOneBalanceAccount**.
        Returns:
        tip

      • setTip

        public void setTip​(SplitConfigurationLogic.TipEnum tip)
        Books the tips (gratuity) to the specified balance account. Possible values: **addToLiableAccount**, **addToOneBalanceAccount**.
        Parameters:
        tip -

      • equals

        public boolean equals​(Object o)
        Return true if this SplitConfigurationLogic object is equal to o.
        Overrides:
        equals in class Object

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class Object

      • fromJson

        public static SplitConfigurationLogic fromJson​(String jsonString)
                                        throws com.fasterxml.jackson.core.JsonProcessingException
        Create an instance of SplitConfigurationLogic given an JSON string
        Parameters:
        jsonString - JSON string
        Returns:
        An instance of SplitConfigurationLogic
        Throws:
        com.fasterxml.jackson.core.JsonProcessingException - if the JSON string is invalid with respect to SplitConfigurationLogic

      • toJson

        public String toJson()
              throws com.fasterxml.jackson.core.JsonProcessingException
        Convert an instance of SplitConfigurationLogic to an JSON string
        Returns:
        JSON string
        Throws:
        com.fasterxml.jackson.core.JsonProcessingException