DoReferenceTransaction API Operation (SOAP)

ReferenceID

xs:string

(Required) A valid transaction ID from a previous purchase, such as a credit card charge using the DoDirectPaymentAPI, or a valid billing agreement ID. Billing agreements are valid until the agreement is canceled by the buyer; whereas, transaction IDs are valid for 730 days from the transaction date.

PaymentAction

xs:string

(Required) 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.

• Order — This payment is an Order authorization subject to settlement with PayPal Authorization and Capture.

PaymentDetails

ebl:PaymentDetailsType

(Required) Information about the payment.

IPAddress

xs:string

(Optional) IP address of the buyer's browser. Supports IPv4, IPv6, and IPv4-mapped IPv6. IPv6 and IPv4-mapped IPv6 can be zero compressed.

Character length and limitations: 45 single—byte characters, including periods or colons.

• IPv4 example, 255.255.255.255

• IPv6 example, FDEC:0:0:0:0:BBFF:0:FFFF

  or zero-compressed, FDEC::BBFF:0:FFFF

• IPv4-mapped IPv6 example, 0000:0000:0000:0000:0000:FFFF:255.255.255.255

  or zero compressed, : :FFFF:255.255.255.255

RiskSessionCorrelationID

xs:string

(Optional) The ID of the risk session for correlation purposes.

MerchantSessionId

xs:string

(Optional) Your buyer session identification token.

Character length and limitations: 64 single-byte numeric characters

ReturnFMFDetails

xs:int

(Optional) Flag to indicate whether you want the results returned by Fraud Management Filters. By default, you do not receive this information. Value is:

• 0 — Do not receive FMF details (default)

• 1 — Receive FMF details

SoftDescriptorCity

xs:string

PaymentReason

ns:PaymentReasonType

Indicates the type of transaction. Value is:

• None — Transaction is not identified as a particular type.

Name

xs:string

Person's name associated with this shipping address. It is required if using a shipping address.

Character length and limitations: 32 double-byte characters

Street1

xs:string

First street address. It is required if using a shipping address.

Character length and limitations: 100 single-byte characters

Street2

xs:string

(Optional) Second street address.

Character length and limitations: 100 single-byte characters

CityName

xs:string

Name of city. It is required if using a shipping address.

Character length and limitations: 40 single-byte characters

StateOrProvince

xs:string

State or province.

It is required for transactions only if the address is in one of the following countries: Argentina, Brazil, Canada, China, Indonesia, India, Japan, Mexico, Thailand or USA. See the list of PayPal State codes.

Character length and limitations: 40 single-byte characters

PostalCode

xs:string

U.S. ZIP code or other country-specific postal code. It is required if using a U.S. shipping address.

Character length and limitations: 20 single-byte characters

Country

ebl:CountryCodeType

Country code. It is required if using a shipping address.

Character length and limitations: 2 single-byte characters

Phone

xs:string

(Optional) Phone number.

Character length and limitations: 20 single-byte characters

OrderTotal

ebl:BasicAmountType

(Required) The total cost of the transaction to the buyer. If shipping cost and tax charges are known, include them in this value. If not, this value should be the current subtotal of the order. If the transaction includes one or more one-time purchases, this field must be equal to the sum of the purchases. Set this field to 0 if the transaction does not include a one-time purchase such as when you set up a billing agreement for a recurring payment that is not immediately charged. When the field is set to 0, purchase-specific fields are ignored.

Character length and limitations:

Value is typically a positive number that cannot exceed nine (9) digits in SOAP request/response for USD, CLP, or JPY or the per transaction limit for the currency. It includes no currency symbol. Most currencies require two decimal places. The decimal separator must be a period (.), and the optional thousands separator must be a comma (,). Some currencies do not allow decimals. For details, see the currency codes page.

ItemTotal

ebl:BasicAmountType

(Optional) Sum of cost of all items in this order.

Character length and limitations:

Value is typically a positive number that cannot exceed nine (9) digits in SOAP request/response for USD, CLP, or JPY or the per transaction limit for the currency. It includes no currency symbol. Most currencies require two decimal places. The decimal separator must be a period (.), and the optional thousands separator must be a comma (,). Some currencies do not allow decimals. For details, see the currency codes page.

ShippingTotal

ebl:BasicAmountType

(Optional) Total shipping costs for this order.

Character length and limitations:

Value is typically a positive number that cannot exceed nine (9) digits in SOAP request/response for USD, CLP, or JPY or the per transaction limit for the currency. It includes no currency symbol. Most currencies require two decimal places. The decimal separator must be a period (.), and the optional thousands separator must be a comma (,). Some currencies do not allow decimals. For details, see the currency codes page.

