Installment Period.
Optional
Installment Frequency.
Optional
Installment Cycles.
Optional
Installment Amount.
Optional
Installment Amount.
Optional
Installment Amount.
Optional
Option Selection.
Required
Character length and limitations: 12 single-byte alphanumeric characters
Option Price.
Optional
Option Type
Optional
Option Name.
Optional
Type of Button to create.

Required

Must be one of the following: BUYNOW, CART, GIFTCERTIFICATE. SUBSCRIBE, PAYMENTPLAN, AUTOBILLING, DONATE, VIEWCART or UNSUBSCRIBE
button code.

optional

Must be one of the following: hosted, encrypted or cleartext
Button sub type.

optional for button types buynow and cart only

Must Be either PRODUCTS or SERVICES
Button Variable information

At least one required recurring

Character length and limitations: 63 single-byte alphanumeric characters
Details of each option for the button.

Optional
Button image to use.

Optional

Must be one of: REG, SML, or CC
Button URL for custom button image.

Optional

Character length and limitations: 127 single-byte alphanumeric characters
Text to use on Buy Now Button.

Optional

Must be either BUYNOW or PAYNOW
Text to use on Subscribe button.

Optional

Must be either BUYNOW or SUBSCRIBE
Button Country.

Optional

Must be valid ISO country code
Button language code.

Optional

Character length and limitations: 3 single-byte alphanumeric characters
Hosted Button id of the button to update.

Required

Character length and limitations: 10 single-byte numeric characters
Type of Button to create.

Required

Must be one of the following: BUYNOW, CART, GIFTCERTIFICATE. SUBSCRIBE, PAYMENTPLAN, AUTOBILLING, DONATE, VIEWCART or UNSUBSCRIBE
button code.

optional

Must be one of the following: hosted, encrypted or cleartext
Button sub type.

optional for button types buynow and cart only

Must Be either PRODUCTS or SERVICES
Button Variable information

At least one required recurring

Character length and limitations: 63 single-byte alphanumeric characters
Details of each option for the button.

Optional
Button image to use.

Optional

Must be one of: REG, SML, or CC
Button URL for custom button image.

Optional

Character length and limitations: 127 single-byte alphanumeric characters
Text to use on Buy Now Button.

Optional

Must be either BUYNOW or PAYNOW
Text to use on Subscribe button.

Optional

Must be either BUYNOW or SUBSCRIBE
Button Country.

Optional

Must be valid ISO country code
Button language code.

Optional

Character length and limitations: 2 single-byte alphanumeric characters
Button ID of Hosted button.

Required

Character length and limitations: 10 single-byte numeric characters
Requested Status change for hosted button.

Required

Character length and limitations: 1 single-byte alphanumeric characters
Button ID of button to return.

Required

Character length and limitations: 10 single-byte numeric characters
Type of button.

One of the following: BUYNOW, CART, GIFTCERTIFICATE. SUBSCRIBE, PAYMENTPLAN, AUTOBILLING, DONATE, VIEWCART or UNSUBSCRIBE
Type of button code.

One of the following: hosted, encrypted or cleartext
Button sub type.

optional for button types buynow and cart only

Either PRODUCTS or SERVICES
Button Variable information

Character length and limitations: 63 single-byte alphanumeric characters
Text field

Button image to use.

One of: REG, SML, or CC
Button URL for custom button image.

Text to use on Buy Now Button.

Either BUYNOW or PAYNOW
Text to use on Subscribe button.

Must be either BUYNOW or SUBSCRIBE
Button Country.

Valid ISO country code or 'International'
Button language code.

Character length and limitations: 3 single-byte alphanumeric characters
Hosted Button ID of button you wish to change.

Required

Character length and limitations: 10 single-byte numeric characters
Is Inventory tracked.

Required

0 or 1
Is PNL Tracked.

Required

0 or 1
Option Index.

Optional

Character length and limitations: 1 single-byte alphanumeric characters
URL of page to display when an item is soldout.

Optional

Character length and limitations: 127 single-byte alphanumeric characters
Whether to use the same digital download key repeatedly.

Optional
Whether to append these keys to the list or not (replace).

Optional
Zero or more digital download keys to distribute to customers after transaction is completed.

Optional

Character length and limitations: 1000 single-byte alphanumeric characters
Hosted Button ID of the button to return inventory for.

Required

Character length and limitations: 10 single-byte numeric characters
The earliest transaction date at which to start the search. No wildcards are allowed.

