AdaptivePay Class

Properties   Methods   Events   Configuration Settings   Errors  

The AdaptivePay component is used to make simple payments, chained payments, or parallel payments. These payments can be explicitly approved, preapproved, or implicitly approved.

Syntax

inpaypal.adaptivepay()

Remarks

In an adaptive payment, the sender and recipient refer to the sender and receivers of funds, not the originator and recipient of the payment request. In the case of a simple payment, the recipient (merchant) sends the payment request to the sender (the merchant's customer), who then logs into PayPal and approves the transaction.

Chained and parallel payments are only slightly more complicated. In a parallel payment the sender makes a payment to multiple different recipients in one request. For instance, take a shopping cart that aggregates items from different merchants. When the customer approves the payment request he sees how his payment is being split up between several different merchants.

However, in a chained payment the customer sees only the primary recipient, but behind the scenes multiple recipients receive money. For instance, if you have your products drop-shipped from a warehouse off-site, you can transfer the shipping portion of the payment to them immediately, or you can immediately pay a commission to your sales representative.

This is useful because even though multiple recipients are receiving funds, you are only charged PayPal fees for one transaction.

To make a payment, set at least one Recipients (RecipientEmail and RecipientAmount), the CurrencyCode, CancelURL, and ReturnURL, and then call Pay. To make a parallel payment, set multiple Recipients and to make a chained payment make one (and only one) of the Recipients primary by setting the RecipientPrimary property to True.

For implicit approval, set the SenderEmail property. If you have a Preapproval set up, you can use the preapproval to avoid explicit approval. In that case set the PreApprovalKey and PreApprovalPIN properties instead.

If you need to change any default payment settings, use the CreatePayment method instead. Pass the PaymentKey you receive to the SetPaymentOptions method to update the default payment settings for that transaction. Then call ExecutePayment once you're ready to fulfill the payment.