InsuranceTotal

ebl:BasicAmountType

(Optional) Total shipping insurance costs for this order. The value must be non-negative currency amount or null if you offer insurance options.

Character length and limitations.

Value is typically a positive number that cannot exceed nine (9) digits in SOAP request/response for USD, CLP, or JPY or the per transaction limit for the currency. It includes no currency symbol. Most currencies require two decimal places. The decimal separator must be a period (.), and the optional thousands separator must be a comma (,). Some currencies do not allow decimals. For details, see the currency codes page.

ShippingDiscount

ebl:BasicAmountType

(Optional) Shipping discount for this order, specified as a negative number.

Character length and limitations: Value is a negative number. It includes no currency symbol. Most currencies require 2 decimal places, the decimal separator must be a period (`.`), and the optional thousands separator must be a comma (`,`). Some currencies do not allow decimals. See the [currency codes page](/docs/nvp-soap-api/currency-codes/) for details.

HandlingTotal

ebl:BasicAmountType

(Optional) Total handling costs for this order.

TaxTotal

ebl:BasicAmountType

(Optional) Sum of tax for all items in this order.

Character length and limitations:

Value is typically a positive number that cannot exceed nine (9) digits in SOAP request/response for USD, CLP, or JPY or the per transaction limit for the currency. It includes no currency symbol. Most currencies require two decimal places. The decimal separator must be a period (.), and the optional thousands separator must be a comma (,). Some currencies do not allow decimals. For details, see the currency codes page.

OrderDescription

xs:string

(Optional) Description of items the buyer is purchasing.

Character length and limitations: 127 single-byte alphanumeric characters

Custom

xs:string

(Optional) A free-form field for your own use.

Character length and limitations: 256 single-byte alphanumeric characters

InvoiceID

xs:string

(Optional) Your own invoice or tracking number.

Character length and limitations: 256 single-byte alphanumeric characters

ButtonSource

xs:string

(Optional) An identification code for use by third-party applications to identify transactions.

Character length and limitations: 32 single-byte alphanumeric characters

NotifyURL

xs:string

(Optional) Your URL for receiving Instant Payment Notification (IPN) about this transaction. If you do not specify this value in the request, the notification URL from your Merchant Profile is used, if one exists.

Character length and limitations: 2,048 single-byte alphanumeric characters

ShipToAddress

ns:AddressType

(Optional) Address the order is shipped to.

PaymentDetailsItem

ebl:PaymentDetailsItemType

(Optional) Details about each individual item included in the order.

Recurring

ns:RecurringFlagType

(Optional) Flag to indicate a recurring transaction. Value is:

• Any value other than Y — This is not a recurring transaction (default).

• Y — This is a recurring transaction.

This field is introduced in version 80.0 of the API.

ebl:PaymentCategoryType

(Optional) Category of a payment. Value is:
InternationalShipping
LocalDelivery

ItemCategory

ns:ItemCategoryType

Indicates whether the item is digital or physical. For digital goods, this field is required and you must set it to Digital to get the best rates. Value is:

• Digital

• Physical

This field is introduced in version 69.0.

Name

xs:string

Item name. This field is required when you pass a value for ItemCategory.

Character length and limitations: 127 single-byte characters

Description

xs:string

(Optional) Item description.

This field is available since version 53.0.

Character length and limitations: 127 single-byte characters

Amount

ebl:BasicAmountType

Cost of item. This field is required when you pass a value for ItemCategory.

Character length and limitations:

Value is typically a positive number that cannot exceed nine (9) digits in SOAP request/response for USD, CLP, or JPY or the per transaction limit for the currency. It includes no currency symbol. Most currencies require two decimal places. The decimal separator must be a period (.), and the optional thousands separator must be a comma (,). Some currencies do not allow decimals. For details, see the currency codes page.

Number

xs:string

(Optional) Item number.

Character length and limitations: 127 single-byte characters

Quantity

xs:integer

Item quantity. This field is required when you pass a value forItemCategory.

Character length and limitations: Any positive integer

Tax

ebl:BasicAmountType

(Optional) Item sales tax.

Character length and limitations:

Value is typically a positive number that cannot exceed nine (9) digits in SOAP request/response for USD, CLP, or JPY or the per transaction limit for the currency. It includes no currency symbol. Most currencies require two decimal places. The decimal separator must be a period (.), and the optional thousands separator must be a comma (,). Some currencies do not allow decimals. For details, see the currency codes page.

