java.lang.Object
- com.adyen.model.transfers.PlatformPayment

public class PlatformPayment
extends Object

PlatformPayment

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`static class`	`PlatformPayment.PlatformPaymentTypeEnum`	Specifies the nature of the transfer.
`static class`	`PlatformPayment.TypeEnum`	platformPayment**

Field Summary

Fields
Modifier and Type	Field	Description
`static String`	`JSON_PROPERTY_MODIFICATION_MERCHANT_REFERENCE`
`static String`	`JSON_PROPERTY_MODIFICATION_PSP_REFERENCE`
`static String`	`JSON_PROPERTY_PAYMENT_MERCHANT_REFERENCE`
`static String`	`JSON_PROPERTY_PLATFORM_PAYMENT_TYPE`
`static String`	`JSON_PROPERTY_PSP_PAYMENT_REFERENCE`
`static String`	`JSON_PROPERTY_TYPE`

Constructor Summary

Constructors
Constructor Description

PlatformPayment()

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`boolean`	`equals(Object o)`	Return true if this PlatformPayment object is equal to o.
`static PlatformPayment`	`fromJson(String jsonString)`	Create an instance of PlatformPayment given an JSON string
`Map<String,Object>`	`getExplicitNulls()`	Returns a map of properties to be merged into the JSON payload as explicit null values.
`String`	`getModificationMerchantReference()`	The capture's merchant reference included in the transfer.
`String`	`getModificationPspReference()`	The capture reference included in the transfer.
`String`	`getPaymentMerchantReference()`	The payment's merchant reference included in the transfer.
`PlatformPayment.PlatformPaymentTypeEnum`	`getPlatformPaymentType()`	Specifies the nature of the transfer.
`String`	`getPspPaymentReference()`	The payment reference included in the transfer.
`PlatformPayment.TypeEnum`	`getType()`	platformPayment
`int`	`hashCode()`
`PlatformPayment`	`includeNullValues(boolean includeNullValues)`	Configures whether null values are explicitly serialized in the JSON payload.
`boolean`	`isIncludeNullValues()`	Returns whether null values are explicitly serialized in the JSON payload.
`PlatformPayment`	`modificationMerchantReference(String modificationMerchantReference)`	The capture's merchant reference included in the transfer.
`PlatformPayment`	`modificationPspReference(String modificationPspReference)`	The capture reference included in the transfer.
`PlatformPayment`	`paymentMerchantReference(String paymentMerchantReference)`	The payment's merchant reference included in the transfer.
`PlatformPayment`	`platformPaymentType(PlatformPayment.PlatformPaymentTypeEnum platformPaymentType)`	Specifies the nature of the transfer.
`PlatformPayment`	`pspPaymentReference(String pspPaymentReference)`	The payment reference included in the transfer.
`void`	`setIncludeNullValues(boolean includeNullValues)`	Sets whether null values should be explicitly serialized in the JSON payload.
`void`	`setModificationMerchantReference(String modificationMerchantReference)`	The capture's merchant reference included in the transfer.
`void`	`setModificationPspReference(String modificationPspReference)`	The capture reference included in the transfer.
`void`	`setPaymentMerchantReference(String paymentMerchantReference)`	The payment's merchant reference included in the transfer.
`void`	`setPlatformPaymentType(PlatformPayment.PlatformPaymentTypeEnum platformPaymentType)`	Specifies the nature of the transfer.
`void`	`setPspPaymentReference(String pspPaymentReference)`	The payment reference included in the transfer.
`void`	`setType(PlatformPayment.TypeEnum type)`	platformPayment
`String`	`toJson()`	Convert an instance of PlatformPayment to an JSON string
`String`	`toString()`
`PlatformPayment`	`type(PlatformPayment.TypeEnum type)`	platformPayment

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - JSON_PROPERTY_MODIFICATION_MERCHANT_REFERENCE
```
public static final String JSON_PROPERTY_MODIFICATION_MERCHANT_REFERENCE
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_MODIFICATION_PSP_REFERENCE
```
public static final String JSON_PROPERTY_MODIFICATION_PSP_REFERENCE
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_PAYMENT_MERCHANT_REFERENCE
```
public static final String JSON_PROPERTY_PAYMENT_MERCHANT_REFERENCE
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_PLATFORM_PAYMENT_TYPE
```
public static final String JSON_PROPERTY_PLATFORM_PAYMENT_TYPE
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_PSP_PAYMENT_REFERENCE
```
public static final String JSON_PROPERTY_PSP_PAYMENT_REFERENCE
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_TYPE
```
public static final String JSON_PROPERTY_TYPE
```
    See Also:
    
    Constant Field Values
- 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**: **deprecated** The Dynamic Currency Conversion (DCC) fee on a transaction. * **DCCMarkup**: 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**: **deprecated** The Dynamic Currency Conversion (DCC) fee on a transaction. * **DCCMarkup**: 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**: **deprecated** The Dynamic Currency Conversion (DCC) fee on a transaction. * **DCCMarkup**: 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**: **deprecated** The Dynamic Currency Conversion (DCC) fee on a transaction. * **DCCMarkup**: 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**: **deprecated** The Dynamic Currency Conversion (DCC) fee on a transaction. * **DCCMarkup**: 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**: **deprecated** The Dynamic Currency Conversion (DCC) fee on a transaction. * **DCCMarkup**: 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
  - getType
```
public PlatformPayment.TypeEnum getType()
```
    **platformPayment**
    
    Returns:
    
    type **platformPayment**
  - setType
```
public void setType(PlatformPayment.TypeEnum type)
```
    **platformPayment**
    
    Parameters:
    
    type - **platformPayment**
  - includeNullValues
```
public PlatformPayment includeNullValues(boolean includeNullValues)
```
    Configures whether null values are explicitly serialized in the JSON payload. Default is false.
  - isIncludeNullValues
```
public boolean isIncludeNullValues()
```
    Returns whether null values are explicitly serialized in the JSON payload.
  - setIncludeNullValues
```
public void setIncludeNullValues(boolean includeNullValues)
```
    Sets whether null values should be explicitly serialized in the JSON payload. Default is false.
  - 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
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - getExplicitNulls
```
public Map<String,Object> getExplicitNulls()
```
    Returns a map of properties to be merged into the JSON payload as explicit null values.
  - 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

Class PlatformPayment

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

JSON_PROPERTY_MODIFICATION_MERCHANT_REFERENCE

JSON_PROPERTY_MODIFICATION_PSP_REFERENCE

JSON_PROPERTY_PAYMENT_MERCHANT_REFERENCE

JSON_PROPERTY_PLATFORM_PAYMENT_TYPE

JSON_PROPERTY_PSP_PAYMENT_REFERENCE

JSON_PROPERTY_TYPE

Constructor Detail

PlatformPayment

Method Detail

modificationMerchantReference

getModificationMerchantReference

setModificationMerchantReference

modificationPspReference

getModificationPspReference

setModificationPspReference

paymentMerchantReference

getPaymentMerchantReference

setPaymentMerchantReference

platformPaymentType

getPlatformPaymentType

setPlatformPaymentType

pspPaymentReference

getPspPaymentReference

setPspPaymentReference

type

getType

setType

includeNullValues

isIncludeNullValues

setIncludeNullValues

equals

hashCode

toString

getExplicitNulls

fromJson

toJson