Developer's Guide

Adaptive Payments Developer Guide August 7, 2012 79
Pay API Operation
PayRequest Message
PayRequest Fields
Field Description
actionType xs:string
(Required) Whether the Pay request pays the receiver or whether the Pay
request is set up to create a payment request, but not fulfill the payment until
the ExecutePayment is called.
Allowable 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.
cancelUrl xs:string
(Required) The URL to which the sender’s browser is redirected if the sender
cancels the approval for the payment after logging in to paypal.com to approve
the payment. Specify the URL with the HTTP or HTTPS.
Maximum length: 1024 characters
clientDetails common:ClientDetailsType
(Optional) Information about the sender.