
com.adyen.model.transfers.PlatformPayment Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of adyen-java-api-library Show documentation
Show all versions of adyen-java-api-library Show documentation
Adyen API Client Library for Java
/*
* Transfers API
*
* The version of the OpenAPI document: 4
*
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
* https://openapi-generator.tech
* Do not edit the class manually.
*/
package com.adyen.model.transfers;
import java.util.Objects;
import java.util.Map;
import java.util.HashMap;
import com.fasterxml.jackson.annotation.JsonInclude;
import com.fasterxml.jackson.annotation.JsonProperty;
import com.fasterxml.jackson.annotation.JsonCreator;
import com.fasterxml.jackson.annotation.JsonTypeName;
import com.fasterxml.jackson.annotation.JsonValue;
import java.util.Arrays;
import com.fasterxml.jackson.annotation.JsonPropertyOrder;
import com.fasterxml.jackson.core.JsonProcessingException;
/**
* PlatformPayment
*/
@JsonPropertyOrder({
PlatformPayment.JSON_PROPERTY_MODIFICATION_MERCHANT_REFERENCE,
PlatformPayment.JSON_PROPERTY_MODIFICATION_PSP_REFERENCE,
PlatformPayment.JSON_PROPERTY_PAYMENT_MERCHANT_REFERENCE,
PlatformPayment.JSON_PROPERTY_PLATFORM_PAYMENT_TYPE,
PlatformPayment.JSON_PROPERTY_PSP_PAYMENT_REFERENCE,
PlatformPayment.JSON_PROPERTY_TYPE
})
public class PlatformPayment {
public static final String JSON_PROPERTY_MODIFICATION_MERCHANT_REFERENCE = "modificationMerchantReference";
private String modificationMerchantReference;
public static final String JSON_PROPERTY_MODIFICATION_PSP_REFERENCE = "modificationPspReference";
private String modificationPspReference;
public static final String JSON_PROPERTY_PAYMENT_MERCHANT_REFERENCE = "paymentMerchantReference";
private String paymentMerchantReference;
/**
* 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. * **DCCPlatformCommission**: for the DCC Commission for the platform 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.
*/
public enum PlatformPaymentTypeEnum {
ACQUIRINGFEES(String.valueOf("AcquiringFees")),
ADYENCOMMISSION(String.valueOf("AdyenCommission")),
ADYENFEES(String.valueOf("AdyenFees")),
ADYENMARKUP(String.valueOf("AdyenMarkup")),
BALANCEACCOUNT(String.valueOf("BalanceAccount")),
CHARGEBACKREMAINDER(String.valueOf("ChargebackRemainder")),
COMMISSION(String.valueOf("Commission")),
DCCPLATFORMCOMMISSION(String.valueOf("DCCPlatformCommission")),
DEFAULT(String.valueOf("Default")),
INTERCHANGE(String.valueOf("Interchange")),
PAYMENTFEE(String.valueOf("PaymentFee")),
REMAINDER(String.valueOf("Remainder")),
SCHEMEFEE(String.valueOf("SchemeFee")),
SURCHARGE(String.valueOf("Surcharge")),
TIP(String.valueOf("Tip")),
TOPUP(String.valueOf("TopUp")),
VAT(String.valueOf("VAT"));
private String value;
PlatformPaymentTypeEnum(String value) {
this.value = value;
}
@JsonValue
public String getValue() {
return value;
}
@Override
public String toString() {
return String.valueOf(value);
}
@JsonCreator
public static PlatformPaymentTypeEnum fromValue(String value) {
for (PlatformPaymentTypeEnum b : PlatformPaymentTypeEnum.values()) {
if (b.value.equals(value)) {
return b;
}
}
throw new IllegalArgumentException("Unexpected value '" + value + "'");
}
}
public static final String JSON_PROPERTY_PLATFORM_PAYMENT_TYPE = "platformPaymentType";
private PlatformPaymentTypeEnum platformPaymentType;
public static final String JSON_PROPERTY_PSP_PAYMENT_REFERENCE = "pspPaymentReference";
private String pspPaymentReference;
/**
* **platformPayment**
*/
public enum TypeEnum {
PLATFORMPAYMENT(String.valueOf("platformPayment"));
private String value;
TypeEnum(String value) {
this.value = value;
}
@JsonValue
public String getValue() {
return value;
}
@Override
public String toString() {
return String.valueOf(value);
}
@JsonCreator
public static TypeEnum fromValue(String value) {
for (TypeEnum b : TypeEnum.values()) {
if (b.value.equals(value)) {
return b;
}
}
throw new IllegalArgumentException("Unexpected value '" + value + "'");
}
}
public static final String JSON_PROPERTY_TYPE = "type";
private TypeEnum type = TypeEnum.PLATFORMPAYMENT;
public PlatformPayment() {
}
/**
* The capture's merchant reference included in the transfer.
*
* @param modificationMerchantReference The capture's merchant reference included in the transfer.
* @return the current {@code PlatformPayment} instance, allowing for method chaining
*/
public PlatformPayment modificationMerchantReference(String modificationMerchantReference) {
this.modificationMerchantReference = modificationMerchantReference;
return this;
}
/**
* The capture's merchant reference included in the transfer.
* @return modificationMerchantReference The capture's merchant reference included in the transfer.
*/
@JsonProperty(JSON_PROPERTY_MODIFICATION_MERCHANT_REFERENCE)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public String getModificationMerchantReference() {
return modificationMerchantReference;
}
/**
* The capture's merchant reference included in the transfer.
*
* @param modificationMerchantReference The capture's merchant reference included in the transfer.
*/
@JsonProperty(JSON_PROPERTY_MODIFICATION_MERCHANT_REFERENCE)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public void setModificationMerchantReference(String modificationMerchantReference) {
this.modificationMerchantReference = modificationMerchantReference;
}
/**
* The capture reference included in the transfer.
*
* @param modificationPspReference The capture reference included in the transfer.
* @return the current {@code PlatformPayment} instance, allowing for method chaining
*/
public PlatformPayment modificationPspReference(String modificationPspReference) {
this.modificationPspReference = modificationPspReference;
return this;
}
/**
* The capture reference included in the transfer.
* @return modificationPspReference The capture reference included in the transfer.
*/
@JsonProperty(JSON_PROPERTY_MODIFICATION_PSP_REFERENCE)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public String getModificationPspReference() {
return modificationPspReference;
}
/**
* The capture reference included in the transfer.
*
* @param modificationPspReference The capture reference included in the transfer.
*/
@JsonProperty(JSON_PROPERTY_MODIFICATION_PSP_REFERENCE)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public void setModificationPspReference(String modificationPspReference) {
this.modificationPspReference = modificationPspReference;
}
/**
* The payment's merchant reference included in the transfer.
*
* @param paymentMerchantReference The payment's merchant reference included in the transfer.
* @return the current {@code PlatformPayment} instance, allowing for method chaining
*/
public PlatformPayment paymentMerchantReference(String paymentMerchantReference) {
this.paymentMerchantReference = paymentMerchantReference;
return this;
}
/**
* The payment's merchant reference included in the transfer.
* @return paymentMerchantReference The payment's merchant reference included in the transfer.
*/
@JsonProperty(JSON_PROPERTY_PAYMENT_MERCHANT_REFERENCE)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public String getPaymentMerchantReference() {
return paymentMerchantReference;
}
/**
* The payment's merchant reference included in the transfer.
*
* @param paymentMerchantReference The payment's merchant reference included in the transfer.
*/
@JsonProperty(JSON_PROPERTY_PAYMENT_MERCHANT_REFERENCE)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public void setPaymentMerchantReference(String paymentMerchantReference) {
this.paymentMerchantReference = paymentMerchantReference;
}
/**
* 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. * **DCCPlatformCommission**: for the DCC Commission for the platform 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.
*
* @param 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. * **DCCPlatformCommission**: for the DCC Commission for the platform 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.
* @return the current {@code PlatformPayment} instance, allowing for method chaining
*/
public PlatformPayment platformPaymentType(PlatformPaymentTypeEnum platformPaymentType) {
this.platformPaymentType = platformPaymentType;
return this;
}
/**
* 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. * **DCCPlatformCommission**: for the DCC Commission for the platform 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.
* @return 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. * **DCCPlatformCommission**: for the DCC Commission for the platform 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.
*/
@JsonProperty(JSON_PROPERTY_PLATFORM_PAYMENT_TYPE)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public PlatformPaymentTypeEnum getPlatformPaymentType() {
return 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. * **DCCPlatformCommission**: for the DCC Commission for the platform 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.
*
* @param 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. * **DCCPlatformCommission**: for the DCC Commission for the platform 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.
*/
@JsonProperty(JSON_PROPERTY_PLATFORM_PAYMENT_TYPE)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public void setPlatformPaymentType(PlatformPaymentTypeEnum platformPaymentType) {
this.platformPaymentType = platformPaymentType;
}
/**
* The payment reference included in the transfer.
*
* @param pspPaymentReference The payment reference included in the transfer.
* @return the current {@code PlatformPayment} instance, allowing for method chaining
*/
public PlatformPayment pspPaymentReference(String pspPaymentReference) {
this.pspPaymentReference = pspPaymentReference;
return this;
}
/**
* The payment reference included in the transfer.
* @return pspPaymentReference The payment reference included in the transfer.
*/
@JsonProperty(JSON_PROPERTY_PSP_PAYMENT_REFERENCE)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public String getPspPaymentReference() {
return pspPaymentReference;
}
/**
* The payment reference included in the transfer.
*
* @param pspPaymentReference The payment reference included in the transfer.
*/
@JsonProperty(JSON_PROPERTY_PSP_PAYMENT_REFERENCE)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public void setPspPaymentReference(String pspPaymentReference) {
this.pspPaymentReference = pspPaymentReference;
}
/**
* **platformPayment**
*
* @param type **platformPayment**
* @return the current {@code PlatformPayment} instance, allowing for method chaining
*/
public PlatformPayment type(TypeEnum type) {
this.type = type;
return this;
}
/**
* **platformPayment**
* @return type **platformPayment**
*/
@JsonProperty(JSON_PROPERTY_TYPE)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public TypeEnum getType() {
return type;
}
/**
* **platformPayment**
*
* @param type **platformPayment**
*/
@JsonProperty(JSON_PROPERTY_TYPE)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public void setType(TypeEnum type) {
this.type = type;
}
/**
* Return true if this PlatformPayment object is equal to o.
*/
@Override
public boolean equals(Object o) {
if (this == o) {
return true;
}
if (o == null || getClass() != o.getClass()) {
return false;
}
PlatformPayment platformPayment = (PlatformPayment) o;
return Objects.equals(this.modificationMerchantReference, platformPayment.modificationMerchantReference) &&
Objects.equals(this.modificationPspReference, platformPayment.modificationPspReference) &&
Objects.equals(this.paymentMerchantReference, platformPayment.paymentMerchantReference) &&
Objects.equals(this.platformPaymentType, platformPayment.platformPaymentType) &&
Objects.equals(this.pspPaymentReference, platformPayment.pspPaymentReference) &&
Objects.equals(this.type, platformPayment.type);
}
@Override
public int hashCode() {
return Objects.hash(modificationMerchantReference, modificationPspReference, paymentMerchantReference, platformPaymentType, pspPaymentReference, type);
}
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("class PlatformPayment {\n");
sb.append(" modificationMerchantReference: ").append(toIndentedString(modificationMerchantReference)).append("\n");
sb.append(" modificationPspReference: ").append(toIndentedString(modificationPspReference)).append("\n");
sb.append(" paymentMerchantReference: ").append(toIndentedString(paymentMerchantReference)).append("\n");
sb.append(" platformPaymentType: ").append(toIndentedString(platformPaymentType)).append("\n");
sb.append(" pspPaymentReference: ").append(toIndentedString(pspPaymentReference)).append("\n");
sb.append(" type: ").append(toIndentedString(type)).append("\n");
sb.append("}");
return sb.toString();
}
/**
* Convert the given object to string with each line indented by 4 spaces
* (except the first line).
*/
private String toIndentedString(Object o) {
if (o == null) {
return "null";
}
return o.toString().replace("\n", "\n ");
}
/**
* Create an instance of PlatformPayment given an JSON string
*
* @param jsonString JSON string
* @return An instance of PlatformPayment
* @throws JsonProcessingException if the JSON string is invalid with respect to PlatformPayment
*/
public static PlatformPayment fromJson(String jsonString) throws JsonProcessingException {
return JSON.getMapper().readValue(jsonString, PlatformPayment.class);
}
/**
* Convert an instance of PlatformPayment to an JSON string
*
* @return JSON string
*/
public String toJson() throws JsonProcessingException {
return JSON.getMapper().writeValueAsString(this);
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy