C# (CSharp) PayPal.PayPalAPIInterfaceService.Model Namespace

Classes

Name Description
APICredentialsType APICredentialsType
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. Character length and limitations: 32 single-byte alphanumeric characters
AddressVerifyReq
AddressVerifyRequestType Email address of buyer to be verified. Required Maximum string length: 255 single-byte characters Input mask: ?@?.??
AddressVerifyResponseType 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
AirlineItineraryType AID for Airlines
AuctionInfoType AuctionInfoType Basic information about an auction.
AuthorizationInfoType Authorization details
AuthorizationRequestType
AuthorizationResponseType Status will denote whether Auto authorization was successful or not.
BAUpdateRequestType
BAUpdateResponseDetailsType
BAUpdateResponseType
BMButtonSearchReq
BMButtonSearchRequestType The earliest transaction date at which to start the search. No wildcards are allowed. Required
BMButtonSearchResponseType
BMCreateButtonReq
BMCreateButtonRequestType Type of Button to create. Required Must be one of the following: BUYNOW, CART, GIFTCERTIFICATE. SUBSCRIBE, PAYMENTPLAN, AUTOBILLING, DONATE, VIEWCART or UNSUBSCRIBE
BMCreateButtonResponseType
BMGetButtonDetailsReq
BMGetButtonDetailsRequestType Button ID of button to return. Required Character length and limitations: 10 single-byte numeric characters
BMGetButtonDetailsResponseType Type of button. One of the following: BUYNOW, CART, GIFTCERTIFICATE. SUBSCRIBE, PAYMENTPLAN, AUTOBILLING, DONATE, VIEWCART or UNSUBSCRIBE
BMGetInventoryReq
BMGetInventoryRequestType Hosted Button ID of the button to return inventory for. Required Character length and limitations: 10 single-byte numeric characters
BMGetInventoryResponseType
BMLOfferInfoType BMLOfferInfoType Specific information for BML.
BMManageButtonStatusReq
BMManageButtonStatusRequestType Button ID of Hosted button. Required Character length and limitations: 10 single-byte numeric characters
BMManageButtonStatusResponseType
BMSetInventoryReq
BMSetInventoryRequestType Hosted Button ID of button you wish to change. Required Character length and limitations: 10 single-byte numeric characters
BMSetInventoryResponseType
BMUpdateButtonReq
BMUpdateButtonRequestType Hosted Button id of the button to update. Required Character length and limitations: 10 single-byte numeric characters
BMUpdateButtonResponseType
BankAccountDetailsType BankAccountDetailsType
BasicAmountType On requests, you must set the currencyID attribute to one of the three-character currency codes for any of the supported PayPal currencies. 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 (,).
BillAgreementUpdateReq
BillOutstandingAmountReq
BillOutstandingAmountRequestDetailsType
BillOutstandingAmountRequestType
BillOutstandingAmountResponseDetailsType
BillOutstandingAmountResponseType
BillUserReq
BillUserRequestType This flag indicates that the response should include FMFDetails
BillUserResponseType
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
BusinessInfoType BusinessInfoType
BusinessOwnerInfoType BusinessOwnerInfoType
ButtonSearchResultType
BuyerDetailType Information that is used to indentify the Buyer. This is used for auto authorization. Mandatory if Authorization is requested.
BuyerDetailsType Details about the buyer's account passed in by the merchant or partner. Optional.
CancelRecoupReq
CancelRecoupRequestType
CancelRecoupResponseType
CompleteRecoupReq
CompleteRecoupRequestType
CompleteRecoupResponseType
CoupledBucketsType Defines relationship between buckets
CoupledPaymentInfoType Information about Coupled Payment transactions.
CreateBillingAgreementReq
CreateBillingAgreementRequestType
CreateBillingAgreementResponseType
CreateMobilePaymentReq
CreateMobilePaymentRequestDetailsType Type of the payment Required
CreateMobilePaymentRequestType
CreateMobilePaymentResponseType
CreateRecurringPaymentsProfileReq
CreateRecurringPaymentsProfileRequestDetailsType Billing Agreement token (required if Express Checkout)
CreateRecurringPaymentsProfileRequestType
CreateRecurringPaymentsProfileResponseDetailsType Recurring Billing Profile ID
CreateRecurringPaymentsProfileResponseType
CreditCardDetailsType CreditCardDetailsType Information about a Credit Card.
CreditCardNumberTypeType
DeserializationUtils
DeviceDetailsType Device ID Optional Character length and limits: 256 single-byte characters DeviceID length morethan 256 is truncated
DiscountInfoType Describes discount information.
DiscountType Describes discount information
DisplayControlDetailsType Contains elements that allows customization of display (user interface) elements.
DoAuthorizationReq
DoAuthorizationRequestType The value of the order’s transaction identification number returned by a PayPal product. Required Character length and limits: 19 single-byte characters maximum
DoAuthorizationResponseType An authorization identification number. Character length and limits: 19 single-byte characters
DoCancelReq
DoCancelRequestType Msg Sub Id that was used for the orginal operation.
DoCancelResponseType Return msgsubid back to merchant
DoCaptureReq
DoCaptureRequestType The authorization identification number of the payment you want to capture. Required Character length and limits: 19 single-byte characters maximum
DoCaptureResponseDetailsType The authorization identification number you specified in the request. Character length and limits: 19 single-byte characters maximum
DoCaptureResponseType
DoDirectPaymentReq
DoDirectPaymentRequestDetailsType How you want to obtain payment. Required Authorization indicates that this payment is a basic authorization subject to settlement with PayPal Authorization and Capture. Sale indicates that this is a final sale for which you are requesting payment. NOTE: Order is not allowed for Direct Payment. Character length and limit: Up to 13 single-byte alphabetic characters
DoDirectPaymentRequestType This flag indicates that the response should include FMFDetails
DoDirectPaymentResponseType The amount of the payment as specified by you on DoDirectPaymentRequest.
DoExpressCheckoutPaymentReq
DoExpressCheckoutPaymentRequestDetailsType How you want to obtain payment. Required Authorization indicates that this payment is a basic authorization subject to settlement with PayPal Authorization and Capture. Order indicates that this payment is is an order authorization subject to settlement with PayPal Authorization and Capture. Sale indicates that this is a final sale for which you are requesting payment. IMPORTANT: You cannot set PaymentAction to Sale on SetExpressCheckoutRequest and then change PaymentAction to Authorization on the final Express Checkout API, DoExpressCheckoutPaymentRequest. Character length and limit: Up to 13 single-byte alphabetic characters
DoExpressCheckoutPaymentRequestType This flag indicates that the response should include FMFDetails
DoExpressCheckoutPaymentResponseDetailsType The timestamped token value that was returned by SetExpressCheckoutResponse and passed on GetExpressCheckoutDetailsRequest. Character length and limitations:20 single-byte characters
DoExpressCheckoutPaymentResponseType
DoMobileCheckoutPaymentReq
DoMobileCheckoutPaymentRequestType A timestamped token, the value of which was returned by SetMobileCheckoutResponse. RequiredCharacter length and limitations: 20 single-byte characters
DoMobileCheckoutPaymentResponseDetailsType A free-form field for your own use, such as a tracking number or other value you want returned to you in IPN. Optional Character length and limitations: 256 single-byte alphanumeric characters
DoMobileCheckoutPaymentResponseType
DoNonReferencedCreditReq
DoNonReferencedCreditRequestDetailsType
DoNonReferencedCreditRequestType
DoNonReferencedCreditResponseDetailsType
DoNonReferencedCreditResponseType
DoReauthorizationReq
DoReauthorizationRequestType 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
DoReauthorizationResponseType A new authorization identification number. Character length and limits: 19 single-byte characters
DoReferenceTransactionReq
DoReferenceTransactionRequestDetailsType
DoReferenceTransactionRequestType This flag indicates that the response should include FMFDetails
DoReferenceTransactionResponseDetailsType
DoReferenceTransactionResponseType
DoUATPAuthorizationReq
DoUATPAuthorizationRequestType UATP card details Required
DoUATPAuthorizationResponseType Auth Authorization Code.
DoUATPExpressCheckoutPaymentReq
DoUATPExpressCheckoutPaymentRequestType
DoUATPExpressCheckoutPaymentResponseType
DoVoidReq
DoVoidRequestType 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
DoVoidResponseType The authorization identification number you specified in the request. Character length and limits: 19 single-byte characters
EbayItemPaymentDetailsItemType EbayItemPaymentDetailsItemType - Type declaration to be used by other schemas. Information about an Ebay Payment Item.
EnhancedCancelRecoupRequestDetailsType
EnhancedCheckoutDataType
EnhancedCompleteRecoupRequestDetailsType
EnhancedCompleteRecoupResponseDetailsType
EnhancedDataType Enhanced Data Information. Example: AID for Airlines
EnhancedInitiateRecoupRequestDetailsType
EnhancedItemDataType
EnhancedPayerInfoType
EnhancedPaymentDataType Enhanced data for different transactions.
EnhancedPaymentInfoType
EnterBoardingReq
EnterBoardingRequestDetailsType Onboarding program code given to you by PayPal. Required Character length and limitations: 64 alphanumeric characters
EnterBoardingRequestType
EnterBoardingResponseType 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
EnumUtils Utility class for Enums with descriptions
ErrorParameterType Value of the application-specific error parameter.
ErrorType Error code can be used by a receiving application to debugging a response message. These codes will need to be uniquely defined for each application.
ExecuteCheckoutOperationsReq
ExecuteCheckoutOperationsRequestDetailsType On your first invocation of ExecuteCheckoutOperationsRequest, the value of this token is returned by ExecuteCheckoutOperationsResponse. Optional Include this element and its value only if you want to modify an existing checkout session with another invocation of ExecuteCheckoutOperationsRequest; for example, if you want the customer to edit his shipping address on PayPal. Character length and limitations: 20 single-byte characters
ExecuteCheckoutOperationsRequestType
ExecuteCheckoutOperationsResponseDetailsType
ExecuteCheckoutOperationsResponseType
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.
ExternalRememberMeOptOutReq
ExternalRememberMeOptOutRequestType 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
ExternalRememberMeOptOutResponseType
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.
FMFDetailsType Thes are filters that could result in accept/deny/pending action.
FlightDetailsType Details of leg information
FlowControlDetailsType An optional set of values related to flow-specific details.
FundingSourceDetailsType Allowable values: 0,1 The value 1 indicates that the customer can accept push funding, and 0 means they cannot. Optional Character length and limitations: One single-byte numeric character.
GetAccessPermissionDetailsReq
GetAccessPermissionDetailsRequestType A timestamped token, the value of which was returned by SetAuthFlowParam Response. Required Character length and limitations: 20 single-byte characters
GetAccessPermissionDetailsResponseDetailsType The first name of the User. Character length and limitations: 127 single-byte alphanumeric characters
GetAccessPermissionDetailsResponseType
GetAuthDetailsReq
GetAuthDetailsRequestType A timestamped token, the value of which was returned by SetAuthFlowParam Response. RequiredCharacter length and limitations: 20 single-byte characters
GetAuthDetailsResponseDetailsType The first name of the User. Character length and limitations: 127 single-byte alphanumeric characters
GetAuthDetailsResponseType
GetBalanceReq
GetBalanceRequestType
GetBalanceResponseType
GetBillingAgreementCustomerDetailsReq
GetBillingAgreementCustomerDetailsRequestType
GetBillingAgreementCustomerDetailsResponseDetailsType
GetBillingAgreementCustomerDetailsResponseType
GetBoardingDetailsReq
GetBoardingDetailsRequestType A unique token returned by the EnterBoarding API call that identifies this boarding session. RequiredCharacter length and limitations: 64 alphanumeric characters. The token has the following format:OB-61characterstring
GetBoardingDetailsResponseDetailsType Status of merchant's onboarding process: CompletedCancelledPending Character length and limitations: Eight alphabetic characters
GetBoardingDetailsResponseType
GetExpressCheckoutDetailsReq
GetExpressCheckoutDetailsRequestType A timestamped token, the value of which was returned by SetExpressCheckoutResponse. RequiredCharacter length and limitations: 20 single-byte characters
GetExpressCheckoutDetailsResponseDetailsType The timestamped token value that was returned by SetExpressCheckoutResponse and passed on GetExpressCheckoutDetailsRequest. Character length and limitations: 20 single-byte characters
GetExpressCheckoutDetailsResponseType
GetIncentiveEvaluationReq
GetIncentiveEvaluationRequestDetailsType
GetIncentiveEvaluationRequestType
GetIncentiveEvaluationResponseDetailsType
GetIncentiveEvaluationResponseType
GetMobileStatusReq
GetMobileStatusRequestDetailsType Phone number for status inquiry
GetMobileStatusRequestType
GetMobileStatusResponseType Indicates whether the phone is activated for mobile payments
GetPalDetailsReq
GetPalDetailsRequestType
GetPalDetailsResponseType
GetRecurringPaymentsProfileDetailsReq
GetRecurringPaymentsProfileDetailsRequestType
GetRecurringPaymentsProfileDetailsResponseDetailsType Recurring Billing Profile ID
GetRecurringPaymentsProfileDetailsResponseType
GetTransactionDetailsReq
GetTransactionDetailsRequestType Unique identifier of a transaction. RequiredThe 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
GetTransactionDetailsResponseType
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
IncentiveDetailType
IncentiveDetailsType Information about the incentives that were applied from Ebay RYP page and PayPal RYP page.
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
InitiateRecoupReq
InitiateRecoupRequestType
InitiateRecoupResponseType
InstallmentDetailsType Installment Period. Optional
InstrumentDetailsType InstrumentDetailsType Promotional Instrument Information.
InvoiceItemType Describes an individual item for an invoice.
ItemTrackingDetailsType Item Number. Required
ManagePendingTransactionStatusReq
ManagePendingTransactionStatusRequestType
ManagePendingTransactionStatusResponseType
ManageRecurringPaymentsProfileStatusReq
ManageRecurringPaymentsProfileStatusRequestDetailsType
ManageRecurringPaymentsProfileStatusRequestType
ManageRecurringPaymentsProfileStatusResponseDetailsType
ManageRecurringPaymentsProfileStatusResponseType
MassPayReq
MassPayRequestItemType MassPayRequestItemType
MassPayRequestType 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
MassPayResponseType
MeasureType
MerchantDataType This holds all key-value pairs which merchants wants to pass it to the open wallet(PLCC) processor.
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.
OptionDetailsType Option Name. Optional
OptionSelectionDetailsType Option Selection. Required Character length and limitations: 12 single-byte alphanumeric characters
OptionTrackingDetailsType Option Number. Optional
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. Money Order. Optional.
PayeeInfoType PayeeInfoType Payee Information
PayerInfoType PayerInfoType Payer information
PaymentDetailsItemType PaymentDetailsItemType Information about a Payment Item.
PaymentDetailsType PaymentDetailsType Information about a payment. Used by DCC and Express Checkout.
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
RefundTransactionReq
RefundTransactionRequestType Unique identifier of the transaction you are refunding. Optional Character length and limitations: 17 single-byte alphanumeric characters
RefundTransactionResponseType Unique transaction ID of the refund. Character length and limitations:17 single-byte characters
RememberMeIDInfoType External remember-me ID returned by GetExpressCheckoutDetails on successful opt-in. The ExternalRememberMeID is a 17-character alphanumeric (encrypted) string that identifies the buyer's remembered login with a merchant and has meaning only to the merchant. If present, requests that the web flow attempt bypass of login.
ReverseTransactionReq
ReverseTransactionRequestDetailsType Identifier of the transaction to reverse. Required Character length and limitations: 17 single-byte alphanumeric characters
ReverseTransactionRequestType
ReverseTransactionResponseDetailsType Unique transaction identifier of the reversal transaction created. Character length and limitations:17 single-byte characters
ReverseTransactionResponseType
RiskFilterDetailsType Details of Risk Filter.
RiskFilterListType Details of Risk Filter.
ScheduleDetailsType Schedule details for the Recurring Payment
SellerDetailsType Details about the seller.
SenderDetailsType
SetAccessPermissionsReq
SetAccessPermissionsRequestDetailsType URL to which the customer's browser is returned after choosing to login with PayPal. Required Character length and limitations: no limit.
SetAccessPermissionsRequestType
SetAccessPermissionsResponseType 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
SetAuthFlowParamReq
SetAuthFlowParamRequestDetailsType URL to which the customer's browser is returned after choosing to login with PayPal. Required Character length and limitations: no limit.
SetAuthFlowParamRequestType
SetAuthFlowParamResponseType 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
SetCustomerBillingAgreementReq
SetCustomerBillingAgreementRequestDetailsType
SetCustomerBillingAgreementRequestType
SetCustomerBillingAgreementResponseType
SetDataRequestType Details about Billing Agreements requested to be created.
SetDataResponseType If Checkout session was initialized successfully, the corresponding token is returned in this element.
SetExpressCheckoutReq
SetExpressCheckoutRequestDetailsType The total cost of the order to the customer. If shipping cost and tax charges are known, include them in OrderTotal; if not, OrderTotal should be the current sub-total of the order. You must set the currencyID attribute to one of the three-character currency codes for any of the supported PayPal currencies. 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 (,).
SetExpressCheckoutRequestType
SetExpressCheckoutResponseType 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
SetMobileCheckoutReq
SetMobileCheckoutRequestDetailsType The phone number of the buyer's mobile device, if available. Optional
SetMobileCheckoutRequestType
SetMobileCheckoutResponseType 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
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. Optional.
ThreeDSecureInfoType 3DSecureInfoType Information about 3D Secure parameters.
ThreeDSecureRequestType The Common 3DS fields. Common for both GTD and DCC API's.
ThreeDSecureResponseType 3DS remaining fields.
TransactionSearchReq
TransactionSearchRequestType The earliest transaction date at which to start the search. No wildcards are allowed. Required
TransactionSearchResponseType Results of a Transaction Search.
TupleType This holds single key-value pair.
UATPDetailsType UATP Card Details Type
UpdateAccessPermissionsReq
UpdateAccessPermissionsRequestType Unique PayPal customer account number, the value of which was returned by GetAuthDetails Response. Required Character length and limitations: 20 single-byte characters
UpdateAccessPermissionsResponseType The status of the update call, Success/Failure. Character length and limitations: 20 single-byte characters
UpdateAuthorizationReq
UpdateAuthorizationRequestType The value of the authorizationâtransaction identification number returned by a PayPal product. Required Character length and limits: 19 single-byte characters maximum
UpdateAuthorizationResponseType An authorization identification number. Character length and limits: 19 single-byte characters
UpdateRecurringPaymentsProfileReq
UpdateRecurringPaymentsProfileRequestDetailsType
UpdateRecurringPaymentsProfileRequestType
UpdateRecurringPaymentsProfileResponseDetailsType
UpdateRecurringPaymentsProfileResponseType
UserSelectedOptionType Information on user selected options
WalletItemsType Details about an Item stored in the PayPal Wallet.