2013

Recurring Payments and Reference Transactions API Operations
DoReferenceTransaction API Operation
12
172 February 01, 2013 Name-Value Pair API Developer Guide
DoReferenceTransaction Request Message
DoReferenceTransaction Request Fields
Field Description
METHOD (Required) Must be DoReferenceTransaction.
REFERENCEID (Required) A transaction ID from a previous purchase, such as a credit card charge
using the DoDirectPayment API, or a billing agreement ID.
PAYMENTACTION (Optional) How you want to obtain payment. It is one of the following values:
 Authorization – This payment is a basic authorization subject to settlement
with PayPal Authorization and Capture.
 Sale – This is a final sale for which you are requesting payment.
PAYMENTTYPE (Optional) Specifies type of PayPal payment you require for the billing agreement. It
is one of the following values.
 Any
 InstantOnly
NOTE: Echeck is not supported for DoReferenceTransaction requests.
IPADDRESS (Optional) IP address of the buyer’s browser.
NOTE: PayPal records this IP addresses as a means to detect possible fraud.
Character length and limitations: 15 single-byte characters, including periods, for
example, 255.255.255.255
REQCONFIRMSHIPPING Whether you require that the buyer’s shipping address on file with PayPal be a
confirmed address. You must have permission from PayPal to not require a confirmed
address. It is one of the following values:
 0 – You do not require that the buyer’s shipping address be a confirmed address.
 1 – You require that the buyer’s shipping address be a confirmed address.
NOTE: Setting this field overrides the setting you have specified in your Merchant
Account Profile.
Character length and limitations: 1 single-byte numeric character
RETURNFMFDETAILS (Optional) Flag to indicate whether you want the results returned by Fraud
Management Filters. By default, you do not receive this information. It is one of the
following values:
 0 – Do not receive FMF details (default)
 1 – Receive FMF details