com.paypal.sdk.models

Class PaymentInstruction

java.lang.Object

com.paypal.sdk.models.PaymentInstruction

public class PaymentInstruction
extends Object

This is a model class for PaymentInstruction type.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PaymentInstruction.Builder Class to build instances of PaymentInstruction.

Constructor Summary

Constructors

Constructor and Description
PaymentInstruction() Default constructor.
PaymentInstruction(List<PlatformFee> platformFees, DisbursementMode disbursementMode, String payeePricingTierId, String payeeReceivableFxRateId) Initialization constructor.

Method Summary

Modifier and Type	Method and Description
DisbursementMode	getDisbursementMode() Getter for DisbursementMode.
String	getPayeePricingTierId() Getter for PayeePricingTierId.
String	getPayeeReceivableFxRateId() Getter for PayeeReceivableFxRateId.
List<PlatformFee>	getPlatformFees() Getter for PlatformFees.
void	setDisbursementMode(DisbursementMode disbursementMode) Setter for DisbursementMode.
void	setPayeePricingTierId(String payeePricingTierId) Setter for PayeePricingTierId.
void	setPayeeReceivableFxRateId(String payeeReceivableFxRateId) Setter for PayeeReceivableFxRateId.
void	setPlatformFees(List<PlatformFee> platformFees) Setter for PlatformFees.
PaymentInstruction.Builder	toBuilder() Builds a new PaymentInstruction.Builder object.
String	toString() Converts this PaymentInstruction into string format.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

PaymentInstruction

public PaymentInstruction()

Default constructor.

PaymentInstruction

public PaymentInstruction(List<PlatformFee> platformFees,
                          DisbursementMode disbursementMode,
                          String payeePricingTierId,
                          String payeeReceivableFxRateId)

Initialization constructor.

Parameters:

platformFees - List of PlatformFee value for platformFees.

disbursementMode - DisbursementMode value for disbursementMode.

payeePricingTierId - String value for payeePricingTierId.

payeeReceivableFxRateId - String value for payeeReceivableFxRateId.

Method Detail

getPlatformFees

public List<PlatformFee> getPlatformFees()

Getter for PlatformFees. An array of various fees, commissions, tips, or donations. This field is only applicable to merchants that been enabled for PayPal Complete Payments Platform for Marketplaces and Platforms capability.

Returns:

Returns the List of PlatformFee

setPlatformFees

public void setPlatformFees(List<PlatformFee> platformFees)

Setter for PlatformFees. An array of various fees, commissions, tips, or donations. This field is only applicable to merchants that been enabled for PayPal Complete Payments Platform for Marketplaces and Platforms capability.

Parameters:

platformFees - Value for List of PlatformFee

getDisbursementMode

public DisbursementMode getDisbursementMode()

Getter for DisbursementMode. The funds that are held on behalf of the merchant.

Returns:

Returns the DisbursementMode

setDisbursementMode

public void setDisbursementMode(DisbursementMode disbursementMode)

Setter for DisbursementMode. The funds that are held on behalf of the merchant.

Parameters:

disbursementMode - Value for DisbursementMode

getPayeePricingTierId

public String getPayeePricingTierId()

Getter for PayeePricingTierId. This field is only enabled for selected merchants/partners to use and provides the ability to trigger a specific pricing rate/plan for a payment transaction. The list of eligible 'payee_pricing_tier_id' would be provided to you by your Account Manager. Specifying values other than the one provided to you by your account manager would result in an error.

Returns:

Returns the String

setPayeePricingTierId

public void setPayeePricingTierId(String payeePricingTierId)

Setter for PayeePricingTierId. This field is only enabled for selected merchants/partners to use and provides the ability to trigger a specific pricing rate/plan for a payment transaction. The list of eligible 'payee_pricing_tier_id' would be provided to you by your Account Manager. Specifying values other than the one provided to you by your account manager would result in an error.

Parameters:

payeePricingTierId - Value for String

getPayeeReceivableFxRateId

public String getPayeeReceivableFxRateId()

Getter for PayeeReceivableFxRateId. FX identifier generated returned by PayPal to be used for payment processing in order to honor FX rate (for eligible integrations) to be used when amount is settled/received into the payee account.

Returns:

Returns the String

setPayeeReceivableFxRateId

public void setPayeeReceivableFxRateId(String payeeReceivableFxRateId)

Setter for PayeeReceivableFxRateId. FX identifier generated returned by PayPal to be used for payment processing in order to honor FX rate (for eligible integrations) to be used when amount is settled/received into the payee account.

Parameters:

payeeReceivableFxRateId - Value for String

toString

public String toString()

Converts this PaymentInstruction into string format.

Overrides:

toString in class Object

Returns:

String representation of this class

toBuilder

public PaymentInstruction.Builder toBuilder()

Builds a new PaymentInstruction.Builder object. Creates the instance with the state of the current model.

Returns:

a new PaymentInstruction.Builder object