Developer's Guide

Adaptive Payments Developer Guide August 7, 2012 73
3
Pay API Operation
Use the Pay API operation to transfer funds from a sender’s PayPal account to one or more
receivers’ PayPal accounts. You can use the Pay API operation to make simple payments,
chained payments, or parallel payments; these payments can be explicitly approved,
preapproved, or implicitly approved.
Pay Summary
Create your PayRequest message by setting the common fields. If you want more than a
simple payment, add fields for the specific kind of request, which include parallel payments,
chained payments, implicit payments, and preapproved payments.
Common Fields for All Payments
For each kind of payment, you must specify values for the following fields:
Field Description
actionType The action for this request. Possible values are:
 PAY – Use this option if you are not using the Pay
request in combination with ExecutePayment.
 CREATE – Use this option to set up the payment
instructions with SetPaymentOptions and then
execute the payment at a later time with the
ExecutePayment.
 PAY_PRIMARY – For chained payments only, specify this
value to delay payments to the secondary receivers; only
the payment to the primary receiver is processed.
receiverList.receiver(0).email A receiver’s email address
receiverList.receiver(0).amount Amount to be credited to the receiver’s account
currencyCode The code for the currency in which the payment is made;
you can specify only one currency, regardless of the number
of receivers
cancelUrl URL to redirect the sender’s browser to after canceling the
approval for a payment; it is always required but only used
for payments that require approval (explicit payments)