Package com.broadleafcommerce.paypal.micro.gateway.domain.orders

Class PaymentInstruction

java.lang.Object

com.broadleafcommerce.paypal.micro.gateway.domain.orders.PaymentInstruction

All Implemented Interfaces:

Serializable

public class PaymentInstruction
extends Object
implements Serializable

Author:

Dima Myroniuk (dmyroniuk)

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
PaymentInstruction()

Method Summary

Modifier and Type	Method	Description
String	getDisbursementMode()	The funds that are held payee by the marketplace/platform.
String	getPayeePricingTierId()	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.
String	getPayeeReceivableFxRateId()	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.
List<PlatformFee>	getPlatformFees()	An array of various fees, commissions, tips, or donations.
void	setDisbursementMode(String disbursementMode)	The funds that are held payee by the marketplace/platform.
void	setPayeePricingTierId(String 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.
void	setPayeeReceivableFxRateId(String 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.
void	setPlatformFees(List<PlatformFee> platformFees)	An array of various fees, commissions, tips, or donations.

Methods inherited from class java.lang.Object

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

Constructor Detail

PaymentInstruction

public PaymentInstruction()

Method Detail

setDisbursementMode

public void setDisbursementMode(String disbursementMode)

The funds that are held payee by the marketplace/platform. This field is only applicable to merchants that been enabled for PayPal Commerce Platform for Marketplaces and Platforms capability. The possible values are:

• "INSTANT". The funds are released to the merchant immediately.
• "DELAYED". The funds are held for a finite number of days. The actual duration depends on the region and type of integration. You can release the funds through a referenced payout. Otherwise, the funds disbursed automatically after the specified duration.

setPayeePricingTierId

public void setPayeePricingTierId(String 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.

setPayeeReceivableFxRateId

public void setPayeeReceivableFxRateId(String 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.

setPlatformFees

public void setPlatformFees(List<PlatformFee> platformFees)

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

getDisbursementMode

public String getDisbursementMode()

The funds that are held payee by the marketplace/platform. This field is only applicable to merchants that been enabled for PayPal Commerce Platform for Marketplaces and Platforms capability. The possible values are:

• "INSTANT". The funds are released to the merchant immediately.
• "DELAYED". The funds are held for a finite number of days. The actual duration depends on the region and type of integration. You can release the funds through a referenced payout. Otherwise, the funds disbursed automatically after the specified duration.

getPayeePricingTierId

public String getPayeePricingTierId()

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.

getPayeeReceivableFxRateId

public String getPayeeReceivableFxRateId()

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.

getPlatformFees

public List<PlatformFee> getPlatformFees()

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