Required
The latest transaction date to be included in the search

Optional
Unique identifier of the transaction you are refunding.

Optional

Character length and limitations: 17 single-byte alphanumeric characters
Encrypted PayPal customer account identification number.

Optional

Character length and limitations: 127 single-byte alphanumeric characters
Invoice number corresponding to transaction details for tracking the refund of a payment. This parameter is passed by the merchant or recipient while refunding the transaction. This parameter does not affect the business logic, it is persisted in the DB for transaction reference
Optional
Type of refund you are making

Required
Refund amount.

Amount is required if RefundType is Partial.

NOTE: If RefundType is Full, do not set Amount.
Custom memo about the refund.

Optional

Character length and limitations: 255 single-byte alphanumeric characters
The maximum time till which refund must be tried.

Optional
The type of funding source for refund.

Optional
Flag to indicate that the customer was already given store credit for a given transaction. This will allow us to make sure we do not double refund.

Optional
To pass the Merchant store information

Optional
Information about the individual details of the items to be refunded.
Optional
Unique id for each API request to prevent duplicate payments.

Optional
Character length and limits: 38 single-byte characters maximum.
Unique transaction ID of the refund.

Character length and limitations:17 single-byte characters
Amount subtracted from PayPal balance of original recipient of payment to make this refund Transaction fee refunded to original recipient of payment Amount of money refunded to original payer Total of all previous refunds Contains Refund Payment status information. Any general information like offer details that is reinstated or any other marketing data Return msgsubid back to merchant
Unique identifier of a transaction.

Required

The details for some kinds of transactions cannot be retrieved with GetTransactionDetailsRequest. You cannot obtain details of bank transfer withdrawals, for example.

Character length and limitations: 17 single-byte alphanumeric characters
This flag indicates that the response should include FMFDetails The earliest transaction date at which to start the search. No wildcards are allowed.

Required
The latest transaction date to be included in the search

Optional
Search by the buyer's email address

Optional

Character length and limitations: 127 single-byte alphanumeric characters
Search by the receiver's email address. If the merchant account has only one email, this is the primary email. Can also be a non-primary email.

Optional
Search by the PayPal Account Optional receipt ID

Optional
Search by the transaction ID.

Optional

The returned results are from the merchant's transaction records.

Character length and limitations: 19 single-byte characters maximum
Search by Recurring Payment Profile id. The ProfileID is returned as part of the CreateRecurringPaymentsProfile API response.

Optional
Search by the buyer's name

Optional

Salutation: 20 single-byte character limit.

FirstName: 25 single-byte character limit.

MiddleName: 25 single-byte character limit.

LastName: 25 single-byte character limit.

Suffix: 12 single-byte character limit.
Search by item number of the purchased goods.

Optional

To search for purchased items not related to auctions, set the AuctionItemNumber element to the value of the HTML item_number variable set in the shopping cart for the original transaction.
Search by invoice identification key, as set by you for the original transaction. InvoiceID searches the invoice records for items sold by the merchant, not the items purchased.

Optional

The value for InvoiceID must exactly match an invoice identification number. No wildcards are allowed.

Character length and limitations: 127 single-byte characters maximum
Search by classification of transaction. Some kinds of possible classes of transactions are not searchable with TransactionSearchRequest. You cannot search for bank transfer withdrawals, for example.

Optional

All: all transaction classifications.

Sent: only payments sent.

Received: only payments received.

MassPay: only mass payments.

MoneyRequest: only money requests.

FundsAdded: only funds added to balance.

FundsWithdrawn: only funds withdrawn from balance.

Referral: only transactions involving referrals.

Fee: only transactions involving fees.

Subscription: only transactions involving subscriptions.

Dividend: only transactions involving dividends.

Billpay: only transactions involving BillPay Transactions.

Refund: only transactions involving funds.

CurrencyConversions: only transactions involving currency conversions.

BalanceTransfer: only transactions involving balance transfers.

Reversal: only transactions involving BillPay reversals.

Shipping: only transactions involving UPS shipping fees.

BalanceAffecting: only transactions that affect the account balance.

ECheck: only transactions involving eCheck

ForcedPostTransaction: forced post transaction.

NonReferencedRefunds: non-referenced refunds.
Search by transaction amount

Optional

You must set the currencyID attribute to one of the three-character currency codes for any of the supported PayPal currencies.
Search by currency code

Optional
Search by transaction status

Optional

Pending: The payment is pending. The specific reason the payment is pending is returned by the GetTransactionDetails APIPendingReason element. For more information, see PendingReason.

Processing: The payment is being processed.

Success: 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.

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.
Results of a Transaction Search. Subject line of the email sent to all recipients. This subject is not contained in the input file; you must create it with your application.

Optional

Character length and limitations: 255 single-byte alphanumeric characters
Indicates how you identify the recipients of payments in all MassPayItems: either by EmailAddress (ReceiverEmail in MassPayItem), PhoneNumber (ReceiverPhone in MassPayItem), or by UserID (ReceiverID in MassPayItem).

Required. You must specify one or the other of EmailAddress or UserID.
Known as BN code, to track the partner referred merchant transactions.

Optional

Character length and limitations: 32 single-byte alphanumeric characters
Details of each payment. A single MassPayRequest can include up to 250 MassPayItems.

Required
MassPayRequestItemType Email address of recipient.

Required

You must specify ReceiverEmail, ReceiverPhone, or ReceiverID, but all MassPayItems in a request must use the same field to specify recipients.

Character length and limitations: 127 single-byte characters maximum.
Phone number of recipient.

Required

You must specify ReceiverEmail, ReceiverPhone, or ReceiverID, but all MassPayItems in a request must use the same field to specify recipients.

Unique PayPal customer account number. This value corresponds to the value of PayerID returned by GetTransactionDetails.

Required

You must specify ReceiverEmail, ReceiverPhone, or ReceiverID, but all MassPayItems in a request must use the same field to specify recipients.

Character length and limitations: 17 single-byte characters maximum.
Payment amount. You must set the currencyID attribute to one of the three-character currency codes for any of the supported PayPal currencies.

Required

You cannot mix currencies in a single MassPayRequest. A single request must include items that are of the same currency.
Transaction-specific identification number for tracking in an accounting system.

Optional

Character length and limitations: 30 single-byte characters. No whitespace allowed.
Custom note for each recipient.

Optional

Character length and limitations: 4,000 single-byte alphanumeric characters
Email address of buyer to be verified.

Required

Maximum string length: 255 single-byte characters Input mask: ?@?.??
First line of buyer’s billing or shipping street address to be verified.

Required

For verification, input value of street address must match the first three single-byte characters of the street address on file for the PayPal account.

Maximum string length: 35 single-byte characters Alphanumeric plus - , . ‘ # \ Whitespace and case of input value are ignored.
Postal code to be verified.

Required

For verification, input value of postal code must match the first five single-byte characters of the postal code on file for the PayPal account.

Maximum string length: 16 single-byte characters Whitespace and case of input value are ignored.
Confirmation of a match, with one of the following tokens:

None: The input value of the Email object does not match any email address on file at PayPal.

Confirmed: If the value of the StreetMatch object is Matched, PayPal responds that the entire postal address is confirmed.

Unconfirmed: PayPal responds that the postal address is unconfirmed
PayPal has compared the postal address you want to verify with the postal address on file at PayPal.

None: The input value of the Email object does not match any email address on file at PayPal. In addition, an error response is returned. No further comparison of other input values has been made.

Matched: The street address matches the street address on file at PayPal.

Unmatched: The street address does not match the street address on file at PayPal.
PayPal has compared the zip code you want to verify with the zip code on file for the email address.

None: The street address was unmatched. No further comparison of other input values has been made.

Matched: The zip code matches the zip code on file at PayPal.

Unmatched: The zip code does not match the zip code on file at PayPal.
Two-character country code (ISO 3166) on file for the PayPal email address. The token prevents a buyer from using any street address other than the address on file at PayPal during additional purchases he might make from the merchant. It contains encrypted information about the user’s street address and email address. You can pass the value of the token with the Buy Now button HTML address_api_token variable so that PayPal prevents the buyer from using any street address or email address other than those verified by PayPal. The token is valid for 24 hours.
Character length and limitations: 94 single-byte characters
A unique token that identifies this boarding session. Use this token with the GetBoarding Details API call.

Character length and limitations: 64 alphanumeric characters. The token has the following format:

OB-61characterstring
A unique token returned by the EnterBoarding API call that identifies this boarding session.

Required

Character length and limitations: 64 alphanumeric characters. The token has the following format:

OB-61characterstring
A timestamped token by which you identify to PayPal that you are processing this user. The token expires after three hours.

Character length and limitations: 20 single-byte characters
A timestamped token, the value of which was returned by SetAuthFlowParam Response.

Required

