Package com.adyen.model.transferwebhooks

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 - The capture's merchant reference included in the transfer.
        Returns:
        the current PlatformPayment instance, allowing for method chaining

      • getModificationMerchantReference

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

      • setModificationMerchantReference

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

      • modificationPspReference

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

      • getModificationPspReference

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

      • setModificationPspReference

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

      • paymentMerchantReference

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

      • getPaymentMerchantReference

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

      • setPaymentMerchantReference

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

      • 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**: The acquiring fee (the aggregated amount of interchange and scheme fee) incurred on a transaction. * **AdyenCommission**: 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**: All transaction fees due to Adyen. This is the aggregated amount of Adyen's commission and markup. * **AdyenMarkup**: The transaction fee due to Adyen under [Interchange++ pricing](https://www.adyen.com/pricing). * **BalanceAccount**: The amount booked to your user after the deduction of the relevant fees. * **Commission**: Your platform's or marketplace's commission on a transaction. * **DCCPlatformCommission**: The Dynamic Currency Conversion (DCC) fee on a transaction. * **Interchange**: The interchange fee (fee paid to the issuer) incurred on a transaction. * **PaymentFee**: The aggregated amount of all transaction fees. * **Remainder**: The leftover amount after currency conversion. * **SchemeFee**: The scheme fee incurred on a transaction. * **Surcharge**: The surcharge paid by the customer on a transaction. * **Tip**: The tip paid by the customer. * **TopUp**: An incoming transfer to top up your user's balance account. * **VAT**: The value-added tax charged on the payment.
        Parameters:
        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**: The acquiring fee (the aggregated amount of interchange and scheme fee) incurred on a transaction. * **AdyenCommission**: 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**: All transaction fees due to Adyen. This is the aggregated amount of Adyen's commission and markup. * **AdyenMarkup**: The transaction fee due to Adyen under [Interchange++ pricing](https://www.adyen.com/pricing). * **BalanceAccount**: The amount booked to your user after the deduction of the relevant fees. * **Commission**: Your platform's or marketplace's commission on a transaction. * **DCCPlatformCommission**: The Dynamic Currency Conversion (DCC) fee on a transaction. * **Interchange**: The interchange fee (fee paid to the issuer) incurred on a transaction. * **PaymentFee**: The aggregated amount of all transaction fees. * **Remainder**: The leftover amount after currency conversion. * **SchemeFee**: The scheme fee incurred on a transaction. * **Surcharge**: The surcharge paid by the customer on a transaction. * **Tip**: The tip paid by the customer. * **TopUp**: An incoming transfer to top up your user's balance account. * **VAT**: The value-added tax charged on the payment.
        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**: The acquiring fee (the aggregated amount of interchange and scheme fee) incurred on a transaction. * **AdyenCommission**: 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**: All transaction fees due to Adyen. This is the aggregated amount of Adyen's commission and markup. * **AdyenMarkup**: The transaction fee due to Adyen under [Interchange++ pricing](https://www.adyen.com/pricing). * **BalanceAccount**: The amount booked to your user after the deduction of the relevant fees. * **Commission**: Your platform's or marketplace's commission on a transaction. * **DCCPlatformCommission**: The Dynamic Currency Conversion (DCC) fee on a transaction. * **Interchange**: The interchange fee (fee paid to the issuer) incurred on a transaction. * **PaymentFee**: The aggregated amount of all transaction fees. * **Remainder**: The leftover amount after currency conversion. * **SchemeFee**: The scheme fee incurred on a transaction. * **Surcharge**: The surcharge paid by the customer on a transaction. * **Tip**: The tip paid by the customer. * **TopUp**: An incoming transfer to top up your user's balance account. * **VAT**: The value-added tax charged on the payment.
        Returns:
        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**: The acquiring fee (the aggregated amount of interchange and scheme fee) incurred on a transaction. * **AdyenCommission**: 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**: All transaction fees due to Adyen. This is the aggregated amount of Adyen's commission and markup. * **AdyenMarkup**: The transaction fee due to Adyen under [Interchange++ pricing](https://www.adyen.com/pricing). * **BalanceAccount**: The amount booked to your user after the deduction of the relevant fees. * **Commission**: Your platform's or marketplace's commission on a transaction. * **DCCPlatformCommission**: The Dynamic Currency Conversion (DCC) fee on a transaction. * **Interchange**: The interchange fee (fee paid to the issuer) incurred on a transaction. * **PaymentFee**: The aggregated amount of all transaction fees. * **Remainder**: The leftover amount after currency conversion. * **SchemeFee**: The scheme fee incurred on a transaction. * **Surcharge**: The surcharge paid by the customer on a transaction. * **Tip**: The tip paid by the customer. * **TopUp**: An incoming transfer to top up your user's balance account. * **VAT**: The value-added tax charged on the payment.

      • 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**: The acquiring fee (the aggregated amount of interchange and scheme fee) incurred on a transaction. * **AdyenCommission**: 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**: All transaction fees due to Adyen. This is the aggregated amount of Adyen's commission and markup. * **AdyenMarkup**: The transaction fee due to Adyen under [Interchange++ pricing](https://www.adyen.com/pricing). * **BalanceAccount**: The amount booked to your user after the deduction of the relevant fees. * **Commission**: Your platform's or marketplace's commission on a transaction. * **DCCPlatformCommission**: The Dynamic Currency Conversion (DCC) fee on a transaction. * **Interchange**: The interchange fee (fee paid to the issuer) incurred on a transaction. * **PaymentFee**: The aggregated amount of all transaction fees. * **Remainder**: The leftover amount after currency conversion. * **SchemeFee**: The scheme fee incurred on a transaction. * **Surcharge**: The surcharge paid by the customer on a transaction. * **Tip**: The tip paid by the customer. * **TopUp**: An incoming transfer to top up your user's balance account. * **VAT**: The value-added tax charged on the payment.
        Parameters:
        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**: The acquiring fee (the aggregated amount of interchange and scheme fee) incurred on a transaction. * **AdyenCommission**: 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**: All transaction fees due to Adyen. This is the aggregated amount of Adyen's commission and markup. * **AdyenMarkup**: The transaction fee due to Adyen under [Interchange++ pricing](https://www.adyen.com/pricing). * **BalanceAccount**: The amount booked to your user after the deduction of the relevant fees. * **Commission**: Your platform's or marketplace's commission on a transaction. * **DCCPlatformCommission**: The Dynamic Currency Conversion (DCC) fee on a transaction. * **Interchange**: The interchange fee (fee paid to the issuer) incurred on a transaction. * **PaymentFee**: The aggregated amount of all transaction fees. * **Remainder**: The leftover amount after currency conversion. * **SchemeFee**: The scheme fee incurred on a transaction. * **Surcharge**: The surcharge paid by the customer on a transaction. * **Tip**: The tip paid by the customer. * **TopUp**: An incoming transfer to top up your user's balance account. * **VAT**: The value-added tax charged on the payment.

      • pspPaymentReference

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

      • getPspPaymentReference

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

      • setPspPaymentReference

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

      • type

        public PlatformPayment type​(PlatformPayment.TypeEnum type)
        **platformPayment**
        Parameters:
        type - **platformPayment**
        Returns:
        the current PlatformPayment instance, allowing for method chaining

      • setType

        public void setType​(PlatformPayment.TypeEnum type)
        **platformPayment**
        Parameters:
        type - **platformPayment**

      • 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