|
Class Summary |
| AbstractRequestType |
Base type definition of request payload that can carry any
type of payload content with optional versioning information
and detail level requirements. |
| AbstractResponseType |
Base type definition of a response payload that can carry
any type of payload content with following optional
elements: - timestamp of response message, - application
level acknowledgement, and - application-level errors and
warnings. |
| ActivationDetailsType |
|
| AdditionalFeeType |
|
| AddressType |
Person's name associated with this address. |
| AirlineItineraryType |
AID for Airlines |
| APICredentialsType |
APICredentialsType |
| AuctionInfoType |
AuctionInfoType Basic information about an auction. |
| AuthorizationInfoType |
Authorization details |
| AuthorizationRequestType |
|
| AuthorizationResponseType |
Status will denote whether Auto authorization was successful
or not. |
| BankAccountDetailsType |
BankAccountDetailsType |
| BAUpdateResponseDetailsType |
|
| BillingAgreementDetailsType |
|
| BillingApprovalDetailsType |
The Type of Approval requested - Billing Agreement or
Profile |
| BillingPeriodDetailsType |
Unit of meausre for billing cycle |
| BillingPeriodDetailsType_Update |
Unit of meausre for billing cycle |
| BillOutstandingAmountRequestDetailsType |
|
| BillOutstandingAmountResponseDetailsType |
|
| BMLOfferInfoType |
BMLOfferInfoType Specific information for BML. |
| BusinessInfoType |
BusinessInfoType |
| BusinessOwnerInfoType |
BusinessOwnerInfoType |
| ButtonSearchResultType |
|
| BuyerDetailsType |
Details about the buyer's account passed in by the merchant
or partner. |
| BuyerDetailType |
Information that is used to indentify the Buyer. |
| CoupledBucketsType |
Defines relationship between buckets |
| CoupledPaymentInfoType |
Information about Coupled Payment transactions. |
| CreateMobilePaymentRequestDetailsType |
Type of the payment Required |
| CreateRecurringPaymentsProfileRequestDetailsType |
Billing Agreement token (required if Express Checkout) |
| CreateRecurringPaymentsProfileResponseDetailsType |
Recurring Billing Profile ID |
| CreditCardDetailsType |
CreditCardDetailsType Information about a Credit Card. |
| CreditCardNumberTypeType |
|
| DeviceDetailsType |
Device ID Optional Character length and limits: 256
single-byte characters DeviceID length morethan 256 is
truncated |
| DiscountType |
Describes discount information |
| DisplayControlDetailsType |
Contains elements that allows customization of display (user
interface) elements. |
| DoCaptureResponseDetailsType |
The authorization identification number you specified in the
request. |
| DoDirectPaymentRequestDetailsType |
How you want to obtain payment. |
| DoExpressCheckoutPaymentRequestDetailsType |
How you want to obtain payment. |
| DoExpressCheckoutPaymentResponseDetailsType |
The timestamped token value that was returned by
SetExpressCheckoutResponse and passed on
GetExpressCheckoutDetailsRequest. |
| DoMobileCheckoutPaymentResponseDetailsType |
A free-form field for your own use, such as a tracking
number or other value you want returned to you in IPN. |
| DoNonReferencedCreditRequestDetailsType |
|
| DoNonReferencedCreditResponseDetailsType |
|
| DoReferenceTransactionRequestDetailsType |
|
| DoReferenceTransactionResponseDetailsType |
|
| EbayItemPaymentDetailsItemType |
EbayItemPaymentDetailsItemType - Type declaration to be used
by other schemas. |
| EnhancedDataType |
Enhanced Data Information. |
| EnterBoardingRequestDetailsType |
Onboarding program code given to you by PayPal. |
| ErrorParameterType |
Value of the application-specific error parameter. |
| ErrorType |
Error code can be used by a receiving application to
debugging a response message. |
| ExecuteCheckoutOperationsRequestDetailsType |
On your first invocation of
ExecuteCheckoutOperationsRequest, the value of this token is
returned by ExecuteCheckoutOperationsResponse. |
| ExecuteCheckoutOperationsResponseDetailsType |
|
| ExternalPartnerTrackingDetailsType |
Contains elements that allow tracking for an external
partner. |
| ExternalRememberMeOptInDetailsType |
This element contains information that allows the merchant
to request to opt into external remember me on behalf of the
buyer or to request login bypass using external remember me. |
| ExternalRememberMeOwnerDetailsType |
E-mail address or secure merchant account ID of merchant to
associate with new external remember-me. |
| ExternalRememberMeStatusDetailsType |
Response information resulting from opt-in operation or
current login bypass status. |
| FlightDetailsType |
Details of leg information |
| FlowControlDetailsType |
An optional set of values related to flow-specific details. |
| FMFDetailsType |
Thes are filters that could result in accept/deny/pending
action. |
| FundingSourceDetailsType |
Allowable values: 0,1 The value 1 indicates that the
customer can accept push funding, and 0 means they cannot. |
| GetAccessPermissionDetailsResponseDetailsType |
The first name of the User. |
| GetAuthDetailsResponseDetailsType |
The first name of the User. |
| GetBillingAgreementCustomerDetailsResponseDetailsType |
|
| GetBoardingDetailsResponseDetailsType |
Status of merchant's onboarding process:
CompletedCancelledPending Character length and limitations:
Eight alphabetic characters |
| GetExpressCheckoutDetailsResponseDetailsType |
The timestamped token value that was returned by
SetExpressCheckoutResponse and passed on
GetExpressCheckoutDetailsRequest. |
| GetIncentiveEvaluationRequestDetailsType |
|
| GetIncentiveEvaluationResponseDetailsType |
|
| GetMobileStatusRequestDetailsType |
Phone number for status inquiry |
| GetRecurringPaymentsProfileDetailsResponseDetailsType |
Recurring Billing Profile ID |
| IdentificationInfoType |
Mobile specific buyer identification. |
| IdentityTokenInfoType |
Identity Access token from merchant |
| IncentiveAppliedDetailsType |
Details of incentive application on individual bucket/item. |
| IncentiveAppliedToType |
|
| IncentiveApplyIndicationType |
Defines which bucket or item that the incentive should be
applied to. |
| IncentiveBucketType |
|
| IncentiveDetailsType |
Information about the incentives that were applied from Ebay
RYP page and PayPal RYP page. |
| IncentiveDetailType |
|
| IncentiveInfoType |
Details of incentive application on individual bucket. |
| IncentiveItemType |
|
| IncentiveRequestDetailsType |
|
| InfoSharingDirectivesType |
If Billing Address should be returned in
GetExpressCheckoutDetails response, this parameter should be
set to yes here |
| InstrumentDetailsType |
InstrumentDetailsType Promotional Instrument Information. |
| InvoiceItemType |
Describes an individual item for an invoice. |
| ItemTrackingDetailsType |
Item Number. |
| ManageRecurringPaymentsProfileStatusRequestDetailsType |
|
| ManageRecurringPaymentsProfileStatusResponseDetailsType |
|
| MerchantPullInfoType |
MerchantPullInfoType Information about the merchant pull. |
| MerchantPullPaymentResponseType |
MerchantPullPaymentResponseType Response data from the
merchant pull. |
| MerchantPullPaymentType |
MerchantPullPayment Parameters to make initiate a pull
payment |
| MerchantStoreDetailsType |
Store IDOptional Character length and limits: 50 single-byte
characters |
| MobileIDInfoType |
The Session token returned during buyer authentication. |
| OfferCouponInfoType |
OffersAndCouponsInfoType Information about a Offers and
Coupons. |
| OfferDetailsType |
OfferDetailsType Specific information for an offer. |
| OptionTrackingDetailsType |
Option Number. |
| OptionType |
OptionType PayPal item options for shopping cart. |
| OrderDetailsType |
Description of the Order. |
| OtherPaymentMethodDetailsType |
Lists the Payment Methods (other than PayPal) that the use
can pay with e.g. |
| PayerInfoType |
PayerInfoType Payer information |
| PaymentDetailsItemType |
PaymentDetailsItemType Information about a Payment Item. |
| PaymentDetailsType |
PaymentDetailsType Information about a payment. |
| PaymentDirectivesType |
Type of the Payment is it Instant or Echeck or Any. |
| PaymentInfoType |
PaymentInfoType Payment information. |
| PaymentItemInfoType |
PaymentItemInfoType Information about a PayPal item. |
| PaymentItemType |
PaymentItemType Information about a Payment Item. |
| PaymentRequestInfoType |
Contains payment request information for each bucket in the
cart. |
| PaymentTransactionSearchResultType |
PaymentTransactionSearchResultType Results from a
PaymentTransaction search |
| PaymentTransactionType |
PaymentTransactionType Information about a PayPal payment
from the seller side |
| PersonNameType |
|
| PhoneNumberType |
Country code associated with this phone number. |
| ReceiverInfoType |
ReceiverInfoType Receiver information. |
| RecurringPaymentsProfileDetailsType |
Subscriber name - if missing, will use name in buyer's
account |
| RecurringPaymentsSummaryType |
|
| ReferenceCreditCardDetailsType |
CreditCardDetailsType for DCC Reference Transaction
Information about a Credit Card. |
| RefreshTokenStatusDetailsType |
Response information resulting from opt-in operation or
current login bypass status. |
| RefundInfoType |
Holds refunds payment status information |
| RememberMeIDInfoType |
External remember-me ID returned by
GetExpressCheckoutDetails on successful opt-in. |
| ReverseTransactionRequestDetailsType |
Identifier of the transaction to reverse. |
| ReverseTransactionResponseDetailsType |
Unique transaction identifier of the reversal transaction
created. |
| RiskFilterDetailsType |
Details of Risk Filter. |
| RiskFilterListType |
Details of Risk Filter. |
| ScheduleDetailsType |
Schedule details for the Recurring Payment |
| SellerDetailsType |
Details about the seller. |
| SenderDetailsType |
|
| SetAccessPermissionsRequestDetailsType |
URL to which the customer's browser is returned after
choosing to login with PayPal. |
| SetAuthFlowParamRequestDetailsType |
URL to which the customer's browser is returned after
choosing to login with PayPal. |
| SetCustomerBillingAgreementRequestDetailsType |
|
| SetDataRequestType |
Details about Billing Agreements requested to be created. |
| SetDataResponseType |
If Checkout session was initialized successfully, the
corresponding token is returned in this element. |
| SetExpressCheckoutRequestDetailsType |
The total cost of the order to the customer. |
| SetMobileCheckoutRequestDetailsType |
The phone number of the buyer's mobile device, if available. |
| ShippingOptionType |
Fallback shipping options type. |
| SubscriptionInfoType |
SubscriptionInfoType Information about a PayPal
Subscription. |
| SubscriptionTermsType |
SubscriptionTermsType Terms of a PayPal subscription. |
| TaxIdDetailsType |
Details about the payer's tax info passed in by the merchant
or partner. |
| ThreeDSecureInfoType |
3DSecureInfoType Information about 3D Secure parameters. |
| ThreeDSecureRequestType |
The Common 3DS fields. |
| ThreeDSecureResponseType |
3DS remaining fields. |
| UATPDetailsType |
UATP Card Details Type |
| UpdateRecurringPaymentsProfileRequestDetailsType |
|
| UpdateRecurringPaymentsProfileResponseDetailsType |
|
| UserSelectedOptionType |
Information on user selected options |
|
Enum Summary |
| AckCodeType |
AckCodeType
This code identifies the acknowledgement code types that
could be used to communicate the status of processing a
(request) message to an application. |
| AddressNormalizationStatusCodeType |
Normalization Status of the Address |
| AddressOwnerCodeType |
AddressOwnerCodeType
This code identifies the AddressOwner code types which
indicates
who owns the user'a address. |
| AddressStatusCodeType |
AddressStatusCodeType
This is the PayPal address status |
| AllowedPaymentMethodType |
AllowedPaymentMethodType
This is the payment Solution merchant needs to specify for
Autopay (used by Express Checkout)
Optional
Default indicates that its merchant supports all funding
source
InstantPaymentOnly indicates that its merchant only
supports instant payment
AnyFundingSource allow all funding methods to be chosen by
the buyer irrespective of merchant's profile setting
InstantFundingSource allow only instant funding methods,
block echeck, meft, elevecheck. |
| APIAuthenticationType |
API Authentication Type |
| APIType |
Supported API Types for DoCancel operation |
| ApprovalSubTypeType |
|
| ApprovalTypeType |
|
| AutoBillType |
|
| AverageMonthlyVolumeType |
AverageMonthlyVolumeType
Enumeration
Meaning
AverageMonthlyVolume-Not-Applicable
AverageMonthlyVolume-Range1
Less than $1,000 USD
AverageMonthlyVolume-Range2
$1,000 USD to $5,000 USD
AverageMonthlyVolume-Range3
$5,000 USD to $25,000 USD
AverageMonthlyVolume-Range4
$25,000 USD to $100,000 USD
AverageMonthlyVolume-Range5
$100,000 USD to $1,000,000 USD
AverageMonthlyVolume-Range6
More than $1,000,000 USD |
| AverageTransactionPriceType |
AverageTransactionPriceType
Enumeration
Meaning
AverageTransactionPrice-Not-Applicable
AverageTransactionPrice-Range1
Less than $25 USD
AverageTransactionPrice-Range2
$25 USD to $50 USD
AverageTransactionPrice-Range3
$50 USD to $100 USD
AverageTransactionPrice-Range4
$100 USD to $250 USD
AverageTransactionPrice-Range5
$250 USD to $500 USD
AverageTransactionPrice-Range6
$500 USD to $1,000 USD
AverageTransactionPrice-Range7
$1,000 USD to $2,000 USD
AverageTransactionPrice-Range8
$2,000 USD to $5,000 USD
AverageTransactionPrice-Range9
$5,000 USD to $10,000 USD
AverageTransactionPrice-Range10
More than $10,000 USD |
| BankAccountTypeType |
BankAccountTypeType |
| BillingCodeType |
|
| BillingPeriodType |
|
| BoardingStatusType |
Boarding Status |
| BusinessCategoryType |
BusinessCategoryType |
| BusinessSubCategoryType |
BusinessSubCategoryType |
| BusinessTypeType |
BusinessTypeType |
| ButtonCodeType |
Types of button coding |
| ButtonImageType |
Types of button images |
| ButtonStatusType |
values for subscribe button text |
| ButtonSubTypeType |
Types of button sub types |
| ButtonTypeType |
Types of buttons |
| BuyNowTextType |
values for buynow button text |
| ChannelType |
ChannelType - Type declaration to be used by other schemas. |
| CompleteCodeType |
CompleteCodeType
This is the PayPal DoCapture CompleteType code |
| CountryCodeType |
CountryCodeType
This code list module defines the enumerated types
of standard 2-letter ISO 3166 country codes. |
| CoupleType |
Defines couple relationship type between buckets |
| CreditCardTypeType |
Type declaration to be used by other schemas. |
| CurrencyCodeType |
ISO 4217 standard 3-letter currency code. |
| DetailLevelCodeType |
DetailLevelCodeType |
| FailedPaymentActionType |
|
| FMFPendingTransactionActionType |
This is various actions that a merchant can take on a FMF
Pending Transaction. |
| IncentiveAppliedStatusType |
This defines if the incentive is applied successfully or
not. |
| IncentiveRequestCodeType |
IncentiveRequestType
This identifies the type of request for the API call. |
| IncentiveRequestDetailLevelCodeType |
IncentiveRequestDetailLevelType
This identifies the granularity of information requested by
the client application. |
| IncentiveSiteAppliedOnType |
This defines if the incentive is applied on Ebay or PayPal. |
| IncentiveTypeCodeType |
IncentiveType
This identifies the type of INCENTIVE for the redemption
code. |
| ItemCategoryType |
|
| LandingPageType |
LandingPageType
This is the PayPal payment Landing Page details type (used
by Express Checkout) |
| MarketingCategoryType |
MarketingCategoryType |
| MatchStatusCodeType |
MatchStatusCodeType
This is the PayPal (street/zip) match code |
| MerchantPullPaymentCodeType |
MerchantPullPaymentCodeType
Type of Payment to be initiated by the merchant |
| MerchantPullStatusCodeType |
MerchantPullStatusCodeType
Status of the merchant pull |
| MobilePaymentCodeType |
MobilePaymentCodeType
These are the accepted types of mobile payments |
| MobileRecipientCodeType |
MobileRecipientCodeType
These are the accepted types of recipients for
mobile-originated transactions |
| OptionTypeListType |
|
| PaymentActionCodeType |
PaymentDetailsCodeType
This is the PayPal payment details type (used by DCC and
Express Checkout) |
| PaymentCategoryType |
Category of payment like international shipping |
| PaymentCodeType |
PaymentCodeType
This is the type of PayPal payment which matches the output
from IPN. |
| PaymentReasonType |
PaymentReasonType
This is the Payment Reason type (used by DoRT and SetEC for
Refund of PI transaction, eBay return shipment, external
dispute) |
| PaymentStatusCodeType |
PaymentStatusCodeType
This is the status of a PayPal Payment which matches the
output from IPN |
| PaymentTransactionClassCodeType |
PaymentTransactionClassCodeType
The Type of PayPal payment. |
| PaymentTransactionCodeType |
PaymentTransactionCodeType
This is the type of a PayPal of which matches the output
from IPN |
| PaymentTransactionStatusCodeType |
PaymentTransactionStatusCodeType
The status of the PayPal payment. |
| PayPalUserStatusCodeType |
PayPalUserStatusCodeType
PayPal status of a user Address |
| PendingStatusCodeType |
PendingStatusCodeType
The pending status for a PayPal Payment transaction which
matches the output from IPN |
| PercentageRevenueFromOnlineSalesType |
PercentageRevenueFromOnlineSalesType
Enumeration
Meaning
PercentageRevenueFromOnlineSales-Not-Applicable
PercentageRevenueFromOnlineSales-Range1
Less than 25%
PercentageRevenueFromOnlineSales-Range2
25% to 50%
PercentageRevenueFromOnlineSales-Range3
50% to 75%
PercentageRevenueFromOnlineSales-Range4
75% to 100% |
| POSTransactionCodeType |
POSTransactionCodeType
POS Transaction Code Type. |
| ProductCategoryType |
|
| ReceiverInfoCodeType |
ReceiverInfoCodeType
Payee identifier type for MassPay API |
| RecurringFlagType |
|
| RecurringPaymentsProfileStatusType |
|
| RedeemedOfferType |
|
| RefundSourceCodeType |
RefundSourceCodeType
This is the type of PayPal funding source that can be used
for auto refund. |
| RefundType |
RefundType - Type declaration to be used by other
schema. |
| ReversalReasonCodeType |
ReversalReasonCodeType
Reason for a reversal on a PayPal transaction which matches
the output from IPN |
| SalesVenueType |
SalesVenueType |
| SeverityCodeType |
SeverityCodeType
This code identifies the Severity code types in terms of
whether
there is an API-level error or warning that needs to be
communicated
to the client. |
| ShippingServiceCodeType |
ShippingServiceCodeType
These are the possible codes to describe insurance
option as part of shipping
service. |
| SolutionTypeType |
SolutionTypeType
This is the PayPal payment Solution details type (used by
Express Checkout) |
| StatusChangeActionType |
|
| SubscribeTextType |
values for subscribe button text |
| TotalType |
TotalType - Type declaration for the label to be displayed
in MiniCart for UX. |
| TransactionEntityType |
TransactionEntityType
This is the PayPal DoAuthorization TransactionEntityType
code |
| UnitOfMeasure |
Based on NRF-ARTS Specification for Units of Measure |
| UserSelectedFundingSourceType |
UserSelectedFundingSourceType
User Selected Funding Source (used by Express Checkout) |
| UserWithdrawalLimitTypeType |
User Withdrawal Limit Type Type |