Character length and limitations: 20 single-byte characters
A timestamped token by which you identify to PayPal that you are processing this user. The token expires after three hours.

Character length and limitations: 20 single-byte characters
Unique PayPal customer account number, the value of which was returned by GetAuthDetails Response.

Required

Character length and limitations: 20 single-byte characters
The status of the update call, Success/Failure.

Character length and limitations: 20 single-byte characters
A timestamped token, the value of which was returned by SetAuthFlowParam Response.

Required

Character length and limitations: 20 single-byte characters
A timestamped token by which you identify to PayPal that you are processing this payment with Express Checkout. The token expires after three hours. If you set Token in the SetExpressCheckoutRequest, the value of Token in the response is identical to the value in the request.

Character length and limitations: 20 single-byte characters
A timestamped token, the value of which was returned by SetExpressCheckoutResponse.

Required

Character length and limitations: 20 single-byte characters
This flag indicates that the response should include FMFDetails This flag indicates that the response should include FMFDetails The amount of the payment as specified by you on DoDirectPaymentRequest. Address Verification System response code. Character limit: One single-byte alphanumeric character
AVS CodeMeaningMatched Details
A AddressAddress only (no ZIP)
B International “A”Address only (no ZIP)
CInternational “N” None
DInternational “X” Address and Postal Code
E Not allowed for MOTO (Internet/Phone) transactions Not applicable
F UK-specific “X”Address and Postal Code
G Global Unavailable Not applicable
I International UnavailableNot applicable
N NoNone
PPostal (International “Z”)Postal Code only (no Address)
RRetryNot applicable
S Service not Supported Not applicable
U UnavailableNot applicable
W Whole ZIPNine-digit ZIP code (no Address)
X Exact match Address and nine-digit ZIP code
Y YesAddress and five-digit ZIP
Z ZIP Five-digit ZIP code (no Address)
All others Error Not applicable
Result of the CVV2 check by PayPal.
CVV2 CodeMeaningMatched Details
M MatchCVV2
N No match None
P Not ProcessedNot applicable
SService not SupportedNot applicable
U UnavailableNot applicable
XNo response Not applicable
All others ErrorNot applicable
Transaction identification number.

Character length and limitations: 19 characters maximum.
The reason why a particular transaction went in pending. This will identify the actual transaction status. Response code from the processor when a recurring transaction is declined.
Msg Sub Id that was used for the orginal operation. Original API's type Unique id for each API request to prevent duplicate payments.

Optional
Character length and limits: 38 single-byte characters maximum.
Return msgsubid back to merchant The authorization identification number of the payment you want to capture.

Required

Character length and limits: 19 single-byte characters maximum
Amount to authorize. You must set the currencyID attribute to USD.

Required

Limitations: Must not exceed $10,000 USD in any currency. No currency symbol. Decimal separator must be a period (.), and the thousands separator must be a comma (,)
Indicates if this capture is the last capture you intend to make. The default is Complete. If CompleteType is Complete, any remaining amount of the original reauthorized transaction is automatically voided.

Required

Character length and limits: 12 single-byte alphanumeric characters
An informational note about this settlement that is displayed to the payer in email and in transaction history.

Optional

Character length and limits: 255 single-byte characters
Your invoice number or other identification number.

The InvoiceID value is recorded only if the authorization you are capturing is an order authorization, not a basic authorization.

Optional

Character length and limits: 127 single-byte alphanumeric characters
Contains enhanced data like airline itinerary information.

Not Required
dynamic descriptor

Dynamic descriptor is used for merchant to provide detail of a transaction appears on statement

Optional

Character length and limits: <18 characters alphanumeric characters
To pass the Merchant store information

Optional
Unique id for each API request to prevent duplicate payments.

Optional
Character length and limits: 38 single-byte characters maximum.
This holds key-value pair which merchants wants to pass it to the open wallet-PLCC processor

Optional
The value of a previously authorized transaction identification number returned by a PayPal product. You can obtain a buyer's transaction number from the TransactionID element of the PayerInfo structure returned by GetTransactionDetailsResponse.

Required

Character length and limits: 19 single-byte characters maximum
Amount to reauthorize.

Required

Limitations: Must not exceed $10,000 USD in any currency. No currency symbol. Decimal separator must be a period (.), and the thousands separator must be a comma (,).
Unique id for each API request to prevent duplicate payments.

Optional
Character length and limits: 38 single-byte characters maximum.
A new authorization identification number.