• CUSTOMER (default) - Customer initiates the payment. Also referred to as a Customer Initiated Transaction (CIT).
• MERCHANT - Merchant initiates the transaction and the merchant has established consent to charge the buyer. Also referred to as a Merchant Initiated Transaction (MIT).

• UNSCHEDULED - Payments that the merchant initiates and are not on a specified schedule. For example, this includes preauthorized transactions where the merchant can charge the buyer once a balance falls within a specified range. These transactions are also referred to as top-up.
• RECURRING - Merchant initiates a payment as part of a series of recurring payments. The payment amounts can be variable and are on a fixed time interval.
• ONE_TIME - Single, one-time payment.

• FIRST - Save card information or payment token to use in subsequent transactions. Collect consent from the buyer that you intend to save their payment information.
• SUBSEQUENT - Card information or payment token was previously saved and is used in the transaction.

• PREVIOUSNETWORKTRANSACTIONID - Transaction ID from a non-PayPal payment processor that you have previously used to process the payment.
• Network - TransactionID from a non-PayPal payment processor that you have previously used to process the payment.

ItemNumber

xs:string

(Optional) Auction item number.

Character length: 765 single-byte characters

AuctionTransaction Id

xs:string

(Optional) Auction transaction identification number.

Character length: 255 single-byte characters

OrderID

xs:string

(Optional) Auction order identification number.

Character length: 64 single-byte characters

CreditCardType

ebl:CreditCardType

(Optional) Type of credit card. Is one of the following values:

• Visa
• Mastercard
• Discover
• JCB
• Amex
• Maestro: See note.

For UK, only Maestro, Mastercard, Discover, and Visa are allowable. For Canada, only Mastercard and Visa are allowable. Interac debit cards are not supported.

Character length and limitations: Up to 10 single-byte alphabetic characters

CreditCardNumber

xs:string

(Optional) Credit card number.

Character length and limitations: Numeric characters only with no spaces or punctuation. The string must conform with modulo and length required by each credit card type.

ExpMonth

xs:int

(Optional) Credit card expiration month.

Character length and limitations: 2 single-byte numeric characters, including leading zero

ExpYear

xs:int

(Optional) Credit card expiration year.

Character length and limitations: 4 single-byte numeric characters

CVV2

xs:string

(Optional) Card Verification Value, version 2. To comply with credit card processing regulations, you must not store this value after a transaction has been completed.

Character length and limitations: For Visa, Mastercard, and Discover, the value is exactly 3 digits. For American Express, the value is exactly 4 digits.

CardOwner

ns:PayerInfoType

(Optional) Details about the owner of the credit card.

StartMonth

xs:int

(Optional) Month that Maestro card was issued.

Character length and limitations: 2-digit, zero-filled if necessary

StartYear

xs:int

(Optional) Year that Maestro card was issued.

Character length and limitations: 4 digits

IssueNumber

xs:string

(Optional) Issue number of Maestro card.

Character length and limitations: 2 numeric digits maximum.

Salutation

xs:string

(Optional) Buyer's salutation.

Character length and limitations: 20 single-byte characters

FirstName

ebl:PersonNameType

(Optional) Buyer's first name.

Character length and limitations: 64 double-byte characters

MiddleName

ebl:NameUser

(Optional) Buyer's middle name.

Character length and limitations: 64 double-byte characters

LastName

ebl:NameType

(Optional) Buyer's last name.

Character length and limitations: 64 double-byte characters

Suffix

ebl:SuffixType

(Optional) Buyer's suffix.

Character length and limitations: 12 single-byte characters

PaymentInfo

ns:PaymentInfoType

Information about the payment such as the transaction ID, whether the payment is instant or delayed, and the settlement amount.

AVSCode

xs:string

Returned only for Direct Credit Card transactions. Address Verification System response code.

Character limit: 1 single-byte alphanumeric character

CVV2Code

xs:string

Returned only for Direct Credit Card transactions. Result of the CVV2 check by PayPal.

BillingAgreementID

xs:string

Identification number of the billing agreement. When the buyer approves the billing agreement, it becomes valid and remains valid until it is canceled by the buyer.

Character length and limitations: 19 single-byte alphanumeric characters

FMFDetails

ebl:FMFDetailsType

Fraud filter details.

PaymentAdviceCode

xs:string

A processor response code typically returned on declined Website Payments Pro recurring transactions. Its purpose is to provide merchants with information and specific instructions on how to handle the decline. It is the merchant's responsibility to follow the instructions provided in order to avoid chargebacks. For details on the meanings of these codes, see AVS, CVV2, and payment advice response codes.

