Package com.adyen.model.transfers

Class PlatformPayment

  • public class PlatformPayment
extends Object
    PlatformPayment

    • Constructor Detail

      • PlatformPayment

        public PlatformPayment()

    • Method Detail

      • modificationMerchantReference

        public PlatformPayment modificationMerchantReference​(String modificationMerchantReference)
        The capture's merchant reference included in the transfer.
        Parameters:
        modificationMerchantReference -
        Returns:
        the current PlatformPayment instance, allowing for method chaining

      • getModificationMerchantReference

        public String getModificationMerchantReference()
        The capture's merchant reference included in the transfer.
        Returns:
        modificationMerchantReference

      • setModificationMerchantReference

        public void setModificationMerchantReference​(String modificationMerchantReference)
        The capture's merchant reference included in the transfer.
        Parameters:
        modificationMerchantReference -

      • modificationPspReference

        public PlatformPayment modificationPspReference​(String modificationPspReference)
        The capture reference included in the transfer.
        Parameters:
        modificationPspReference -
        Returns:
        the current PlatformPayment instance, allowing for method chaining

      • getModificationPspReference

        public String getModificationPspReference()
        The capture reference included in the transfer.
        Returns:
        modificationPspReference

      • setModificationPspReference

        public void setModificationPspReference​(String modificationPspReference)
        The capture reference included in the transfer.
        Parameters:
        modificationPspReference -

      • paymentMerchantReference

        public PlatformPayment paymentMerchantReference​(String paymentMerchantReference)
        The payment's merchant reference included in the transfer.
        Parameters:
        paymentMerchantReference -
        Returns:
        the current PlatformPayment instance, allowing for method chaining

      • getPaymentMerchantReference

        public String getPaymentMerchantReference()
        The payment's merchant reference included in the transfer.
        Returns:
        paymentMerchantReference

      • setPaymentMerchantReference

        public void setPaymentMerchantReference​(String paymentMerchantReference)
        The payment's merchant reference included in the transfer.
        Parameters:
        paymentMerchantReference -

      • platformPaymentType

        public PlatformPayment platformPaymentType​(PlatformPayment.PlatformPaymentTypeEnum platformPaymentType)
        Specifies the nature of the transfer. This parameter helps categorize transfers so you can reconcile transactions at a later time, using the Balance Platform Accounting Report for [marketplaces](https://docs.adyen.com/marketplaces/reports-and-fees/balance-platform-accounting-report/) or [platforms](https://docs.adyen.com/platforms/reports-and-fees/balance-platform-accounting-report/). Possible values: * **AcquiringFees**: for the acquiring fee incurred on a transaction. * **AdyenCommission**: for 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). * **AdyenFees**: for all the transaction fees due to Adyen. This is the sum of Adyen's commission and Adyen's markup. * **AdyenMarkup**: for the transaction fee due to Adyen under [Interchange++ pricing](https://www.adyen.com/pricing). * **BalanceAccount**: or the sale amount of a transaction. * **Commission**: for your platform's commission on a transaction. * **Interchange**: for the interchange fee (fee paid to the issuer) incurred on a transaction. * **PaymentFee**: for all of the transaction fees. * **Remainder**: for the left over amount after currency conversion. * **SchemeFee**: for the scheme fee incurred on a transaction. This is the sum of the interchange fees and the acquiring fees. * **Surcharge**: for the surcharge paid by the customer on a transaction. * **Tip**: for the tip paid by the customer. * **TopUp**: for an incoming transfer to top up your user's balance account. * **VAT**: for the Value Added Tax.
        Parameters:
        platformPaymentType -
        Returns:
        the current PlatformPayment instance, allowing for method chaining

      • getPlatformPaymentType

        public PlatformPayment.PlatformPaymentTypeEnum getPlatformPaymentType()
        Specifies the nature of the transfer. This parameter helps categorize transfers so you can reconcile transactions at a later time, using the Balance Platform Accounting Report for [marketplaces](https://docs.adyen.com/marketplaces/reports-and-fees/balance-platform-accounting-report/) or [platforms](https://docs.adyen.com/platforms/reports-and-fees/balance-platform-accounting-report/). Possible values: * **AcquiringFees**: for the acquiring fee incurred on a transaction. * **AdyenCommission**: for 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). * **AdyenFees**: for all the transaction fees due to Adyen. This is the sum of Adyen's commission and Adyen's markup. * **AdyenMarkup**: for the transaction fee due to Adyen under [Interchange++ pricing](https://www.adyen.com/pricing). * **BalanceAccount**: or the sale amount of a transaction. * **Commission**: for your platform's commission on a transaction. * **Interchange**: for the interchange fee (fee paid to the issuer) incurred on a transaction. * **PaymentFee**: for all of the transaction fees. * **Remainder**: for the left over amount after currency conversion. * **SchemeFee**: for the scheme fee incurred on a transaction. This is the sum of the interchange fees and the acquiring fees. * **Surcharge**: for the surcharge paid by the customer on a transaction. * **Tip**: for the tip paid by the customer. * **TopUp**: for an incoming transfer to top up your user's balance account. * **VAT**: for the Value Added Tax.
        Returns:
        platformPaymentType

      • setPlatformPaymentType

        public void setPlatformPaymentType​(PlatformPayment.PlatformPaymentTypeEnum platformPaymentType)
        Specifies the nature of the transfer. This parameter helps categorize transfers so you can reconcile transactions at a later time, using the Balance Platform Accounting Report for [marketplaces](https://docs.adyen.com/marketplaces/reports-and-fees/balance-platform-accounting-report/) or [platforms](https://docs.adyen.com/platforms/reports-and-fees/balance-platform-accounting-report/). Possible values: * **AcquiringFees**: for the acquiring fee incurred on a transaction. * **AdyenCommission**: for 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). * **AdyenFees**: for all the transaction fees due to Adyen. This is the sum of Adyen's commission and Adyen's markup. * **AdyenMarkup**: for the transaction fee due to Adyen under [Interchange++ pricing](https://www.adyen.com/pricing). * **BalanceAccount**: or the sale amount of a transaction. * **Commission**: for your platform's commission on a transaction. * **Interchange**: for the interchange fee (fee paid to the issuer) incurred on a transaction. * **PaymentFee**: for all of the transaction fees. * **Remainder**: for the left over amount after currency conversion. * **SchemeFee**: for the scheme fee incurred on a transaction. This is the sum of the interchange fees and the acquiring fees. * **Surcharge**: for the surcharge paid by the customer on a transaction. * **Tip**: for the tip paid by the customer. * **TopUp**: for an incoming transfer to top up your user's balance account. * **VAT**: for the Value Added Tax.
        Parameters:
        platformPaymentType -

      • pspPaymentReference

        public PlatformPayment pspPaymentReference​(String pspPaymentReference)
        The payment reference included in the transfer.
        Parameters:
        pspPaymentReference -
        Returns:
        the current PlatformPayment instance, allowing for method chaining

      • getPspPaymentReference

        public String getPspPaymentReference()
        The payment reference included in the transfer.
        Returns:
        pspPaymentReference

      • setPspPaymentReference

        public void setPspPaymentReference​(String pspPaymentReference)
        The payment reference included in the transfer.
        Parameters:
        pspPaymentReference -

      • equals

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

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class Object

      • fromJson

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

      • toJson

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