Character length and limits: 19 single-byte characters
Return msgsubid back to merchant
The value of the original authorization identification number returned by a PayPal product.

If you are voiding a transaction that has been reauthorized, use the ID from the original authorization, and not the reauthorization.

Required

Character length and limits: 19 single-byte characters
An informational note about this settlement that is displayed to the payer in email and in transaction history.

Optional

Character length and limits: 255 single-byte characters
Unique id for each API request to prevent duplicate payments.

Optional
Character length and limits: 38 single-byte characters maximum.
The authorization identification number you specified in the request.

Character length and limits: 19 single-byte characters
Return msgsubid back to merchant
The value of the order’s transaction identification number returned by a PayPal product.

Required

Character length and limits: 19 single-byte characters maximum
Type of transaction to authorize. The only allowable value is Order, which means that the transaction represents a customer order that can be fulfilled over 29 days.

Optional
Amount to authorize.

Required

Limitations: Must not exceed $10,000 USD in any currency. No currency symbol. Decimal separator must be a period (.), and the thousands separator must be a comma (,).
Address the order will be shipped to.

Optional

Information about the individual purchased items Sum of cost of all items in this order. You must set the currencyID attribute to one of the three-character currency codes for any of the supported PayPal currencies.

Optional

Limitations: Must not exceed $10,000 USD in any currency. No currency symbol. Decimal separator must be a period (.), and the thousands separator must be a comma (,).
Total shipping costs for this order. You must set the currencyID attribute to one of the three-character currency codes for any of the supported PayPal currencies.

Optional

Limitations: Must not exceed $10,000 USD in any currency. No currency symbol. Decimal separator must be a period (.), and the thousands separator must be a comma (,).
Total handling costs for this order. You must set the currencyID attribute to one of the three-character currency codes for any of the supported PayPal currencies.

Optional

Limitations: Must not exceed $10,000 USD in any currency. No currency symbol. Decimal separator must be a period (.), and the thousands separator must be a comma (,).
Sum of tax for all items in this order. You must set the currencyID attribute to one of the three-character currency codes for any of the supported PayPal currencies.

Optional

Limitations: Must not exceed $10,000 USD in any currency. No currency symbol. Decimal separator must be a period (.), and the thousands separator must be a comma (,).
Total shipping insurance costs for this order.
Optional
Shipping discount for this order, specified as a negative number.
Optional
Description of items the customer is purchasing.

Optional

Character length and limitations: 127 single-byte alphanumeric characters
A free-form field for your own use.

Optional

Character length and limitations: 256 single-byte alphanumeric characters
Unique id for each API request to prevent duplicate payments.

Optional
Character length and limits: 38 single-byte characters maximum.
IP Address of the buyer
An authorization identification number.

Character length and limits: 19 single-byte characters
The amount and currency you specified in the request. Return msgsubid back to merchant
The value of the authorizationâtransaction identification number returned by a PayPal product.

Required

Character length and limits: 19 single-byte characters maximum
Shipping Address for this transaction. IP Address of the buyer
An authorization identification number.

Character length and limits: 19 single-byte characters
UATP card details

Required
Type of transaction to authorize. The only allowable value is Order, which means that the transaction represents a customer order that can be fulfilled over 29 days.

Optional
Amount to authorize.

Required

Limitations: Must not exceed $10,000 USD in any currency. No currency symbol. Decimal separator must be a period (.), and the thousands separator must be a comma (,).
Invoice ID. A pass through. Unique id for each API request to prevent duplicate payments.

Optional
Character length and limits: 38 single-byte characters maximum.
Auth Authorization Code. Invoice ID. A pass through. Unique id for each API request to prevent duplicate payments.

Optional
Character length and limits: 38 single-byte characters maximum.
Indicates whether the phone is activated for mobile payments

Indicates whether the password is enabled for particular account

Indicates whether there is a payment pending from the phone

A timestamped token by which you identify to PayPal that you are processing this payment with Mobile Checkout. The token expires after three hours.

Character length and limitations: 20 single-byte characters
A timestamped token, the value of which was returned by SetMobileCheckoutResponse.

Required

Character length and limitations: 20 single-byte characters
This flag indicates that the response should include FMFDetails The merchant passes in the ExternalRememberMeID to identify the user to opt out. This is a 17-character alphanumeric (encrypted) string that identifies the buyer's remembered login with a merchant and has meaning only to the merchant.

Required

E-mail address or secure merchant account ID of merchant to associate with external remember-me.