TransactionID

xs:string

Unique transaction ID of the payment.

Character length and limitations: 17 characters. Orders transactions have 19 characters.

ParentTransactionID

xs:string

Parent or related transaction identification number. This value in this field is for the following transaction types:

• Reversal — Capture of an authorized transaction.

• Reversal — Reauthorization of a transaction.

• Capture of an order — The value of ParentTransactionID is the original OrderID.

• Authorization of an order — The value of ParentTransactionID is the original OrderID.

• Capture of an order authorization.

• Void of an order — The value of ParentTransactionID is the original OrderID.

Character length and limitations: 17 characters. Orders transactions have 19 characters.

ReceiptID

xs:string

Receipt identification number

Character length and limitations: 16 digits in xxxx-xxxx-xxxx-xxxx format

TransactionType

ns:PaymentTransactionCodeType

The type of transaction. Value is:

• cart

• express-checkout

Character length and limitations: 15 single-byte characters

PaymentType

ebl:PaymentCodeType

Indicates whether the payment is instant or delayed. It only applies to Express Checkout reference transactions and is not applicable to direct credit card reference transactions. Value is:

• none

• echeck

• instant

Character length and limitations: 7 single-byte characters

PaymentDate

xs:dateTime

Date and time stamp of the payment.

Character length and limitations:

Date and time are in UTC/GMT format. For example, 2013-08-24T05:38:48Z.

GrossAmount

ebl:BasicAmountType

The final amount charged, including any shipping and taxes from your Merchant Profile.

Character length and limitations:

Value is typically a positive number that cannot exceed nine (9) digits in SOAP request/response for USD, CLP, or JPY or the per transaction limit for the currency. It includes no currency symbol. Most currencies require two decimal places. The decimal separator must be a period (.), and the optional thousands separator must be a comma (,). Some currencies do not allow decimals. For details, see the currency codes page.

FeeAmount

ebl:BasicAmountType

PayPal fee amount charged for the transaction.

Character length and limitations:

Value is typically a positive number that cannot exceed nine (9) digits in SOAP request/response for USD, CLP, or JPY or the per transaction limit for the currency. It includes no currency symbol. Most currencies require two decimal places. The decimal separator must be a period (.), and the optional thousands separator must be a comma (,). Some currencies do not allow decimals. For details, see the currency codes page.

SettleAmount

ebl:BasicAmountType

Amount deposited in your PayPal account after a currency conversion.

Character length and limitations:

Value is typically a positive number that cannot exceed nine (9) digits in SOAP request/response for USD, CLP, or JPY or the per transaction limit for the currency. It includes no currency symbol. Most currencies require two decimal places. The decimal separator must be a period (.), and the optional thousands separator must be a comma (,). Some currencies do not allow decimals. For details, see the currency codes page.

TaxAmount

ebl:BasicAmountType

Tax charged on the transaction.

Character length and limitations:

Value is typically a positive number that cannot exceed nine (9) digits in SOAP request/response for USD, CLP, or JPY or the per transaction limit for the currency. It includes no currency symbol. Most currencies require two decimal places. The decimal separator must be a period (.), and the optional thousands separator must be a comma (,). Some currencies do not allow decimals. For details, see the currency codes page.

ExchangeRate

xs:string

Exchange rate if a currency conversion occurred. Relevant only if your are billing in their non-primary currency. If the buyer chooses to pay with a currency other than the non-primary currency, the conversion occurs in the buyer's account.

Character length and limitations: Decimal value that does not exceed 17 characters, including decimal point

PaymentStatus

ebl:PaymentStatusCodeType

Status of the payment. Value is:

• None — No status

• Canceled-Reversal— A reversal has been canceled, for example, when you win a dispute and the funds for the reversal have been returned to you.

• Completed — The payment has been completed, and the funds have been added successfully to your account balance.

• Denied — You denied the payment. This happens only if the payment was previously pending because of possible reasons described for the PendingReason element.

• Expired — The authorization period for this payment has been reached.

• Failed — The payment has failed. This happens only if the payment was made from your buyer's bank account.

• In-Progress — The transaction has not terminated, for example, an authorization may be awaiting completion.

• Partially-Refunded — The payment has been partially refunded.

• Pending — The payment is pending. See the PendingReason field for more information.

• Refunded — You refunded the payment.

• Reversed — A payment was reversed due to a chargeback or other type of reversal. The funds have been removed from your account balance and returned to the buyer. The reason for the reversal is specified in the ReasonCode element.

• Processed — A payment has been accepted.

• Voided — An authorization for this transaction has been voided.

PendingReason

ebl:PendingStatusCodeType

The reason the payment is pending. Value is:

• none — No pending reason.

• address — The payment is pending because your buyer did not include a confirmed shipping address and your Payment Receiving Preferences is set such that you want to manually accept or deny each of these payments. To change your preference, go to the Preferences section of your Profile.

• authorization — The payment is pending because it has been authorized but not settled. You must capture the funds first.

• echeck — The payment is pending because it was made by an eCheck that has not yet cleared.

• intl — The payment is pending because you hold a non-U.S. account and do not have a withdrawal mechanism. You must manually accept or deny this payment from your Account Overview.

• multi-currency — You do not have a balance in the currency sent, and you do not have your Payment Receiving Preferences set to automatically convert and accept this payment. You must manually accept or deny this payment.

• order — The payment is pending because it is part of an order that has been authorized but not settled.

• paymentreview — The payment is pending while it is being reviewed by PayPal for risk.

• regulatoryreview - The payment is pending while we make sure it meets regulatory requirements. You will be contacted again in 24-72 hours with the outcome of the review.

• unilateral — The payment is pending because it was made to an email address that is not yet registered or confirmed.

• verify —The payment is pending because you are not yet verified. You must verify your account before you can accept this payment.

• other — The payment is pending for a reason other than those listed above. For more information, contact PayPal Customer Service.

ReasonCode

ebl:ReasonCodeType

The reason for a reversal if the transaction type is reversal. Value is:

• none — No reason code.

• chargeback — A reversal has occurred on this transaction due to a chargeback by your buyer.

• guarantee — A reversal has occurred on this transaction due to your buyer triggering a money-back guarantee.

• buyer-complaint — A reversal has occurred on this transaction due to a complaint about the transaction from your buyer.

• refund — A reversal has occurred on this transaction because you have given the buyer a refund.

• other — A reversal has occurred on this transaction due to a reason not listed above.

ProtectionEligibility

xs:string

Prior to version 64.4, the kind of seller protection in force for the transaction. Value is:

• Eligible — Merchant is protected by PayPal's Seller Protection Policy for Unauthorized Payments and Item Not Received.

• PartiallyEligible — Merchant is protected by PayPal's Seller Protection Policy for Item Not Received.

• Ineligible — Merchant is not protected under the Seller Protection Policy.

ProtectionEligibilityType

xs:string

It is one or more of the following values:

• ItemNotReceivedEligible – Merchant is protected by PayPal's Seller Protection Policy for Item Not Received.
• UnauthorizedPaymentEligible – Merchant is protected by PayPal's Seller Protection Policy for Unauthorized Payment.
• Ineligible – Merchant is not protected under the Seller Protection Policy.

This field is available since version 64.4.

StoreId

xs:string

StoreId as entered in the transaction

TerminalId

xs:string

TerminalId as entered in the transaction

InstrumentDetails

ns:InstrumentDetailsType

Type of the payment instrument.

InstrumentCategory

xs:string

Returns the category of the instrument only when it is promotional. Value is:
1 represents PayPal Credit

InstrumentID

xs:string

Reserved for future use.
Returns an instrument ID (issued by the external party) corresponding to the funding source used in the payment.

AcceptFilters

xs:RiskFilterListType

List of filters that recommend acceptance of the payment.

DenyFilters

xs:RiskFilterListType

List of filters that recommend denial of the payment.

PendingFilters

xs:RiskFilterListType

List of filters that caused the payment to become pending.

ReportsFilters

xs:RiskFilterListType

List of filters that caused the payment to become flagged.

ID

xs:int

Filter ID. Value is:

• 1 - AVS No Match

• 2 - AVS Partial Match

• 3 - AVS Unavailable/Unsupported

• 4 - Card Security Code (CSC) Mismatch

• 5 - Maximum Transaction Amount

• 6 - Unconfirmed Address

• 7 - Country Monitor

• 8 - Large Order Number

• 9 - Billing/Shipping Address Mismatch

• 10 - Risky ZIP Code

• 11 - Suspected Freight Forwarder Check

• 12 - Total Purchase Price Minimum

• 13 - IP Address Velocity

• 14 - Risky Email Address Domain Check

• 15 - Risky Bank Identification Number (BIN) Check

• 16 - Risky IP Address Range

• 17 - PayPal Fraud Model

Name

xs:string

Filter name.

Description

xs:string

Filter description.

• 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.

Character length and limitations: One single-byte numeric character.