PayPal.xml
|
<?xml version="1.0"?>
<doc> <assembly> <name>PayPal</name> </assembly> <members> <member name="T:PayPal.Api.APIContext"> <summary> APIContext is used when making HTTP calls to the PayPal REST API. </summary> </member> <member name="M:PayPal.Api.APIContext.#ctor"> <summary> Initializes a new instance of <seealso cref="T:PayPal.Api.APIContext"/> that is used when making HTTP calls to the PayPal REST API. </summary> </member> <member name="M:PayPal.Api.APIContext.#ctor(System.String)"> <summary> Initializes a new instance of <seealso cref="T:PayPal.Api.APIContext"/> that is used when making HTTP calls to the PayPal REST API; as well as sets and verifies the state of an <paramref name="accessToken"/>. </summary> <param name="accessToken">OAuth access token to use when making API requests</param> </member> <member name="M:PayPal.Api.APIContext.#ctor(System.String,System.String)"> <summary> Initializes a new instance of <seealso cref="T:PayPal.Api.APIContext"/> that is used when making HTTP calls to the PayPal REST API; as well as sets and verifies the states of an <paramref name="accessToken"/> and <paramref name="requestId"/>. </summary> <param name="accessToken">OAuth access token to use when making API requests</param> <param name="requestId">ID used for ensuring idempotency when making a REST API call</param> </member> <member name="P:PayPal.Api.APIContext.AccessToken"> <summary> Gets or sets the OAuth access token to use when making API requests. </summary> </member> <member name="P:PayPal.Api.APIContext.MaskRequestId"> <summary> Gets or sets whether or not the PayPal-Request-Id header will be set when making API requests, which is used for ensuring idempotency when making API calls. </summary> </member> <member name="P:PayPal.Api.APIContext.RequestId"> <summary> Gets or sets the request ID used for ensuring idempotency when making a REST API call. </summary> </member> <member name="P:PayPal.Api.APIContext.Config"> <summary> Gets or sets the PayPal configuration settings to be used when making API requests. </summary> </member> <member name="P:PayPal.Api.APIContext.HTTPHeaders"> <summary> Gets or sets the HTTP headers to include when making HTTP requests to the API. </summary> </member> <member name="P:PayPal.Api.APIContext.SdkVersion"> <summary> Gets or sets the SDK version to include in the User-Agent header. </summary> </member> <member name="M:PayPal.Api.APIContext.ResetRequestId"> <summary> Resets the request ID used for ensuring idempotency when making a REST API call. </summary> </member> <member name="M:PayPal.Api.APIContext.GetConfigWithDefaults"> <summary> Gets the stored configuration and merges it with the application's default config. </summary> <returns></returns> </member> <member name="T:PayPal.Api.Address"> <summary> Base Address object used as billing address in a payment or extended for Shipping Address. <para> See <a href="https://developer.paypal.com/docs/api/">PayPal Developer documentation</a> for more information. </para> </summary> </member> <member name="P:PayPal.Api.Address.phone"> <summary> Phone number in E.123 format. 50 characters max. </summary> </member> <member name="P:PayPal.Api.Address.normalization_status"> <summary> Address normalization status, returned only for payers from Brazil. </summary> </member> <member name="P:PayPal.Api.Address.status"> <summary> Address status </summary> </member> <member name="P:PayPal.Api.Address.type"> <summary> Type of address (e.g., HOME_OR_WORK, GIFT etc). </summary> </member> <member name="T:PayPal.Api.Agreement"> <summary> A REST API billing agreement resource. <para> See <a href="https://developer.paypal.com/docs/api/">PayPal Developer documentation</a> for more information. </para> </summary> </member> <member name="P:PayPal.Api.Agreement.id"> <summary> Identifier of the agreement. </summary> </member> <member name="P:PayPal.Api.Agreement.state"> <summary> State of the agreement. </summary> </member> <member name="P:PayPal.Api.Agreement.name"> <summary> Name of the agreement. </summary> </member> <member name="P:PayPal.Api.Agreement.description"> <summary> Description of the agreement. </summary> </member> <member name="P:PayPal.Api.Agreement.start_date"> <summary> Start date of the agreement. Date format yyyy-MM-dd z, as defined in [ISO8601](http://tools.ietf.org/html/rfc3339#section-5.6). </summary> </member> <member name="P:PayPal.Api.Agreement.agreement_details"> <summary> Details of the agreement. </summary> </member> <member name="P:PayPal.Api.Agreement.payer"> <summary> Details of the buyer who is enrolling in this agreement. This information is gathered from execution of the approval URL. </summary> </member> <member name="P:PayPal.Api.Agreement.shipping_address"> <summary> Shipping address object of the agreement, which should be provided if it is different from the default address. </summary> </member> <member name="P:PayPal.Api.Agreement.override_merchant_preferences"> <summary> Default merchant preferences from the billing plan are used, unless override preferences are provided here. </summary> </member> <member name="P:PayPal.Api.Agreement.override_charge_models"> <summary> Array of override_charge_model for this agreement if needed to change the default models from the billing plan. </summary> </member> <member name="P:PayPal.Api.Agreement.plan"> <summary> Plan details for this agreement. </summary> </member> <member name="P:PayPal.Api.Agreement.create_time"> <summary> Date and time that this resource was created. Date format yyyy-MM-dd z, as defined in [ISO8601](http://tools.ietf.org/html/rfc3339#section-5.6). </summary> </member> <member name="P:PayPal.Api.Agreement.update_time"> <summary> Date and time that this resource was updated. Date format yyyy-MM-dd z, as defined in [ISO8601](http://tools.ietf.org/html/rfc3339#section-5.6). </summary> </member> <member name="P:PayPal.Api.Agreement.token"> <summary> Get or sets the token found in the approval_url link returned from a call to create this resource. </summary> </member> <member name="M:PayPal.Api.Agreement.Create(PayPal.Api.APIContext)"> <summary> Create a new billing agreement by passing the details for the agreement, including the name, description, start date, payer, and billing plan in the request JSON. </summary> <param name="apiContext">APIContext used for the API call.</param> <returns>Agreement</returns> </member> <member name="M:PayPal.Api.Agreement.Create(PayPal.Api.APIContext,PayPal.Api.Agreement)"> <summary> Create a new billing agreement by passing the details for the agreement, including the name, description, start date, payer, and billing plan in the request JSON. </summary> <param name="apiContext">APIContext used for the API call.</param> <param name="agreement">The Agreement object to be used when creating the PayPal resource.</param> <returns>Agreement</returns> </member> <member name="M:PayPal.Api.Agreement.Execute(PayPal.Api.APIContext)"> <summary> Execute a billing agreement after buyer approval by passing the payment token to the request URI. </summary> <param name="apiContext">APIContext used for the API call.</param> <returns>Agreement</returns> </member> <member name="M:PayPal.Api.Agreement.Execute(PayPal.Api.APIContext,System.String)"> <summary> Execute a billing agreement after buyer approval by passing the payment token to the request URI. </summary> <param name="apiContext">APIContext used for the API call.</param> <param name="token">Payment token received after buyer approval of the billing agreement.</param> <returns>Agreement</returns> </member> <member name="M:PayPal.Api.Agreement.Get(PayPal.Api.APIContext,System.String)"> <summary> Retrieve details for a particular billing agreement by passing the ID of the agreement to the request URI. </summary> <param name="apiContext">APIContext used for the API call.</param> <param name="agreementId">Identifier of the agreement resource to retrieve.</param> <returns>Agreement</returns> </member> <member name="M:PayPal.Api.Agreement.Update(PayPal.Api.APIContext,PayPal.Api.PatchRequest)"> <summary> Update details of a billing agreement, such as the description, shipping address, and start date, by passing the ID of the agreement to the request URI. </summary> <param name="apiContext">APIContext used for the API call.</param> <param name="patchRequest">PatchRequest</param> </member> <member name="M:PayPal.Api.Agreement.Update(PayPal.Api.APIContext,System.String,PayPal.Api.PatchRequest)"> <summary> Update details of a billing agreement, such as the description, shipping address, and start date, by passing the ID of the agreement to the request URI. </summary> <param name="apiContext">APIContext used for the API call.</param> <param name="agreementId">ID of the billing agreement that will be updated.</param> <param name="patchRequest">PatchRequest</param> </member> <member name="M:PayPal.Api.Agreement.Suspend(PayPal.Api.APIContext,PayPal.Api.AgreementStateDescriptor)"> <summary> Suspend a particular billing agreement by passing the ID of the agreement to the request URI. </summary> <param name="apiContext">APIContext used for the API call.</param> <param name="agreementStateDescriptor">AgreementStateDescriptor</param> </member> <member name="M:PayPal.Api.Agreement.Suspend(PayPal.Api.APIContext,System.String,PayPal.Api.AgreementStateDescriptor)"> <summary> Suspend a particular billing agreement by passing the ID of the agreement to the request URI. </summary> <param name="apiContext">APIContext used for the API call.</param> <param name="agreementId">ID of the billing agreement that will be suspended.</param> <param name="agreementStateDescriptor">AgreementStateDescriptor</param> </member> <member name="M:PayPal.Api.Agreement.ReActivate(PayPal.Api.APIContext,PayPal.Api.AgreementStateDescriptor)"> <summary> Reactivate a suspended billing agreement by passing the ID of the agreement to the appropriate URI. In addition, pass an AgreementStateDescriptor object in the request JSON that includes a note about the reason for changing the state of the agreement and the amount and currency for the agreement. </summary> <param name="apiContext">APIContext used for the API call.</param> <param name="agreementStateDescriptor">AgreementStateDescriptor</param> </member> <member name="M:PayPal.Api.Agreement.ReActivate(PayPal.Api.APIContext,System.String,PayPal.Api.AgreementStateDescriptor)"> <summary> Reactivate a suspended billing agreement by passing the ID of the agreement to the appropriate URI. In addition, pass an AgreementStateDescriptor object in the request JSON that includes a note about the reason for changing the state of the agreement and the amount and currency for the agreement. </summary> <param name="apiContext">APIContext used for the API call.</param> <param name="agreementId">ID of the billing agreement that will be reactivated.</param> <param name="agreementStateDescriptor">AgreementStateDescriptor</param> </member> <member name="M:PayPal.Api.Agreement.Cancel(PayPal.Api.APIContext,PayPal.Api.AgreementStateDescriptor)"> <summary> Cancel a billing agreement by passing the ID of the agreement to the request URI. In addition, pass an agreement_state_descriptor object in the request JSON that includes a note about the reason for changing the state of the agreement and the amount and currency for the agreement. </summary> <param name="apiContext">APIContext used for the API call.</param> <param name="agreementStateDescriptor">AgreementStateDescriptor</param> </member> <member name="M:PayPal.Api.Agreement.Cancel(PayPal.Api.APIContext,System.String,PayPal.Api.AgreementStateDescriptor)"> <summary> Cancel a billing agreement by passing the ID of the agreement to the request URI. In addition, pass an AgreementStateDescriptor object in the request JSON that includes a note about the reason for changing the state of the agreement and the amount and currency for the agreement. </summary> <param name="apiContext">APIContext used for the API call.</param> <param name="agreementId">ID of the billing agreement that will be canceled.</param> <param name="agreementStateDescriptor">AgreementStateDescriptor</param> </member> <member name="M:PayPal.Api.Agreement.BillBalance(PayPal.Api.APIContext,PayPal.Api.AgreementStateDescriptor)"> <summary> Bill an outstanding amount for an agreement by passing the ID of the agreement to the request URI. In addition, pass an AgreementStateDescriptor object in the request JSON that includes a note about the reason for changing the state of the agreement and the amount and currency for the agreement. </summary> <param name="apiContext">APIContext used for the API call.</param> <param name="agreementStateDescriptor">AgreementStateDescriptor</param> </member> <member name="M:PayPal.Api.Agreement.BillBalance(PayPal.Api.APIContext,System.String,PayPal.Api.AgreementStateDescriptor)"> <summary> Bill an outstanding amount for an agreement by passing the ID of the agreement to the request URI. In addition, pass an AgreementStateDescriptor object in the request JSON that includes a note about the reason for changing the state of the agreement and the amount and currency for the agreement. </summary> <param name="apiContext">APIContext used for the API call.</param> <param name="agreementId">ID of the billing agreement to perform the operation against.</param> <param name="agreementStateDescriptor">AgreementStateDescriptor</param> </member> <member name="M:PayPal.Api.Agreement.SetBalance(PayPal.Api.APIContext,PayPal.Api.Currency)"> <summary> Set the balance for an agreement by passing the ID of the agreement to the request URI. In addition, pass a Currency object in the request JSON that specifies the currency type and value of the balance. </summary> <param name="apiContext">APIContext used for the API call.</param> <param name="currency">Currency</param> </member> <member name="M:PayPal.Api.Agreement.SetBalance(PayPal.Api.APIContext,System.String,PayPal.Api.Currency)"> <summary> Set the balance for an agreement by passing the ID of the agreement to the request URI. In addition, pass a Currency object in the request JSON that specifies the currency type and value of the balance. </summary> <param name="apiContext">APIContext used for the API call.</param> <param name="agreementId">ID of the billing agreement to perform the operation against.</param> <param name="currency">Currency</param> </member> <member name="M:PayPal.Api.Agreement.ListTransactions(PayPal.Api.APIContext,System.String,System.String,System.String)"> <summary> List transactions for a billing agreement by passing the ID of the agreement, as well as the start and end dates of the range of transactions to list, to the request URI. </summary> <param name="apiContext">APIContext used for the API call.</param> <param name="agreementId">Identifier of the agreement resource for which to list transactions.</param> <param name="startDate">The start date of the range of transactions to list. Date format must be yyyy-MM-dd.</param> <param name="endDate">The end date of the range of transactions to list. Date format must be yyyy-MM-dd.</param> <returns>AgreementTransactions</returns> </member> <member name="T:PayPal.Api.AgreementDetails"> <summary> The details of a billing agreement. <para> See <a href="https://developer.paypal.com/docs/api/">PayPal Developer documentation</a> for more information. </para> </summary> </member> <member name="P:PayPal.Api.AgreementDetails.outstanding_balance"> <summary> The outstanding balance for this agreement. </summary> </member> <member name="P:PayPal.Api.AgreementDetails.cycles_remaining"> <summary> Number of cycles remaining for this agreement. </summary> </member> <member name="P:PayPal.Api.AgreementDetails.cycles_completed"> <summary> Number of cycles completed for this agreement. </summary> </member> <member name="P:PayPal.Api.AgreementDetails.next_billing_date"> <summary> The next billing date for this agreement, represented as 2014-02-19T10:00:00Z format. </summary> </member> <member name="P:PayPal.Api.AgreementDetails.last_payment_date"> <summary> Last payment date for this agreement, represented as 2014-06-09T09:42:31Z format. </summary> </member> <member name="P:PayPal.Api.AgreementDetails.last_payment_amount"> <summary> Last payment amount for this agreement. </summary> </member> <member name="P:PayPal.Api.AgreementDetails.final_payment_date"> <summary> Last payment date for this agreement, represented as 2015-02-19T10:00:00Z format. </summary> </member> <member name="P:PayPal.Api.AgreementDetails.failed_payment_count"> <summary> Total number of failed payments for this agreement. </summary> </member> <member name="T:PayPal.Api.AgreementStateDescriptor"> <summary> The state of the associated billing agreement. <para> See <a href="https://developer.paypal.com/docs/api/">PayPal Developer documentation</a> for more information. </para> </summary> </member> <member name="P:PayPal.Api.AgreementStateDescriptor.note"> <summary> Reason for changing the state of the agreement. </summary> </member> <member name="P:PayPal.Api.AgreementStateDescriptor.amount"> <summary> The amount and currency of the agreement. </summary> </member> <member name="T:PayPal.Api.AgreementTransaction"> <summary> Details of a transaction associated with a billing agreement. <para> See <a href="https://developer.paypal.com/docs/api/">PayPal Developer documentation</a> for more information. </para> </summary> </member> <member name="P:PayPal.Api.AgreementTransaction.transaction_id"> <summary> Id corresponding to this transaction. </summary> </member> <member name="P:PayPal.Api.AgreementTransaction.status"> <summary> State of the subscription at this time. </summary> </member> <member name="P:PayPal.Api.AgreementTransaction.transaction_type"> <summary> Type of transaction, usually Recurring Payment. </summary> </member> <member name="P:PayPal.Api.AgreementTransaction.amount"> <summary> Amount for this transaction. </summary> </member> <member name="P:PayPal.Api.AgreementTransaction.fee_amount"> <summary> Fee amount for this transaction. </summary> </member> <member name="P:PayPal.Api.AgreementTransaction.net_amount"> <summary> Net amount for this transaction. </summary> </member> <member name="P:PayPal.Api.AgreementTransaction.payer_email"> <summary> Email id of payer. </summary> </member> <member name="P:PayPal.Api.AgreementTransaction.payer_name"> <summary> Business name of payer. </summary> </member> <member name="P:PayPal.Api.AgreementTransaction.time_stamp"> <summary> Time at which this transaction happened. </summary> </member> <member name="P:PayPal.Api.AgreementTransaction.time_zone"> <summary> Time zone of time_updated field. </summary> </member> <member name="P:PayPal.Api.AgreementTransaction.time_updated"> <summary> Time at which this transaction happened. </summary> </member> <member name="T:PayPal.Api.AgreementTransactions"> <summary> A list of transactions associated with a billing agreement. <para> See <a href="https://developer.paypal.com/docs/api/">PayPal Developer documentation</a> for more information. </para> </summary> </member> <member name="P:PayPal.Api.AgreementTransactions.agreement_transaction_list"> <summary> Array of agreement_transaction object. </summary> </member> <member name="T:PayPal.Api.Amount"> <summary> payment amount with break-ups. <para> See <a href="https://developer.paypal.com/docs/api/">PayPal Developer documentation</a> for more information. </para> </summary> </member> <member name="P:PayPal.Api.Amount.currency"> <summary> 3-letter [currency code](https://developer.paypal.com/docs/integration/direct/rest_api_payment_country_currency_support/). PayPal does not support all currencies. </summary> </member> <member name="P:PayPal.Api.Amount.total"> <summary> Total amount charged from the payer to the payee. In case of a refund, this is the refunded amount to the original payer from the payee. 10 characters max with support for 2 decimal places. </summary> </member> <member name="P:PayPal.Api.Amount.details"> <summary> Additional details of the payment amount. </summary> </member> <member name="T:PayPal.Api.Authorization"> <summary> An authorization transaction. <para> See <a href="https://developer.paypal.com/docs/api/">PayPal Developer documentation</a> for more information. </para> </summary> </member> <member name="P:PayPal.Api.Authorization.id"> <summary> ID of the authorization transaction. </summary> </member> <member name="P:PayPal.Api.Authorization.amount"> <summary> Amount being authorized. </summary> </member> <member name="P:PayPal.Api.Authorization.payment_mode"> <summary> Specifies the payment mode of the transaction. </summary> </member> <member name="P:PayPal.Api.Authorization.state"> <summary> State of the authorization. </summary> </member> <member name="P:PayPal.Api.Authorization.reason_code"> <summary> Reason code, `AUTHORIZATION`, for a transaction state of `pending`. </summary> </member> <!-- Badly formed XML comment ignored for member "P:PayPal.Api.Authorization.protection_eligibility" --> <!-- Badly formed XML comment ignored for member "P:PayPal.Api.Authorization.protection_eligibility_type" --> <member name="P:PayPal.Api.Authorization.fmf_details"> <summary> Fraud Management Filter (FMF) details applied for the payment that could result in accept, deny, or pending action. Returned in a payment response only if the merchant has enabled FMF in the profile settings and one of the fraud filters was triggered based on those settings. See [Fraud Management Filters Summary](https://developer.paypal.com/docs/classic/fmf/integration-guide/FMFSummary/) for more information. </summary> </member> <member name="P:PayPal.Api.Authorization.parent_payment"> <summary> ID of the Payment resource that this transaction is based on. </summary> </member> <member name="P:PayPal.Api.Authorization.valid_until"> <summary> Authorization expiration time and date as defined in [RFC 3339 Section 5.6](http://tools.ietf.org/html/rfc3339#section-5.6). </summary> </member> <member name="P:PayPal.Api.Authorization.create_time"> <summary> Time of authorization as defined in [RFC 3339 Section 5.6](http://tools.ietf.org/html/rfc3339#section-5.6). </summary> </member> <member name="P:PayPal.Api.Authorization.update_time"> <summary> Time that the resource was last updated. </summary> </member> <member name="P:PayPal.Api.Authorization.processor_response"> <summary> Collection of payment response related fields returned from a payment request. </summary> </member> <member name="P:PayPal.Api.Authorization.pending_reason"> <summary> Reason code for the transaction state being Pending. </summary> </member> <member name="P:PayPal.Api.Authorization.reference_id"> <summary> Identifier to the purchase or transaction unit corresponding to this authorization transaction. </summary> </member> <member name="P:PayPal.Api.Authorization.receipt_id"> <summary> Receipt id is 16 digit number payment identification number returned for guest users to identify the payment. </summary> </member> <member name="M:PayPal.Api.Authorization.Get(PayPal.Api.APIContext,System.String)"> <summary> Shows details for an authorization, by ID. </summary> <param name="apiContext">APIContext used for the API call.</param> <param name="authorizationId">The ID of the authorization for which to show details.</param> <returns>Authorization</returns> </member> <member name="M:PayPal.Api.Authorization.Capture(PayPal.Api.APIContext,PayPal.Api.Capture)"> <summary> Captures and processes an authorization, by ID. To use this call, the original payment call must specify an intent of `authorize`. </summary> <param name="apiContext">APIContext used for the API call.</param> <param name="capture">Capture</param> <returns>Capture</returns> </member> <member name="M:PayPal.Api.Authorization.Capture(PayPal.Api.APIContext,System.String,PayPal.Api.Capture)"> <summary> Creates (and processes) a new Capture Transaction added as a related resource. </summary> <param name="apiContext">APIContext used for the API call.</param> <param name="authorizationId">ID of the authorization to capture.</param> <param name="capture">Capture</param> <returns>Capture</returns> </member> <member name="M:PayPal.Api.Authorization.Void(PayPal.Api.APIContext)"> <summary> Voids, or cancels, an authorization, by ID. You cannot void a fully captured authorization. </summary> <param name="apiContext">APIContext used for the API call.</param> <returns>Authorization</returns> </member> <member name="M:PayPal.Api.Authorization.Void(PayPal.Api.APIContext,System.String)"> <summary> Voids (cancels) an Authorization. </summary> <param name="apiContext">APIContext used for the API call.</param> <param name="authorizationId">ID of the authorization to void.</param> <returns>Authorization</returns> </member> <member name="M:PayPal.Api.Authorization.Reauthorize(PayPal.Api.APIContext)"> <summary> Reauthorizes a PayPal account payment, by authorization ID. To ensure that funds are still available, reauthorize a payment after the initial three-day honor period. Supports only the `amount` request parameter. </summary> <param name="apiContext">APIContext used for the API call.</param> <returns>Authorization</returns> </member> <member name="M:PayPal.Api.Authorization.Reauthorize(PayPal.Api.APIContext,PayPal.Api.Authorization)"> <summary> Reauthorizes an expired Authorization. </summary> <param name="apiContext">APIContext used for the API call.</param> <param name="authorization">The Authorization object containing the details of the authorization that should be reauthorized.</param> <returns>Authorization</returns> </member> <member name="T:PayPal.Api.BankAccount"> <summary> A resource representing a bank account that can be used to fund a payment. <para> See <a href="https://developer.paypal.com/docs/api/">PayPal Developer documentation</a> for more information. </para> </summary> </member> <member name="P:PayPal.Api.BankAccount.id"> <summary> ID of the bank account being saved for later use. </summary> </member> <member name="P:PayPal.Api.BankAccount.account_number"> <summary> Account number in either IBAN (max length 34) or BBAN (max length 17) format. </summary> </member> <member name="P:PayPal.Api.BankAccount.account_number_type"> <summary> Type of the bank account number (International or Basic Bank Account Number). For more information refer to http://en.wikipedia.org/wiki/International_Bank_Account_Number. </summary> </member> <member name="P:PayPal.Api.BankAccount.routing_number"> <summary> Routing transit number (aka Bank Code) of the bank (typically for domestic use only - for international use, IBAN includes bank code). For more information refer to http://en.wikipedia.org/wiki/Bank_code. </summary> </member> <member name="P:PayPal.Api.BankAccount.account_type"> <summary> Type of the bank account. </summary> </member> <member name="P:PayPal.Api.BankAccount.account_name"> <summary> A customer designated name. </summary> </member> <member name="P:PayPal.Api.BankAccount.check_type"> <summary> Type of the check when this information was obtained through a check by the facilitator or merchant. </summary> </member> <member name="P:PayPal.Api.BankAccount.auth_type"> <summary> How the check was obtained from the customer, if check was the source of the information provided. </summary> </member> <member name="P:PayPal.Api.BankAccount.auth_capture_timestamp"> <summary> Time at which the authorization (or check) was captured. Use this field if the user authorization needs to be captured due to any privacy requirements. </summary> </member> <member name="P:PayPal.Api.BankAccount.bank_name"> <summary> Name of the bank. </summary> </member> <member name="P:PayPal.Api.BankAccount.country_code"> <summary> 2 letter country code of the Bank. </summary> </member> <member name="P:PayPal.Api.BankAccount.first_name"> <summary> Account holder's first name. </summary> </member> <member name="P:PayPal.Api.BankAccount.last_name"> <summary> Account holder's last name. </summary> </member> <member name="P:PayPal.Api.BankAccount.birth_date"> <summary> Birth date of the bank account holder. </summary> </member> <member name="P:PayPal.Api.BankAccount.billing_address"> <summary> Billing address. </summary> </member> <member name="P:PayPal.Api.BankAccount.state"> <summary> State of this funding instrument. </summary> </member> <member name="P:PayPal.Api.BankAccount.confirmation_status"> <summary> Confirmation status of a bank account. </summary> </member> <member name="P:PayPal.Api.BankAccount.payer_id"> <summary> Deprecated - Use external_customer_id instead. </summary> </member> <member name="P:PayPal.Api.BankAccount.external_customer_id"> <summary> A unique identifier of the customer to whom this bank account belongs to. Generated and provided by the facilitator. This is required when creating or using a stored funding instrument in vault. </summary> </member> <member name="P:PayPal.Api.BankAccount.merchant_id"> <summary> A unique identifier of the merchant for which this bank account has been stored for. Generated and provided by the facilitator so it can be used to restrict the usage of the bank account to the specific merchant. </summary> </member> <member name="P:PayPal.Api.BankAccount.external_account_id"> <summary> A client supplied unique identifier of the bank account resource, to faciliate easy look up of the resource, via GET queries </summary> </member> <member name="P:PayPal.Api.BankAccount.create_time"> <summary> Time the resource was created. </summary> </member> <member name="P:PayPal.Api.BankAccount.update_time"> <summary> Time the resource was last updated. </summary> </member> <member name="P:PayPal.Api.BankAccount.valid_until"> <summary> Date/Time until this resource can be used to fund a payment. </summary> </member> <member name="M:PayPal.Api.BankAccount.Create(PayPal.Api.APIContext)"> <summary> Creates a new Bank Account Resource. </summary> <param name="apiContext">APIContext used for the API call.</param> <returns>BankAccount</returns> </member> <member name="M:PayPal.Api.BankAccount.Create(PayPal.Api.APIContext,PayPal.Api.BankAccount)"> <summary> Creates a new Bank Account Resource. </summary> <param name="apiContext">APIContext used for the API call.</param> <param name="bankAccount">The BankAccount object specifying the details of the PayPal resource to create.</param> <returns>BankAccount</returns> </member> <member name="M:PayPal.Api.BankAccount.Get(PayPal.Api.APIContext,System.String)"> <summary> Obtain the Bank Account resource for the given identifier. </summary> <param name="apiContext">APIContext used for the API call.</param> <param name="bankAccountId">Identifier of the bank account resource to obtain the data for.</param> <returns>BankAccount</returns> </member> <member name="M:PayPal.Api.BankAccount.Delete(PayPal.Api.APIContext)"> <summary> Delete the bank account resource for the given identifier. </summary> <param name="apiContext">APIContext used for the API call.</param> </member> <member name="M:PayPal.Api.BankAccount.Delete(PayPal.Api.APIContext,System.String)"> <summary> Delete the bank account resource for the given identifier. </summary> <param name="apiContext">APIContext used for the API call.</param> <param name="bankAccountId">Identifier of the bank account resource to obtain the data for.</param> </member> <member name="M:PayPal.Api.BankAccount.Update(PayPal.Api.APIContext,PayPal.Api.PatchRequest)"> <summary> Update information in a previously saved bank account. Only the modified fields need to be passed in the request. </summary> <param name="apiContext">APIContext used for the API call.</param> <param name="patchRequest">PatchRequest</param> <returns>BankAccount</returns> </member> <member name="M:PayPal.Api.BankAccount.Update(PayPal.Api.APIContext,System.String,PayPal.Api.PatchRequest)"> <summary> Update information in a previously saved bank account. Only the modified fields need to be passed in the request. </summary> <param name="apiContext">APIContext used for the API call.</param> <param name="bankAccountId">ID of the bank account to update.</param> <param name="patchRequest">PatchRequest</param> <returns>BankAccount</returns> </member> <member name="M:PayPal.Api.BankAccount.List(PayPal.Api.APIContext,System.Int32,System.Int32,System.String,System.String,System.String,System.String,System.String,System.String,System.String)"> <summary> Retrieves a list of bank account resources. </summary> <param name="apiContext">APIContext used for the API call.</param> <param name="pageSize">Number of items to be returned in the current page size, by a GET operation. Defaults to a size of 10.</param> <param name="page">The page number to be retrieved, for the list of items, by the current GET request. Defaults to a size of 1.</param> <param name="startTime">Resource creation time as ISO8601 date-time format (ex: 1994-11-05T13:15:30Z) that indicates the start of a range of results.</param> <param name="endTime">Resource creation time as ISO8601 date-time format (ex: 1994-11-05T13:15:30Z) that indicates the end of a range of results.</param> <param name="sortOrder">Sort based on order of results. Options include 'asc' for ascending order or 'desc' for descending order. Defaults to 'asc'.</param> <param name="sortBy">Sort based on 'create_time' or 'update_time'. Defaults to 'create_time'.</param> <param name="merchantId">Identifier the merchants who owns this resource</param> <param name="externalCustomerId">Identifier of the external customer resource to obtain the data for.</param> <param name="externalAccountId">Identifier of the external bank account resource id to obtain the data for.</param> <returns>BankAccountList</returns> </member> <member name="T:PayPal.Api.BankAccountList"> <summary> A list of bank accounts returned from a search operation. <para> See <a href="https://developer.paypal.com/docs/api/">PayPal Developer documentation</a> for more information. </para> </summary> </member> <member name="P:PayPal.Api.BankAccountList.items"> <summary> A list of bank account resources </summary> </member> <member name="P:PayPal.Api.BankAccountList.total_items"> <summary> Total number of items present in the given list. Note that the number of items might be larger than the records in the current page. </summary> </member> <member name="P:PayPal.Api.BankAccountList.total_pages"> <summary> Total number of pages that exist, for the total number of items, with the given page size. </summary> </member> <member name="T:PayPal.Api.BankToken"> <summary> A resource representing a bank that can be used to fund a payment. <para> See <a href="https://developer.paypal.com/docs/api/">PayPal Developer documentation</a> for more information. </para> </summary> </member> <member name="P:PayPal.Api.BankToken.bank_id"> <summary> ID of a previously saved Bank resource using /vault/bank API. </summary> </member> <member name="P:PayPal.Api.BankToken.external_customer_id"> <summary> The unique identifier of the payer used when saving this bank using /vault/bank API. </summary> </member> <member name="P:PayPal.Api.BankToken.mandate_reference_number"> <summary> Identifier of the direct debit mandate to validate. Currently supported only for EU bank accounts(SEPA). </summary> </member> <member name="T:PayPal.Api.BaseAddress"> <summary> Base Address object used as billing address in a payment or extended for Shipping Address. <para> See <a href="https://developer.paypal.com/docs/api/">PayPal Developer documentation</a> for more information. </para> </summary> </member> <member name="P:PayPal.Api.BaseAddress.line1"> <summary> Line 1 of the Address (eg. number, street, etc). </summary> </member> <member name="P:PayPal.Api.BaseAddress.line2"> <summary> Optional line 2 of the Address (eg. suite, apt #, etc.). </summary> </member> <member name="P:PayPal.Api.BaseAddress.city"> <summary> City name. </summary> </member> <member name="P:PayPal.Api.BaseAddress.country_code"> <summary> 2 letter country code. </summary> </member> <member name="P:PayPal.Api.BaseAddress.postal_code"> <summary> Zip code or equivalent is usually required for countries that have them. For list of countries that do not have postal codes please refer to http://en.wikipedia.org/wiki/Postal_code. </summary> </member> <member name="P:PayPal.Api.BaseAddress.state"> <summary> 2 letter code for US states, and the equivalent for other countries. </summary> </member> <member name="P:PayPal.Api.BaseAddress.normalization_status"> <summary> Address normalization status </summary> </member> <member name="P:PayPal.Api.BaseAddress.status"> <summary> Address status </summary> </member> <member name="T:PayPal.Api.BillingInfo"> <summary> Billing information for the invoice recipient. <para> See <a href="https://developer.paypal.com/docs/api/">PayPal Developer documentation</a> for more information. </para> </summary> </member> <member name="P:PayPal.Api.BillingInfo.email"> <summary> The invoice recipient email address.<blockquote><strong>Note:</strong>Before you get a QR code, you must create an invoice that specifies `qrinvoice@paypal.com `as the recipient email address in the `billing_info` object. Use a customer email address only if you want to email the invoice.</blockquote> </summary> </member> <member name="P:PayPal.Api.BillingInfo.first_name"> <summary> The invoice recipient first name. </summary> </member> <member name="P:PayPal.Api.BillingInfo.last_name"> <summary> The invoice recipient last name. </summary> </member> <member name="P:PayPal.Api.BillingInfo.business_name"> <summary> The invoice recipient company business name. </summary> </member> <member name="P:PayPal.Api.BillingInfo.address"> <summary> The invoice recipient address. </summary> </member> <member name="P:PayPal.Api.BillingInfo.language"> <summary> The language in which to send the email to the recipient. Used only when the recipient lacks a PayPal account. </summary> </member> <member name="P:PayPal.Api.BillingInfo.additional_info"> <summary> Additional information, such as business hours. </summary> </member> <member name="P:PayPal.Api.BillingInfo.notification_channel"> <summary> The preferred notification channel for the recipient. Value is `SMS` or `EMAIL`. Default is `EMAIL`. If `SMS` is specified, a `phone` value is required. </summary> </member> <member name="P:PayPal.Api.BillingInfo.phone"> <summary> The mobile phone number to which to send SMS notification if `notification_channel` is `SMS`. </summary> </member> <member name="T:PayPal.Api.CancelNotification"> <summary> Cancels an email or SMS notification. <para> See <a href="https://developer.paypal.com/docs/api/">PayPal Developer documentation</a> for more information. </para> </summary> </member> <member name="P:PayPal.Api.CancelNotification.subject"> <summary> The subject of the notification. </summary> </member> <member name="P:PayPal.Api.CancelNotification.note"> <summary> A note to the payer. </summary> </member> <member name="P:PayPal.Api.CancelNotification.send_to_merchant"> <summary> Indicates whether to send the notification to the merchant. </summary> </member> <member name="P:PayPal.Api.CancelNotification.send_to_payer"> <summary> Indicates whether to send the notification to the payer. </summary> </member> <member name="P:PayPal.Api.CancelNotification.cc_emails"> <summary> An array of one or more Cc: emails. If you omit this parameter from the JSON request body, a notification is sent to all Cc: email addresses that are part of the invoice. Otherwise, specify this parameter to limit the email addresses to which a notification is sent.<blockquote><strong>Note:</strong> Additional email addresses are not supported.</blockquote> </summary> </member> <member name="T:PayPal.Api.Capture"> <summary> A capture transaction. <para> See <a href="https://developer.paypal.com/docs/api/">PayPal Developer documentation</a> for more information. </para> </summary> </member> <member name="P:PayPal.Api.Capture.id"> <summary> The ID of the capture transaction. </summary> </member> <member name="P:PayPal.Api.Capture.amount"> <summary> The amount to capture. If the amount matches the orginally authorized amount, the state of the authorization changes to `captured`. If not, the state of the authorization changes to `partially_captured`. </summary> </member> <member name="P:PayPal.Api.Capture.is_final_capture"> <summary> Indicates whether to release all remaining funds that the authorization holds in the funding instrument. Default is `false`. </summary> </member> <member name="P:PayPal.Api.Capture.state"> <summary> The state of the capture. </summary> </member> <member name="P:PayPal.Api.Capture.reason_code"> <summary> The reason code that describes why the transaction state is pending or reversed. </summary> </member> <member name="P:PayPal.Api.Capture.parent_payment"> <summary> The ID of the payment on which this transaction is based. </summary> </member> <member name="P:PayPal.Api.Capture.invoice_number"> <summary> The invoice number to track this payment. </summary> </member> <member name="P:PayPal.Api.Capture.transaction_fee"> <summary> The transaction fee for this payment. </summary> </member> <member name="P:PayPal.Api.Capture.create_time"> <summary> The date and time of capture, as defined in [RFC 3339 Section 5.6](http://tools.ietf.org/html/rfc3339#section-5.6). </summary> </member> <member name="P:PayPal.Api.Capture.update_time"> <summary> The date and time when the resource was last updated. </summary> </member> <member name="M:PayPal.Api.Capture.Get(PayPal.Api.APIContext,System.String)"> <summary> Shows details for a captured payment, by ID. </summary> <param name="apiContext">APIContext used for the API call.</param> <param name="captureId">The ID of the captured payment for which to show details.</param> <returns>Capture</returns> </member> <member name="M:PayPal.Api.Capture.Refund(PayPal.Api.APIContext,PayPal.Api.Refund)"> <summary> Creates (and processes) a new Refund Transaction added as a related resource. </summary> <param name="apiContext">APIContext used for the API call.</param> <param name="refund">Refund</param> <returns>Refund</returns> </member> <member name="M:PayPal.Api.Capture.Refund(PayPal.Api.APIContext,System.String,PayPal.Api.Refund)"> <summary> Creates (and processes) a new Refund Transaction added as a related resource. </summary> <param name="apiContext">APIContext used for the API call.</param> <param name="captureId">ID of the captured payment resource to refund.</param> <param name="refund">Refund</param> <returns>Refund</returns> </member> <member name="M:PayPal.Api.Capture.Refund(PayPal.Api.APIContext,System.String,PayPal.Api.RefundRequest)"> <summary> Refunds a captured payment, by ID. Include an `amount` object in the JSON request body. </summary> <param name="apiContext">APIContext used for the API call.</param> <param name="refundRequest">RefundRequest</param> <returns>DetailedRefund</returns> </member> <member name="T:PayPal.Api.CarrierAccountToken"> <summary> A resource representing a carrier account that can be used to fund a payment. <para> See <a href="https://developer.paypal.com/docs/api/">PayPal Developer documentation</a> for more information. </para> </summary> </member> <member name="P:PayPal.Api.CarrierAccountToken.carrier_account_id"> <summary> ID of a previously saved carrier account resource. </summary> </member> <member name="P:PayPal.Api.CarrierAccountToken.external_customer_id"> <summary> The unique identifier of the payer used when saving this carrier account instrument. </summary> </member> <member name="T:PayPal.Api.CartBase"> <summary> Base properties of a cart resource <para> See <a href="https://developer.paypal.com/docs/api/">PayPal Developer documentation</a> for more information. </para> </summary> </member> <member name="P:PayPal.Api.CartBase.reference_id"> <summary> Merchant identifier to the purchase unit. Optional parameter </summary> </member> <member name="P:PayPal.Api.CartBase.amount"> <summary> Amount being collected. </summary> </member> <member name="P:PayPal.Api.CartBase.payee"> <summary> Recipient of the funds in this transaction. </summary> </member> <member name="P:PayPal.Api.CartBase.description"> <summary> Description of what is being paid for. </summary> </member> <member name="P:PayPal.Api.CartBase.note_to_payee"> <summary> Note to the recipient of the funds in this transaction. </summary> </member> <member name="P:PayPal.Api.CartBase.custom"> <summary> free-form field for the use of clients </summary> </member> <member name="P:PayPal.Api.CartBase.invoice_number"> <summary> invoice number to track this payment </summary> </member> <member name="P:PayPal.Api.CartBase.soft_descriptor"> <summary> Soft descriptor used when charging this funding source. If length exceeds max length, the value will be truncated </summary> </member> <member name="P:PayPal.Api.CartBase.payment_options"> <summary> Payment options requested for this purchase unit </summary> </member> <member name="P:PayPal.Api.CartBase.item_list"> <summary> List of items being paid for. </summary> </member> <member name="P:PayPal.Api.CartBase.notify_url"> <summary> URL to send payment notifications </summary> </member> <member name="P:PayPal.Api.CartBase.order_url"> <summary> Url on merchant site pertaining to this payment. </summary> </member> <member name="T:PayPal.Api.ChargeModel"> <summary> Defines a charge model to be used in context of a billing plan. <para> See <a href="https://developer.paypal.com/docs/api/">PayPal Developer documentation</a> for more information. </para> </summary> </member> <member name="P:PayPal.Api.ChargeModel.id"> <summary> Identifier of the charge model. 128 characters max. </summary> </member> <member name="P:PayPal.Api.ChargeModel.type"> <summary> Type of charge model. Allowed values: `SHIPPING`, `TAX`. </summary> </member> <member name="P:PayPal.Api.ChargeModel.amount"> <summary> Specific amount for this charge model. </summary> </member> <member name="T:PayPal.Api.Cost"> <summary> The cost as a percent or an amount value. For example, to specify 10%, enter `10`. Alternatively, to specify an amount of 5, enter `5`. <para> See <a href="https://developer.paypal.com/docs/api/">PayPal Developer documentation</a> for more information. </para> </summary> </member> <member name="P:PayPal.Api.Cost.percent"> <summary> The cost, as a percent value. Valid value is from 0 to 100. </summary> </member> <member name="P:PayPal.Api.Cost.amount"> <summary> The cost, as an amount value. Valid value is from 0 to 1,000,000. </summary> </member> <member name="T:PayPal.Api.CreateProfileResponse"> <summary> Response object when creating a web experience profile. <para> See <a href="https://developer.paypal.com/docs/api/">PayPal Developer documentation</a> for more information. </para> </summary> </member> <member name="P:PayPal.Api.CreateProfileResponse.id"> <summary> ID of the payment web experience profile. </summary> </member> <member name="T:PayPal.Api.Credit"> <summary> A resource representing a credit instrument. <para> See <a href="https://developer.paypal.com/docs/api/">PayPal Developer documentation</a> for more information. </para> </summary> </member> <member name="P:PayPal.Api.Credit.id"> <summary> Unique identifier of credit resource. </summary> </member> <member name="P:PayPal.Api.Credit.type"> <summary> specifies type of credit </summary> </member> <member name="T:PayPal.Api.CreditCard"> <summary> [DEPRECATED] Represents a credit card to fund a payment. Use Payment Card instead. <para> See <a href="https://developer.paypal.com/docs/api/">PayPal Developer documentation</a> for more information. </para> </summary> </member> <member name="P:PayPal.Api.CreditCard.id"> <summary> ID of the credit card being saved for later use. </summary> </member> <member name="P:PayPal.Api.CreditCard.number"> <summary> Credit card number. Numeric characters only with no spaces or punctuation. The string must conform with modulo and length required by each credit card type. *Redacted in responses.* </summary> </member> <member name="P:PayPal.Api.CreditCard.type"> <summary> Credit card type. Valid types are: `visa`, `mastercard`, `discover`, `amex` </summary> </member> <member name="P:PayPal.Api.CreditCard.expire_month"> <summary> Expiration month with no leading zero. Acceptable values are 1 through 12. </summary> </member> <member name="P:PayPal.Api.CreditCard.expire_year"> <summary> 4-digit expiration year. </summary> </member> <member name="P:PayPal.Api.CreditCard.cvv2"> <summary> 3-4 digit card validation code. </summary> </member> <member name="P:PayPal.Api.CreditCard.first_name"> <summary> Cardholder's first name. </summary> </member> <member name="P:PayPal.Api.CreditCard.last_name"> <summary> Cardholder's last name. </summary> </member> <member name="P:PayPal.Api.CreditCard.billing_address"> <summary> Billing Address associated with this card. </summary> </member> <member name="P:PayPal.Api.CreditCard.payer_id"> <summary> A unique identifier of the payer generated and provided by the facilitator. This is required when creating or using a tokenized funding instrument. </summary> </member> <member name="P:PayPal.Api.CreditCard.external_customer_id"> <summary> A unique identifier of the customer to whom this bank account belongs. Generated and provided by the facilitator. **This is now used in favor of `payer_id` when creating or using a stored funding instrument in the vault.** </summary> </member> <member name="P:PayPal.Api.CreditCard.merchant_id"> <summary> A user provided, optional convenvience field that functions as a unique identifier for the merchant on behalf of whom this credit card is being stored for. Note that this has no relation to PayPal merchant id </summary> </member> <member name="P:PayPal.Api.CreditCard.external_card_id"> <summary> A unique identifier of the bank account resource. Generated and provided by the facilitator so it can be used to restrict the usage of the bank account to the specific merchant. </summary> </member> <member name="P:PayPal.Api.CreditCard.state"> <summary> State of the credit card funding instrument. </summary> </member> <member name="P:PayPal.Api.CreditCard.create_time"> <summary> Resource creation time as ISO8601 date-time format (ex: 1994-11-05T13:15:30Z) that indicates creation time. </summary> </member> <member name="P:PayPal.Api.CreditCard.update_time"> <summary> Resource creation time as ISO8601 date-time format (ex: 1994-11-05T13:15:30Z) that indicates the updation time. </summary> </member> <member name="P:PayPal.Api.CreditCard.valid_until"> <summary> Funding instrument expiration date. </summary> </member> <member name="M:PayPal.Api.CreditCard.Create(PayPal.Api.APIContext)"> <summary> Creates a new Credit Card Resource (aka Tokenize). </summary> <param name="apiContext">APIContext used for the API call.</param> <returns>CreditCard</returns> </member> <member name="M:PayPal.Api.CreditCard.Create(PayPal.Api.APIContext,PayPal.Api.CreditCard)"> <summary> Creates a new Credit Card Resource (aka Tokenize). </summary> <param name="apiContext">APIContext used for the API call.</param> <param name="creditCard">CreditCard object to be used to create the PayPal resource.</param> <returns>CreditCard</returns> </member> <member name="M:PayPal.Api.CreditCard.Get(PayPal.Api.APIContext,System.String)"> <summary> Obtain the Credit Card resource for the given identifier. </summary> <param name="apiContext">APIContext used for the API call.</param> <param name="creditCardId">Identifier of the credit card resource to obtain the data for.</param> <returns>CreditCard</returns> </member> <member name="M:PayPal.Api.CreditCard.Delete(PayPal.Api.APIContext)"> <summary> Delete the Credit Card resource for the given identifier. </summary> <param name="apiContext">APIContext used for the API call.</param> </member> <member name="M:PayPal.Api.CreditCard.Delete(PayPal.Api.APIContext,System.String)"> <summary> Delete the Credit Card resource for the given identifier. </summary> <param name="apiContext">APIContext used for the API call.</param> <param name="creditCardId">Identifier of the credit card resource to obtain the data for.</param> </member> <member name="M:PayPal.Api.CreditCard.Update(PayPal.Api.APIContext,PayPal.Api.PatchRequest)"> <summary> Update information in a previously saved card. Only the modified fields need to be passed in the request. </summary> <param name="apiContext">APIContext used for the API call.</param> <param name="patchRequest">PatchRequest</param> <returns>CreditCard</returns> </member> <member name="M:PayPal.Api.CreditCard.Update(PayPal.Api.APIContext,System.String,PayPal.Api.PatchRequest)"> <summary> Update information in a previously saved card. Only the modified fields need to be passed in the request. </summary> <param name="apiContext">APIContext used for the API call.</param> <param name="creditCardId">ID fo the credit card to update.</param> <param name="patchRequest">PatchRequest</param> <returns>CreditCard</returns> </member> <member name="M:PayPal.Api.CreditCard.List(PayPal.Api.APIContext,System.Int32,System.Int32,System.String,System.String,System.String,System.String,System.String,System.String,System.String,System.Boolean)"> <summary> Retrieves a list of Credit Card resources. </summary> <param name="apiContext">APIContext used for the API call.</param> <param name="pageSize">Number of items to be returned in the current page size, by a GET operation.</param> <param name="page">The page number to be retrieved, for the list of items, by the current GET request.</param> <param name="startTime">Resource creation time as ISO8601 date-time format (ex: 1994-11-05T13:15:30Z) that indicates the start of a range of results.</param> <param name="endTime">Resource creation time as ISO8601 date-time format (ex: 1994-11-05T13:15:30Z) that indicates the end of a range of results.</param> <param name="sortOrder">Sort based on order of results. Options include 'asc' for ascending order or 'desc' for descending order.</param> <param name="sortBy">Sort based on 'create_time' or 'update_time'.</param> <param name="merchantId">Merchant identifier to filter the search results in list operations.</param> <param name="externalCardId">Externally provided card identifier to filter the search results in list operations.</param> <param name="externalCustomerId">Externally provided customer identifier to filter the search results in list operations.</param> <param name="totalRequired">Identifies if total count is required or not. Defaults to true.</param> <returns>CreditCardList</returns> </member> <member name="T:PayPal.Api.CreditCardList"> <summary> A list of credit card resources returned from a search operation. <para> See <a href="https://developer.paypal.com/docs/api/">PayPal Developer documentation</a> for more information. </para> </summary> </member> <member name="P:PayPal.Api.CreditCardList.items"> <summary> A list of credit card resources </summary> </member> <member name="P:PayPal.Api.CreditCardList.total_items"> <summary> Total number of items present in the given list. Note that the number of items might be larger than the records in the current page. </summary> </member> <member name="P:PayPal.Api.CreditCardList.total_pages"> <summary> Total number of pages that exist, for the total number of items, with the given page size. </summary> </member> <member name="T:PayPal.Api.CreditCardToken"> <summary> A resource representing a credit card that can be used to fund a payment. <para> See <a href="https://developer.paypal.com/docs/api/">PayPal Developer documentation</a> for more information. </para> </summary> </member> <member name="P:PayPal.Api.CreditCardToken.credit_card_id"> <summary> ID of credit card previously stored using `/vault/credit-card`. </summary> </member> <member name="P:PayPal.Api.CreditCardToken.payer_id"> <summary> A unique identifier that you can assign and track when storing a credit card or using a stored credit card. This ID can help to avoid unintentional use or misuse of credit cards. This ID can be any value you would like to associate with the saved card, such as a UUID, username, or email address. **Required when using a stored credit card if a payer_id was originally provided when storing the credit card in vault.** </summary> </member> <member name="P:PayPal.Api.CreditCardToken.last4"> <summary> Last four digits of the stored credit card number. </summary> </member> <member name="P:PayPal.Api.CreditCardToken.type"> <summary> Credit card type. Valid types are: `visa`, `mastercard`, `discover`, `amex`. Values are presented in lowercase and not should not be used for display. </summary> </member> <member name="P:PayPal.Api.CreditCardToken.expire_month"> <summary> Expiration month with no leading zero. Acceptable values are 1 through 12. </summary> </member> <member name="P:PayPal.Api.CreditCardToken.expire_year"> <summary> 4-digit expiration year. </summary> </member> <member name="T:PayPal.Api.Currency"> <summary> Base object for all financial value related fields (balance, payment due, etc.) <para> See <a href="https://developer.paypal.com/docs/api/">PayPal Developer documentation</a> for more information. </para> </summary> </member> <member name="P:PayPal.Api.Currency.currency"> <summary> 3 letter currency code </summary> </member> <member name="P:PayPal.Api.Currency.value"> <summary> amount upto 2 decimals represented as string </summary> </member> <member name="T:PayPal.Api.CurrencyConversion"> <summary> Object used to store the currency conversion rate. <para> See <a href="https://developer.paypal.com/docs/api/">PayPal Developer documentation</a> for more information. </para> </summary> </member> <member name="P:PayPal.Api.CurrencyConversion.conversion_date"> <summary> Date of validity for the conversion rate. </summary> </member> <member name="P:PayPal.Api.CurrencyConversion.from_currency"> <summary> 3 letter currency code </summary> </member> <member name="P:PayPal.Api.CurrencyConversion.from_amount"> <summary> Amount participating in currency conversion, set to 1 as default </summary> </member> <member name="P:PayPal.Api.CurrencyConversion.to_currency"> <summary> 3 letter currency code </summary> </member> <member name="P:PayPal.Api.CurrencyConversion.to_amount"> <summary> Amount resulting from currency conversion. </summary> </member> <member name="P:PayPal.Api.CurrencyConversion.conversion_type"> <summary> Field indicating conversion type applied. </summary> </member> <member name="P:PayPal.Api.CurrencyConversion.conversion_type_changeable"> <summary> Allow Payer to change conversion type. </summary> </member> <member name="P:PayPal.Api.CurrencyConversion.web_url"> <summary> Base URL to web applications endpoint </summary> </member> <member name="T:PayPal.Api.CustomAmount"> <summary> The custom amount to apply to an invoice. If you include a label, you must include a custom amount. <para> See <a href="https://developer.paypal.com/docs/api/">PayPal Developer documentation</a> for more information. </para> </summary> </member> <member name="P:PayPal.Api.CustomAmount.label"> <summary> The custom amount label. </summary> </member> <member name="P:PayPal.Api.CustomAmount.amount"> <summary> The custom amount value. Valid value is from -999999.99 to 999999.99. </summary> </member> <member name="T:PayPal.Api.DetailedRefund"> <summary> A refund transaction. This is the resource that is returned on GET /refund <para> See <a href="https://developer.paypal.com/docs/api/">PayPal Developer documentation</a> for more information. </para> </summary> </member> <member name="P:PayPal.Api.DetailedRefund.custom"> <summary> free-form field for the use of clients </summary> </member> <member name="P:PayPal.Api.DetailedRefund.invoice_number"> <summary> invoice number to track this payment </summary> </member> <member name="P:PayPal.Api.DetailedRefund.refund_to_payer"> <summary> Amount refunded to payer of the original transaction, in the current Refund call </summary> </member> <member name="P:PayPal.Api.DetailedRefund.refund_to_external_funding"> <summary> List of external funding that were refunded by the Refund call. Each external_funding unit should have a unique reference_id </summary> </member> <member name="P:PayPal.Api.DetailedRefund.refund_from_transaction_fee"> <summary> Transaction fee refunded to original recipient of payment. </summary> </member> <member name="P:PayPal.Api.DetailedRefund.refund_from_received_amount"> <summary> Amount subtracted from PayPal balance of the original recipient of payment, to make this refund. </summary> </member> <member name="P:PayPal.Api.DetailedRefund.total_refunded_amount"> <summary> Total amount refunded so far from the original purchase. Say, for example, a buyer makes $100 purchase, the buyer was refunded $20 a week ago and is refunded $30 in this transaction. The gross refund amount is $30 (in this transaction). The total refunded amount is $50. </summary> </member> <member name="T:PayPal.Api.Details"> <summary> Additional details of the payment amount. <para> See <a href="https://developer.paypal.com/docs/api/">PayPal Developer documentation</a> for more information. </para> </summary> </member> <member name="P:PayPal.Api.Details.subtotal"> <summary> Amount of the subtotal of the items. **Required** if line items are specified. 10 characters max, with support for 2 decimal places. </summary> </member> <member name="P:PayPal.Api.Details.shipping"> <summary> Amount charged for shipping. 10 characters max with support for 2 decimal places. </summary> </member> <member name="P:PayPal.Api.Details.tax"> <summary> Amount charged for tax. 10 characters max with support for 2 decimal places. </summary> </member> <member name="P:PayPal.Api.Details.handling_fee"> <summary> Amount being charged for the handling fee. Only supported when the `payment_method` is set to `paypal`. </summary> </member> <member name="P:PayPal.Api.Details.shipping_discount"> <summary> Amount being discounted for the shipping fee. Only supported when the `payment_method` is set to `paypal`. </summary> </member> <member name="P:PayPal.Api.Details.insurance"> <summary> Amount being charged for the insurance fee. Only supported when the `payment_method` is set to `paypal`. </summary> </member> <member name="P:PayPal.Api.Details.gift_wrap"> <summary> Amount being charged as gift wrap fee. </summary> </member> <member name="P:PayPal.Api.Details.fee"> <summary> Fee charged by PayPal. In case of a refund, this is the fee amount refunded to the original receipient of the payment. </summary> </member> <member name="T:PayPal.Api.Error"> <summary> Details of an Error <para> See <a href="https://developer.paypal.com/docs/api/">PayPal Developer documentation</a> for more information. </para> </summary> </member> <member name="P:PayPal.Api.Error.name"> <summary> Human readable, unique name of the error. </summary> </member> <member name="P:PayPal.Api.Error.purchase_unit_reference_id"> <summary> Reference ID of the purchase_unit associated with this error </summary> </member> <member name="P:PayPal.Api.Error.debug_id"> <summary> PayPal internal identifier used for correlation purposes. </summary> </member> <member name="P:PayPal.Api.Error.message"> <summary> Message describing the error. </summary> </member> <member name="P:PayPal.Api.Error.code"> <summary> PayPal internal error code. </summary> </member> <member name="P:PayPal.Api.Error.details"> <summary> Additional details of the error </summary> </member> <member name="P:PayPal.Api.Error.information_link"> <summary> URI for detailed information related to this error for the developer. </summary> </member> <member name="T:PayPal.Api.ErrorDetails"> <summary> Details about a specific error. <para> See <a href="https://developer.paypal.com/docs/api/">PayPal Developer documentation</a> for more information. </para> </summary> </member> <member name="P:PayPal.Api.ErrorDetails.field"> <summary> Name of the field that caused the error. </summary> </member> <member name="P:PayPal.Api.ErrorDetails.issue"> <summary> Reason for the error. </summary> </member> <member name="P:PayPal.Api.ErrorDetails.purchase_unit_reference_id"> <summary> Reference ID of the purchase_unit associated with this error </summary> </member> <member name="P:PayPal.Api.ErrorDetails.code"> <summary> PayPal internal error code. </summary> </member> <member name="T:PayPal.Api.ExtendedBankAccount"> <summary> A resource representing a bank account that can be used to fund a payment including support for SEPA. <para> See <a href="https://developer.paypal.com/docs/api/">PayPal Developer documentation</a> for more information. </para> </summary> </member> <member name="P:PayPal.Api.ExtendedBankAccount.mandate_reference_number"> <summary> Identifier of the direct debit mandate to validate. Currently supported only for EU bank accounts(SEPA). </summary> </member> <member name="T:PayPal.Api.ExternalFunding"> <summary> A resource representing an external funding object. <para> See <a href="https://developer.paypal.com/docs/api/">PayPal Developer documentation</a> for more information. </para> </summary> </member> <member name="P:PayPal.Api.ExternalFunding.reference_id"> <summary> Unique identifier for the external funding </summary> </member> <member name="P:PayPal.Api.ExternalFunding.code"> <summary> Generic identifier for the external funding </summary> </member> <member name="P:PayPal.Api.ExternalFunding.funding_account_id"> <summary> Encrypted PayPal Account identifier for the funding account </summary> </member> <member name="P:PayPal.Api.ExternalFunding.display_text"> <summary> Description of the external funding being applied </summary> </member> <member name="P:PayPal.Api.ExternalFunding.amount"> <summary> Amount being funded by the external funding account </summary> </member> <member name="P:PayPal.Api.ExternalFunding.funding_instruction"> <summary> Indicates that the Payment should be fully funded by External Funded Incentive </summary> </member> <member name="T:PayPal.Api.FileAttachment"> <summary> The file attached to an invoice or template. <para> See <a href="https://developer.paypal.com/docs/api/">PayPal Developer documentation</a> for more information. </para> </summary> </member> <member name="P:PayPal.Api.FileAttachment.name"> <summary> The name of the attached file. </summary> </member> <member name="P:PayPal.Api.FileAttachment.url"> <summary> The URL of the attached file, which can be downloaded. </summary> </member> <member name="T:PayPal.Api.FlowConfig"> <summary> Parameters for flow configuration. <para> See <a href="https://developer.paypal.com/docs/api/">PayPal Developer documentation</a> for more information. </para> </summary> </member> <member name="P:PayPal.Api.FlowConfig.landing_page_type"> <summary> The type of landing page to display on the PayPal site for user checkout. Set to `Billing` to use the non-PayPal account landing page. Set to `Login` to use the PayPal account login landing page. </summary> </member> <member name="P:PayPal.Api.FlowConfig.bank_txn_pending_url"> <summary> The merchant site URL to display after a bank transfer payment. Valid for only the Giropay or bank transfer payment method in Germany. </summary> </member> <member name="P:PayPal.Api.FlowConfig.user_action"> <summary> Defines whether buyers can complete purchases on the PayPal or merchant website. </summary> </member> <member name="P:PayPal.Api.FlowConfig.return_uri_http_method"> <summary> The HTTP method to use to redirect the user to a return URL. Valid value is `GET` or `POST`. </summary> </member> <member name="T:PayPal.Api.FmfDetails"> <summary> Details of Fraud Management Filter (FMF). <para> See <a href="https://developer.paypal.com/docs/api/">PayPal Developer documentation</a> for more information. </para> </summary> </member> <member name="P:PayPal.Api.FmfDetails.filter_type"> <summary> Type of filter. </summary> </member> <member name="P:PayPal.Api.FmfDetails.filter_id"> <summary> Filter Identifier. </summary> </member> <member name="P:PayPal.Api.FmfDetails.name"> <summary> Name of the filter </summary> </member> <member name="P:PayPal.Api.FmfDetails.description"> <summary> Description of the filter. </summary> </member> <member name="T:PayPal.Api.FundingDetail"> <summary> Additional detail of the funding. <para> See <a href="https://developer.paypal.com/docs/api/">PayPal Developer documentation</a> for more information. </para> </summary> </member> <member name="P:PayPal.Api.FundingDetail.clearing_time"> <summary> Expected clearing time </summary> </member> <member name="P:PayPal.Api.FundingDetail.payment_hold_date"> <summary> [DEPRECATED] Hold-off duration of the payment. payment_debit_date should be used instead. </summary> </member> <member name="P:PayPal.Api.FundingDetail.payment_debit_date"> <summary> Date when funds will be debited from the payer's account </summary> </member> <member name="P:PayPal.Api.FundingDetail.processing_type"> <summary> Processing type of the payment card </summary> </member> <member name="T:PayPal.Api.FundingInstrument"> <summary> A resource representing a Payer's funding instrument. An instance of this schema is valid if and only if it is valid against exactly one of these supported properties <para> See <a href="https://developer.paypal.com/docs/api/">PayPal Developer documentation</a> for more information. </para> </summary> </member> <member name="P:PayPal.Api.FundingInstrument.credit_card"> <summary> Credit Card instrument. </summary> </member> <member name="P:PayPal.Api.FundingInstrument.credit_card_token"> <summary> PayPal vaulted credit Card instrument. </summary> </member> <member name="P:PayPal.Api.FundingInstrument.payment_card"> <summary> Payment Card information. <para>NOTE: This property is currently not supported as a funding instrument option with the PayPal REST API.</para> </summary> </member> <member name="P:PayPal.Api.FundingInstrument.bank_account"> <summary> Bank Account information. <para>NOTE: This property is currently not supported as a funding instrument option with the PayPal REST API.</para> </summary> </member> <member name="P:PayPal.Api.FundingInstrument.bank_account_token"> <summary> Bank Account information. <para>NOTE: This property is currently not supported as a funding instrument option with the PayPal REST API.</para> </summary> </member> <member name="P:PayPal.Api.FundingInstrument.credit"> <summary> Credit funding information. <para>NOTE: This property is currently not supported as a funding instrument option with the PayPal REST API.</para> </summary> </member> <member name="P:PayPal.Api.FundingInstrument.incentive"> <summary> Incentive funding information. <para>NOTE: This property is currently not supported as a funding instrument option with the PayPal REST API.</para> </summary> </member> <member name="P:PayPal.Api.FundingInstrument.carrier_account_token"> <summary> Carrier account token information. <para>NOTE: This property is currently not supported as a funding instrument option with the PayPal REST API.</para> </summary> </member> <member name="T:PayPal.Api.FundingOption"> <summary> specifies the funding option details. <para> See <a href="https://developer.paypal.com/docs/api/">PayPal Developer documentation</a> for more information. </para> </summary> </member> <member name="P:PayPal.Api.FundingOption.id"> <summary> id of the funding option. </summary> </member> <member name="P:PayPal.Api.FundingOption.funding_sources"> <summary> List of funding sources that contributes to a payment. </summary> </member> <member name="P:PayPal.Api.FundingOption.backup_funding_instrument"> <summary> Backup funding instrument which will be used for payment if primary fails. </summary> </member> <member name="P:PayPal.Api.FundingOption.currency_conversion"> <summary> Currency conversion applicable to this funding option. </summary> </member> <member name="P:PayPal.Api.FundingOption.installment_info"> <summary> Installment options available for a funding option. </summary> </member> <member name="T:PayPal.Api.FundingSource"> <summary> specifies the funding source details. <para> See <a href="https://developer.paypal.com/docs/api/">PayPal Developer documentation</a> for more information. </para> </summary> </member> <member name="P:PayPal.Api.FundingSource.funding_mode"> <summary> specifies funding mode of the instrument </summary> </member> <member name="P:PayPal.Api.FundingSource.funding_instrument_type"> <summary> Instrument type for this funding source </summary> </member> <member name="P:PayPal.Api.FundingSource.soft_descriptor"> <summary> Soft descriptor used when charging this funding source. </summary> </member> <member name="P:PayPal.Api.FundingSource.amount"> <summary> Total anticipated amount of money to be pulled from instrument. </summary> </member> <member name="P:PayPal.Api.FundingSource.negative_balance_amount"> <summary> Additional amount to be pulled from the instrument to recover a negative balance on the buyer's account that is owed to PayPal. </summary> </member> <member name="P:PayPal.Api.FundingSource.legal_text"> <summary> Localized legal text relevant to funding source. </summary> </member> <member name="P:PayPal.Api.FundingSource.terms"> <summary> URL to legal terms relevant to funding source. </summary> </member> <member name="P:PayPal.Api.FundingSource.funding_detail"> <summary> Additional detail of the funding. </summary> </member> <member name="P:PayPal.Api.FundingSource.additional_text"> <summary> Additional text relevant to funding source. </summary> </member> <member name="P:PayPal.Api.FundingSource.extends"> <summary> </summary> </member> <member name="T:PayPal.Api.FuturePayment"> <summary> A REST API future payment resource. <para> See <a href="https://developer.paypal.com/docs/api/">PayPal Developer documentation</a> for more information. </para> </summary> </member> <member name="M:PayPal.Api.FuturePayment.Create(PayPal.Api.APIContext,System.String)"> <summary> Creates a future payment using the specified API context and correlation ID. </summary> <param name="apiContext">APIContext used for the API call.</param> <param name="correlationId">(Optional) Application correlation ID</param> <returns>A new payment object setup to be used for a future payment.</returns> </member> <member name="M:PayPal.Api.FuturePayment.Create(PayPal.Api.APIContext,PayPal.Api.FuturePayment,System.String)"> <summary> Creates a future payment using the specified API context and correlation ID. </summary> <param name="apiContext">APIContext used for the API call.</param> <param name="payment">FuturePayment object to be used in creating the PayPal resource.</param> <param name="correlationId">(Optional) Application correlation ID</param> <returns>A new payment object setup to be used for a future payment.</returns> </member> <member name="T:PayPal.Api.HyperSchema"> <summary> A REST API hyper schema resource that provides schema information for a HATEOAS link. <para> See <a href="https://developer.paypal.com/docs/api/">PayPal Developer documentation</a> for more information. </para> </summary> </member> <member name="P:PayPal.Api.HyperSchema.fragmentResolution"> <summary> </summary> </member> <member name="P:PayPal.Api.HyperSchema.readOnly"> <summary> </summary> </member> <member name="P:PayPal.Api.HyperSchema.contentEncoding"> <summary> </summary> </member> <member name="P:PayPal.Api.HyperSchema.pathStart"> <summary> </summary> </member> <member name="P:PayPal.Api.HyperSchema.mediaType"> <summary> </summary> </member> <member name="T:PayPal.Api.IPayPalSerializableObject"> <summary> Defines an interface for a PayPal JSON-serializable object. </summary> </member> <member name="M:PayPal.Api.IPayPalSerializableObject.ConvertToJson"> <summary> Converts this object to a JSON string. </summary> <returns>A JSON-formatted string.</returns> </member> <member name="T:PayPal.Api.Image"> <summary> A QR code image for an invoice. <para> See <a href="https://developer.paypal.com/docs/api/">PayPal Developer documentation</a> for more information. </para> </summary> </member> <member name="P:PayPal.Api.Image.image"> <summary> A base-64 encoded string representing a PNG image. </summary> </member> <member name="M:PayPal.Api.Image.Save(System.String)"> <summary> Saves the image data to a file on disk. </summary> <param name="filename">The path to the file where the image will be saved.</param> </member> <member name="M:PayPal.Api.Image.Save(System.String,PayPal.Api.Image)"> <summary> Saves the image data to a file on disk. </summary> <param name="filename">The path to the file where the image will be saved.</param> <param name="image">Image object containing the image data sent from PayPal.</param> </member> <member name="T:PayPal.Api.Incentive"> <summary> A resource representing a incentive. <para> See <a href="https://developer.paypal.com/docs/api/">PayPal Developer documentation</a> for more information. </para> </summary> </member> <member name="P:PayPal.Api.Incentive.id"> <summary> Identifier of the instrument in PayPal Wallet </summary> </member> <member name="P:PayPal.Api.Incentive.code"> <summary> Code that identifies the incentive. </summary> </member> <member name="P:PayPal.Api.Incentive.name"> <summary> Name of the incentive. </summary> </member> <member name="P:PayPal.Api.Incentive.description"> <summary> Description of the incentive. </summary> </member> <member name="P:PayPal.Api.Incentive.minimum_purchase_amount"> <summary> Indicates incentive is applicable for this minimum purchase amount. </summary> </member> <member name="P:PayPal.Api.Incentive.logo_image_url"> <summary> Logo image url for the incentive. </summary> </member> <member name="P:PayPal.Api.Incentive.expiry_date"> <summary> expiry date of the incentive. </summary> </member> <member name="P:PayPal.Api.Incentive.type"> <summary> Specifies type of incentive </summary> </member> <member name="P:PayPal.Api.Incentive.terms"> <summary> URI to the associated terms </summary> </member> <member name="T:PayPal.Api.InputFields"> <summary> Parameters for input fields customization. <para> See <a href="https://developer.paypal.com/docs/api/">PayPal Developer documentation</a> for more information. </para> </summary> </member> <member name="P:PayPal.Api.InputFields.allow_note"> <summary> Indicates whether the buyer can enter a note to the merchant on the PayPal page during checkout. </summary> </member> <member name="P:PayPal.Api.InputFields.no_shipping"> <summary> Indicates whether PayPal displays shipping address fields on the experience pages. For digital goods, this field is required and must be <code>1</code>. Value is:<ul><li><code>0</code>. Displays the shipping address on the PayPal pages.</li><li><code>1</code>. Redacts shipping address fields from the PayPal pages.</li><li><code>2</code>. Gets the shipping address from the buyer's account profile.</li></ul> </summary> </member> <member name="P:PayPal.Api.InputFields.address_override"> <summary> Indicates whether to display the shipping address that is passed to this call rather than the one on file with PayPal for this buyer on the PayPal experience pages. Value is:<ul><li><code>0</code>. Displays the shipping address on file.</li><li><code>1</code>. Displays the shipping address supplied to this call. The buyer cannot edit this shipping address.</li></ul> </summary> </member> <member name="T:PayPal.Api.InstallmentInfo"> <summary> A resource representing installment information available for a transaction <para> See <a href="https://developer.paypal.com/docs/api/">PayPal Developer documentation</a> for more information. </para> </summary> </member> <member name="P:PayPal.Api.InstallmentInfo.installment_id"> <summary> Installment id. </summary> </member> <member name="P:PayPal.Api.InstallmentInfo.network"> <summary> Credit card network. </summary> </member> <member name="P:PayPal.Api.InstallmentInfo.issuer"> <summary> Credit card issuer. </summary> </member> <member name="P:PayPal.Api.InstallmentInfo.installment_options"> <summary> List of available installment options and the cost associated with each one. </summary> </member> <member name="T:PayPal.Api.InstallmentOption"> <summary> A resource describing an installment <para> See <a href="https://developer.paypal.com/docs/api/">PayPal Developer documentation</a> for more information. </para> </summary> </member> <member name="P:PayPal.Api.InstallmentOption.term"> <summary> Number of installments </summary> </member> <member name="P:PayPal.Api.InstallmentOption.monthly_payment"> <summary> Monthly payment </summary> </member> <member name="P:PayPal.Api.InstallmentOption.discount_amount"> <summary> Discount amount applied to the payment, if any </summary> </member> <member name="P:PayPal.Api.InstallmentOption.discount_percentage"> <summary> Discount percentage applied to the payment, if any </summary> </member> <member name="T:PayPal.Api.Invoice"> <summary> Detailed invoice information. <para> See <a href="https://developer.paypal.com/docs/api/">PayPal Developer documentation</a> for more information. </para> </summary> </member> <member name="P:PayPal.Api.Invoice.id"> <summary> The ID of the invoice. </summary> </member> <member name="P:PayPal.Api.Invoice.number"> <summary> The unique invoice number. If you omit this number, it is auto-incremented from the previous invoice number. </summary> </member> <member name="P:PayPal.Api.Invoice.template_id"> <summary> The ID of the template from which to create the invoice. Useful for copy functionality. </summary> </member> <member name="P:PayPal.Api.Invoice.uri"> <summary> The URI of the invoice. </summary> </member> <member name="P:PayPal.Api.Invoice.status"> <summary> The invoice status. </summary> </member> <member name="P:PayPal.Api.Invoice.merchant_info"> <summary> Additional information about the merchant who sends the invoice. </summary> </member> <member name="P:PayPal.Api.Invoice.billing_info"> <summary> The required invoice recipient email address and any optional billing information. Supports only one recipient. </summary> </member> <member name="P:PayPal.Api.Invoice.cc_info"> <summary> For invoices sent by email, one or more email addresses to which to send a Cc: copy of the notification. Supports only email addresses under participant. </summary> </member> <member name="P:PayPal.Api.Invoice.shipping_info"> <summary> The shipping information for entities to whom items are being shipped. </summary> </member> <member name="P:PayPal.Api.Invoice.items"> <summary> The items to include in the invoice. An invoice can contain a maximum of 100 items. </summary> </member> <member name="P:PayPal.Api.Invoice.invoice_date"> <summary> The date when the invoice was enabled. The date format is *yyyy*-*MM*-*dd* *z*, as defined in [Internet Date/Time Format](http://tools.ietf.org/html/rfc3339#section-5.6). </summary> </member> <member name="P:PayPal.Api.Invoice.payment_term"> <summary> Optional. The payment deadline for the invoice. Value is either `term_type` or `due_date` but not both. </summary> </member> <member name="P:PayPal.Api.Invoice.reference"> <summary> Reference data, such as PO number, to add to the invoice. </summary> </member> <member name="P:PayPal.Api.Invoice.discount"> <summary> The invoice level discount, as a percent or an amount value. </summary> </member> <member name="P:PayPal.Api.Invoice.shipping_cost"> <summary> The shipping cost, as a percent or an amount value. </summary> </member> <member name="P:PayPal.Api.Invoice.custom"> <summary> The custom amount to apply to an invoice. If you include a label, you must include a custom amount. </summary> </member> <member name="P:PayPal.Api.Invoice.allow_partial_payment"> <summary> Indicates whether the invoice allows a partial payment. If `false`, invoice must be paid in full. If `true`, the invoice allows partial payments. Default is `false`. </summary> </member> <member name="P:PayPal.Api.Invoice.minimum_amount_due"> <summary> The minimum amount allowed for a partial payment. Required if `allow_partial_payment` is `true`. </summary> </member> <member name="P:PayPal.Api.Invoice.tax_calculated_after_discount"> <summary> Indicates whether the tax is calculated before or after a discount. If `false`, the tax is calculated before a discount. If `true`, the tax is calculated after a discount. Default is `false`. </summary> </member> <member name="P:PayPal.Api.Invoice.tax_inclusive"> <summary> Indicates whether the unit price includes tax. Default is `false`. </summary> </member> <member name="P:PayPal.Api.Invoice.terms"> <summary> The general terms of the invoice. </summary> </member> <member name="P:PayPal.Api.Invoice.note"> <summary> A note to the payer. </summary> </member> <member name="P:PayPal.Api.Invoice.merchant_memo"> <summary> A private bookkeeping memo for the merchant. </summary> </member> <member name="P:PayPal.Api.Invoice.logo_url"> <summary> The full URL to an external logo image. </summary> </member> <member name="P:PayPal.Api.Invoice.total_amount"> <summary> The total amount of the invoice. </summary> </member> <member name="P:PayPal.Api.Invoice.payments"> <summary> List of payment details for the invoice. </summary> </member> <member name="P:PayPal.Api.Invoice.refunds"> <summary> List of refund details for the invoice. </summary> </member> <member name="P:PayPal.Api.Invoice.metadata"> <summary> Audit information for the invoice. </summary> </member> <member name="P:PayPal.Api.Invoice.additional_data"> <summary> Any miscellaneous invoice data. </summary> </member> <member name="P:PayPal.Api.Invoice.gratuity"> <summary> Gratuity to include with the invoice. </summary> </member> <member name="P:PayPal.Api.Invoice.payment_details"> <summary> Payment summary of the invoice including amount paid through PayPal and other sources. </summary> </member> <member name="P:PayPal.Api.Invoice.paid_amount"> <summary> Payment summary of the invoice including amount paid through PayPal and other sources. </summary> </member> <member name="P:PayPal.Api.Invoice.refund_details"> <summary> Payment summary of the invoice, including amount refunded through PayPal and other sources. </summary> </member> <member name="P:PayPal.Api.Invoice.refunded_amount"> <summary> Payment summary of the invoice, including amount refunded through PayPal and other sources. </summary> </member> <member name="P:PayPal.Api.Invoice.attachments"> <summary> List of files that are attached to the invoice. </summary> </member> <member name="M:PayPal.Api.Invoice.Create(PayPal.Api.APIContext)"> <param name="apiContext">APIContext used for the API call.</param> <returns>Invoice</returns> </member> <member name="M:PayPal.Api.Invoice.Create(PayPal.Api.APIContext,PayPal.Api.Invoice)"> <summary> Creates a draft invoice. You can optionally create an invoice [template](/docs/api/invoicing/#templates). Then, when you create an invoice from a template, the invoice is populated with the predefined data that the source template contains. To move the invoice from a draft to payable state, you must [send the invoice](/docs/api/invoicing/#invoices_send). In the JSON request body, include invoice details including merchant information. The `invoice` object must include an `items` array.<blockquote><strong>Note:</strong> The merchant specified in an invoice must have a PayPal account in good standing.</blockquote> </summary> <param name="apiContext">APIContext used for the API call.</param> <param name="invoice">Invoice object to be used for creating the PayPal resource.</param> <returns>Invoice</returns> </member> <member name="M:PayPal.Api.Invoice.Search(PayPal.Api.APIContext,PayPal.Api.Search)"> <summary> Lists invoices that match search criteria. In the JSON request body, include a `search` object that specifies the search criteria. </summary> <param name="apiContext">APIContext used for the API call.</param> <param name="search">Search</param> <returns>InvoiceSearchResponse</returns> </member> <member name="M:PayPal.Api.Invoice.Send(PayPal.Api.APIContext,System.Boolean)"> <summary> Sends an invoice, by ID, to a customer.<blockquote><strong>Note:</strong> After you send an invoice, you cannot resend it.</blockquote><br/>Optionally, set the `notify_merchant` query parameter to also send the merchant an invoice update notification. Default is `true`. </summary> <param name="apiContext">APIContext used for the API call.</param> <param name="notifyMerchant">Indicates whether to send the invoice update notification to the merchant. Default is `true`.</param> </member> <member name="M:PayPal.Api.Invoice.Send(PayPal.Api.APIContext,System.String,System.Boolean)"> <summary> Sends a legitimate invoice to the payer. </summary> <param name="apiContext">APIContext used for the API call.</param> <param name="invoiceId">ID of the invoice to send.</param> <param name="notifyMerchant">Specifies if the invoice send notification is needed for merchant</param> </member> <member name="M:PayPal.Api.Invoice.Remind(PayPal.Api.APIContext,PayPal.Api.Notification)"> <summary> Sends a reminder about an invoice, by ID, to a customer. In the JSON request body, include a `notification` object that defines the subject of the reminder and other details. </summary> <param name="apiContext">APIContext used for the API call.</param> <param name="notification">Notification</param> </member> <member name="M:PayPal.Api.Invoice.Remind(PayPal.Api.APIContext,System.String,PayPal.Api.Notification)"> <summary> Reminds the payer to pay the invoice. </summary> <param name="apiContext">APIContext used for the API call.</param> <param name="invoiceId">ID of the invoice the payer will be reminded to pay.</param> <param name="notification">Notification</param> </member> <member name="M:PayPal.Api.Invoice.Cancel(PayPal.Api.APIContext,PayPal.Api.CancelNotification)"> <summary> Cancels a sent invoice, by ID, and, optionally, sends a notification about the cancellation to the payer, merchant, and Cc: emails. </summary> <param name="apiContext">APIContext used for the API call.</param> <param name="cancelNotification">CancelNotification</param> </member> <member name="M:PayPal.Api.Invoice.Cancel(PayPal.Api.APIContext,System.String,PayPal.Api.CancelNotification)"> <summary> Cancels an invoice. </summary> <param name="apiContext">APIContext used for the API call.</param> <param name="invoiceId">ID of the invoice to cancel.</param> <param name="cancelNotification">CancelNotification</param> </member> <member name="M:PayPal.Api.Invoice.RecordPayment(PayPal.Api.APIContext,PayPal.Api.PaymentDetail)"> <summary> Marks the status of a specified invoice, by ID, as paid. Include a payment detail object that defines the payment method and other details in the JSON request body. </summary> <param name="apiContext">APIContext used for the API call.</param> <param name="paymentDetail">PaymentDetail</param> </member> <member name="M:PayPal.Api.Invoice.RecordPayment(PayPal.Api.APIContext,System.String,PayPal.Api.PaymentDetail)"> <summary> Mark the status of the invoice as paid. </summary> <param name="apiContext">APIContext used for the API call.</param> <param name="invoiceId">ID of the invoice to mark as paid.</param> <param name="paymentDetail">PaymentDetail</param> </member> <member name="M:PayPal.Api.Invoice.RecordRefund(PayPal.Api.APIContext,PayPal.Api.RefundDetail)"> <summary> Marks the status of an invoice, by ID, as refunded. In the JSON request body, include a payment detail object that defines the payment method and other details. </summary> <param name="apiContext">APIContext used for the API call.</param> <param name="refundDetail">RefundDetail</param> </member> <member name="M:PayPal.Api.Invoice.RecordRefund(PayPal.Api.APIContext,System.String,PayPal.Api.RefundDetail)"> <summary> Mark the status of the invoice as refunded. </summary> <param name="apiContext">APIContext used for the API call.</param> <param name="invoiceId">ID fo the invoice to mark as refunded.</param> <param name="refundDetail">RefundDetail</param> </member> <member name="M:PayPal.Api.Invoice.Get(PayPal.Api.APIContext,System.String)"> <summary> Shows details for a specified invoice, by ID. </summary> <param name="apiContext">APIContext used for the API call.</param> <param name="invoiceId">The ID of the invoice for which to show details.</param> <returns>Invoice</returns> </member> <member name="M:PayPal.Api.Invoice.GetAll(PayPal.Api.APIContext,System.Int32,System.Int32,System.Boolean)"> <summary> Lists merchant invoices. Optionally, you can specify one or more query parameters to filter the response. </summary> <param name="apiContext">APIContext used for the API call.</param> <param name="page">A *zero-relative* index of the list of merchant invoices.</param> <param name="pageSize">The number of invoices to list beginning with the specified `page`.</param> <param name="totalCountRequired">Indicates whether the total count appears in the response. Default is `false`.</param> <returns>InvoiceSearchResponse</returns> </member> <member name="M:PayPal.Api.Invoice.Update(PayPal.Api.APIContext,System.Boolean)"> <summary> Fully updates an invoice, by ID. In the JSON request body, include a complete `invoice` object. This call does not support partial updates. </summary> <param name="apiContext">APIContext used for the API call.</param> <param name="notifyMerchant">Indicates whether to send the invoice update notification to the merchant. Default is `true`.</param> <returns>Invoice</returns> </member> <member name="M:PayPal.Api.Invoice.Update(PayPal.Api.APIContext,PayPal.Api.Invoice,System.Boolean)"> <summary> Full update of the invoice resource for the given identifier. </summary> <param name="apiContext">APIContext used for the API call.</param> <param name="invoice">Invoice object to update.</param> <param name="notifyMerchant">Specifies if the invoice update notification is needed for merchant</param> <returns>Invoice</returns> </member> <member name="M:PayPal.Api.Invoice.Delete(PayPal.Api.APIContext)"> <summary> Deletes a draft invoice, by ID. Note that this call works for invoices in the draft state only. For invoices that have already been sent, you can [cancel the invoice](/docs/api/invoicing/#invoices_cancel). After you delete a draft invoice, you can no longer use it or show its details. However, you can reuse its invoice number. </summary> <param name="apiContext">APIContext used for the API call.</param> </member> <member name="M:PayPal.Api.Invoice.Delete(PayPal.Api.APIContext,System.String)"> <summary> Deletes a draft invoice, by ID. Note that this call works for invoices in the draft state only. For invoices that have already been sent, you can [cancel the invoice](/docs/api/invoicing/#invoices_cancel). After you delete a draft invoice, you can no longer use it or show its details. However, you can reuse its invoice number. </summary> <param name="apiContext">APIContext used for the API call.</param> <param name="invoiceId">The ID of the invoice to delete.</param> </member> <member name="M:PayPal.Api.Invoice.DeleteExternalPayment(PayPal.Api.APIContext,System.String,System.String)"> <summary> Deletes an external payment, by invoice ID and transaction ID. </summary> <param name="apiContext">APIContext used for the API call.</param> <param name="invoiceId">The ID of the invoice from which to delete a payment transaction.</param> <param name="transactionId">The ID of the payment transaction to delete.</param> </member> <member name="M:PayPal.Api.Invoice.DeleteExternalRefund(PayPal.Api.APIContext,System.String,System.String)"> <summary> Deletes an external refund, by invoice ID and transaction ID. </summary> <param name="apiContext">APIContext used for the API call.</param> <param name="invoiceId">The ID of the invoice from which to delete the refund transaction.</param> <param name="transactionId">The ID of the refund transaction to delete.</param> </member> <member name="M:PayPal.Api.Invoice.QrCode(PayPal.Api.APIContext,System.String,System.Int32,System.Int32,System.String)"> <summary> Generates a QR code for an invoice, by ID.<br/><br/>The QR code is a PNG image in [Base64-encoded](https://www.base64encode.org/) format that corresponds to the invoice ID. You can generate a QR code for an invoice and add it to a paper or PDF invoice. When a customer uses their mobile device to scan the QR code, he or she is redirected to the PayPal mobile payment flow where he or she can pay online with PayPal or a credit card.<br/><br/>Before you get a QR code, you must:<ol><li><p>[Create an invoice](#invoices_create). Specify `qrinvoice@paypal.com` as the recipient email address in the `billing_info` object. Use a customer email address only if you want to email the invoice.</p></li><li><p>[Send an invoice](#invoices_send) to move the invoice from a draft to payable state. If you specify `qrinvoice@paypal.com` as the recipient email address, the invoice is not emailed.</p></li></ol> </summary> <param name="apiContext">APIContext used for the API call.</param> <param name="invoiceId">The ID of the invoice for which to generate a QR code.</param> <param name="width">The width, in pixels, of the QR code image. Valid value is from 150 to 500. Default is 500.</param> <param name="height">The height, in pixels, of the QR code image. Valid value is from 150 to 500. Default is 500.</param> <param name="action">The type of URL for which to generate a QR code. Default is `pay` and is the only supported value.</param> <returns>Image</returns> </member> <member name="M:PayPal.Api.Invoice.GenerateNumber(PayPal.Api.APIContext)"> <summary> Generates the next invoice number that is available to the user. </summary> <param name="apiContext">APIContext used for the API call.</param> <returns>InvoiceNumber</returns> </member> <member name="T:PayPal.Api.InvoiceAddress"> <summary> Base Address object used as billing address in a payment or extended for Shipping Address. <para> See <a href="https://developer.paypal.com/docs/api/">PayPal Developer documentation</a> for more information. </para> </summary> </member> <member name="P:PayPal.Api.InvoiceAddress.phone"> <summary> Phone number in E.123 format. </summary> </member> <member name="T:PayPal.Api.InvoiceItem"> <summary> Line item information. <para> See <a href="https://developer.paypal.com/docs/api/">PayPal Developer documentation</a> for more information. </para> </summary> </member> <member name="P:PayPal.Api.InvoiceItem.name"> <summary> The item name. </summary> </member> <member name="P:PayPal.Api.InvoiceItem.description"> <summary> The item description. </summary> </member> <member name="P:PayPal.Api.InvoiceItem.quantity"> <summary> The item quantity. Valid value is from -10000 to 10000. </summary> </member> <member name="P:PayPal.Api.InvoiceItem.unit_price"> <summary> The item unit price. Valid value is from -1,000,000 to 1,000,000. </summary> </member> <member name="P:PayPal.Api.InvoiceItem.tax"> <summary> The tax associated with the item. </summary> </member> <member name="P:PayPal.Api.InvoiceItem.date"> <summary> The date when the item or service was provided. The date format is *yyyy*-*MM*-*dd* *z*, as defined in [Internet Date/Time Format](http://tools.ietf.org/html/rfc3339#section-5.6). </summary> </member> <member name="P:PayPal.Api.InvoiceItem.discount"> <summary> The item discount, as a percent or an amount value. </summary> </member> <member name="P:PayPal.Api.InvoiceItem.unit_of_measure"> <summary> The unit of measure for the invoiced item. Value is quantity, hours, or amount. </summary> </member> <member name="T:PayPal.Api.InvoiceNumber"> <summary> <para> See <a href="https://developer.paypal.com/docs/api/">PayPal Developer documentation</a> for more information. </para> </summary> </member> <member name="P:PayPal.Api.InvoiceNumber.number"> <summary> The next invoice number that is available to the user. This number is auto-incremented from the most recent invoice number. </summary> </member> <member name="T:PayPal.Api.InvoiceSearchResponse"> <summary> Response object from an invoice search operation. <para> See <a href="https://developer.paypal.com/docs/api/">PayPal Developer documentation</a> for more information. </para> </summary> </member> <member name="P:PayPal.Api.InvoiceSearchResponse.total_count"> <summary> Total number of invoices. </summary> </member> <member name="P:PayPal.Api.InvoiceSearchResponse.invoices"> <summary> List of invoices belonging to a merchant. </summary> </member> <member name="T:PayPal.Api.Item"> <summary> Item details. <para> See <a href="https://developer.paypal.com/docs/api/">PayPal Developer documentation</a> for more information. </para> </summary> </member> <member name="P:PayPal.Api.Item.sku"> <summary> Stock keeping unit corresponding (SKU) to item. </summary> </member> <member name="P:PayPal.Api.Item.name"> <summary> Item name. 127 characters max. </summary> </member> <member name="P:PayPal.Api.Item.description"> <summary> Description of the item. Only supported when the `payment_method` is set to `paypal`. </summary> </member> <member name="P:PayPal.Api.Item.quantity"> <summary> Number of a particular item. 10 characters max. </summary> </member> <member name="P:PayPal.Api.Item.price"> <summary> Item cost. 10 characters max. </summary> </member> <member name="P:PayPal.Api.Item.currency"> <summary> 3-letter [currency code](https://developer.paypal.com/docs/integration/direct/rest_api_payment_country_currency_support/). </summary> </member> <member name="P:PayPal.Api.Item.tax"> <summary> Tax of the item. Only supported when the `payment_method` is set to `paypal`. </summary> </member> <member name="P:PayPal.Api.Item.url"> <summary> URL linking to item information. Available to payer in transaction history. </summary> </member> <member name="P:PayPal.Api.Item.supplementary_data"> <summary> Set of optional data used for PayPal risk determination. </summary> </member> <member name="P:PayPal.Api.Item.postback_data"> <summary> Set of optional data used for PayPal post-transaction notifications. </summary> </member> <member name="P:PayPal.Api.Item.category"> <summary> Category type of the item. </summary> </member> <member name="P:PayPal.Api.Item.weight"> <summary> Weight of the item. </summary> </member> <member name="P:PayPal.Api.Item.length"> <summary> Length of the item. </summary> </member> <member name="P:PayPal.Api.Item.height"> <summary> Height of the item. </summary> </member> <member name="P:PayPal.Api.Item.width"> <summary> Width of the item. </summary> </member> <member name="T:PayPal.Api.ItemList"> <summary> Details of a list of purchasable items and shipping information included with a payment transaction. </summary> </member> <member name="P:PayPal.Api.ItemList.items"> <summary> List of items. </summary> </member> <member name="P:PayPal.Api.ItemList.shipping_address"> <summary> Shipping address. </summary> </member> <member name="P:PayPal.Api.ItemList.shipping_method"> <summary> Shipping method used for this payment like USPSParcel etc. </summary> </member> <member name="P:PayPal.Api.ItemList.shipping_phone_number"> <summary> Allows merchant's to share payer’s contact number with PayPal for the current payment. Final contact number of payer associated with the transaction might be same as shipping_phone_number or different based on Payer’s action on PayPal. The phone number must be represented in its canonical international format, as defined by the E.164 numbering plan </summary> </member> <member name="T:PayPal.Api.JsonFormatterDeserializationErrorEventArgs"> <summary> Event arguments for when an error is encountered while deserializing a JSON string. </summary> </member> <member name="P:PayPal.Api.JsonFormatterDeserializationErrorEventArgs.Message"> <summary> Gets or sets the error message associated with this event. </summary> </member> <member name="T:PayPal.Api.JsonFormatterDeserializationErrorEventHandler"> <summary> Event handler delegate for when an error is encountered while deserializing a JSON string. </summary> <param name="e"></param> </member> <member name="T:PayPal.Api.JsonFormatter"> <summary> Helper class that handles serializing and deserializing to and from JSON strings, respectively. </summary> </member> <member name="E:PayPal.Api.JsonFormatter.DeserializationError"> <summary> Event handler for when an error occurs while attempting to deserialize a JSON string. </summary> </member> <member name="M:PayPal.Api.JsonFormatter.ConvertToJson``1(``0)"> <summary> Converts the specified object to a JSON string. </summary> <typeparam name="T">A JSON-serializable object type.</typeparam> <param name="t">The object to be serialized.</param> <returns>A JSON string representing the specified object.</returns> </member> <member name="M:PayPal.Api.JsonFormatter.ConvertFromJson``1(System.String)"> <summary> Converts the specified JSON string to the specified object. </summary> <typeparam name="T">The object type to which the JSON string will be deserialized.</typeparam> <param name="value">A JSON string.</param> <returns>An object containing the data from the JSON string.</returns> </member> <member name="M:PayPal.Api.JsonFormatter.ErrorHandler(System.Object,Newtonsoft.Json.Serialization.ErrorEventArgs)"> <summary> Error handler for errors encountered while attempting to deserialize a JSON string. </summary> <param name="sender">Object that sent the event</param> <param name="e">Event arguments</param> </member> <member name="T:PayPal.Api.Links"> <summary> A HATEOAS (Hypermedia as the Engine of Application State) link included with most PayPal REST API resource objects. <para> See <a href="https://developer.paypal.com/docs/api/">PayPal Developer documentation</a> for more information. </para> </summary> </member> <member name="P:PayPal.Api.Links.href"> <summary> </summary> </member> <member name="P:PayPal.Api.Links.rel"> <summary> </summary> </member> <member name="P:PayPal.Api.Links.targetSchema"> <summary> </summary> </member> <member name="P:PayPal.Api.Links.method"> <summary> </summary> </member> <member name="P:PayPal.Api.Links.enctype"> <summary> </summary> </member> <member name="P:PayPal.Api.Links.schema"> <summary> </summary> </member> <member name="T:PayPal.Api.Measurement"> <summary> Measurement to represent item dimensions like length, width, height and weight etc. <para> See <a href="https://developer.paypal.com/docs/api/">PayPal Developer documentation</a> for more information. </para> </summary> </member> <member name="P:PayPal.Api.Measurement.value"> <summary> Value this measurement represents. </summary> </member> <member name="P:PayPal.Api.Measurement.unit"> <summary> Unit in which the value is represented. </summary> </member> <member name="T:PayPal.Api.MerchantInfo"> <summary> Merchant business information that appears on the invoice. <para> See <a href="https://developer.paypal.com/docs/api/">PayPal Developer documentation</a> for more information. </para> </summary> </member> <member name="P:PayPal.Api.MerchantInfo.email"> <summary> The merchant email address. </summary> </member> <member name="P:PayPal.Api.MerchantInfo.first_name"> <summary> The merchant first name. </summary> </member> <member name="P:PayPal.Api.MerchantInfo.last_name"> <summary> The merchant last name. </summary> </member> <member name="P:PayPal.Api.MerchantInfo.address"> <summary> The merchant address. </summary> </member> <member name="P:PayPal.Api.MerchantInfo.business_name"> <summary> The merchant company business name. </summary> </member> <member name="P:PayPal.Api.MerchantInfo.phone"> <summary> The merchant phone number. </summary> </member> <member name="P:PayPal.Api.MerchantInfo.fax"> <summary> The merchant fax number. </summary> </member> <member name="P:PayPal.Api.MerchantInfo.website"> <summary> The merchant website. </summary> </member> <member name="P:PayPal.Api.MerchantInfo.tax_id"> <summary> The merchant tax ID. </summary> </member> <member name="P:PayPal.Api.MerchantInfo.additional_info_label"> <summary> A label for the `additional_info` field. </summary> </member> <member name="P:PayPal.Api.MerchantInfo.additional_info"> <summary> Additional information, such as business hours. </summary> </member> <member name="T:PayPal.Api.MerchantPreferences"> <summary> Merchant preferences for a billing agreement. <para> See <a href="https://developer.paypal.com/docs/api/">PayPal Developer documentation</a> for more information. </para> </summary> </member> <member name="P:PayPal.Api.MerchantPreferences.id"> <summary> Identifier of the merchant_preferences. 128 characters max. </summary> </member> <member name="P:PayPal.Api.MerchantPreferences.setup_fee"> <summary> Setup fee amount. Default is 0. </summary> </member> <member name="P:PayPal.Api.MerchantPreferences.cancel_url"> <summary> Redirect URL on cancellation of agreement request. 1000 characters max. </summary> </member> <member name="P:PayPal.Api.MerchantPreferences.return_url"> <summary> Redirect URL on creation of agreement request. 1000 characters max. </summary> </member> <member name="P:PayPal.Api.MerchantPreferences.notify_url"> <summary> Notify URL on agreement creation. 1000 characters max. </summary> </member> <member name="P:PayPal.Api.MerchantPreferences.max_fail_attempts"> <summary> Total number of failed attempts allowed. Default is 0, representing an infinite number of failed attempts. </summary> </member> <member name="P:PayPal.Api.MerchantPreferences.auto_bill_amount"> <summary> Allow auto billing for the outstanding amount of the agreement in the next cycle. Allowed values: `YES`, `NO`. Default is `NO`. </summary> </member> <member name="P:PayPal.Api.MerchantPreferences.initial_fail_amount_action"> <summary> Action to take if a failure occurs during initial payment. Allowed values: `CONTINUE`, `CANCEL`. Default is continue. </summary> </member> <member name="P:PayPal.Api.MerchantPreferences.accepted_payment_type"> <summary> Payment types that are accepted for this plan. </summary> </member> <member name="P:PayPal.Api.MerchantPreferences.char_set"> <summary> char_set for this plan. </summary> </member> <member name="T:PayPal.Api.Metadata"> <summary> Audit information for the resource. <para> See <a href="https://developer.paypal.com/docs/api/">PayPal Developer documentation</a> for more information. </para> </summary> </member> <member name="P:PayPal.Api.Metadata.created_date"> <summary> The date and time when the resource was created. </summary> </member> <member name="P:PayPal.Api.Metadata.created_by"> <summary> The email address of the account that created the resource. </summary> </member> <member name="P:PayPal.Api.Metadata.cancelled_date"> <summary> The date and time when the resource was canceled. </summary> </member> <member name="P:PayPal.Api.Metadata.cancelled_by"> <summary> The actor who canceled the resource. </summary> </member> <member name="P:PayPal.Api.Metadata.last_updated_date"> <summary> The date and time when the resource was last edited. </summary> </member> <member name="P:PayPal.Api.Metadata.last_updated_by"> <summary> The email address of the account that last edited the resource. </summary> </member> <member name="P:PayPal.Api.Metadata.first_sent_date"> <summary> The date and time when the resource was first sent. </summary> </member> <member name="P:PayPal.Api.Metadata.last_sent_date"> <summary> The date and time when the resource was last sent. </summary> </member> <member name="P:PayPal.Api.Metadata.last_sent_by"> <summary> The email address of the account that last sent the resource. </summary> </member> <member name="P:PayPal.Api.Metadata.payer_view_url"> <summary> URL representing the payer's view of the invoice. </summary> </member> <member name="T:PayPal.Api.NameValuePair"> <summary> Used to define a type for name-value pairs. The use of name value pairs in an API should be limited and approved by architecture. <para> See <a href="https://developer.paypal.com/docs/api/">PayPal Developer documentation</a> for more information. </para> </summary> </member> <member name="P:PayPal.Api.NameValuePair.name"> <summary> Key for the name value pair. The value name types should be correlated </summary> </member> <member name="P:PayPal.Api.NameValuePair.value"> <summary> Value for the name value pair. </summary> </member> <member name="T:PayPal.Api.Notification"> <summary> Email/SMS notification. <para> See <a href="https://developer.paypal.com/docs/api/">PayPal Developer documentation</a> for more information. </para> </summary> </member> <member name="P:PayPal.Api.Notification.subject"> <summary> The subject of the notification. </summary> </member> <member name="P:PayPal.Api.Notification.note"> <summary> A note to the payer. </summary> </member> <member name="P:PayPal.Api.Notification.send_to_merchant"> <summary> Indicates whether to send a copy of the email to the merchant. </summary> </member> <member name="P:PayPal.Api.Notification.cc_emails"> <summary> An array of one or more Cc: emails. If you omit this parameter from the JSON request body, a notification is sent to all Cc: email addresses that are part of the invoice. Otherwise, specify this parameter to limit the email addresses to which notifications are sent.<blockquote><strong>Note:</strong> Additional email addresses are not supported.</blockquote> </summary> </member> <member name="T:PayPal.Api.OAuthTokenCredential"> <summary> OAuthTokenCredential is used for generation of OAuth Token used by PayPal REST API service. clientId and clientSecret are required by the class to generate OAuth Token, the resulting token is of the form "Bearer xxxxxx". The class has two constructors, one of it taking an additional Dictionary used for dynamic configuration. </summary> </member> <member name="F:PayPal.Api.OAuthTokenCredential.OAuthTokenPath"> <summary> Specifies the PayPal endpoint for sending an OAuth request. </summary> </member> <member name="F:PayPal.Api.OAuthTokenCredential.config"> <summary> Dynamic configuration map </summary> </member> <member name="F:PayPal.Api.OAuthTokenCredential.accessToken"> <summary> Cached access token that is generated when calling <see cref="M:PayPal.Api.OAuthTokenCredential.GetAccessToken"/>. </summary> </member> <member name="F:PayPal.Api.OAuthTokenCredential.SdkVersion"> <summary> SDKVersion instance </summary> </member> <member name="P:PayPal.Api.OAuthTokenCredential.ClientId"> <summary> Gets the client ID to be used when creating an OAuth token. </summary> </member> <member name="P:PayPal.Api.OAuthTokenCredential.ClientSecret"> <summary> Gets the client secret to be used when creating an OAuth token. </summary> </member> <member name="P:PayPal.Api.OAuthTokenCredential.ApplicationId"> <summary> Gets the application ID returned by OAuth servers. Must first call <see cref="M:PayPal.Api.OAuthTokenCredential.GetAccessToken"/> to populate this property. </summary> </member> <member name="P:PayPal.Api.OAuthTokenCredential.AccessTokenExpirationInSeconds"> <summary> Gets or sets the lifetime of a created access token in seconds. Must first call <see cref="M:PayPal.Api.OAuthTokenCredential.GetAccessToken"/> to populate this property. </summary> </member> <member name="P:PayPal.Api.OAuthTokenCredential.AccessTokenLastCreationDate"> <summary> Gets the last date when access token was generated. Must first call <see cref="M:PayPal.Api.OAuthTokenCredential.GetAccessToken"/> to populate this property. </summary> </member> <member name="P:PayPal.Api.OAuthTokenCredential.AccessTokenExpirationSafetyGapInSeconds"> <summary> Gets or sets the safety gap when checking the expiration of an already created access token in seconds. If the elapsed time since the last access token was created is more than the expiration - the safety gap, then a new token will be created when calling <see cref="M:PayPal.Api.OAuthTokenCredential.GetAccessToken"/>. </summary> </member> <member name="M:PayPal.Api.OAuthTokenCredential.#ctor(System.Collections.Generic.Dictionary{System.String,System.String})"> <summary> </summary> <param name="config"></param> </member> <member name="M:PayPal.Api.OAuthTokenCredential.#ctor(System.String,System.String)"> <summary> Client Id and Secret for the OAuth </summary> <param name="clientId"></param> <param name="clientSecret"></param> </member> <member name="M:PayPal.Api.OAuthTokenCredential.#ctor(System.String,System.String,System.Collections.Generic.Dictionary{System.String,System.String})"> <summary> Client Id and Secret for the OAuth </summary> <param name="clientId"></param> <param name="clientSecret"></param> <param name="config"></param> </member> <member name="M:PayPal.Api.OAuthTokenCredential.GetAccessToken"> <summary> Returns the currently cached access token. If no access token was previously cached, or if the current access token is expired, then a new one is generated and returned. </summary> <returns>The OAuth access token to use for making PayPal requests.</returns> <exception cref="T:PayPal.MissingCredentialException">Thrown if clientId or clientSecret are null or empty.</exception> <exception cref="T:PayPal.InvalidCredentialException">Thrown if there is an issue converting the credentials to a formatted authorization string.</exception> <exception cref="T:PayPal.IdentityException">Thrown if authorization fails as a result of providing invalid credentials.</exception> <exception cref="T:PayPal.HttpException">Thrown if authorization fails and an HTTP error response is received.</exception> <exception cref="T:PayPal.ConnectionException">Thrown if there is an issue attempting to connect to PayPal's services.</exception> <exception cref="T:PayPal.ConfigException">Thrown if there is an error with any informaiton provided by the <see cref="T:PayPal.Api.ConfigManager"/>.</exception> <exception cref="T:PayPal.PayPalException">Thrown for any other general exception. See inner exception for further details.</exception> </member> <member name="M:PayPal.Api.OAuthTokenCredential.GenerateOAuthToken"> <summary> Generates a new OAuth token useing the specified client credentials in the authorization request. </summary> <returns>The OAuth access token to use for making PayPal requests.</returns> </member> <member name="M:PayPal.Api.OAuthTokenCredential.GetEndpointOverride"> <summary> Gets the overridden endpoint defined in the config, if set. Otherwise returns an empty string, in which case the default endpoint will be used when requesting a new token. </summary> <returns>An endpoint to use; empty string if no override is specified.</returns> </member> <member name="T:PayPal.Api.Order"> <summary> An order transaction. <para> See <a href="https://developer.paypal.com/docs/api/">PayPal Developer documentation</a> for more information. </para> </summary> </member> <member name="P:PayPal.Api.Order.id"> <summary> Identifier of the order transaction. </summary> </member> <member name="P:PayPal.Api.Order.purchase_unit_reference_id"> <summary> Identifier to the purchase unit associated with this object. Obsolete. Use one in cart_base. </summary> </member> <member name="P:PayPal.Api.Order.amount"> <summary> Amount being collected. </summary> </member> <member name="P:PayPal.Api.Order.payment_mode"> <summary> specifies payment mode of the transaction </summary> </member> <member name="P:PayPal.Api.Order.state"> <summary> State of the order transaction. </summary> </member> <member name="P:PayPal.Api.Order.reason_code"> <summary> Reason code for the transaction state being Pending or Reversed. This field will replace pending_reason field eventually. Only supported when the `payment_method` is set to `paypal`. </summary> </member> <member name="P:PayPal.Api.Order.pending_reason"> <summary> [DEPRECATED] Reason code for the transaction state being Pending. Obsolete. Retained for backward compatability. Use reason_code field above instead. </summary> </member> <member name="P:PayPal.Api.Order.protection_eligibility"> <summary> The level of seller protection in force for the transaction. </summary> </member> <!-- Badly formed XML comment ignored for member "P:PayPal.Api.Order.protection_eligibility_type" --> <member name="P:PayPal.Api.Order.parent_payment"> <summary> ID of the Payment resource that this transaction is based on. </summary> </member> <member name="P:PayPal.Api.Order.fmf_details"> <summary> Fraud Management Filter (FMF) details applied for the payment that could result in accept/deny/pending action. </summary> </member> <member name="P:PayPal.Api.Order.create_time"> <summary> Time the resource was created in UTC ISO8601 format. </summary> </member> <member name="P:PayPal.Api.Order.update_time"> <summary> Time the resource was last updated in UTC ISO8601 format. </summary> </member> <member name="M:PayPal.Api.Order.Get(PayPal.Api.APIContext,System.String)"> <summary> Shows details for an order, by ID. </summary> <param name="apiContext">APIContext used for the API call.</param> <param name="orderId">The ID of the order for which to show details.</param> <returns>Order</returns> </member> <member name="M:PayPal.Api.Order.Capture(PayPal.Api.APIContext,PayPal.Api.Capture)"> <summary> Captures a payment for an order, by ID. To use this call, the original payment call must specify an intent of `order`. In the JSON request body, include the payment amount and indicate whether this capture is the final capture for the authorization. </summary> <param name="apiContext">APIContext used for the API call.</param> <param name="capture">Capture</param> <returns>Capture</returns> </member> <member name="M:PayPal.Api.Order.Capture(PayPal.Api.APIContext,System.String,PayPal.Api.Capture)"> <summary> Creates (and processes) a new Capture Transaction added as a related resource. </summary> <param name="apiContext">APIContext used for the API call.</param> <param name="orderId">ID of the order to capture.</param> <param name="capture">Capture</param> <returns>Capture</returns> </member> <member name="M:PayPal.Api.Order.Void(PayPal.Api.APIContext)"> <summary> Voids, or cancels, an order, by ID. You cannot void an order if a payment has already been partially or fully captured. </summary> <param name="apiContext">APIContext used for the API call.</param> <returns>Order</returns> </member> <member name="M:PayPal.Api.Order.Void(PayPal.Api.APIContext,System.String)"> <summary> Voids (cancels) an Order. </summary> <param name="apiContext">APIContext used for the API call.</param> <param name="orderId">ID of the order to void.</param> <returns>Order</returns> </member> <member name="M:PayPal.Api.Order.Authorize(PayPal.Api.APIContext)"> <summary> Authorizes an order, by ID. Include an `amount` object in the JSON request body. </summary> <param name="apiContext">APIContext used for the API call.</param> <returns>Authorization</returns> </member> <member name="M:PayPal.Api.Order.Authorize(PayPal.Api.APIContext,PayPal.Api.Order)"> <summary> Creates an authorization on an order </summary> <param name="apiContext">APIContext used for the API call.</param> <param name="order">Order object to authorize.</param> <returns>Authorization</returns> </member> <member name="T:PayPal.Api.OverrideChargeModel"> <summary> Override for a charge model when creating a billing agreement. <para> See <a href="https://developer.paypal.com/docs/api/">PayPal Developer documentation</a> for more information. </para> </summary> </member> <member name="P:PayPal.Api.OverrideChargeModel.charge_id"> <summary> ID of charge model. </summary> </member> <member name="P:PayPal.Api.OverrideChargeModel.amount"> <summary> Updated Amount to be associated with this charge model. </summary> </member> <member name="T:PayPal.Api.Participant"> <summary> Participant information. <para> See <a href="https://developer.paypal.com/docs/api/">PayPal Developer documentation</a> for more information. </para> </summary> </member> <member name="P:PayPal.Api.Participant.email"> <summary> The participant email address. </summary> </member> <member name="P:PayPal.Api.Participant.first_name"> <summary> The participant first name. </summary> </member> <member name="P:PayPal.Api.Participant.last_name"> <summary> The participant last name. </summary> </member> <member name="P:PayPal.Api.Participant.business_name"> <summary> The participant company business name. </summary> </member> <member name="P:PayPal.Api.Participant.phone"> <summary> The participant phone number. </summary> </member> <member name="P:PayPal.Api.Participant.fax"> <summary> The participant fax number. </summary> </member> <member name="P:PayPal.Api.Participant.website"> <summary> The participant website. </summary> </member> <member name="P:PayPal.Api.Participant.additional_info"> <summary> Additional information, such as business hours. </summary> </member> <member name="P:PayPal.Api.Participant.address"> <summary> The participant address. </summary> </member> <member name="T:PayPal.Api.Patch"> <summary> A JSON Patch object used for doing partial updates to resources. <para> See <a href="https://developer.paypal.com/docs/api/">PayPal Developer documentation</a> for more information. </para> </summary> </member> <member name="P:PayPal.Api.Patch.op"> <summary> The operation to perform. </summary> </member> <member name="P:PayPal.Api.Patch.path"> <summary> A JSON pointer that references a location in the target document where the operation is performed. A `string` value. </summary> </member> <member name="P:PayPal.Api.Patch.value"> <summary> New value to apply based on the operation. </summary> </member> <member name="P:PayPal.Api.Patch.from"> <summary> A string containing a JSON Pointer value that references the location in the target document to move the value from. </summary> </member> <member name="T:PayPal.Api.PatchRequest"> <summary> Request object used for updating REST API resource objects. <para> See <a href="https://developer.paypal.com/docs/api/">PayPal Developer documentation</a> for more information. </para> </summary> </member> <member name="T:PayPal.Api.PayPalRelationalObject"> <summary> Represents a PayPal model object that will be returned from PayPal containing common resource data. </summary> </member> <member name="P:PayPal.Api.PayPalRelationalObject.links"> <summary> A list of HATEOAS (Hypermedia as the Engine of Application State) links. More information: https://developer.paypal.com/docs/api/#hateoas-links </summary> </member> <member name="M:PayPal.Api.PayPalRelationalObject.GetHateoasLink(System.String)"> <summary> Gets the HATEOAS link that matches the specified relation name. </summary> <param name="relationName">The name of the link relation.</param> <returns>A Links object containing the details of the HATEOAS link; null if not found.</returns> </member> <member name="M:PayPal.Api.PayPalRelationalObject.GetApprovalUrl(System.Boolean)"> <summary> Gets the approval URL from a list of HATEOAS links. </summary> <param name="setUserActionParameter">If true, appends the 'useraction' URL query parameter. <para>For PayPal payments, this will set the approval button text on the PayPal site to "Pay Now".</para></param> <returns>The approval URL or an empty string if not found.</returns> </member> <member name="M:PayPal.Api.PayPalRelationalObject.GetTokenFromApprovalUrl"> <summary> Gets the resource token from an approval URL HATEOAS link, if found. </summary> <returns>A string containing the resource token associated with an approval URL.</returns> </member> <member name="T:PayPal.Api.PayPalResource"> <summary> Abstract class that handles configuring an HTTP request prior to making an API call. </summary> </member> <member name="F:PayPal.Api.PayPalResource.logger"> <summary> Logs output statements, errors, debug info to a text file </summary> </member> <member name="T:PayPal.Api.PayPalResource.HttpMethod"> <summary> List of supported HTTP methods when making HTTP requests to the PayPal REST API. </summary> </member> <member name="F:PayPal.Api.PayPalResource.HttpMethod.GET"> <summary> GET HTTP request. This is typically used in API operations to retrieve a static resource. </summary> </member> <member name="F:PayPal.Api.PayPalResource.HttpMethod.HEAD"> <summary> HEAD HTTP request. This is typically used to retrieve only the header information for a static resource. </summary> </member> <member name="F:PayPal.Api.PayPalResource.HttpMethod.POST"> <summary> POST HTTP request. This is typically used in API operations that require data in the request body to complete. </summary> </member> <member name="F:PayPal.Api.PayPalResource.HttpMethod.PUT"> <summary> PUT HTTP request. This is used in some API operations that update a given resource. </summary> </member> <member name="F:PayPal.Api.PayPalResource.HttpMethod.DELETE"> <summary> DELETE HTTP request. This is typcially used in API oeprations that delete a given resource. </summary> </member> <member name="F:PayPal.Api.PayPalResource.HttpMethod.PATCH"> <summary> PATCH HTTP request. This is typcially used in API operations that update a given resource. </summary> </member> <member name="P:PayPal.Api.PayPalResource.LastRequestDetails"> <summary> Gets the last request sent by the SDK in the current thread. </summary> </member> <member name="P:PayPal.Api.PayPalResource.LastResponseDetails"> <summary> Gets the last response received by the SDK in the current thread. </summary> </member> <member name="M:PayPal.Api.PayPalResource.#cctor"> <summary> Static constructor initializing any static properties. </summary> </member> <member name="M:PayPal.Api.PayPalResource.ConfigureAndExecute(PayPal.Api.APIContext,PayPal.Api.PayPalResource.HttpMethod,System.String,System.String,System.String,System.Boolean)"> <summary> Configures and executes REST call: Supports JSON </summary> <param name="apiContext">APIContext object</param> <param name="httpMethod">HttpMethod type</param> <param name="resource">URI path of the resource</param> <param name="payload">JSON request payload</param> <param name="endpoint">Optional endpoint to use when generating the full URL for the resource. If none is specified, a default endpoint is generated by the SDK based on other config settings.</param> <param name="setAuthorizationHeader">Specifies whether or not to set the Authorization header in outgoing requests. Defaults to true.</param> <returns>Response object or null otherwise for void API calls</returns> <exception cref="T:PayPal.HttpException">Thrown if there was an error sending the request.</exception> <exception cref="T:PayPal.PaymentsException">Thrown if an HttpException was raised and contains a Payments API error object.</exception> <exception cref="T:PayPal.PayPalException">Thrown for any other issues encountered. See inner exception for further details.</exception> </member> <member name="M:PayPal.Api.PayPalResource.ConfigureAndExecute``1(PayPal.Api.APIContext,PayPal.Api.PayPalResource.HttpMethod,System.String,System.String,System.String,System.Boolean)"> <summary> Configures and executes REST call: Supports JSON </summary> <typeparam name="T">Generic Type parameter for response object</typeparam> <param name="apiContext">APIContext object</param> <param name="httpMethod">HttpMethod type</param> <param name="resource">URI path of the resource</param> <param name="payload">JSON request payload</param> <param name="endpoint">Endpoint to use when generating the full URL for the resource. If none is specified, a default endpoint is generated by the SDK based on other config settings.</param> <param name="setAuthorizationHeader">Specifies whether or not to set the Authorization header in outgoing requests. Defaults to true.</param> <returns>Response object or null otherwise for void API calls</returns> <exception cref="T:PayPal.HttpException">Thrown if there was an error sending the request.</exception> <exception cref="T:PayPal.PaymentsException">Thrown if an HttpException was raised and contains a Payments API error object.</exception> <exception cref="T:PayPal.PayPalException">Thrown for any other issues encountered. See inner exception for further details.</exception> </member> <member name="M:PayPal.Api.PayPalResource.GetHeaderMap(PayPal.Api.APIContext)"> <summary> Gets a collection of headers to be used in an HTTP request. </summary> <param name="apiContext">APIContext object containing information needed to construct the headers map.</param> <returns>A collection of headers.</returns> </member> <member name="M:PayPal.Api.PayPalResource.GetEndpoint(System.Collections.Generic.Dictionary{System.String,System.String})"> <summary> Gets the endpoint to be used when making an HTTP call to the REST API. </summary> <returns>The endpoint to be used when making an HTTP call to the REST API.</returns> </member> <member name="M:PayPal.Api.PayPalResource.EncodeToBase64(System.String,System.String)"> <summary> Covnerts the specified client credentials to a base-64 string for authorization purposes. </summary> <param name="clientId">The client ID to be used in generating the base-64 client identifier.</param> <param name="clientSecret">The client secret to be used in generating the base-64 client identifier.</param> <returns>The base-64 encoded client identifier to use in the authorization request.</returns> <exception cref="T:PayPal.MissingCredentialException">Thrown if clientId or clientSecret are null or empty.</exception> <exception cref="T:PayPal.InvalidCredentialException">Thrown if there is an issue converting the credentials to a formatted authorization string.</exception> <exception cref="T:PayPal.PayPalException">Thrown for any other issue encountered. See inner exception for further details.</exception> </member> <member name="T:PayPal.Api.PayPalSerializableListObject`1"> <summary> Represents a PayPal model object that can be serialized to and from JSON as an array. </summary> </member> <member name="M:PayPal.Api.PayPalSerializableListObject`1.ConvertToJson"> <summary> Converts this object to a JSON string. </summary> <returns>A JSON-formatted string.</returns> </member> <member name="T:PayPal.Api.PayPalSerializableObject"> <summary> Represents a PayPal model object that can be serialized to and from a JSON string. </summary> </member> <member name="M:PayPal.Api.PayPalSerializableObject.ConvertToJson"> <summary> Converts this object to a JSON string. </summary> <returns>A JSON-formatted string.</returns> </member> <member name="T:PayPal.Api.Payee"> <summary> A resource representing a Payee who receives the funds and fulfills the order. <para> See <a href="https://developer.paypal.com/docs/api/">PayPal Developer documentation</a> for more information. </para> </summary> </member> <member name="P:PayPal.Api.Payee.email"> <summary> Email Address associated with the Payee's PayPal Account. If the provided email address is not associated with any PayPal Account, the payee can only receive PayPal Wallet Payments. Direct Credit Card Payments will be denied due to card compliance requirements. </summary> </member> <member name="P:PayPal.Api.Payee.merchant_id"> <summary> Encrypted PayPal account identifier for the Payee. </summary> </member> <member name="P:PayPal.Api.Payee.phone"> <summary> Information related to the Payer. In case of PayPal Wallet payment, this information will be filled in by PayPal after the user approves the payment using their PayPal Wallet. </summary> </member> <member name="T:PayPal.Api.Payer"> <summary> A resource representing a Payer that funds a payment. <para> See <a href="https://developer.paypal.com/docs/api/">PayPal Developer documentation</a> for more information. </para> </summary> </member> <member name="P:PayPal.Api.Payer.payment_method"> <summary> Payment method being used - PayPal Wallet payment, Bank Direct Debit or Direct Credit card. </summary> </member> <member name="P:PayPal.Api.Payer.status"> <summary> Status of payer's PayPal Account. </summary> </member> <member name="P:PayPal.Api.Payer.account_type"> <summary> Type of account relationship payer has with PayPal. </summary> </member> <member name="P:PayPal.Api.Payer.account_age"> <summary> Duration since the payer established account relationship with PayPal in days. </summary> </member> <member name="P:PayPal.Api.Payer.funding_instruments"> <summary> List of funding instruments to fund the payment. 'OneOf' funding_instruments,funding_option_id to be used to identify the specifics of payment method passed. </summary> </member> <member name="P:PayPal.Api.Payer.funding_option_id"> <summary> Instrument type pre-selected by the user outside of PayPal and passed along the payment creation. This param is used in cases such as PayPal Credit Second Button </summary> </member> <member name="P:PayPal.Api.Payer.funding_option"> <summary> Default funding option available for the payment </summary> </member> <member name="P:PayPal.Api.Payer.related_funding_option"> <summary> Funding option related to default funding option. </summary> </member> <member name="P:PayPal.Api.Payer.payer_info"> <summary> Information related to the Payer. </summary> </member> <member name="P:PayPal.Api.Payer.external_selected_funding_instrument_type"> <summary> Instrument type pre-selected by the user outside of PayPal and passed along the payment creation. This param is used in cases such as PayPal Credit Second Button </summary> </member> <member name="T:PayPal.Api.PayerInfo"> <summary> A resource representing a information about Payer. <para> See <a href="https://developer.paypal.com/docs/api/">PayPal Developer documentation</a> for more information. </para> </summary> </member> <member name="P:PayPal.Api.PayerInfo.email"> <summary> Email address representing the payer. 127 characters max. </summary> </member> <member name="P:PayPal.Api.PayerInfo.external_remember_me_id"> <summary> External Remember Me id representing the payer </summary> </member> <member name="P:PayPal.Api.PayerInfo.buyer_account_number"> <summary> Account Number representing the Payer </summary> </member> <member name="P:PayPal.Api.PayerInfo.salutation"> <summary> Salutation of the payer. </summary> </member> <member name="P:PayPal.Api.PayerInfo.first_name"> <summary> First name of the payer. </summary> </member> <member name="P:PayPal.Api.PayerInfo.middle_name"> <summary> Middle name of the payer. </summary> </member> <member name="P:PayPal.Api.PayerInfo.last_name"> <summary> Last name of the payer. </summary> </member> <member name="P:PayPal.Api.PayerInfo.suffix"> <summary> Suffix of the payer. </summary> </member> <member name="P:PayPal.Api.PayerInfo.payer_id"> <summary> PayPal assigned encrypted Payer ID. </summary> </member> <member name="P:PayPal.Api.PayerInfo.phone"> <summary> Phone number representing the payer. 20 characters max. </summary> </member> <member name="P:PayPal.Api.PayerInfo.phone_type"> <summary> Phone type </summary> </member> <member name="P:PayPal.Api.PayerInfo.birth_date"> <summary> Birth date of the Payer in ISO8601 format (yyyy-mm-dd). </summary> </member> <member name="P:PayPal.Api.PayerInfo.tax_id"> <summary> Payer’s tax ID. Only supported when the `payment_method` is set to `paypal`. </summary> </member> <member name="P:PayPal.Api.PayerInfo.tax_id_type"> <summary> Payer’s tax ID type. Allowed values: `BR_CPF` or `BR_CNPJ`. Only supported when the `payment_method` is set to `paypal`. </summary> </member> <member name="P:PayPal.Api.PayerInfo.country_code"> <summary> Two-letter registered country code of the payer to identify the buyer country. </summary> </member> <member name="P:PayPal.Api.PayerInfo.billing_address"> <summary> Billing address of the Payer. </summary> </member> <member name="P:PayPal.Api.PayerInfo.shipping_address"> <summary> [DEPRECATED] Use shipping address present in purchase unit or at root level of checkout Session. </summary> </member> <member name="T:PayPal.Api.Payment"> <summary> Lets you create, process and manage payments. <para> See <a href="https://developer.paypal.com/docs/api/">PayPal Developer documentation</a> for more information. </para> </summary> </member> <member name="P:PayPal.Api.Payment.id"> <summary> Identifier of the payment resource created. </summary> </member> <member name="P:PayPal.Api.Payment.intent"> <summary> Payment intent. </summary> </member> <member name="P:PayPal.Api.Payment.payer"> <summary> Source of the funds for this payment represented by a PayPal account or a direct credit card. </summary> </member> <member name="P:PayPal.Api.Payment.payee"> <summary> . </summary> </member> <member name="P:PayPal.Api.Payment.cart"> <summary> ID of the cart to execute the payment. </summary> </member> <member name="P:PayPal.Api.Payment.transactions"> <summary> Transactional details including the amount and item details. </summary> </member> <member name="P:PayPal.Api.Payment.failed_transactions"> <summary> Applicable for advanced payments like multi seller payment (MSP) to support partial failures </summary> </member> <member name="P:PayPal.Api.Payment.payment_instruction"> <summary> A payment instruction resource </summary> </member> <member name="P:PayPal.Api.Payment.state"> <summary> The state of the payment, authorization, or order transaction. The value is:<ul><li><code>created</code>. The transaction was successfully created.</li><li><code>approved</code>. The buyer approved the transaction.</li><li><code>failed</code>. The transaction request failed.</li></ul> </summary> </member> <member name="P:PayPal.Api.Payment.experience_profile_id"> <summary> PayPal generated identifier for the merchant's payment experience profile. Refer to [this](https://developer.paypal.com/docs/api/#payment-experience) link to create experience profile ID. </summary> </member> <member name="P:PayPal.Api.Payment.note_to_payer"> <summary> free-form field for the use of clients to pass in a message to the payer </summary> </member> <member name="P:PayPal.Api.Payment.redirect_urls"> <summary> Set of redirect URLs you provide only for PayPal-based payments. </summary> </member> <member name="P:PayPal.Api.Payment.failure_reason"> <summary> Failure reason code returned when the payment failed for some valid reasons. </summary> </member> <member name="P:PayPal.Api.Payment.create_time"> <summary> Payment creation time as defined in [RFC 3339 Section 5.6](http://tools.ietf.org/html/rfc3339#section-5.6). </summary> </member> <member name="P:PayPal.Api.Payment.update_time"> <summary> Payment update time as defined in [RFC 3339 Section 5.6](http://tools.ietf.org/html/rfc3339#section-5.6). </summary> </member> <member name="P:PayPal.Api.Payment.billing_agreement_tokens"> <summary> Collection of PayPal generated billing agreement tokens. </summary> </member> <member name="P:PayPal.Api.Payment.token"> <summary> Get or sets the token found in the approval_url link returned from a call to create this resource. </summary> </member> <member name="M:PayPal.Api.Payment.Create(PayPal.Api.APIContext)"> <summary> Creates and processes a payment. In the JSON request body, include a `payment` object with the intent, payer, and transactions. For PayPal payments, include redirect URLs in the `payment` object. </summary> <param name="apiContext">APIContext used for the API call.</param> <returns>Payment</returns> </member> <member name="M:PayPal.Api.Payment.Create(PayPal.Api.APIContext,PayPal.Api.Payment)"> <summary> Creates (and processes) a new Payment Resource. </summary> <param name="apiContext">APIContext used for the API call.</param> <param name="payment">Payment object to be used in creating the PayPal resource.</param> <returns>Payment</returns> </member> <member name="M:PayPal.Api.Payment.Get(PayPal.Api.APIContext,System.String)"> <summary> Shows details for a payment, by ID. </summary> <param name="apiContext">APIContext used for the API call.</param> <param name="paymentId">The ID of the payment for which to show details.</param> <returns>Payment</returns> </member> <member name="M:PayPal.Api.Payment.Update(PayPal.Api.APIContext,PayPal.Api.PatchRequest)"> <summary> Partially updates a payment, by ID. You can update the amount, shipping address, invoice ID, and custom data. You cannot use patch after execute has been called. </summary> <param name="apiContext">APIContext used for the API call.</param> <param name="patchRequest">PatchRequest</param> </member> <member name="M:PayPal.Api.Payment.Update(PayPal.Api.APIContext,System.String,PayPal.Api.PatchRequest)"> <summary> Partially update the Payment resource for the given identifier </summary> <param name="apiContext">APIContext used for the API call.</param> <param name="paymentId">ID of the payment to update.</param> <param name="patchRequest">PatchRequest</param> </member> <member name="M:PayPal.Api.Payment.Execute(PayPal.Api.APIContext,PayPal.Api.PaymentExecution)"> <summary> Executes, or completes, a PayPal payment that the payer has approved. You can optionally update selective payment information when you execute a payment. </summary> <param name="apiContext">APIContext used for the API call.</param> <param name="paymentExecution">PaymentExecution</param> <returns>Payment</returns> </member> <member name="M:PayPal.Api.Payment.Execute(PayPal.Api.APIContext,System.String,PayPal.Api.PaymentExecution)"> <summary> Executes the payment (after approved by the Payer) associated with this resource when the payment method is PayPal. </summary> <param name="apiContext">APIContext used for the API call.</param> <param name="paymentId">ID of the payment to execute.</param> <param name="paymentExecution">PaymentExecution</param> <returns>Payment</returns> </member> <member name="M:PayPal.Api.Payment.List(PayPal.Api.APIContext,System.Nullable{System.Int32},System.String,System.Nullable{System.Int32},System.String,System.String,System.String,System.String,System.String,System.String,System.String,System.String)"> <summary> List payments that were made to the merchant who issues the request. Payments can be in any state. </summary> <param name="apiContext">APIContext used for the API call.</param> <param name="count">The number of items to list in the response.</param> <param name="startId">The ID of the starting resource in the response. When results are paged, you can use the `next_id` value as the `start_id` to continue with the next set of results.</param> <param name="startIndex">The start index of the resources to return. Typically used to jump to a specific position in the resource history based on its cart. Example for starting at the second item in a list of results: `?start_index=2`</param> <param name="startTime">The date and time when the resource was created. Indicates the start of a range of results. Example: `start_time=2013-03-06T11:00:00Z`</param> <param name="endTime">The date and time when the resource was created. Indicates the end of a range of results.</param> <param name="startDate">Resource creation date that indicates the start of results.</param> <param name="endDate">Resource creation date that indicates the end of a range of results.</param> <param name="payeeEmail">Payee identifier (email) to filter the search results in list operations.</param> <param name="payeeId">Payee identifier (merchant id) assigned by PayPal to filter the search results in list operations.</param> <param name="sortBy">Field name that determines sort order of results.</param> <param name="sortOrder">Specifies if order of results is ascending or descending.</param> <returns>PaymentHistory</returns> </member> <member name="T:PayPal.Api.PaymentCard"> <summary> A payment card that can fund a payment. <para> See <a href="https://developer.paypal.com/docs/api/">PayPal Developer documentation</a> for more information. </para> </summary> </member> <member name="P:PayPal.Api.PaymentCard.id"> <summary> The ID of a credit card to save for later use. </summary> </member> <member name="P:PayPal.Api.PaymentCard.number"> <summary> The card number. </summary> </member> <member name="P:PayPal.Api.PaymentCard.type"> <summary> The card type. </summary> </member> <member name="P:PayPal.Api.PaymentCard.expire_month"> <summary> The two-digit expiry month for the card. </summary> </member> <member name="P:PayPal.Api.PaymentCard.expire_year"> <summary> The four-digit expiry year for the card. </summary> </member> <member name="P:PayPal.Api.PaymentCard.start_month"> <summary> The two-digit start month for the card. Required for UK Maestro cards. </summary> </member> <member name="P:PayPal.Api.PaymentCard.start_year"> <summary> The four-digit start year for the card. Required for UK Maestro cards. </summary> </member> <member name="P:PayPal.Api.PaymentCard.cvv2"> <summary> The validation code for the card. Supported for payments but not for saving payment cards for future use. </summary> </member> <member name="P:PayPal.Api.PaymentCard.first_name"> <summary> The first name of the card holder. </summary> </member> <member name="P:PayPal.Api.PaymentCard.last_name"> <summary> The last name of the card holder. </summary> </member> <member name="P:PayPal.Api.PaymentCard.billing_country"> <summary> The two-letter country code. </summary> </member> <member name="P:PayPal.Api.PaymentCard.billing_address"> <summary> The billing address for the card. </summary> </member> <member name="P:PayPal.Api.PaymentCard.external_customer_id"> <summary> The ID of the customer who owns this card account. The facilitator generates and provides this ID. Required when you create or use a stored funding instrument in the PayPal vault. </summary> </member> <member name="P:PayPal.Api.PaymentCard.status"> <summary> The state of the funding instrument. </summary> </member> <member name="P:PayPal.Api.PaymentCard.card_product_class"> <summary> The product class of the financial instrument issuer. </summary> </member> <member name="P:PayPal.Api.PaymentCard.valid_until"> <summary> The date and time until when this instrument can be used fund a payment. </summary> </member> <member name="P:PayPal.Api.PaymentCard.issue_number"> <summary> The one- to two-digit card issue number. Required for UK Maestro cards. </summary> </member> <member name="T:PayPal.Api.PaymentDefinition"> <summary> Defines the payment terms of a billing plan. <para> See <a href="https://developer.paypal.com/docs/api/">PayPal Developer documentation</a> for more information. </para> </summary> </member> <member name="P:PayPal.Api.PaymentDefinition.id"> <summary> Identifier of the payment_definition. 128 characters max. </summary> </member> <member name="P:PayPal.Api.PaymentDefinition.name"> <summary> Name of the payment definition. 128 characters max. </summary> </member> <member name="P:PayPal.Api.PaymentDefinition.type"> <summary> Type of the payment definition. Allowed values: `TRIAL`, `REGULAR`. </summary> </member> <member name="P:PayPal.Api.PaymentDefinition.frequency_interval"> <summary> How frequently the customer should be charged. </summary> </member> <member name="P:PayPal.Api.PaymentDefinition.frequency"> <summary> Frequency of the payment definition offered. Allowed values: `WEEK`, `DAY`, `YEAR`, `MONTH`. </summary> </member> <member name="P:PayPal.Api.PaymentDefinition.cycles"> <summary> Number of cycles in this payment definition. </summary> </member> <member name="P:PayPal.Api.PaymentDefinition.amount"> <summary> Amount that will be charged at the end of each cycle for this payment definition. </summary> </member> <member name="P:PayPal.Api.PaymentDefinition.charge_models"> <summary> Array of charge_models for this payment definition. </summary> </member> <member name="T:PayPal.Api.PaymentDetail"> <summary> Invoicing payment information. <para> See <a href="https://developer.paypal.com/docs/api/">PayPal Developer documentation</a> for more information. </para> </summary> </member> <member name="P:PayPal.Api.PaymentDetail.type"> <summary> The payment type in an invoicing flow. Value is `PAYPAL` or `EXTERNAL`. The [record refund](/docs/api/invoicing/#invoices_record-refund) method supports the `EXTERNAL` refund type. The `PAYPAL` refund type is supported for backward compatibility. </summary> </member> <member name="P:PayPal.Api.PaymentDetail.transaction_id"> <summary> The ID for a PayPal payment transaction. Required with the `PAYPAL` payment type. </summary> </member> <member name="P:PayPal.Api.PaymentDetail.transaction_type"> <summary> The transaction type. Value is `SALE`, `AUTHORIZATION`, or `CAPTURE`. </summary> </member> <member name="P:PayPal.Api.PaymentDetail.date"> <summary> The date when the invoice was paid. The date format is *yyyy*-*MM*-*dd* *z*, as defined in [Internet Date/Time Format](http://tools.ietf.org/html/rfc3339#section-5.6). </summary> </member> <member name="P:PayPal.Api.PaymentDetail.method"> <summary> The payment mode or method. Required with the `EXTERNAL` payment type. Value is bank transfer, cash, check, credit card, debit card, PayPal, wire transfer, or other. </summary> </member> <member name="P:PayPal.Api.PaymentDetail.note"> <summary> Optional. A note associated with the payment. </summary> </member> <member name="P:PayPal.Api.PaymentDetail.amount"> <summary> The payment amount to record against the invoice. If you omit this parameter, records the total invoice amount as paid. </summary> </member> <member name="T:PayPal.Api.PaymentExecution"> <summary> Let's you execute a PayPal Account based Payment resource with the payer_id obtained from web approval url. <para> See <a href="https://developer.paypal.com/docs/api/">PayPal Developer documentation</a> for more information. </para> </summary> </member> <member name="P:PayPal.Api.PaymentExecution.payer_id"> <summary> The ID of the Payer, passed in the `return_url` by PayPal. </summary> </member> <member name="P:PayPal.Api.PaymentExecution.transactions"> <summary> Transactional details including the amount and item details. </summary> </member> <member name="T:PayPal.Api.PaymentHistory"> <summary> List of Payments made by the seller. <para> See <a href="https://developer.paypal.com/docs/api/">PayPal Developer documentation</a> for more information. </para> </summary> </member> <member name="P:PayPal.Api.PaymentHistory.payments"> <summary> A list of Payment resources </summary> </member> <member name="P:PayPal.Api.PaymentHistory.count"> <summary> Number of items returned in each range of results. Note that the last results range could have fewer items than the requested number of items. Maximum value: 20. </summary> </member> <member name="P:PayPal.Api.PaymentHistory.next_id"> <summary> Identifier of the next element to get the next range of results. </summary> </member> <member name="T:PayPal.Api.PaymentInstruction"> <summary> Contain details of how and when the payment should be made to PayPal in cases of manual bank transfer. <para> See <a href="https://developer.paypal.com/docs/api/">PayPal Developer documentation</a> for more information. </para> </summary> </member> <member name="P:PayPal.Api.PaymentInstruction.reference_number"> <summary> ID of payment instruction </summary> </member> <member name="P:PayPal.Api.PaymentInstruction.instruction_type"> <summary> Type of payment instruction </summary> </member> <member name="P:PayPal.Api.PaymentInstruction.recipient_banking_instruction"> <summary> Recipient bank Details. </summary> </member> <member name="P:PayPal.Api.PaymentInstruction.amount"> <summary> Amount to be transferred </summary> </member> <member name="P:PayPal.Api.PaymentInstruction.payment_due_date"> <summary> Date by which payment should be received </summary> </member> <member name="P:PayPal.Api.PaymentInstruction.note"> <summary> Additional text regarding payment handling </summary> </member> <member name="M:PayPal.Api.PaymentInstruction.Get(PayPal.Api.APIContext,System.String)"> <summary> Obtain the payment instruction resource for the given identifier. </summary> <param name="apiContext">APIContext used for the API call.</param> <param name="paymentId">Identifier of the Payment instruction resource to obtain the data for.</param> <returns>PaymentInstruction</returns> </member> <member name="T:PayPal.Api.PaymentOptions"> <summary> Payment options requested for this purchase unit <para> See <a href="https://developer.paypal.com/docs/api/">PayPal Developer documentation</a> for more information. </para> </summary> </member> <member name="P:PayPal.Api.PaymentOptions.allowed_payment_method"> <summary> Payment method requested for this purchase unit </summary> </member> <member name="T:PayPal.Api.PaymentSummary"> <summary> The payment and refund summary. <para> See <a href="https://developer.paypal.com/docs/api/">PayPal Developer documentation</a> for more information. </para> </summary> </member> <member name="P:PayPal.Api.PaymentSummary.paypal"> <summary> The total amount paid or refunded through PayPal. </summary> </member> <member name="P:PayPal.Api.PaymentSummary.other"> <summary> The total amount paid or refunded through other sources. </summary> </member> <member name="T:PayPal.Api.PaymentTerm"> <summary> The payment term of the invoice. If you specify `term_type`, you cannot specify `due_date`, and vice versa. <para> See <a href="https://developer.paypal.com/docs/api/">PayPal Developer documentation</a> for more information. </para> </summary> </member> <member name="P:PayPal.Api.PaymentTerm.term_type"> <summary> The terms by which the invoice payment is due. </summary> </member> <member name="P:PayPal.Api.PaymentTerm.due_date"> <summary> The date when the invoice payment is due. This date must be a future date. Date format is *yyyy*-*MM*-*dd* *z*, as defined in [Internet Date/Time Format](http://tools.ietf.org/html/rfc3339#section-5.6). </summary> </member> <member name="T:PayPal.Api.Payout"> <summary> A REST API payout resource object. <para> See <a href="https://developer.paypal.com/docs/api/">PayPal Developer documentation</a> for more information. </para> </summary> </member> <member name="P:PayPal.Api.Payout.sender_batch_header"> <summary> The original batch header as provided by the payment sender. </summary> </member> <member name="P:PayPal.Api.Payout.items"> <summary> An array of payout items (that is, a set of individual payouts). </summary> </member> <member name="M:PayPal.Api.Payout.Create(PayPal.Api.APIContext,System.Boolean)"> <summary> Create a payout batch resource by passing a sender_batch_header and an items array to the request URI. The sender_batch_header contains payout parameters that describe the handling of a batch resource while the items array conatins payout items. </summary> <param name="apiContext">APIContext used for the API call.</param> <param name="syncMode">A value of true will provide an immediate, synchronous response. Without this query keyword or if the value is false, the response will be a background batch mode.</param> <returns>PayoutCreateResponse</returns> </member> <member name="M:PayPal.Api.Payout.Create(PayPal.Api.APIContext,PayPal.Api.Payout,System.Boolean)"> <summary> Create a payout batch resource by passing a sender_batch_header and an items array to the request URI. The sender_batch_header contains payout parameters that describe the handling of a batch resource while the items array conatins payout items. </summary> <param name="apiContext">APIContext used for the API call.</param> <param name="payout">Payout object to be created as a PayPal resource.</param> <param name="syncMode">A value of true will provide an immediate, synchronous response. Without this query keyword or if the value is false, the response will be a background batch mode.</param> <returns>PayoutCreateResponse</returns> </member> <member name="M:PayPal.Api.Payout.Get(PayPal.Api.APIContext,System.String)"> <summary> Obtain the status of a specific batch resource by passing the payout batch ID to the request URI. You can issue this call multiple times to get the current status. </summary> <param name="apiContext">APIContext used for the API call.</param> <param name="payoutBatchId">Identifier of the Payout Resource to obtain data.</param> <returns>PayoutBatchStatus</returns> </member> <member name="T:PayPal.Api.PayoutBatch"> <summary> The PayPal-generated batch status. <para> See <a href="https://developer.paypal.com/docs/api/">PayPal Developer documentation</a> for more information. </para> </summary> </member> <member name="P:PayPal.Api.PayoutBatch.batch_header"> <summary> A batch header. Includes the generated batch status. </summary> </member> <member name="P:PayPal.Api.PayoutBatch.items"> <summary> An array of items in a batch payout. </summary> </member> <member name="T:PayPal.Api.PayoutBatchHeader"> <summary> A batch payout header data object, which can be the response to a batch payout header request. Enables you to get payout header information for an entire batch payout request. <para> See <a href="https://developer.paypal.com/docs/api/">PayPal Developer documentation</a> for more information. </para> </summary> </member> <member name="P:PayPal.Api.PayoutBatchHeader.payout_batch_id"> <summary> The PayPal-generated ID for a batch payout. </summary> </member> <member name="P:PayPal.Api.PayoutBatchHeader.batch_status"> <summary> The PayPal-generated batch status. If the batch payout passes preliminary checks, the status is `PENDING`. </summary> </member> <member name="P:PayPal.Api.PayoutBatchHeader.time_created"> <summary> The date and time when processing for the batch payout began. </summary> </member> <member name="P:PayPal.Api.PayoutBatchHeader.time_completed"> <summary> The date and time when processing for the batch payout completed. </summary> </member> <member name="P:PayPal.Api.PayoutBatchHeader.sender_batch_header"> <summary> The original batch payout header, as provided by the payment sender. </summary> </member> <member name="P:PayPal.Api.PayoutBatchHeader.amount"> <summary> The total amount, in U.S. dollars, requested for the payouts. </summary> </member> <member name="P:PayPal.Api.PayoutBatchHeader.fees"> <summary> The total estimate, in U.S. dollars, for the applicable payouts fees. </summary> </member> <member name="P:PayPal.Api.PayoutBatchHeader.errors"> <summary> An array of batch errors, if any. </summary> </member> <member name="T:PayPal.Api.PayoutItem"> <summary> A sender-created definition of a payout to a single recipient. <para> See <a href="https://developer.paypal.com/docs/api/">PayPal Developer documentation</a> for more information. </para> </summary> </member> <!-- Badly formed XML comment ignored for member "P:PayPal.Api.PayoutItem.recipient_type" --> <member name="P:PayPal.Api.PayoutItem.amount"> <summary> The amount of money to pay the receiver. </summary> </member> <member name="P:PayPal.Api.PayoutItem.note"> <summary> Optional. A sender-specified note for notifications. Value is any string value. </summary> </member> <member name="P:PayPal.Api.PayoutItem.receiver"> <summary> The receiver of the payment. Corresponds to the `recipient_type` value in the request. </summary> </member> <member name="P:PayPal.Api.PayoutItem.sender_item_id"> <summary> A sender-specified ID number. Tracks the batch payout in an accounting system. </summary> </member> <member name="M:PayPal.Api.PayoutItem.Get(PayPal.Api.APIContext,System.String)"> <summary> Obtain the status of a payout item by passing the item ID to the request URI. </summary> <param name="apiContext">APIContext used for the API call.</param> <param name="payoutItemId">Payouts generated payout_item_id to obtain status.</param> <returns>PayoutItemDetails</returns> </member> <member name="M:PayPal.Api.PayoutItem.Cancel(PayPal.Api.APIContext,System.String)"> <summary> Cancels the unclaimed payment using the items id passed in the request URI. </summary> <param name="apiContext">APIContext used for the API call.</param> <param name="payoutItemId">Payouts generated payout_item_id to obtain status.</param> <returns>PayoutItemDetails</returns> </member> <member name="T:PayPal.Api.PayoutItemDetails"> <summary> The payout item status and other details. <para> See <a href="https://developer.paypal.com/docs/api/">PayPal Developer documentation</a> for more information. </para> </summary> </member> <member name="P:PayPal.Api.PayoutItemDetails.payout_item_id"> <summary> The ID for the payout item. Viewable when you show details for a batch payout. </summary> </member> <member name="P:PayPal.Api.PayoutItemDetails.transaction_id"> <summary> The PayPal-generated ID for the transaction. </summary> </member> <member name="P:PayPal.Api.PayoutItemDetails.transaction_status"> <summary> The transaction status. </summary> </member> <member name="P:PayPal.Api.PayoutItemDetails.payout_item_fee"> <summary> The amount of money, in U.S. dollars, for fees. </summary> </member> <member name="P:PayPal.Api.PayoutItemDetails.payout_batch_id"> <summary> The PayPal-generated ID for the batch payout. </summary> </member> <member name="P:PayPal.Api.PayoutItemDetails.sender_batch_id"> <summary> A sender-specified ID number. Tracks the batch payout in an accounting system. </summary> </member> <member name="P:PayPal.Api.PayoutItemDetails.payout_item"> <summary> The sender-provided information for the payout item. </summary> </member> <member name="P:PayPal.Api.PayoutItemDetails.time_processed"> <summary> The date and time when this item was last processed. </summary> </member> <member name="P:PayPal.Api.PayoutItemDetails.error"> <summary> Error information associated with this item, if any. </summary> </member> <member name="M:PayPal.Api.PayoutItemDetails.Get(PayPal.Api.APIContext,System.String)"> <summary> Obtain the status of a payout item by passing the item ID to the request URI. </summary> <param name="apiContext">APIContext used for the API call.</param> <param name="payoutItemId">Payouts generated payout_item_id to obtain status.</param> <returns>PayoutItemDetails</returns> </member> <member name="T:PayPal.Api.PayoutRecipientType"> <summary> Type of identification for the payment receiver. <para> See <a href="https://developer.paypal.com/docs/api/">PayPal Developer documentation</a> for more information. </para> </summary> </member> <member name="F:PayPal.Api.PayoutRecipientType.EMAIL"> <summary> Email recipient for a payout. </summary> </member> <member name="F:PayPal.Api.PayoutRecipientType.PHONE"> <summary> Phone number recipient for a payout. </summary> </member> <member name="F:PayPal.Api.PayoutRecipientType.PAYPAL_ID"> <summary> PayPal recipient for a payout. </summary> </member> <member name="T:PayPal.Api.PayoutSenderBatchHeader"> <summary> The sender-provided batch header for a batch payout request. <para> See <a href="https://developer.paypal.com/docs/api/">PayPal Developer documentation</a> for more information. </para> </summary> </member> <member name="P:PayPal.Api.PayoutSenderBatchHeader.sender_batch_id"> <summary> A sender-specified ID number. Tracks the batch payout in an accounting system.<blockquote><strong>Note:</strong> PayPal prevents duplicate batches from being processed. If you specify a `sender_batch_id` that was used in the last 30 days, the API rejects the request and returns an error message that indicates the duplicate `sender_batch_id` and includes a HATEOAS link to the original batch payout with the same `sender_batch_id`. If you receive a HTTP `5nn` status code, you can safely retry the request with the same `sender_batch_id`. In any case, the API completes a payment only once for a specific `sender_batch_id` that is used within 30 days.</blockquote> </summary> </member> <member name="P:PayPal.Api.PayoutSenderBatchHeader.email_subject"> <summary> The subject line text for the email that PayPal sends when a payout item is completed. (The subject line is the same for all recipients.) Maximum of 255 single-byte alphanumeric characters. </summary> </member> <!-- Badly formed XML comment ignored for member "P:PayPal.Api.PayoutSenderBatchHeader.recipient_type" --> <member name="T:PayPal.Api.PayoutTransactionStatus"> <summary> Status of a payout transaction. <para> See <a href="https://developer.paypal.com/docs/api/">PayPal Developer documentation</a> for more information. </para> </summary> </member> <member name="F:PayPal.Api.PayoutTransactionStatus.SUCCESS"> <summary> The item has been successfully processed. </summary> </member> <member name="F:PayPal.Api.PayoutTransactionStatus.DENIED"> <summary> The item has been denied payment. </summary> </member> <member name="F:PayPal.Api.PayoutTransactionStatus.PENDING"> <summary> The item is awaiting payment. </summary> </member> <member name="F:PayPal.Api.PayoutTransactionStatus.PROCESSING"> <summary> The item is being processed. </summary> </member> <member name="F:PayPal.Api.PayoutTransactionStatus.FAILED"> <summary> Processing failed for the item. </summary> </member> <member name="F:PayPal.Api.PayoutTransactionStatus.UNCLAIMED"> <summary> The item is unclaimed. If the item is not claimed within 30 days, the funds will be returned to the sender. </summary> </member> <member name="F:PayPal.Api.PayoutTransactionStatus.RETURNED"> <summary> The item is returned. The funds are returned if the recipient hasn't claimed them in 30 days. </summary> </member> <member name="F:PayPal.Api.PayoutTransactionStatus.ONHOLD"> <summary> The item is on hold. </summary> </member> <member name="F:PayPal.Api.PayoutTransactionStatus.BLOCKED"> <summary> The item is blocked. </summary> </member> <member name="F:PayPal.Api.PayoutTransactionStatus.CANCELLED"> <summary> It is not possible for the CANCELLED state to occur if the sender is solely using the API to send Payouts. This status is an edge-case if a sender uses both the MassPay web upload and the Payouts API, cancels the web upload, and then uses the API to find the batch/items. In this case, CANCELLED status is possible. </summary> </member> <member name="T:PayPal.Api.Phone"> <summary> Information related to the Payee. <para> See <a href="https://developer.paypal.com/docs/api/">PayPal Developer documentation</a> for more information. </para> </summary> </member> <member name="P:PayPal.Api.Phone.country_code"> <summary> Country code (from in E.164 format) </summary> </member> <member name="P:PayPal.Api.Phone.national_number"> <summary> In-country phone number (from in E.164 format) </summary> </member> <member name="P:PayPal.Api.Phone.extension"> <summary> Phone extension </summary> </member> <member name="T:PayPal.Api.Plan"> <summary> A REST API billing plan resource. <para> See <a href="https://developer.paypal.com/docs/api/">PayPal Developer documentation</a> for more information. </para> </summary> </member> <member name="P:PayPal.Api.Plan.id"> <summary> Identifier of the billing plan. 128 characters max. </summary> </member> <member name="P:PayPal.Api.Plan.name"> <summary> Name of the billing plan. 128 characters max. </summary> </member> <member name="P:PayPal.Api.Plan.description"> <summary> Description of the billing plan. 128 characters max. </summary> </member> <member name="P:PayPal.Api.Plan.type"> <summary> Type of the billing plan. Allowed values: `FIXED`, `INFINITE`. </summary> </member> <member name="P:PayPal.Api.Plan.state"> <summary> Status of the billing plan. Allowed values: `CREATED`, `ACTIVE`, `INACTIVE`, and `DELETED`. </summary> </member> <member name="P:PayPal.Api.Plan.create_time"> <summary> Time when the billing plan was created. Format YYYY-MM-DDTimeTimezone, as defined in [ISO8601](http://tools.ietf.org/html/rfc3339#section-5.6). </summary> </member> <member name="P:PayPal.Api.Plan.update_time"> <summary> Time when this billing plan was updated. Format YYYY-MM-DDTimeTimezone, as defined in [ISO8601](http://tools.ietf.org/html/rfc3339#section-5.6). </summary> </member> <member name="P:PayPal.Api.Plan.payment_definitions"> <summary> Array of payment definitions for this billing plan. </summary> </member> <member name="P:PayPal.Api.Plan.terms"> <summary> Array of terms for this billing plan. </summary> </member> <member name="P:PayPal.Api.Plan.merchant_preferences"> <summary> Specific preferences such as: set up fee, max fail attempts, autobill amount, and others that are configured for this billing plan. </summary> </member> <member name="M:PayPal.Api.Plan.Get(PayPal.Api.APIContext,System.String)"> <summary> Retrieve the details for a particular billing plan by passing the billing plan ID to the request URI. </summary> <param name="apiContext">APIContext used for the API call.</param> <param name="planId">ID of the billing plan to return details about.</param> <returns>Plan</returns> </member> <member name="M:PayPal.Api.Plan.Create(PayPal.Api.APIContext)"> <summary> Create a new billing plan by passing the details for the plan, including the plan name, description, and type, to the request URI. </summary> <param name="apiContext">APIContext used for the API call.</param> <returns>Plan</returns> </member> <member name="M:PayPal.Api.Plan.Create(PayPal.Api.APIContext,PayPal.Api.Plan)"> <summary> Create a new billing plan by passing the details for the plan, including the plan name, description, and type, to the request URI. </summary> <param name="apiContext">APIContext used for the API call.</param> <param name="plan">The Plan object to be used to create the billing plan resource.</param> <returns>Plan</returns> </member> <member name="M:PayPal.Api.Plan.Update(PayPal.Api.APIContext,PayPal.Api.PatchRequest)"> <summary> Replace specific fields within a billing plan by passing the ID of the billing plan to the request URI. In addition, pass a patch object in the request JSON that specifies the operation to perform, field to update, and new value for each update. </summary> <param name="apiContext">APIContext used for the API call.</param> <param name="patchRequest">PatchRequest</param> </member> <member name="M:PayPal.Api.Plan.Update(PayPal.Api.APIContext,System.String,PayPal.Api.PatchRequest)"> <summary> Replace specific fields within a billing plan by passing the ID of the billing plan to the request URI. In addition, pass a patch object in the request JSON that specifies the operation to perform, field to update, and new value for each update. </summary> <param name="apiContext">APIContext used for the API call.</param> <param name="planId">ID of the billing plan to be updated.</param> <param name="patchRequest">PatchRequest</param> </member> <member name="M:PayPal.Api.Plan.List(PayPal.Api.APIContext,System.String,System.String,System.String,System.String)"> <summary> List billing plans according to optional query string parameters specified. </summary> <param name="apiContext">APIContext used for the API call.</param> <param name="page">A non-zero integer representing the 'page' of the results.</param> <param name="status">Specifies the status (CREATED, ACTIVE, or INACTIVE) of the billing plans to return.</param> <param name="pageSize">A non-negative, non-zero integer indicating the maximum number of results to return at one time.</param> <param name="totalRequired">A boolean indicating total number of items (total_items) and pages (total_pages) are expected to be returned in the response</param> <returns>PlanList</returns> </member> <member name="M:PayPal.Api.Plan.Delete(PayPal.Api.APIContext)"> <summary> Deletes the specified billing plan. </summary> <param name="apiContext">APIContext used for the API call.</param> </member> <member name="M:PayPal.Api.Plan.Delete(PayPal.Api.APIContext,System.String)"> <summary> Deletes the specified billing plan. </summary> <param name="apiContext">APIContext used for the API call.</param> <param name="planId">ID of the billing plan to delete.</param> </member> <member name="T:PayPal.Api.PlanList"> <summary> A list of billing plans returned from a search operation. <para> See <a href="https://developer.paypal.com/docs/api/">PayPal Developer documentation</a> for more information. </para> </summary> </member> <member name="P:PayPal.Api.PlanList.plans"> <summary> Array of billing plans. </summary> </member> <member name="P:PayPal.Api.PlanList.total_items"> <summary> Total number of items. </summary> </member> <member name="P:PayPal.Api.PlanList.total_pages"> <summary> Total number of pages. </summary> </member> <member name="T:PayPal.Api.PotentialPayerInfo"> <summary> A resource representing a information about a potential Payer. <para> See <a href="https://developer.paypal.com/docs/api/">PayPal Developer documentation</a> for more information. </para> </summary> </member> <member name="P:PayPal.Api.PotentialPayerInfo.email"> <summary> Email address representing the potential payer. </summary> </member> <member name="P:PayPal.Api.PotentialPayerInfo.external_remember_me_id"> <summary> xternalRememberMe id representing the potential payer. </summary> </member> <member name="P:PayPal.Api.PotentialPayerInfo.billing_address"> <summary> Billing address of the potential payer. </summary> </member> <member name="T:PayPal.Api.Presentation"> <summary> Parameters for style and presentation. <para> See <a href="https://developer.paypal.com/docs/api/">PayPal Developer documentation</a> for more information. </para> </summary> </member> <member name="P:PayPal.Api.Presentation.brand_name"> <summary> A label that overrides the business name in the PayPal account on the PayPal pages. Character length and limitations: 127 single-byte alphanumeric characters. </summary> </member> <member name="P:PayPal.Api.Presentation.logo_image"> <summary> A URL to the logo image. A valid media type is `.gif`, `.jpg`, or `.png`. The maximum width of the image is 190 pixels. The maximum height of the image is 60 pixels. PayPal crops images that are larger. PayPal places your logo image at the top of the cart review area. PayPal recommends that you store the image on a secure (HTTPS) server. Otherwise, web browsers display a message that checkout pages contain non-secure items. Character length and limit: 127 single-byte alphanumeric characters. </summary> </member> <member name="P:PayPal.Api.Presentation.locale_code"> <summary> The locale of pages displayed by PayPal payment experience. A valid value is `AU`, `AT`, `BE`, `BR`, `CA`, `CH`, `CN`, `DE`, `ES`, `GB`, `FR`, `IT`, `NL`, `PL`, `PT`, `RU`, or `US`. A 5-character code is also valid for languages in specific countries: `da_DK`, `he_IL`, `id_ID`, `ja_JP`, `no_NO`, `pt_BR`, `ru_RU`, `sv_SE`, `th_TH`, `zh_CN`, `zh_HK`, or `zh_TW`. </summary> </member> <member name="P:PayPal.Api.Presentation.return_url_label"> <summary> A label to use as hypertext for the return to merchant link. </summary> </member> <member name="P:PayPal.Api.Presentation.note_to_seller_label"> <summary> A label to use as the title for the note to seller field. Used only when `allow_note` is `1`. </summary> </member> <member name="T:PayPal.Api.ProcessorResponse"> <summary> Collection of payment response related fields returned from a payment request <para> See <a href="https://developer.paypal.com/docs/api/">PayPal Developer documentation</a> for more information. </para> </summary> </member> <member name="P:PayPal.Api.ProcessorResponse.response_code"> <summary> Paypal normalized response code, generated from the processor's specific response code </summary> </member> <member name="P:PayPal.Api.ProcessorResponse.avs_code"> <summary> Address Verification System response code. https://developer.paypal.com/webapps/developer/docs/classic/api/AVSResponseCodes/ </summary> </member> <member name="P:PayPal.Api.ProcessorResponse.cvv_code"> <summary> CVV System response code. https://developer.paypal.com/webapps/developer/docs/classic/api/AVSResponseCodes/ </summary> </member> <member name="P:PayPal.Api.ProcessorResponse.advice_code"> <summary> Provides merchant advice on how to handle declines related to recurring payments </summary> </member> <member name="P:PayPal.Api.ProcessorResponse.eci_submitted"> <summary> Response back from the authorization. Provided by the processor </summary> </member> <member name="P:PayPal.Api.ProcessorResponse.vpas"> <summary> Visa Payer Authentication Service status. Will be return from processor </summary> </member> <member name="T:PayPal.Api.RecipientBankingInstruction"> <summary> Recipient bank Details. <para> See <a href="https://developer.paypal.com/docs/api/">PayPal Developer documentation</a> for more information. </para> </summary> </member> <member name="P:PayPal.Api.RecipientBankingInstruction.bank_name"> <summary> Name of the financial institution. </summary> </member> <member name="P:PayPal.Api.RecipientBankingInstruction.account_holder_name"> <summary> Name of the account holder </summary> </member> <member name="P:PayPal.Api.RecipientBankingInstruction.account_number"> <summary> bank account number </summary> </member> <member name="P:PayPal.Api.RecipientBankingInstruction.routing_number"> <summary> bank routing number </summary> </member> <member name="P:PayPal.Api.RecipientBankingInstruction.international_bank_account_number"> <summary> IBAN equivalent of the bank </summary> </member> <member name="P:PayPal.Api.RecipientBankingInstruction.bank_identifier_code"> <summary> BIC identifier of the financial institution </summary> </member> <member name="T:PayPal.Api.RedirectUrls"> <summary> Set of redirect URLs you provide only for PayPal-based payments. <para> See <a href="https://developer.paypal.com/docs/api/">PayPal Developer documentation</a> for more information. </para> </summary> </member> <member name="P:PayPal.Api.RedirectUrls.return_url"> <summary> Url where the payer would be redirected to after approving the payment. **Required for PayPal account payments.** </summary> </member> <member name="P:PayPal.Api.RedirectUrls.cancel_url"> <summary> Url where the payer would be redirected to after canceling the payment. **Required for PayPal account payments.** </summary> </member> <member name="T:PayPal.Api.Refund"> <summary> A refund transaction. <para> See <a href="https://developer.paypal.com/docs/api/">PayPal Developer documentation</a> for more information. </para> </summary> </member> <member name="P:PayPal.Api.Refund.id"> <summary> ID of the refund transaction. 17 characters max. </summary> </member> <member name="P:PayPal.Api.Refund.amount"> <summary> Details including both refunded amount (to payer) and refunded fee (to payee). 10 characters max. </summary> </member> <member name="P:PayPal.Api.Refund.state"> <summary> State of the refund. </summary> </member> <member name="P:PayPal.Api.Refund.reason"> <summary> Reason description for the Sale transaction being refunded. </summary> </member> <member name="P:PayPal.Api.Refund.invoice_number"> <summary> Your own invoice or tracking ID number. Character length and limitations: 127 single-byte alphanumeric characters. </summary> </member> <member name="P:PayPal.Api.Refund.sale_id"> <summary> ID of the Sale transaction being refunded. </summary> </member> <member name="P:PayPal.Api.Refund.capture_id"> <summary> ID of the sale transaction being refunded. </summary> </member> <member name="P:PayPal.Api.Refund.parent_payment"> <summary> ID of the payment resource on which this transaction is based. </summary> </member> <member name="P:PayPal.Api.Refund.description"> <summary> Description of what is being refunded for. </summary> </member> <member name="P:PayPal.Api.Refund.create_time"> <summary> Time of refund as defined in [RFC 3339 Section 5.6](http://tools.ietf.org/html/rfc3339#section-5.6). </summary> </member> <member name="P:PayPal.Api.Refund.update_time"> <summary> Time that the resource was last updated. </summary> </member> <member name="P:PayPal.Api.Refund.reason_code"> <summary> The reason code for the refund state being pending </summary> </member> <member name="M:PayPal.Api.Refund.Get(PayPal.Api.APIContext,System.String)"> <summary> Shows details for a refund, by ID. </summary> <param name="apiContext">APIContext used for the API call.</param> <param name="refundId">The ID of the refund for which to show details.</param> <returns>Refund</returns> </member> <member name="T:PayPal.Api.RefundDetail"> <summary> Invoicing refund information. <para> See <a href="https://developer.paypal.com/docs/api/">PayPal Developer documentation</a> for more information. </para> </summary> </member> <member name="P:PayPal.Api.RefundDetail.type"> <summary> The PayPal refund type. Indicates whether refund was paid through PayPal or externally in invoicing flow. The [record refund](/docs/api/invoicing/#invoices_record-refund) method supports the `EXTERNAL` refund type. The `PAYPAL` refund type is supported for backward compatibility. </summary> </member> <member name="P:PayPal.Api.RefundDetail.transaction_id"> <summary> The ID of the PayPal refund transaction. Required with the `PAYPAL` refund type. </summary> </member> <member name="P:PayPal.Api.RefundDetail.date"> <summary> The date when the invoice was refunded. The date format is *yyyy*-*MM*-*dd* *z*, as defined in [Internet Date/Time Format](http://tools.ietf.org/html/rfc3339#section-5.6). For example, `2014-02-27 PST`. </summary> </member> <member name="P:PayPal.Api.RefundDetail.note"> <summary> A note associated with the refund. </summary> </member> <member name="P:PayPal.Api.RefundDetail.amount"> <summary> The amount to record as refunded. If you omit the amount, the total invoice paid amount is recorded as refunded. </summary> </member> <member name="T:PayPal.Api.RefundRequest"> <summary> A refund transaction. <para> See <a href="https://developer.paypal.com/docs/api/">PayPal Developer documentation</a> for more information. </para> </summary> </member> <member name="P:PayPal.Api.RefundRequest.amount"> <summary> Details including both refunded amount (to payer) and refunded fee (to payee). </summary> </member> <member name="P:PayPal.Api.RefundRequest.description"> <summary> Description of what is being refunded for. Character length and limitations: 255 single-byte alphanumeric characters. </summary> </member> <member name="P:PayPal.Api.RefundRequest.refund_source"> <summary> Type of PayPal funding source (balance or eCheck) that can be used for auto refund. </summary> </member> <member name="P:PayPal.Api.RefundRequest.reason"> <summary> Reason description for the Sale transaction being refunded. </summary> </member> <member name="P:PayPal.Api.RefundRequest.invoice_number"> <summary> The invoice number that is used to track this payment. Character length and limitations: 127 single-byte alphanumeric characters. </summary> </member> <member name="P:PayPal.Api.RefundRequest.refund_advice"> <summary> Flag to indicate that the buyer was already given store credit for a given transaction. </summary> </member> <member name="T:PayPal.Api.RelatedResources"> <summary> Each one representing a financial transaction (Sale, Authorization, Capture, Refund) related to the payment. <para> See <a href="https://developer.paypal.com/docs/api/">PayPal Developer documentation</a> for more information. </para> </summary> </member> <member name="P:PayPal.Api.RelatedResources.sale"> <summary> Sale transaction </summary> </member> <member name="P:PayPal.Api.RelatedResources.authorization"> <summary> Authorization transaction </summary> </member> <member name="P:PayPal.Api.RelatedResources.order"> <summary> Order transaction </summary> </member> <member name="P:PayPal.Api.RelatedResources.capture"> <summary> Capture transaction </summary> </member> <member name="P:PayPal.Api.RelatedResources.refund"> <summary> Refund transaction </summary> </member> <member name="T:PayPal.Api.Sale"> <summary> A sale transaction. This is the resource that is returned as a part related resources in Payment <para> See <a href="https://developer.paypal.com/docs/api/">PayPal Developer documentation</a> for more information. </para> </summary> </member> <member name="P:PayPal.Api.Sale.id"> <summary> Identifier of the sale transaction. </summary> </member> <member name="P:PayPal.Api.Sale.purchase_unit_reference_id"> <summary> Identifier to the purchase or transaction unit corresponding to this sale transaction. </summary> </member> <member name="P:PayPal.Api.Sale.amount"> <summary> Amount being collected. </summary> </member> <member name="P:PayPal.Api.Sale.payment_mode"> <summary> Specifies payment mode of the transaction. Only supported when the `payment_method` is set to `paypal`. </summary> </member> <member name="P:PayPal.Api.Sale.invoice_number"> <summary> your own invoice number or tracking IDs, Maximum length: 127. </summary> </member> <member name="P:PayPal.Api.Sale.custom"> <summary> free-form field for the use of clients, Maximum length: 127. </summary> </member> <member name="P:PayPal.Api.Sale.state"> <summary> State of the sale transaction. </summary> </member> <member name="P:PayPal.Api.Sale.reason_code"> <summary> Reason code for the transaction state being Pending or Reversed. Only supported when the `payment_method` is set to `paypal`. </summary> </member> <member name="P:PayPal.Api.Sale.protection_eligibility"> <summary> The level of seller protection in force for the transaction. Only supported when the `payment_method` is set to `paypal`. </summary> </member> <member name="P:PayPal.Api.Sale.protection_eligibility_type"> <summary> The kind of seller protection in force for the transaction. It is returned only when protection_eligibility is ELIGIBLE or PARTIALLY_ELIGIBLE. Only supported when the `payment_method` is set to `paypal`. </summary> </member> <member name="P:PayPal.Api.Sale.clearing_time"> <summary> Expected clearing time for eCheck Transactions. Returned when payment is made with eCheck. Only supported when the `payment_method` is set to `paypal`. </summary> </member> <member name="P:PayPal.Api.Sale.payment_hold_status"> <summary> Status of the Recipient Fund. For now, it will be returned only when fund status is held </summary> </member> <member name="P:PayPal.Api.Sale.payment_hold_reasons"> <summary> Reasons for PayPal holding recipient fund. It is set only if payment hold status is held </summary> </member> <member name="P:PayPal.Api.Sale.recipient_fund_status"> <summary> Indicates the credit status of fund to the recipient. It will be returned only when payment status is 'completed' </summary> </member> <member name="P:PayPal.Api.Sale.hold_reason"> <summary> Reason for holding the funds. </summary> </member> <member name="P:PayPal.Api.Sale.transaction_fee"> <summary> Transaction fee applicable for this payment. </summary> </member> <member name="P:PayPal.Api.Sale.receivable_amount"> <summary> Net amount the merchant receives for this transaction in their receivable currency. Returned only in cross-currency use cases where a merchant bills a buyer in a non-primary currency for that buyer. </summary> </member> <member name="P:PayPal.Api.Sale.exchange_rate"> <summary> Exchange rate applied for this transaction. Returned only in cross-currency use cases where a merchant bills a buyer in a non-primary currency for that buyer. </summary> </member> <member name="P:PayPal.Api.Sale.fmf_details"> <summary> Fraud Management Filter (FMF) details applied for the payment that could result in accept, deny, or pending action. Returned in a payment response only if the merchant has enabled FMF in the profile settings and one of the fraud filters was triggered based on those settings. See [Fraud Management Filters Summary](/docs/classic/fmf/integration-guide/FMFSummary/) for more information. </summary> </member> <member name="P:PayPal.Api.Sale.receipt_id"> <summary> Receipt id is a payment identification number returned for guest users to identify the payment. </summary> </member> <member name="P:PayPal.Api.Sale.parent_payment"> <summary> ID of the payment resource on which this transaction is based. </summary> </member> <member name="P:PayPal.Api.Sale.processor_response"> <summary> Response codes returned by the processor concerning the submitted payment. Only supported when the `payment_method` is set to `credit_card`. </summary> </member> <member name="P:PayPal.Api.Sale.billing_agreement_id"> <summary> ID of the billing agreement used as reference to execute this transaction. </summary> </member> <member name="P:PayPal.Api.Sale.create_time"> <summary> Time of sale as defined in [RFC 3339 Section 5.6](http://tools.ietf.org/html/rfc3339#section-5.6) </summary> </member> <member name="P:PayPal.Api.Sale.update_time"> <summary> Time the resource was last updated in UTC ISO8601 format. </summary> </member> <member name="M:PayPal.Api.Sale.Get(PayPal.Api.APIContext,System.String)"> <summary> Shows details for a sale, by ID. Returns only sales that were created through the REST API. </summary> <param name="apiContext">APIContext used for the API call.</param> <param name="saleId">The ID of the sale for which to show details.</param> <returns>Sale</returns> </member> <member name="M:PayPal.Api.Sale.Refund(PayPal.Api.APIContext,PayPal.Api.Refund)"> <summary> Creates (and processes) a new Refund Transaction added as a related resource. </summary> <param name="apiContext">APIContext used for the API call.</param> <param name="refund">Refund</param> <returns>Refund</returns> </member> <member name="M:PayPal.Api.Sale.Refund(PayPal.Api.APIContext,System.String,PayPal.Api.Refund)"> <summary> Creates (and processes) a new Refund Transaction added as a related resource. </summary> <param name="apiContext">APIContext used for the API call.</param> <param name="saleId">ID of the sale to refund.</param> <param name="refund">Refund</param> <returns>Refund</returns> </member> <member name="M:PayPal.Api.Sale.Refund(PayPal.Api.APIContext,System.String,PayPal.Api.RefundRequest)"> <summary> Refunds a sale, by ID. For a full refund, include an empty payload in the JSON request body. For a partial refund, include an `amount` object in the JSON request body. </summary> <param name="apiContext">APIContext used for the API call.</param> <param name="refundRequest">RefundRequest</param> <returns>DetailedRefund</returns> </member> <member name="T:PayPal.Api.Search"> <summary> Invoice search parameters. <para> See <a href="https://developer.paypal.com/docs/api/">PayPal Developer documentation</a> for more information. </para> </summary> </member> <member name="P:PayPal.Api.Search.email"> <summary> The initial letters of the email address. </summary> </member> <member name="P:PayPal.Api.Search.recipient_first_name"> <summary> The initial letters of the recipient first name. </summary> </member> <member name="P:PayPal.Api.Search.recipient_last_name"> <summary> The initial letters of the recipient last name. </summary> </member> <member name="P:PayPal.Api.Search.recipient_business_name"> <summary> The initial letters of the recipient business name. </summary> </member> <member name="P:PayPal.Api.Search.number"> <summary> The invoice number. </summary> </member> <member name="P:PayPal.Api.Search.status"> <summary> The invoice status. </summary> </member> <member name="P:PayPal.Api.Search.lower_total_amount"> <summary> The lower limit of the total amount. </summary> </member> <member name="P:PayPal.Api.Search.upper_total_amount"> <summary> The upper limit of total amount. </summary> </member> <member name="P:PayPal.Api.Search.start_invoice_date"> <summary> The start date for the invoice. Date format is *yyyy*-*MM*-*dd* *z*, as defined in [Internet Date/Time Format](http://tools.ietf.org/html/rfc3339#section-5.6). </summary> </member> <member name="P:PayPal.Api.Search.end_invoice_date"> <summary> The end date for the invoice. Date format is *yyyy*-*MM*-*dd* *z*, as defined in [Internet Date/Time Format](http://tools.ietf.org/html/rfc3339#section-5.6). </summary> </member> <member name="P:PayPal.Api.Search.start_due_date"> <summary> The start due date for the invoice. Date format is *yyyy*-*MM*-*dd* *z*, as defined in [Internet Date/Time Format](http://tools.ietf.org/html/rfc3339#section-5.6). </summary> </member> <member name="P:PayPal.Api.Search.end_due_date"> <summary> The end due date for the invoice. Date format is *yyyy*-*MM*-*dd* *z*, as defined in [Internet Date/Time Format](http://tools.ietf.org/html/rfc3339#section-5.6). </summary> </member> <member name="P:PayPal.Api.Search.start_payment_date"> <summary> The start payment date for the invoice. Date format is *yyyy*-*MM*-*dd* *z*, as defined in [Internet Date/Time Format](http://tools.ietf.org/html/rfc3339#section-5.6). </summary> </member> <member name="P:PayPal.Api.Search.end_payment_date"> <summary> The end payment date for the invoice. Date format is *yyyy*-*MM*-*dd* *z*, as defined in [Internet Date/Time Format](http://tools.ietf.org/html/rfc3339#section-5.6). </summary> </member> <member name="P:PayPal.Api.Search.start_creation_date"> <summary> The start creation date for the invoice. Date format is *yyyy*-*MM*-*dd* *z*, as defined in [Internet Date/Time Format](http://tools.ietf.org/html/rfc3339#section-5.6). </summary> </member> <member name="P:PayPal.Api.Search.end_creation_date"> <summary> The end creation date for the invoice. Date format is *yyyy*-*MM*-*dd* *z*, as defined in [Internet Date/Time Format](http://tools.ietf.org/html/rfc3339#section-5.6). </summary> </member> <member name="P:PayPal.Api.Search.page"> <summary> The offset for the search results. </summary> </member> <member name="P:PayPal.Api.Search.page_size"> <summary> The page size for the search results. </summary> </member> <member name="P:PayPal.Api.Search.total_count_required"> <summary> Indicates whether the total count appears in the response. Default is `false`. </summary> </member> <member name="P:PayPal.Api.Search.archived"> <summary> Indicates whether to list merchant-archived invoices in the response. If `true`, response lists only merchant-archived invoices. If `false`, response lists only unarchived invoices. If `null`, response lists all invoices. </summary> </member> <member name="T:PayPal.Api.ShippingAddress"> <summary> Extended Address object used as shipping address in a payment. <para> See <a href="https://developer.paypal.com/docs/api/">PayPal Developer documentation</a> for more information. </para> </summary> </member> <member name="P:PayPal.Api.ShippingAddress.id"> <summary> Address ID assigned in PayPal system. </summary> </member> <member name="P:PayPal.Api.ShippingAddress.recipient_name"> <summary> Name of the recipient at this address. </summary> </member> <member name="P:PayPal.Api.ShippingAddress.default_address"> <summary> Default shipping address of the Payer. </summary> </member> <member name="P:PayPal.Api.ShippingAddress.preferred_address"> <summary> Shipping Address marked as preferred by Payer. </summary> </member> <member name="T:PayPal.Api.ShippingCost"> <summary> Shipping cost, as a percent or an amount value. <para> See <a href="https://developer.paypal.com/docs/api/">PayPal Developer documentation</a> for more information. </para> </summary> </member> <member name="P:PayPal.Api.ShippingCost.amount"> <summary> The shipping cost, as an amount value. Valid value is from 0 to 999999.99. </summary> </member> <member name="P:PayPal.Api.ShippingCost.tax"> <summary> The tax percentage on the shipping amount. </summary> </member> <member name="T:PayPal.Api.ShippingInfo"> <summary> Shipping information for the invoice recipient. <para> See <a href="https://developer.paypal.com/docs/api/">PayPal Developer documentation</a> for more information. </para> </summary> </member> <member name="P:PayPal.Api.ShippingInfo.first_name"> <summary> The invoice recipient first name. </summary> </member> <member name="P:PayPal.Api.ShippingInfo.last_name"> <summary> The invoice recipient last name. </summary> </member> <member name="P:PayPal.Api.ShippingInfo.business_name"> <summary> The invoice recipient company business name. </summary> </member> <member name="P:PayPal.Api.ShippingInfo.address"> <summary> The invoice recipient address. </summary> </member> <member name="T:PayPal.Api.Tax"> <summary> Tax information. <para> See <a href="https://developer.paypal.com/docs/api/">PayPal Developer documentation</a> for more information. </para> </summary> </member> <member name="P:PayPal.Api.Tax.id"> <summary> The resource ID. </summary> </member> <member name="P:PayPal.Api.Tax.name"> <summary> The tax name. </summary> </member> <member name="P:PayPal.Api.Tax.percent"> <summary> The tax rate. Valid value is from 0.001 to 99.999. </summary> </member> <member name="P:PayPal.Api.Tax.amount"> <summary> The tax, as a monetary amount. Cannot be specified in a request. </summary> </member> <member name="T:PayPal.Api.InvoiceTemplate"> <summary> Invoicing template. <para> See <a href="https://developer.paypal.com/docs/api/">PayPal Developer documentation</a> for more information. </para> </summary> </member> <member name="P:PayPal.Api.InvoiceTemplate.template_id"> <summary> The ID of the template. </summary> </member> <member name="P:PayPal.Api.InvoiceTemplate.name"> <summary> The template name. </summary> </member> <member name="P:PayPal.Api.InvoiceTemplate.default"> <summary> Indicates whether this template is the default merchant template. A merchant can have one default template. </summary> </member> <member name="P:PayPal.Api.InvoiceTemplate.template_data"> <summary> Customized invoice data, which is saved as the template. </summary> </member> <member name="P:PayPal.Api.InvoiceTemplate.settings"> <summary> Settings for each template. </summary> </member> <member name="P:PayPal.Api.InvoiceTemplate.unit_of_measure"> <summary> The unit of measure for the template. Value is quantity, hours, or amount. </summary> </member> <member name="P:PayPal.Api.InvoiceTemplate.custom"> <summary> Indicates whether this template is a merchant-created custom template. Non-custom templates are system generated. </summary> </member> <member name="M:PayPal.Api.InvoiceTemplate.Get(PayPal.Api.APIContext,System.String)"> <summary> Shows details for a template, by ID. </summary> <param name="apiContext">APIContext used for the API call.</param> <param name="templateId">The ID of the template for which to show details.</param> <returns>Template</returns> </member> <member name="M:PayPal.Api.InvoiceTemplate.GetAll(PayPal.Api.APIContext,System.String)"> <summary> Lists all merchant-created templates. The list shows the emails, addresses, and phone numbers from the merchant profile. </summary> <param name="apiContext">APIContext used for the API call.</param> <param name="fields">The fields to return in the response. Value is `all` or `none`. Specify `none` to return only the template name, ID, and default attributes.</param> <returns>Templates</returns> </member> <member name="M:PayPal.Api.InvoiceTemplate.Delete(PayPal.Api.APIContext)"> <summary> Deletes a template, by ID. </summary> <param name="apiContext">APIContext used for the API call.</param> </member> <member name="M:PayPal.Api.InvoiceTemplate.Delete(PayPal.Api.APIContext,System.String)"> <summary> Deletes a template, by ID. </summary> <param name="apiContext">APIContext used for the API call.</param> <param name="templateId">The ID of the template to delete.</param> </member> <member name="M:PayPal.Api.InvoiceTemplate.Create(PayPal.Api.APIContext)"> <summary> Creates a template. </summary> <param name="apiContext">APIContext used for the API call.</param> <returns>Template</returns> </member> <member name="M:PayPal.Api.InvoiceTemplate.Update(PayPal.Api.APIContext)"> <summary> Updates a template, by ID. In the JSON request body, pass a complete `template` object. The update method does not support partial updates. </summary> <param name="apiContext">APIContext used for the API call.</param> <returns>Template</returns> </member> <member name="T:PayPal.Api.InvoiceTemplateData"> <summary> Detailed template information. <para> See <a href="https://developer.paypal.com/docs/api/">PayPal Developer documentation</a> for more information. </para> </summary> </member> <member name="P:PayPal.Api.InvoiceTemplateData.merchant_info"> <summary> Information about the merchant who sends the invoice. </summary> </member> <member name="P:PayPal.Api.InvoiceTemplateData.billing_info"> <summary> The required invoice recipient email address and any optional billing information. Supports one recipient only. </summary> </member> <member name="P:PayPal.Api.InvoiceTemplateData.cc_info"> <summary> For invoices sent by email, one or more email addresses to which to send a Cc: copy of the notification. Supports only email addresses under participant. </summary> </member> <member name="P:PayPal.Api.InvoiceTemplateData.shipping_info"> <summary> The shipping information for entities to whom items are shipped. </summary> </member> <member name="P:PayPal.Api.InvoiceTemplateData.items"> <summary> The list of items to include in the invoice. Each invoice can contain up to 100 items. </summary> </member> <member name="P:PayPal.Api.InvoiceTemplateData.payment_term"> <summary> Optional. The payment deadline for the invoice. Valid value is either `term_type` or `due_date` but not both. </summary> </member> <member name="P:PayPal.Api.InvoiceTemplateData.reference"> <summary> Reference data, such as PO number, to add to the invoice. </summary> </member> <member name="P:PayPal.Api.InvoiceTemplateData.discount"> <summary> The invoice level discount, as a percent or an amount value. </summary> </member> <member name="P:PayPal.Api.InvoiceTemplateData.shipping_cost"> <summary> The shipping cost, as a percent or an amount value. </summary> </member> <member name="P:PayPal.Api.InvoiceTemplateData.custom"> <summary> The custom amount to apply to an invoice. If you include a label, you must include the custom amount. </summary> </member> <member name="P:PayPal.Api.InvoiceTemplateData.allow_partial_payment"> <summary> Indicates whether the invoice allows a partial payment. If `false`, invoice must be paid in full. If `true`, the invoice allows partial payments. Default is `false`. </summary> </member> <member name="P:PayPal.Api.InvoiceTemplateData.minimum_amount_due"> <summary> The minimum amount allowed for a partial payment. Valid if `allow_partial_payment` is `true`. </summary> </member> <member name="P:PayPal.Api.InvoiceTemplateData.tax_calculated_after_discount"> <summary> Indicates whether the invoice allows a partial payment. If `false`, invoice must be paid in full. If `true`, the invoice allows partial payments. Default is `false`. </summary> </member> <member name="P:PayPal.Api.InvoiceTemplateData.tax_inclusive"> <summary> Indicates whether the unit price includes tax. Default is `false`. </summary> </member> <member name="P:PayPal.Api.InvoiceTemplateData.terms"> <summary> The general terms of the invoice. </summary> </member> <member name="P:PayPal.Api.InvoiceTemplateData.note"> <summary> A note to the payer. </summary> </member> <member name="P:PayPal.Api.InvoiceTemplateData.merchant_memo"> <summary> A private bookkeeping memo for the merchant. </summary> </member> <member name="P:PayPal.Api.InvoiceTemplateData.logo_url"> <summary> The full URL of an external logo image. </summary> </member> <member name="P:PayPal.Api.InvoiceTemplateData.total_amount"> <summary> The total amount of the invoice. </summary> </member> <member name="P:PayPal.Api.InvoiceTemplateData.attachments"> <summary> List of files that are attached to the invoice. </summary> </member> <member name="T:PayPal.Api.InvoiceTemplateSettings"> <summary> Template settings. <para> See <a href="https://developer.paypal.com/docs/api/">PayPal Developer documentation</a> for more information. </para> </summary> </member> <member name="P:PayPal.Api.InvoiceTemplateSettings.field_name"> <summary> The field name for any field in `template_data` for which to map corresponding display preferences. </summary> </member> <member name="P:PayPal.Api.InvoiceTemplateSettings.display_preference"> <summary> The settings metadata for each field. </summary> </member> <member name="T:PayPal.Api.InvoiceTemplateSettingsMetadata"> <summary> Settings metadata for a template field. <para> See <a href="https://developer.paypal.com/docs/api/">PayPal Developer documentation</a> for more information. </para> </summary> </member> <member name="P:PayPal.Api.InvoiceTemplateSettingsMetadata.hidden"> <summary> Indicates whether this field is hidden. Default is `false`. </summary> </member> <member name="T:PayPal.Api.InvoiceTemplates"> <summary> List of merchant templates. <para> See <a href="https://developer.paypal.com/docs/api/">PayPal Developer documentation</a> for more information. </para> </summary> </member> <member name="P:PayPal.Api.InvoiceTemplates.addresses"> <summary> List of addresses in merchant profile. </summary> </member> <member name="P:PayPal.Api.InvoiceTemplates.emails"> <summary> List of emails in merchant profile. </summary> </member> <member name="P:PayPal.Api.InvoiceTemplates.phones"> <summary> List of phone numbers in merchant profile. </summary> </member> <member name="P:PayPal.Api.InvoiceTemplates.templates"> <summary> An array of templates. </summary> </member> <member name="T:PayPal.Api.Terms"> <summary> Payment terms for a billing plan. <para> See <a href="https://developer.paypal.com/docs/api/">PayPal Developer documentation</a> for more information. </para> </summary> </member> <member name="P:PayPal.Api.Terms.id"> <summary> Identifier of the terms. 128 characters max. </summary> </member> <member name="P:PayPal.Api.Terms.type"> <summary> Term type. Allowed values: `MONTHLY`, `WEEKLY`, `YEARLY`. </summary> </member> <member name="P:PayPal.Api.Terms.max_billing_amount"> <summary> Max Amount associated with this term. </summary> </member> <member name="P:PayPal.Api.Terms.occurrences"> <summary> How many times money can be pulled during this term. </summary> </member> <member name="P:PayPal.Api.Terms.amount_range"> <summary> Amount_range associated with this term. </summary> </member> <member name="P:PayPal.Api.Terms.buyer_editable"> <summary> Buyer's ability to edit the amount in this term. </summary> </member> <member name="T:PayPal.Api.Transaction"> <summary> A transaction defines the contract of a payment - what is the payment for and who is fulfilling it. <para> See <a href="https://developer.paypal.com/docs/api/">PayPal Developer documentation</a> for more information. </para> </summary> </member> <member name="P:PayPal.Api.Transaction.purchase_unit_reference_id"> <summary> Identifier to the purchase unit corresponding to this sale transaction. </summary> </member> <member name="P:PayPal.Api.Transaction.related_resources"> <summary> List of financial transactions (Sale, Authorization, Capture, Refund) related to the payment. </summary> </member> <member name="T:PayPal.Api.VerifyWebhookSignature"> <summary> Verify webhook signature. <para> See <a href="https://developer.paypal.com/docs/api/">PayPal Developer documentation</a> for more information. </para> </summary> </member> <member name="P:PayPal.Api.VerifyWebhookSignature.auth_algo"> <summary> The algorithm that PayPal uses to generate the signature and that you can use to verify the signature. Extract this value from the `PAYPAL-AUTH-ALGO` response header, which is received with the webhook notification. </summary> </member> <member name="P:PayPal.Api.VerifyWebhookSignature.cert_url"> <summary> The X.509 public key certificate. Download the certificate from this URL and use it to verify the signature. Extract this value from the `PAYPAL-CERT-URL` response header, which is received with the webhook notification. </summary> </member> <member name="P:PayPal.Api.VerifyWebhookSignature.transmission_id"> <summary> The ID of the HTTP transmission. Contained in the `PAYPAL-TRANSMISSION-ID` header of the notification message. </summary> </member> <member name="P:PayPal.Api.VerifyWebhookSignature.transmission_sig"> <summary> The PayPal-generated asymmetric signature. Extract this value from the `PAYPAL-TRANSMISSION-SIG` response header, which is received with the webhook notification. </summary> </member> <member name="P:PayPal.Api.VerifyWebhookSignature.transmission_time"> <summary> The date and time of the HTTP transmission. Contained in the `PAYPAL-TRANSMISSION-TIME` header of the notification message. </summary> </member> <member name="P:PayPal.Api.VerifyWebhookSignature.webhook_id"> <summary> The ID of the webhook as configured in your Developer Portal account. </summary> </member> <member name="P:PayPal.Api.VerifyWebhookSignature.webhook_event"> <summary> The webhook notification, which is the content of the HTTP `POST` request body. </summary> </member> <member name="M:PayPal.Api.VerifyWebhookSignature.Post(PayPal.Api.APIContext)"> <summary> Verifies a webhook signature. </summary> <param name="apiContext">APIContext used for the API call.</param> <returns>VerifyWebhookSignatureResponse</returns> </member> <member name="T:PayPal.Api.VerifyWebhookSignatureResponse"> <summary> The verify webhook signature response. <para> See <a href="https://developer.paypal.com/docs/api/">PayPal Developer documentation</a> for more information. </para> </summary> </member> <member name="P:PayPal.Api.VerifyWebhookSignatureResponse.verification_status"> <summary> The status of the signature verification. Value is `SUCCESS` or `FAILURE`. </summary> </member> <member name="T:PayPal.Api.WebProfile"> <summary> Payment web experience profile. <para> See <a href="https://developer.paypal.com/docs/api/">PayPal Developer documentation</a> for more information. </para> </summary> </member> <member name="P:PayPal.Api.WebProfile.id"> <summary> The ID of the web experience profile. </summary> </member> <member name="P:PayPal.Api.WebProfile.name"> <summary> The web experience profile name. Unique for a specified merchant's profiles. </summary> </member> <member name="P:PayPal.Api.WebProfile.temporary"> <summary> Indicates whether the profile persists for three hours or permanently. Set to `false` to persist the profile permanently. Set to `true` to persist the profile for three hours. </summary> </member> <member name="P:PayPal.Api.WebProfile.flow_config"> <summary> Parameters for flow configuration. </summary> </member> <member name="P:PayPal.Api.WebProfile.input_fields"> <summary> Parameters for input fields customization. </summary> </member> <member name="P:PayPal.Api.WebProfile.presentation"> <summary> Parameters for style and presentation. </summary> </member> <member name="M:PayPal.Api.WebProfile.Create(PayPal.Api.APIContext)"> <summary> Creates a web experience profile. Pass the profile name and details in the JSON request body. </summary> <param name="apiContext">APIContext used for the API call.</param> <returns>CreateProfileResponse</returns> </member> <member name="M:PayPal.Api.WebProfile.Create(PayPal.Api.APIContext,PayPal.Api.WebProfile)"> <summary> Create a web experience profile by passing the name of the profile and other profile details in the request JSON to the request URI. </summary> <param name="apiContext">APIContext used for the API call.</param> <param name="webProfile">WebProfile object to be created as a PayPal resource.</param> <returns>CreateProfileResponse</returns> </member> <member name="M:PayPal.Api.WebProfile.Update(PayPal.Api.APIContext)"> <summary> Updates a web experience profile. Pass the ID of the profile to the request URI and pass the profile details in the JSON request body. If your request omits any profile detail fields, the operation removes the previously set values for those fields. </summary> <param name="apiContext">APIContext used for the API call.</param> </member> <member name="M:PayPal.Api.WebProfile.Update(PayPal.Api.APIContext,PayPal.Api.WebProfile)"> <summary> Update a web experience profile by passing the ID of the profile to the request URI. In addition, pass the profile details in the request JSON. If your request does not include values for all profile detail fields, the previously set values for the omitted fields are removed by this operation. </summary> <param name="apiContext">APIContext used for the API call.</param> <param name="profile">WebProfile resource to update.</param> </member> <member name="M:PayPal.Api.WebProfile.PartialUpdate(PayPal.Api.APIContext,PayPal.Api.PatchRequest)"> <summary> Partially-updates a web experience profile. Pass the profile ID to the request URI. Pass a patch object with the operation, path of the profile location to update, and, if needed, a new value to complete the operation in the JSON request body. </summary> <param name="apiContext">APIContext used for the API call.</param> <param name="patchRequest">PatchRequest</param> </member> <member name="M:PayPal.Api.WebProfile.PartialUpdate(PayPal.Api.APIContext,System.String,PayPal.Api.PatchRequest)"> <summary> Partially update an existing web experience profile by passing the ID of the profile to the request URI. In addition, pass a patch object in the request JSON that specifies the operation to perform, path of the profile location to update, and a new value if needed to complete the operation. </summary> <param name="apiContext">APIContext used for the API call.</param> <param name="profileId">ID fo the web profile to partially update.</param> <param name="patchRequest">PatchRequest</param> </member> <member name="M:PayPal.Api.WebProfile.Get(PayPal.Api.APIContext,System.String)"> <summary> Shows details for a web experience profile, by ID. </summary> <param name="apiContext">APIContext used for the API call.</param> <param name="profileId">The ID of the profile for which to show details.</param> <returns>WebProfile</returns> </member> <member name="M:PayPal.Api.WebProfile.GetList(PayPal.Api.APIContext)"> <summary> Lists all web experience profiles for a merchant or subject. </summary> <param name="apiContext">APIContext used for the API call.</param> <returns>WebProfileList</returns> </member> <member name="M:PayPal.Api.WebProfile.Delete(PayPal.Api.APIContext)"> <summary> Deletes a web experience profile, by ID. </summary> <param name="apiContext">APIContext used for the API call.</param> </member> <member name="M:PayPal.Api.WebProfile.Delete(PayPal.Api.APIContext,System.String)"> <summary> Deletes a web experience profile, by ID. </summary> <param name="apiContext">APIContext used for the API call.</param> <param name="profileId">The ID of the profile to delete.</param> </member> <member name="T:PayPal.Api.WebProfileList"> <summary> A list of web experience profiles resource objects returned from a search operation. <para> See <a href="https://developer.paypal.com/docs/api/">PayPal Developer documentation</a> for more information. </para> </summary> </member> <member name="T:PayPal.Api.Webhook"> <summary> One or more webhook objects. <para> See <a href="https://developer.paypal.com/docs/api/">PayPal Developer documentation</a> for more information. </para> </summary> </member> <member name="P:PayPal.Api.Webhook.id"> <summary> The ID of the webhook. </summary> </member> <member name="P:PayPal.Api.Webhook.url"> <summary> The URL that is configured to listen on `localhost` for incoming `POST` notification messages that contain event information. </summary> </member> <member name="P:PayPal.Api.Webhook.event_types"> <summary> A list of up to ten events to which to subscribe your webhook. To subscribe to all events including new events as they are added, specify the asterisk (`*`) wildcard. To replace the `event_types` array, specify the `*` wildcard. To see all supported events, [list available events](#available-event-type.list). </summary> </member> <member name="M:PayPal.Api.Webhook.Create(PayPal.Api.APIContext)"> <summary> Subscribes your webhook listener to events. A successful call returns a [`webhook`](/docs/api/webhooks/#definition-webhook) object, which includes the webhook ID for later use. </summary> <param name="apiContext">APIContext used for the API call.</param> <returns>Webhook</returns> </member> <member name="M:PayPal.Api.Webhook.Create(PayPal.Api.APIContext,PayPal.Api.Webhook)"> <summary> Creates the Webhook for the application associated with the access token. </summary> <param name="apiContext">APIContext used for the API call.</param> <param name="webhook"><seealso cref="T:PayPal.Api.Webhook"/> object to be created.</param> <returns>Webhook</returns> </member> <member name="M:PayPal.Api.Webhook.Get(PayPal.Api.APIContext,System.String)"> <summary> Shows details for a webhook, by ID. </summary> <param name="apiContext">APIContext used for the API call.</param> <param name="webhookId">The ID of the webhook for which to show details.</param> <returns>Webhook</returns> </member> <member name="M:PayPal.Api.Webhook.GetAll(PayPal.Api.APIContext,System.String)"> <summary> Lists all webhooks for an app. </summary> <param name="apiContext">APIContext used for the API call.</param> <param name="anchorType">Filters the response by an entity type, `anchor_id`. Value is `APPLICATION` or `ACCOUNT`. Default is `APPLICATION`.</param> <returns>WebhookList</returns> </member> <member name="M:PayPal.Api.Webhook.Update(PayPal.Api.APIContext,PayPal.Api.PatchRequest)"> <summary> Replaces webhook fields with new values. Pass a `json_patch` object with `replace` operation and `path`, which is `/url` for a URL or `/event_types` for events. The `value` is either the URL or a list of events. </summary> <param name="apiContext">APIContext used for the API call.</param> <param name="patchRequest">PatchRequest</param> <returns>Webhook</returns> </member> <member name="M:PayPal.Api.Webhook.Update(PayPal.Api.APIContext,System.String,PayPal.Api.PatchRequest)"> <summary> Updates the Webhook identified by webhook_id for the application associated with access token. </summary> <param name="apiContext">APIContext used for the API call.</param> <param name="webhookId">ID of the webhook to be updated.</param> <param name="patchRequest">PatchRequest</param> <returns>Webhook</returns> </member> <member name="M:PayPal.Api.Webhook.Delete(PayPal.Api.APIContext)"> <summary> Deletes a webhook, by ID. </summary> <param name="apiContext">APIContext used for the API call.</param> </member> <member name="M:PayPal.Api.Webhook.Delete(PayPal.Api.APIContext,System.String)"> <summary> Deletes a webhook, by ID. </summary> <param name="apiContext">APIContext used for the API call.</param> <param name="webhookId">The ID of the webhook to delete.</param> </member> <member name="T:PayPal.Api.WebhookEvent"> <summary> A webhook event notification. <para> See <a href="https://developer.paypal.com/docs/api/">PayPal Developer documentation</a> for more information. </para> </summary> </member> <member name="P:PayPal.Api.WebhookEvent.id"> <summary> The ID of the webhook event notification. </summary> </member> <member name="P:PayPal.Api.WebhookEvent.create_time"> <summary> The date and time when the webhook event notification was created. </summary> </member> <member name="P:PayPal.Api.WebhookEvent.resource_type"> <summary> The name of the resource related to the webhook notification event. </summary> </member> <member name="P:PayPal.Api.WebhookEvent.event_version"> <summary> The version of the event. </summary> </member> <member name="P:PayPal.Api.WebhookEvent.event_type"> <summary> The event that triggered the webhook event notification. </summary> </member> <member name="P:PayPal.Api.WebhookEvent.summary"> <summary> A summary description for the event notification. For example, `A payment authorization was created.` </summary> </member> <member name="P:PayPal.Api.WebhookEvent.resource"> <summary> The resource that triggered the webhook event notification. </summary> </member> <member name="P:PayPal.Api.WebhookEvent.status"> <summary> The event transmission status. Displayed only for internal API calls through the PayPal Developer portal. </summary> </member> <member name="P:PayPal.Api.WebhookEvent.transmissions"> <summary> The list of transmissions for an event. Displayed only for internal API calls through the PayPal Developer portal. </summary> </member> <member name="M:PayPal.Api.WebhookEvent.Get(PayPal.Api.APIContext,System.String)"> <summary> Shows details for a webhook event notification, by ID. </summary> <param name="apiContext">APIContext used for the API call.</param> <param name="eventId">The ID of the webhook event notification for which to show details.</param> <returns>WebhookEvent</returns> </member> <member name="M:PayPal.Api.WebhookEvent.Resend(PayPal.Api.APIContext)"> <summary> Resends the Webhooks event resource identified by event_id. </summary> <param name="apiContext">APIContext used for the API call.</param> <returns>WebhookEvent</returns> </member> <member name="M:PayPal.Api.WebhookEvent.Resend(PayPal.Api.APIContext,System.String)"> <summary> Resends the Webhooks event resource identified by event_id. </summary> <param name="apiContext">APIContext used for the API call.</param> <param name="webhookEventId">ID of the webhook event to resend.</param> <returns>WebhookEvent</returns> </member> <member name="M:PayPal.Api.WebhookEvent.List(PayPal.Api.APIContext,System.Int32,System.String,System.String)"> <summary> Retrieves the list of Webhooks events resources for the application associated with token. The developers can use it to see list of past webhooks events. </summary> <param name="apiContext">APIContext used for the API call.</param> <param name="pageSize">Number of items to be returned by a GET operation</param> <param name="startTime">Resource creation time that indicates the start of a range of results.</param> <param name="endTime">Resource creation time that indicates the end of a range of results.</param> <returns>WebhookEventList</returns> </member> <member name="M:PayPal.Api.WebhookEvent.ValidateReceivedEvent(PayPal.Api.APIContext,System.Collections.Specialized.NameValueCollection,System.String,System.String)"> <summary> Validates a received webhook event by checking the signature of the event and verifying the event originated from PayPal. </summary> <param name="apiContext">APIContext containing any configuration settings to be used when validating the event.</param> <param name="requestHeaders">A collection of HTTP request headers included with the received webhook event.</param> <param name="requestBody">The body of the received HTTP request.</param> <param name="webhookId">ID of the webhook resource associated with this webhook event. If not specified, it is assumed the ID is provided via the Config property of the <paramref name="apiContext"/> parameter.</param> <returns>True if the webhook event is valid and was sent from PayPal; false otherwise.</returns> </member> <member name="M:PayPal.Api.WebhookEvent.ConvertAuthAlgorithmHeaderToHashAlgorithmName(System.String)"> <summary> Converts the algorithm name specified by <paramref name="authAlgorithmHeader"/> into a hash algorithm name recognized by <seealso cref="T:System.Security.Cryptography.CryptoConfig"/>. </summary> <param name="authAlgorithmHeader">The PAYPAL-AUTH-ALGO header value included with a received Webhook event.</param> <returns>A mapped hash algorithm name.</returns> </member> <member name="T:PayPal.Api.WebhookEventList"> <summary> List of webhooks events. <para> See <a href="https://developer.paypal.com/docs/api/">PayPal Developer documentation</a> for more information. </para> </summary> </member> <member name="P:PayPal.Api.WebhookEventList.events"> <summary> A list of webhooks events. </summary> </member> <member name="P:PayPal.Api.WebhookEventList.count"> <summary> The number of items in each range of results. Note that the response might have fewer items than the requested `page_size` value. </summary> </member> <member name="T:PayPal.Api.WebhookEventType"> <summary> A list of events. <para> See <a href="https://developer.paypal.com/docs/api/">PayPal Developer documentation</a> for more information. </para> </summary> </member> <member name="P:PayPal.Api.WebhookEventType.name"> <summary> The unique event name. </summary> </member> <member name="P:PayPal.Api.WebhookEventType.description"> <summary> A human-readable description of the event. </summary> </member> <member name="P:PayPal.Api.WebhookEventType.status"> <summary> The status of a webhook event. </summary> </member> <member name="M:PayPal.Api.WebhookEventType.SubscribedEventTypes(PayPal.Api.APIContext,System.String)"> <summary> Lists event subscriptions for a webhook, by ID. </summary> <param name="apiContext">APIContext used for the API call.</param> <param name="webhookId">The ID of the webhook for which to list subscriptions.</param> <returns>WebhookEventTypeList</returns> </member> <member name="M:PayPal.Api.WebhookEventType.AvailableEventTypes(PayPal.Api.APIContext)"> <summary> Lists available events to which any webhook can subscribe. For a list of supported events, see [Webhook events](/docs/integration/direct/rest/webhooks/webhook-events/). </summary> <param name="apiContext">APIContext used for the API call.</param> <returns>WebhookEventTypeList</returns> </member> <member name="T:PayPal.Api.WebhookEventTypeList"> <summary> List of webhook events. <para> See <a href="https://developer.paypal.com/docs/api/">PayPal Developer documentation</a> for more information. </para> </summary> </member> <member name="P:PayPal.Api.WebhookEventTypeList.event_types"> <summary> A list of webhook events. </summary> </member> <member name="T:PayPal.Api.WebhookList"> <summary> List of webhooks. <para> See <a href="https://developer.paypal.com/docs/api/">PayPal Developer documentation</a> for more information. </para> </summary> </member> <member name="P:PayPal.Api.WebhookList.webhooks"> <summary> A list of webhooks. </summary> </member> <member name="T:PayPal.Api.BaseConstants"> <summary> Constants that are used by the PayPal SDK. </summary> </member> <member name="F:PayPal.Api.BaseConstants.PayPalTransmissionIdHeader"> <summary> PayPal webhook transmission ID HTTP request header </summary> </member> <member name="F:PayPal.Api.BaseConstants.PayPalTransmissionTimeHeader"> <summary> PayPal webhook transmission time HTTP request header </summary> </member> <member name="F:PayPal.Api.BaseConstants.PayPalTransmissionSignatureHeader"> <summary> PayPal webhook transmission signature HTTP request header </summary> </member> <member name="F:PayPal.Api.BaseConstants.PayPalCertificateUrlHeader"> <summary> PayPal webhook certificate URL HTTP request header </summary> </member> <member name="F:PayPal.Api.BaseConstants.PayPalAuthAlgorithmHeader"> <summary> PayPal webhook authentication algorithm HTTP request header </summary> </member> <member name="F:PayPal.Api.BaseConstants.LiveMode"> <summary> Allowed application mode - live </summary> </member> <member name="F:PayPal.Api.BaseConstants.SandboxMode"> <summary> Allowed application mode - sandbox </summary> </member> <member name="F:PayPal.Api.BaseConstants.SecurityTestSandboxMode"> <summary> Allowed application mode - security-test-sandbox </summary> </member> <member name="F:PayPal.Api.BaseConstants.RESTSandboxEndpoint"> <summary> Sandbox REST API endpoint </summary> </member> <member name="F:PayPal.Api.BaseConstants.RESTLiveEndpoint"> <summary> Live REST API endpoint </summary> </member> <member name="F:PayPal.Api.BaseConstants.RESTSecurityTestSandoxEndpoint"> <summary> Security Test Sandbox REST API endpoint </summary> </member> <member name="F:PayPal.Api.BaseConstants.ApplicationModeConfig"> <summary> Configuration key for application mode </summary> </member> <member name="F:PayPal.Api.BaseConstants.EndpointConfig"> <summary> Configuration key for End point </summary> </member> <member name="F:PayPal.Api.BaseConstants.HttpProxyAddressConfig"> <summary> Configuration key for HTTP Proxy Address </summary> </member> <member name="F:PayPal.Api.BaseConstants.HttpProxyCredentialConfig"> <summary> Configuration key for HTTP Proxy Credential </summary> </member> <member name="F:PayPal.Api.BaseConstants.HttpConnectionTimeoutConfig"> <summary> Configuration key for HTTP Connection Timeout </summary> </member> <member name="F:PayPal.Api.BaseConstants.HttpConnectionRetryConfig"> <summary> Configuration key for HTTP Connection Retry </summary> </member> <member name="F:PayPal.Api.BaseConstants.ClientId"> <summary> Configuration key suffix for Client Id </summary> </member> <member name="F:PayPal.Api.BaseConstants.ClientSecret"> <summary> Configuration key suffix for Client Secret </summary> </member> <member name="F:PayPal.Api.BaseConstants.OAuthEndpoint"> <summary> OAuth endpoint config key </summary> </member> <member name="F:PayPal.Api.BaseConstants.TrustedCertificateLocation"> <summary> Trusted certificate file location to be used when validating webhook event certifcates. </summary> </member> <member name="F:PayPal.Api.BaseConstants.WebhookIdConfig"> <summary> Webhook ID used when validating received webhook notifications. </summary> </member> <member name="F:PayPal.Api.BaseConstants.UserAgentHeader"> <summary> User Agent HTTP Header </summary> </member> <member name="F:PayPal.Api.BaseConstants.ContentTypeHeader"> <summary> Content Type HTTP Header </summary> </member> <member name="F:PayPal.Api.BaseConstants.ContentTypeHeaderJson"> <summary> Application - Json Content Type </summary> </member> <member name="F:PayPal.Api.BaseConstants.ContentTypeHeaderFormUrlEncoded"> <summary> Application - Form URL Encoded Content Type </summary> </member> <member name="F:PayPal.Api.BaseConstants.AuthorizationHeader"> <summary> Authorization HTTP Header </summary> </member> <member name="F:PayPal.Api.BaseConstants.PayPalRequestIdHeader"> <summary> PayPal Request Id HTTP Header </summary> </member> <member name="P:PayPal.Api.BaseConstants.SdkVersion"> <summary> The version of this SDK. </summary> </member> <member name="F:PayPal.Api.BaseConstants.SdkName"> <summary> The name of this SDK. </summary> </member> <member name="T:PayPal.Api.BaseConstants.HateoasLinkRelations"> <summary> Defines string constants for HATEOAS link relations. </summary> </member> <member name="F:PayPal.Api.BaseConstants.HateoasLinkRelations.Self"> <summary> HATEOAS link relation used to get the details of the current resource. </summary> </member> <member name="F:PayPal.Api.BaseConstants.HateoasLinkRelations.ParentPayment"> <summary> HATEOAS link relation used to get the details of the parent payment of a payment resource. </summary> </member> <member name="F:PayPal.Api.BaseConstants.HateoasLinkRelations.Update"> <summary> HATEOAS link relation used to update the current resource. </summary> </member> <member name="F:PayPal.Api.BaseConstants.HateoasLinkRelations.Delete"> <summary> HATEOAS link relation used to delete the current resource. </summary> </member> <member name="F:PayPal.Api.BaseConstants.HateoasLinkRelations.Patch"> <summary> HATEOAS link relation used to patch the current resource. </summary> </member> <member name="F:PayPal.Api.BaseConstants.HateoasLinkRelations.ApprovalUrl"> <summary> HATEOAS link relation used to redirect a buyer to PayPal to provide approval for the payment associated with the current resource. </summary> </member> <member name="F:PayPal.Api.BaseConstants.HateoasLinkRelations.Execute"> <summary> HATEOAS link relation used to execute the payment associated with the current resource. </summary> </member> <member name="F:PayPal.Api.BaseConstants.HateoasLinkRelations.Capture"> <summary> HATEOAS link relation used to capture the payment associated with the current resource. </summary> </member> <member name="F:PayPal.Api.BaseConstants.HateoasLinkRelations.Authorization"> <summary> HATEOAS link relation used to provide authorization for the payment associated with the current resource. </summary> </member> <member name="F:PayPal.Api.BaseConstants.HateoasLinkRelations.Order"> <summary> HATEOAS link relation used to get the order resource associated with the current resource. </summary> </member> <member name="F:PayPal.Api.BaseConstants.HateoasLinkRelations.Refund"> <summary> HATEOAS link relation used to issue a refund for the current resource. </summary> </member> <member name="F:PayPal.Api.BaseConstants.HateoasLinkRelations.Void"> <summary> HATEOAS link relation used to void the current resource. </summary> </member> <member name="F:PayPal.Api.BaseConstants.HateoasLinkRelations.ReAuthorize"> <summary> HATEOAS link relation used to reauthorize a payment authorization resource. </summary> </member> <member name="F:PayPal.Api.BaseConstants.HateoasLinkRelations.NextPage"> <summary> HATEOAS link relation used for searches and provides results for the next set of search results. </summary> </member> <member name="F:PayPal.Api.BaseConstants.HateoasLinkRelations.PreviousPage"> <summary> HATEOAS link relation used for searches and provides results for the previous set of search results. </summary> </member> <member name="F:PayPal.Api.BaseConstants.HateoasLinkRelations.Start"> <summary> HATEOAS link relation used for searches and provides results for the first set of search results. </summary> </member> <member name="F:PayPal.Api.BaseConstants.HateoasLinkRelations.Last"> <summary> HATEOAS link relation used for searches and provides results for the last set of search results. </summary> </member> <member name="F:PayPal.Api.BaseConstants.HateoasLinkRelations.Suspend"> <summary> HATEOAS link relation used to suspend a billing agreement. </summary> </member> <member name="F:PayPal.Api.BaseConstants.HateoasLinkRelations.ReActivate"> <summary> HATEOAS link relation used to reactivate a billing agreement. </summary> </member> <member name="F:PayPal.Api.BaseConstants.HateoasLinkRelations.Cancel"> <summary> HATEOAS link relation used to cancel a billing agreement. </summary> </member> <member name="F:PayPal.Api.BaseConstants.HateoasLinkRelations.Batch"> <summary> HATEOAS link relation used to get the payout batch associated with the current payout item resource. </summary> </member> <member name="F:PayPal.Api.BaseConstants.HateoasLinkRelations.Item"> <summary> HATEOAS link relation used to get a specific payout item resource associated with current payout batch. </summary> </member> <member name="F:PayPal.Api.BaseConstants.HateoasLinkRelations.Resend"> <summary> HATEOAS link relation used to resend a webhook event. </summary> </member> <member name="F:PayPal.Api.BaseConstants.HateoasLinkRelations.Next"> <summary> HATEOAS link relation used for webhook searches and provides results for the next set of search results. </summary> </member> <member name="F:PayPal.Api.BaseConstants.HateoasLinkRelations.Previous"> <summary> HATEOAS link relation used for webhook searches and provides results for the previous set of search results. </summary> </member> <member name="T:PayPal.Api.RequestDetails"> <summary> Stores details related to an HTTP request. </summary> </member> <member name="P:PayPal.Api.RequestDetails.Url"> <summary> Gets or sets the URL for the request. </summary> </member> <member name="P:PayPal.Api.RequestDetails.Method"> <summary> Gets or sets the HTTP method verb used for the request. </summary> </member> <member name="P:PayPal.Api.RequestDetails.Headers"> <summary> Gets or sets the headers used in the request. </summary> </member> <member name="P:PayPal.Api.RequestDetails.Body"> <summary> Gets or sets the request body. </summary> </member> <member name="P:PayPal.Api.RequestDetails.RetryAttempts"> <summary> Gets or sets the number of retry attempts for sending an HTTP request. </summary> </member> <member name="M:PayPal.Api.RequestDetails.Reset"> <summary> Resets the state of this object and clears its properties. </summary> </member> <member name="T:PayPal.Api.ResponseDetails"> <summary> Stores details related to an HTTP response. </summary> </member> <member name="P:PayPal.Api.ResponseDetails.Headers"> <summary> Gets or sets the headers used in the response. </summary> </member> <member name="P:PayPal.Api.ResponseDetails.Body"> <summary> Gets or sets the response body. </summary> </member> <member name="P:PayPal.Api.ResponseDetails.StatusCode"> <summary> Gets or sets the response HTTP status code. </summary> </member> <member name="P:PayPal.Api.ResponseDetails.Exception"> <summary> Gets or sets an exception related to the response. </summary> </member> <member name="M:PayPal.Api.ResponseDetails.Reset"> <summary> Resets the state of this object and clears its properties. </summary> </member> <member name="T:PayPal.Api.HttpConnection"> <summary> Helper class for sending HTTP requests. </summary> </member> <member name="P:PayPal.Api.HttpConnection.RequestDetails"> <summary> Gets the HTTP request details. </summary> </member> <member name="P:PayPal.Api.HttpConnection.ResponseDetails"> <summary> Gets the HTTP response details. </summary> </member> <member name="M:PayPal.Api.HttpConnection.#ctor(System.Collections.Generic.Dictionary{System.String,System.String})"> <summary> Initializes a new instance of <seealso cref="T:PayPal.Api.HttpConnection"/> using the given config. </summary> <param name="config">The config to use when making HTTP requests.</param> </member> <member name="M:PayPal.Api.HttpConnection.CopyRequest(System.Net.HttpWebRequest,System.Collections.Generic.Dictionary{System.String,System.String},System.String)"> <summary> Copying existing HttpWebRequest parameters to newly created HttpWebRequest, can't reuse the same HttpWebRequest for retries. </summary> <param name="httpRequest"></param> <param name="config"></param> <param name="url"></param> <returns>HttpWebRequest</returns> </member> <member name="M:PayPal.Api.HttpConnection.CopyHttpWebRequestHeaders(System.Net.HttpWebRequest,System.Net.HttpWebRequest)"> <summary> Copying existing HttpWebRequest headers into newly created HttpWebRequest </summary> <param name="httpRequest"></param> <param name="newHttpRequest"></param> <returns>HttpWebRequest</returns> </member> <member name="M:PayPal.Api.HttpConnection.Execute(System.String,System.Net.HttpWebRequest)"> <summary> Executing API calls </summary> <param name="payLoad"></param> <param name="httpRequest"></param> <returns>A string containing the response from the remote host.</returns> </member> <member name="T:PayPal.Api.ConfigManager"> <summary> ConfigManager loads the configuration file and hands out appropriate parameters to application </summary> </member> <member name="F:PayPal.Api.ConfigManager.logger"> <summary> Logger </summary> </member> <member name="F:PayPal.Api.ConfigManager.configValues"> <summary> The configValue is readonly as it should not be changed outside constructor (but the content can) </summary> </member> <member name="M:PayPal.Api.ConfigManager.#cctor"> <summary> Explicit static constructor to tell C# compiler not to mark type as beforefieldinit </summary> </member> <member name="F:PayPal.Api.ConfigManager.singletonInstance"> <summary> Singleton instance of the ConfigManager </summary> </member> <member name="P:PayPal.Api.ConfigManager.Instance"> <summary> Gets the Singleton instance of the ConfigManager </summary> </member> <member name="M:PayPal.Api.ConfigManager.#ctor"> <summary> Private constructor </summary> </member> <member name="M:PayPal.Api.ConfigManager.GetProperties"> <summary> Returns all properties from the config file </summary> <returns></returns> </member> <member name="M:PayPal.Api.ConfigManager.GetConfigWithDefaults(System.Collections.Generic.Dictionary{System.String,System.String})"> <summary> Creates new configuration that combines incoming configuration dictionary and defaults </summary> <returns>Default configuration dictionary</returns> </member> <member name="M:PayPal.Api.ConfigManager.GetDefault(System.String)"> <summary> Gets the default configuration value for the specified key. </summary> <param name="configKey">The key to lookup in the default configuration.</param> <returns>A string containing the default configuration value for the specified key. If the key is not found, returns null.</returns> </member> <member name="M:PayPal.Api.ConfigManager.IsLiveModeEnabled(System.Collections.Generic.Dictionary{System.String,System.String})"> <summary> Returns whether or not live mode is enabled in the given configuration. </summary> <param name="config">Configuration to use</param> <returns>True if live mode is enabled; false otherwise.</returns> </member> <member name="T:PayPal.Api.ConnectionManager"> <summary> ConnectionManager retrieves HttpConnection objects used by API service </summary> </member> <member name="F:PayPal.Api.ConnectionManager.logger"> <summary> Logger </summary> </member> <member name="F:PayPal.Api.ConnectionManager.lazyConnectionManager"> <summary> System.Lazy type guarantees thread-safe lazy-construction static holder for instance, need to use lambda to construct since constructor private </summary> </member> <member name="P:PayPal.Api.ConnectionManager.Instance"> <summary> Accessor for the Singleton instance of ConnectionManager </summary> </member> <member name="M:PayPal.Api.ConnectionManager.#ctor"> <summary> Private constructor, private to prevent direct instantiation </summary> </member> <member name="M:PayPal.Api.ConnectionManager.GetConnection(System.Collections.Generic.Dictionary{System.String,System.String},System.String)"> <summary> Create and Config a HttpWebRequest </summary> <param name="config">Config properties</param> <param name="url">Url to connect to</param> <returns></returns> </member> <member name="T:PayPal.Api.OpenIdConnect.Address"> <summary> Address used in context of Log In with PayPal. </summary> </member> <member name="P:PayPal.Api.OpenIdConnect.Address.street_address"> <summary> Street address component, which may include house number, and street name </summary> </member> <member name="P:PayPal.Api.OpenIdConnect.Address.locality"> <summary> City or locality component </summary> </member> <member name="P:PayPal.Api.OpenIdConnect.Address.region"> <summary> State, province, prefecture or region component </summary> </member> <member name="P:PayPal.Api.OpenIdConnect.Address.postal_code"> <summary> Zip code or postal code component </summary> </member> <member name="P:PayPal.Api.OpenIdConnect.Address.country"> <summary> Country name component. </summary> </member> <member name="T:PayPal.Api.OpenIdConnect.Userinfo"> <summary> User information in context of Log In with PayPal. </summary> </member> <member name="P:PayPal.Api.OpenIdConnect.Userinfo.user_id"> <summary> Subject - Identifier for the End-User at the Issuer </summary> </member> <member name="P:PayPal.Api.OpenIdConnect.Userinfo.sub"> <summary> Subject - Identifier for the End-User at the Issuer </summary> </member> <member name="P:PayPal.Api.OpenIdConnect.Userinfo.name"> <summary> End-User's full name in displayable form including all name parts, possibly including titles and suffixes, ordered according to the End-User's locale and preferences </summary> </member> <member name="P:PayPal.Api.OpenIdConnect.Userinfo.given_name"> <summary> Given name(s) or first name(s) of the End-User </summary> </member> <member name="P:PayPal.Api.OpenIdConnect.Userinfo.family_name"> <summary> Surname(s) or last name(s) of the End-User </summary> </member> <member name="P:PayPal.Api.OpenIdConnect.Userinfo.middle_name"> <summary> Middle name(s) of the End-User </summary> </member> <member name="P:PayPal.Api.OpenIdConnect.Userinfo.picture"> <summary> URL of the End-User's profile picture </summary> </member> <member name="P:PayPal.Api.OpenIdConnect.Userinfo.email"> <summary> End-User's preferred e-mail address </summary> </member> <member name="P:PayPal.Api.OpenIdConnect.Userinfo.email_verified"> <summary> True if the End-User's e-mail address has been verified; otherwise false </summary> </member> <member name="P:PayPal.Api.OpenIdConnect.Userinfo.gender"> <summary> End-User's gender. </summary> </member> <member name="P:PayPal.Api.OpenIdConnect.Userinfo.birthdate"> <summary> End-User's birthday, represented as an YYYY-MM-DD format. They year MAY be 0000, indicating it is omited. To represent only the year, YYYY format would be used </summary> </member> <member name="P:PayPal.Api.OpenIdConnect.Userinfo.zoneinfo"> <summary> Time zone database representing the End-User's time zone </summary> </member> <member name="P:PayPal.Api.OpenIdConnect.Userinfo.locale"> <summary> End-User's locale. </summary> </member> <member name="P:PayPal.Api.OpenIdConnect.Userinfo.phone_number"> <summary> End-User's preferred telephone number </summary> </member> <member name="P:PayPal.Api.OpenIdConnect.Userinfo.address"> <summary> End-User's preferred address </summary> </member> <member name="P:PayPal.Api.OpenIdConnect.Userinfo.verified_account"> <summary> Verified account status </summary> </member> <member name="P:PayPal.Api.OpenIdConnect.Userinfo.account_type"> <summary> Account type. </summary> </member> <member name="P:PayPal.Api.OpenIdConnect.Userinfo.age_range"> <summary> Account holder age range. </summary> </member> <member name="P:PayPal.Api.OpenIdConnect.Userinfo.payer_id"> <summary> Account payer identifier. </summary> </member> <member name="M:PayPal.Api.OpenIdConnect.Userinfo.GetUserinfo(PayPal.Api.UserinfoParameters)"> <summary> Returns user details <param name="userinfoParameters">Query parameters used for API call</param> </summary> </member> <member name="M:PayPal.Api.OpenIdConnect.Userinfo.GetUserinfo(PayPal.Api.APIContext,PayPal.Api.UserinfoParameters)"> <summary> Returns user details <param name="apiContext">APIContext to be used for the call.</param> <param name="userinfoParameters">Query parameters used for API call</param> </summary> </member> <member name="T:PayPal.Api.ClientCredentials"> <summary> REST application client credentials. </summary> </member> <member name="F:PayPal.Api.ClientCredentials.clientId"> <summary> Client ID </summary> </member> <member name="F:PayPal.Api.ClientCredentials.clientSecret"> <summary> Client Secret </summary> </member> <member name="M:PayPal.Api.ClientCredentials.setClientId(System.String)"> <summary> Set the Client ID </summary> <param name="clientId"></param> </member> <member name="M:PayPal.Api.ClientCredentials.setClientSecret(System.String)"> <summary> Set the Client Secret </summary> <param name="clientSecret"></param> </member> <member name="M:PayPal.Api.ClientCredentials.getClientId"> <summary> Returns the Client ID </summary> <returns></returns> </member> <member name="M:PayPal.Api.ClientCredentials.getClientSecret"> <summary> Returns the Client Secret </summary> <returns></returns> </member> <member name="T:PayPal.Api.CreateFromAuthorizationCodeParameters"> <summary> Parameters for getting an access token using a authorization code. </summary> </member> <member name="P:PayPal.Api.CreateFromAuthorizationCodeParameters.ContainerMap"> <summary> Backing map </summary> </member> <member name="M:PayPal.Api.CreateFromAuthorizationCodeParameters.#ctor"> <summary> Initializes a new <seealso cref="T:PayPal.Api.CreateFromAuthorizationCodeParameters"/> object and sets the grant type to 'authorization_code'. </summary> </member> <member name="M:PayPal.Api.CreateFromAuthorizationCodeParameters.SetCode(System.String)"> <summary> Set the code </summary> <param name="code"></param> </member> <member name="M:PayPal.Api.CreateFromAuthorizationCodeParameters.SetRedirectUri(System.String)"> <summary> Set the Redirect URI </summary> <param name="redirectUri"></param> </member> <member name="M:PayPal.Api.CreateFromAuthorizationCodeParameters.SetGrantType(System.String)"> <summary> Set the Grant Type </summary> <param name="grantType"></param> </member> <member name="T:PayPal.Api.CreateFromRefreshTokenParameters"> <summary> Parameters for getting an access token using a refresh token. </summary> </member> <member name="M:PayPal.Api.CreateFromRefreshTokenParameters.#ctor"> <summary> Initializes a new <seealso cref="T:PayPal.Api.CreateFromRefreshTokenParameters"/> object and sets the grant type to 'refresh_token'. </summary> </member> <member name="P:PayPal.Api.CreateFromRefreshTokenParameters.ContainerMap"> <summary> Backing map </summary> </member> <member name="M:PayPal.Api.CreateFromRefreshTokenParameters.SetScope(System.String)"> <summary> Set the scope </summary> <param name="scope"></param> </member> <member name="M:PayPal.Api.CreateFromRefreshTokenParameters.SetGrantType(System.String)"> <summary> Set the Grant Type </summary> <param name="grantType"></param> </member> <member name="M:PayPal.Api.CreateFromRefreshTokenParameters.SetRefreshToken(System.String)"> <summary> Set the Refresh Token </summary> <param name="refreshToken"></param> </member> <member name="T:PayPal.Api.Tokeninfo"> <summary> Class that stores OpenIdConnect access token information. </summary> </member> <member name="P:PayPal.Api.Tokeninfo.scope"> <summary> OPTIONAL, if identical to the scope requested by the client otherwise, REQUIRED </summary> </member> <member name="P:PayPal.Api.Tokeninfo.access_token"> <summary> The access token issued by the authorization server </summary> </member> <member name="P:PayPal.Api.Tokeninfo.refresh_token"> <summary> The refresh token, which can be used to obtain new access tokens using the same authorization grant as described in OAuth2.0 RFC6749 in Section 6 </summary> </member> <member name="P:PayPal.Api.Tokeninfo.token_type"> <summary> The type of the token issued as described in OAuth2.0 RFC6749 (Section 7.1), value is case insensitive </summary> </member> <member name="P:PayPal.Api.Tokeninfo.expires_in"> <summary> The lifetime in seconds of the access token </summary> </member> <member name="M:PayPal.Api.Tokeninfo.#ctor"> <summary> Explicit default constructor </summary> </member> <member name="M:PayPal.Api.Tokeninfo.#ctor(System.String,System.String,System.Int32)"> <summary> Constructor overload </summary> </member> <member name="M:PayPal.Api.Tokeninfo.CreateFromAuthorizationCode(PayPal.Api.CreateFromAuthorizationCodeParameters)"> <summary> Creates an Access Token from an Authorization Code. <param name="createFromAuthorizationCodeParameters">Query parameters used for API call</param> </summary> </member> <member name="M:PayPal.Api.Tokeninfo.CreateFromAuthorizationCode(PayPal.Api.APIContext,PayPal.Api.CreateFromAuthorizationCodeParameters)"> <summary> Creates an Access Token from an Authorization Code. <param name="apiContext">APIContext to be used for the call.</param> <param name="createFromAuthorizationCodeParameters">Query parameters used for API call</param> </summary> </member> <member name="M:PayPal.Api.Tokeninfo.CreateFromAuthorizationCodeForFuturePayments(PayPal.Api.APIContext,PayPal.Api.CreateFromAuthorizationCodeParameters)"> <summary> Creates Access and Refresh Tokens from an Authorization Code for future payments. </summary> <param name="apiContext">APIContext to be used for the call.</param> <param name="createFromAuthorizationCodeParameters">Query parameters used for the API call.</param> <returns>A TokenInfo object containing the Access and Refresh Tokens.</returns> </member> <member name="M:PayPal.Api.Tokeninfo.CreateFromAuthorizationCodeParameters(PayPal.Api.APIContext,PayPal.Api.CreateFromAuthorizationCodeParameters,System.String)"> <summary> Helper method for creating Access and Refresh Tokens from an Authorization Code. </summary> <param name="apiContext">APIContext to be used for the call.</param> <param name="createFromAuthorizationCodeParameters">Query parameters used for the API call.</param> <param name="resourcePath">The path to the REST API resource that will be requested.</param> <returns>A TokenInfo object containing the Access and Refresh Tokens.</returns> </member> <member name="M:PayPal.Api.Tokeninfo.CreateFromRefreshToken(PayPal.Api.CreateFromRefreshTokenParameters)"> <summary> Creates an Access Token from an Refresh Token. <param name="createFromRefreshTokenParameters">Query parameters used for API call</param> </summary> </member> <member name="M:PayPal.Api.Tokeninfo.CreateFromRefreshToken(PayPal.Api.APIContext,PayPal.Api.CreateFromRefreshTokenParameters)"> <summary> Creates an Access Token from an Refresh Token <param name="apiContext">APIContext to be used for the call</param> <param name="createFromRefreshTokenParameters">Query parameters used for API call</param> </summary> </member> <member name="T:PayPal.Api.UserinfoParameters"> <summary> Class for storing user information for OpenIdConnect API calls. </summary> </member> <member name="F:PayPal.Api.UserinfoParameters.Schema"> <summary> Schema used in query parameters </summary> </member> <member name="F:PayPal.Api.UserinfoParameters.AccessToken"> <summary> Access Token used in query parameters </summary> </member> <member name="M:PayPal.Api.UserinfoParameters.#ctor"> <summary> Constructor </summary> </member> <member name="P:PayPal.Api.UserinfoParameters.ContainerMap"> <summary> Gets and sets the backing map </summary> </member> <member name="M:PayPal.Api.UserinfoParameters.SetAccessToken(System.String)"> <summary> Set the Access Token </summary> <param name="accessToken"></param> </member> <member name="T:PayPal.Api.SDKVersion"> <summary> Class for inspecting the ID and version of this SDK. </summary> </member> <member name="M:PayPal.Api.SDKVersion.GetSDKId"> <summary> SDK ID used in User-Agent HTTP header </summary> <returns>SDK ID</returns> </member> <member name="M:PayPal.Api.SDKVersion.GetSDKVersion"> <summary> SDK Version used in User-Agent HTTP header </summary> <returns>SDK Version</returns> </member> <member name="T:PayPal.Api.UserAgentHeader"> <summary> PayPal User-Agent Header implementation class </summary> </member> <member name="M:PayPal.Api.UserAgentHeader.GetHeader"> <summary> Returns a PayPal specific User-Agent HTTP Header </summary> <returns>Dictionary containing User-Agent HTTP Header</returns> </member> <member name="M:PayPal.Api.UserAgentHeader.GetUserAgentHeader"> <summary> Creates the signature for the UserAgent header. </summary> <returns>A string containing the signature for the UserAgent header.</returns> </member> <member name="M:PayPal.Api.UserAgentHeader.FormatUserAgentParameter(System.String,System.Object)"> <summary> Formats a parameter name and value to be used in the signature of a UserAgent header. </summary> <param name="name">The name of the parameter.</param> <param name="value">The value of the parameter.</param> <returns>A formatted string containing both the parameter name and value.</returns> </member> <member name="M:PayPal.Api.UserAgentHeader.Is64Bit"> <summary> Returns whether or not the operating system is 64-bit. </summary> <returns>True = 64-bit, False = 32-bit</returns> </member> <member name="P:PayPal.Api.UserAgentHeader.OperatingSystemBitness"> <summary> Gets the bitness of the operating system. </summary> </member> <member name="P:PayPal.Api.UserAgentHeader.OperatingSystemName"> <summary> Gets the name of the operating system. </summary> </member> <member name="P:PayPal.Api.UserAgentHeader.DotNetClrVersion"> <summary> Gets the version of the current .NET common language runtime environment. </summary> </member> <member name="P:PayPal.Api.UserAgentHeader.DotNetVersion"> <summary> Gets the version of the current .NET environment. </summary> </member> <member name="T:PayPal.AlgorithmNotSupportedException"> <summary> Represents an error that occurred in the PayPal SDK when a hash or security algorithm is not supported. </summary> </member> <member name="M:PayPal.AlgorithmNotSupportedException.#ctor(System.String)"> <summary> Represents errors where a hash or security algorithm is not supported. </summary> <param name="message">The message that describes the error</param> </member> <member name="P:PayPal.AlgorithmNotSupportedException.ExceptionMessagePrefix"> <summary> Gets the prefix to use when logging the exception information. </summary> </member> <member name="T:PayPal.ConfigException"> <summary> Represents an error that occurred in the PayPal SDK when attempting to load information from the application's config file. </summary> </member> <member name="M:PayPal.ConfigException.#ctor(System.String)"> <summary> Represents errors that are related to the application's configuration. </summary> <param name="message">The message that describes the error</param> </member> <member name="P:PayPal.ConfigException.ExceptionMessagePrefix"> <summary> Gets the prefix to use when logging the exception information. </summary> </member> <member name="T:PayPal.ConnectionException"> <summary> Represents a connection error that occurred in the PayPal SDK when attempting to make an HTTP request to the PayPal REST API. </summary> </member> <member name="P:PayPal.ConnectionException.Response"> <summary> Gets the response payload for non-200 response </summary> </member> <member name="P:PayPal.ConnectionException.WebExceptionStatus"> <summary> Gets the <see cref="T:System.Net.WebExceptionStatus"/> returned from a failed HTTP request. </summary> </member> <member name="P:PayPal.ConnectionException.Request"> <summary> Gets the <see cref="T:System.Net.HttpWebRequest"/> sent by the SDK. </summary> </member> <member name="M:PayPal.ConnectionException.#ctor(System.String,System.String,System.Net.WebExceptionStatus,System.Net.HttpWebRequest)"> <summary> Represents errors that occur during application execution </summary> <param name="message">The message that describes the error</param> <param name="response">The response from server</param> <param name="status">The <see cref="T:System.Net.WebExceptionStatus"/> that triggered this exception.</param> <param name="request">HTTP request sent by this SDK.</param> </member> <member name="M:PayPal.ConnectionException.#ctor(PayPal.ConnectionException)"> <summary> Copy constructor provided by convenience for derived classes. </summary> <param name="ex">The original exception to copy information from.</param> </member> <member name="P:PayPal.ConnectionException.ExceptionMessagePrefix"> <summary> Gets the prefix to use when logging the exception information. </summary> </member> <member name="T:PayPal.HttpException"> <summary> Represents an error that occurred in the PayPal SDK after sending an HTTP request to the PayPal REST API. </summary> </member> <member name="P:PayPal.HttpException.StatusCode"> <summary> Gets the <see cref="T:System.Net.HttpStatusCode"/> returned from the server. </summary> </member> <member name="P:PayPal.HttpException.Headers"> <summary> Gets the <see cref="T:System.Net.WebHeaderCollection"/> included with the HTTP response. </summary> </member> <member name="M:PayPal.HttpException.#ctor(System.String,System.String,System.Net.HttpStatusCode,System.Net.WebExceptionStatus,System.Net.WebHeaderCollection,System.Net.HttpWebRequest)"> <summary> Represents an error occurred when attempting to send an HTTP request. </summary> <param name="message">The message that describes the error.</param> <param name="response">The response from server.</param> <param name="statusCode">HTTP status code</param> <param name="webExceptionStatus">HTTP status code returned from the server.</param> <param name="headers">HTTP headers included with the server response.</param> <param name="request">HTTP request sent by this SDK.</param> </member> <member name="M:PayPal.HttpException.#ctor(PayPal.HttpException)"> <summary> Copy constructor provided by convenience for derived classes. </summary> <param name="ex">The original exception to copy information from.</param> </member> <member name="M:PayPal.HttpException.TryConvertTo``1(``0@)"> <summary> Attempts to convert this exception object to another specified exception type. </summary> <typeparam name="T">Object type that must derive from HttpException.</typeparam> <param name="other">Variable that will contain the newly created instance of the derviced class.</param> <returns>True if the object was successfully created; false otherwise.</returns> </member> <member name="P:PayPal.HttpException.ExceptionMessagePrefix"> <summary> Gets the prefix to use when logging the exception information. </summary> </member> <member name="M:PayPal.HttpException.LogDefaultMessage(System.String)"> <summary> Override of the default log message. </summary> <param name="message">The message to be logged.</param> </member> <member name="T:PayPal.IdentityError"> <summary> Represents a JSON error object returned from requests made to the Identity API. More information: https://developer.paypal.com/webapps/developer/docs/api/#common-identity-objects </summary> </member> <member name="P:PayPal.IdentityError.error"> <summary> Gets or sets an ASCII error code. See above link for full list of potential error codes. </summary> </member> <member name="P:PayPal.IdentityError.error_description"> <summary> Gets or sets the details concerning this error. </summary> </member> <member name="P:PayPal.IdentityError.error_uri"> <summary> Gets or sets a URI identifying a human-readable web page with information about the error. This is used to provide the client developer with additional information about the error. </summary> </member> <member name="T:PayPal.IdentityException"> <summary> Represents Identity API errors related to logging into PayPal securely using PayPal login credentials. <para> More Information: https://developer.paypal.com/webapps/developer/docs/api/#identity </para> </summary> </member> <member name="P:PayPal.IdentityException.Details"> <summary> Gets a <see cref="T:PayPal.IdentityError"/> JSON object containing the parsed details of the Identity error. </summary> </member> <member name="M:PayPal.IdentityException.#ctor(PayPal.HttpException)"> <summary> Copy constructor that attempts to deserialize the response from the specified <seealso name="HttpException"/>. </summary> <param name="ex">Originating <see cref="T:PayPal.HttpException"/> object that contains the details of the exception.</param> </member> <member name="P:PayPal.IdentityException.ExceptionMessagePrefix"> <summary> Gets the prefix to use when logging the exception information. </summary> </member> <member name="T:PayPal.InvalidCredentialException"> <summary> Represents an error that occurred in the PayPal SDK when application credentials are in an invalid state. </summary> </member> <member name="M:PayPal.InvalidCredentialException.#ctor(System.String)"> <summary> Represents errors where certain credential information is invalid. </summary> <param name="message">The message that describes the error</param> </member> <member name="P:PayPal.InvalidCredentialException.ExceptionMessagePrefix"> <summary> Gets the prefix to use when logging the exception information. </summary> </member> <member name="T:PayPal.MissingCredentialException"> <summary> Represents an error that occurred in the PayPal SDK when application credentials are required. </summary> </member> <member name="M:PayPal.MissingCredentialException.#ctor(System.String)"> <summary> Represents errors where certain credential information is required but missing. </summary> <param name="message">The message that describes the error</param> </member> <member name="P:PayPal.MissingCredentialException.ExceptionMessagePrefix"> <summary> Gets the prefix to use when logging the exception information. </summary> </member> <member name="T:PayPal.OAuthException"> <summary> Represents an error that occurred when requesting an OAuth token. </summary> </member> <member name="M:PayPal.OAuthException.#ctor(System.String)"> <summary> Represents an exception related to requesting an OAuth token. </summary> <param name="message">The message associated with the exception.</param> </member> <member name="M:PayPal.OAuthException.#ctor(System.String,System.Exception)"> <summary> Represents an exception related to requesting an OAuth token. </summary> <param name="message">The message associated with the exception.</param> <param name="exception">More exception information that should be included with this exception.</param> </member> <member name="P:PayPal.OAuthException.OAuthExceptionShortMessage"> <summary> Gets the OAuth exception short message </summary> </member> <member name="P:PayPal.OAuthException.OAuthExceptionLongMessage"> <summary> Gets the OAuth exception long message </summary> </member> <member name="P:PayPal.OAuthException.ExceptionMessagePrefix"> <summary> Gets the prefix to use when logging the exception information. </summary> </member> <member name="T:PayPal.PayPalException"> <summary> Represents an error that occurred in the PayPal SDK. </summary> </member> <member name="F:PayPal.PayPalException.logger"> <summary> Logs output statements, errors, debug info to a text file </summary> </member> <member name="M:PayPal.PayPalException.#ctor"> <summary> Initializes a new <seealso cref="T:PayPal.PayPalException"/> with no exception details set. </summary> </member> <member name="M:PayPal.PayPalException.#ctor(System.String)"> <summary> Represents errors that occur during application execution </summary> <param name="message">The message that describes the error</param> </member> <member name="M:PayPal.PayPalException.#ctor(System.String,System.Exception)"> <summary> Initializes a new <seealso cref="T:PayPal.PayPalException"/> and sets the exception message and cause. </summary> <param name="message">The message that describes the error</param> <param name="cause">The exception that is the cause of the current exception</param> </member> <member name="M:PayPal.PayPalException.#ctor(PayPal.PayPalException)"> <summary> Copy constructor provided by convenience for derived classes. </summary> <param name="ex">The original exception to copy information from.</param> </member> <member name="P:PayPal.PayPalException.ExceptionMessagePrefix"> <summary> Optional prefix that will be prepended to the error written to the log. This allows for exceptions to be distinguishable in the log by their type while preserving the exception heirarchy. </summary> </member> <member name="M:PayPal.PayPalException.LogMessage(System.String)"> <summary> Helper method that logs a message related to this exception to the logfile. </summary> <param name="message">The exception message to be logged.</param> </member> <member name="M:PayPal.PayPalException.LogMessage(System.String,System.Exception)"> <summary> Helper method that logs a message related to this exception to the logfile. </summary> <param name="message">The exception message to be logged.</param> <param name="ex">Optional System.Exception object to include in the log message.</param> </member> <member name="M:PayPal.PayPalException.LogDefaultMessage(System.String)"> <summary> Helper method for logging a message when this object is created. Derived classes can override this to log more specific exception information without cluttering up the logfile. </summary> <param name="message">The message to be logged.</param> </member> <member name="T:PayPal.PaymentsException"> <summary> Represents an error that occurred when making a call to PayPal's REST API. </summary> </member> <member name="P:PayPal.PaymentsException.Details"> <summary> Gets a <see cref="T:PayPal.Api.Error"/> JSON object containing the parsed details of the Payments error. </summary> </member> <member name="M:PayPal.PaymentsException.#ctor(PayPal.HttpException)"> <summary> Copy constructor that attempts to deserialize the response from the specified <seealso name="HttpException"/>. </summary> <param name="ex">Originating <see cref="T:PayPal.HttpException"/> object that contains the details of the exception.</param> </member> <member name="P:PayPal.PaymentsException.ExceptionMessagePrefix"> <summary> Gets the prefix to use when logging the exception information. </summary> </member> <member name="T:PayPal.Log.BaseLogger"> <summary> Abstract base for the loggers </summary> </member> <member name="P:PayPal.Log.BaseLogger.GivenType"> <summary> Gets the given type associated with this logger. </summary> </member> <member name="P:PayPal.Log.BaseLogger.IsEnabled"> <summary> Get or sets whether this logger is enabled. </summary> </member> <member name="M:PayPal.Log.BaseLogger.#ctor(System.Type)"> <summary> Initializes a new instance of this logger and associates it with the specified object type. </summary> <param name="typeGiven">The type to associate with this logger.</param> </member> <member name="P:PayPal.Log.BaseLogger.IsDebugEnabled"> <summary> Gets whether or not debug logging is enabled. </summary> </member> <member name="P:PayPal.Log.BaseLogger.IsErrorEnabled"> <summary> Gets whether or not error logging is enabled. </summary> </member> <member name="P:PayPal.Log.BaseLogger.IsInfoEnabled"> <summary> Gets whether or not informational logging is enabled. </summary> </member> <member name="P:PayPal.Log.BaseLogger.IsWarnEnabled"> <summary> Gets whether or not logging for warnings is enabled. </summary> </member> <member name="M:PayPal.Log.BaseLogger.Debug(System.String)"> <summary> Records a debug message to the log. </summary> <param name="message">The message to be logged.</param> </member> <member name="M:PayPal.Log.BaseLogger.Debug(System.String,System.Exception)"> <summary> Records a debug message, including any exception details, to the log. </summary> <param name="message">The message to be logged.</param> <param name="exception">Exception details to be logged.</param> </member> <member name="M:PayPal.Log.BaseLogger.DebugFormat(System.String,System.Object[])"> <summary> Records a formatted debug message to the log. </summary> <param name="format">A composite format string to be logged.</param> <param name="args">An array that contains zero or more objects to format.</param> </member> <member name="M:PayPal.Log.BaseLogger.Error(System.String)"> <summary> Records an error message to the log. </summary> <param name="message">The message to be logged.</param> </member> <member name="M:PayPal.Log.BaseLogger.Error(System.String,System.Exception)"> <summary> Records an error message, including any exception details, to the log. </summary> <param name="message">The message to be logged.</param> <param name="exception">Exception details to be logged.</param> </member> <member name="M:PayPal.Log.BaseLogger.ErrorFormat(System.String,System.Object[])"> <summary> Records a formatted error message to the log. </summary> <param name="format">A composite format string to be logged.</param> <param name="args">An array that contains zero or more objects to format.</param> </member> <member name="M:PayPal.Log.BaseLogger.Info(System.String)"> <summary> Records an informational message to the log. </summary> <param name="message">The message to be logged.</param> </member> <member name="M:PayPal.Log.BaseLogger.Info(System.String,System.Exception)"> <summary> Records an informational message, including any exception details, to the log. </summary> <param name="message">The message to be logged.</param> <param name="exception">Exception details to be logged.</param> </member> <member name="M:PayPal.Log.BaseLogger.InfoFormat(System.String,System.Object[])"> <summary> Records a formatted informational message to the log. </summary> <param name="format">A composite format string to be logged.</param> <param name="args">An array that contains zero or more objects to format.</param> </member> <member name="M:PayPal.Log.BaseLogger.Warn(System.String)"> <summary> Records a warning message to the log. </summary> <param name="message">The message to be logged.</param> </member> <member name="M:PayPal.Log.BaseLogger.Warn(System.String,System.Exception)"> <summary> Records a warning message, including any exception details, to the log. </summary> <param name="message">The message to be logged.</param> <param name="exception">Exception details to be logged.</param> </member> <member name="M:PayPal.Log.BaseLogger.WarnFormat(System.String,System.Object[])"> <summary> Records a formatted warning message to the log. </summary> <param name="format">A composite format string to be logged.</param> <param name="args">An array that contains zero or more objects to format.</param> </member> <member name="M:PayPal.Log.BaseLogger.Flush"> <summary> Flushes any resources or streams used by this logger. </summary> </member> <member name="T:PayPal.Log.DiagnosticsLogger"> <summary> System.Diagnostics wrapper </summary> </member> <member name="M:PayPal.Log.DiagnosticsLogger.#ctor(System.Type)"> <summary> Initializes a new instance of the <seealso cref="T:PayPal.Log.DiagnosticsLogger"/> class. </summary> <param name="givenType">The type associated with this logger.</param> </member> <member name="P:PayPal.Log.DiagnosticsLogger.IsDebugEnabled"> <summary> Gets whether or not debug logging is enabled. </summary> </member> <member name="P:PayPal.Log.DiagnosticsLogger.IsErrorEnabled"> <summary> Gets whether or not error logging is enabled. </summary> </member> <member name="P:PayPal.Log.DiagnosticsLogger.IsInfoEnabled"> <summary> Gets whether or not informational logging is enabled. </summary> </member> <member name="P:PayPal.Log.DiagnosticsLogger.IsWarnEnabled"> <summary> Gets whether or not logging for warnings is enabled. </summary> </member> <member name="M:PayPal.Log.DiagnosticsLogger.Debug(System.String)"> <summary> Override the wrapper for System.Diagnostics TraceEventType.Verbose </summary> <param name="message"></param> </member> <member name="M:PayPal.Log.DiagnosticsLogger.Debug(System.String,System.Exception)"> <summary> Override the wrapper for System.Diagnostics TraceEventType.Verbose </summary> <param name="message"></param> <param name="exception"></param> </member> <member name="M:PayPal.Log.DiagnosticsLogger.DebugFormat(System.String,System.Object[])"> <summary> Override the wrapper for System.Diagnostics TraceEventType.Verbose overload </summary> <param name="format"></param> <param name="args"></param> </member> <member name="M:PayPal.Log.DiagnosticsLogger.Error(System.String)"> <summary> Override the wrapper for System.Diagnostics TraceEventType.Error </summary> <param name="message"></param> </member> <member name="M:PayPal.Log.DiagnosticsLogger.Error(System.String,System.Exception)"> <summary> Override the wrapper for System.Diagnostics TraceEventType.Error </summary> <param name="message"></param> <param name="exception"></param> </member> <member name="M:PayPal.Log.DiagnosticsLogger.ErrorFormat(System.String,System.Object[])"> <summary> Override the wrapper for System.Diagnostics TraceEventType.Error overload </summary> <param name="format"></param> <param name="args"></param> </member> <member name="M:PayPal.Log.DiagnosticsLogger.Info(System.String)"> <summary> Override the wrapper for System.Diagnostics TraceEventType.Information </summary> <param name="message"></param> </member> <member name="M:PayPal.Log.DiagnosticsLogger.Info(System.String,System.Exception)"> <summary> Override the wrapper for System.Diagnostics TraceEventType.Information </summary> <param name="message"></param> <param name="exception"></param> </member> <member name="M:PayPal.Log.DiagnosticsLogger.InfoFormat(System.String,System.Object[])"> <summary> Override the wrapper for System.Diagnostics TraceEventType.Information overload </summary> <param name="format"></param> <param name="args"></param> </member> <member name="M:PayPal.Log.DiagnosticsLogger.Warn(System.String)"> <summary> Override the wrapper for System.Diagnostics TraceEventType.Warning </summary> <param name="message"></param> </member> <member name="M:PayPal.Log.DiagnosticsLogger.Warn(System.String,System.Exception)"> <summary> Override the wrapper for System.Diagnostics TraceEventType.Warning </summary> <param name="message"></param> <param name="exception"></param> </member> <member name="M:PayPal.Log.DiagnosticsLogger.WarnFormat(System.String,System.Object[])"> <summary> Override the wrapper for System.Diagnostics TraceEventType.Warning overload </summary> <param name="format"></param> <param name="args"></param> </member> <member name="M:PayPal.Log.DiagnosticsLogger.Flush"> <summary> Override flush </summary> </member> <member name="T:PayPal.Log.Log4netLogger"> <summary> Wrapper for reflected log4net </summary> </member> <member name="M:PayPal.Log.Log4netLogger.Reflect"> <summary> Interrogate log4net </summary> </member> <member name="P:PayPal.Log.Log4netLogger.IsDebugEnabled"> <summary> Override the wrapper for log4net ILog IsDebugEnabled </summary> </member> <member name="P:PayPal.Log.Log4netLogger.IsErrorEnabled"> <summary> Override the wrapper for log4net ILog IsErrorEnabled </summary> </member> <member name="P:PayPal.Log.Log4netLogger.IsInfoEnabled"> <summary> Override the wrapper for log4net ILog IsInfoEnabled </summary> </member> <member name="P:PayPal.Log.Log4netLogger.IsWarnEnabled"> <summary> Override the wrapper for log4net ILog IsInfoEnabled </summary> </member> <member name="M:PayPal.Log.Log4netLogger.Debug(System.String)"> <summary> Override the wrapper for log4net ILog Debug </summary> <param name="message"></param> </member> <member name="M:PayPal.Log.Log4netLogger.Debug(System.String,System.Exception)"> <summary> Override the wrapper for log4net ILog Debug </summary> <param name="message"></param> <param name="exception"></param> </member> <member name="M:PayPal.Log.Log4netLogger.DebugFormat(System.String,System.Object[])"> <summary> Override the wrapper for log4net ILog DebugFormat </summary> <param name="format"></param> <param name="args"></param> </member> <member name="M:PayPal.Log.Log4netLogger.Error(System.String)"> <summary> Override the wrapper for log4net ILog Error </summary> <param name="message"></param> </member> <member name="M:PayPal.Log.Log4netLogger.Error(System.String,System.Exception)"> <summary> Override the wrapper for log4net ILog Error </summary> <param name="message"></param> <param name="exception"></param> </member> <member name="M:PayPal.Log.Log4netLogger.ErrorFormat(System.String,System.Object[])"> <summary> Override the wrapper for log4net ILog ErrorFormat </summary> <param name="format"></param> <param name="args"></param> </member> <member name="M:PayPal.Log.Log4netLogger.Info(System.String)"> <summary> Override the wrapper for log4net ILog Info </summary> <param name="message"></param> </member> <member name="M:PayPal.Log.Log4netLogger.Info(System.String,System.Exception)"> <summary> Override the wrapper for log4net ILog Info </summary> <param name="message"></param> <param name="exception"></param> </member> <member name="M:PayPal.Log.Log4netLogger.InfoFormat(System.String,System.Object[])"> <summary> Override the wrapper for log4net ILog InfoFormat </summary> <param name="format"></param> <param name="args"></param> </member> <member name="M:PayPal.Log.Log4netLogger.Warn(System.String)"> <summary> Override the wrapper for log4net ILog Warn </summary> <param name="message"></param> </member> <member name="M:PayPal.Log.Log4netLogger.Warn(System.String,System.Exception)"> <summary> Override the wrapper for log4net ILog Warn </summary> <param name="message"></param> <param name="exception"></param> </member> <member name="M:PayPal.Log.Log4netLogger.WarnFormat(System.String,System.Object[])"> <summary> Override the wrapper for log4net ILog WarnFormat </summary> <param name="format"></param> <param name="args"></param> </member> <member name="T:PayPal.Log.LogConfiguration"> <summary> Configuration for PayPalCoreSDK </summary> </member> <member name="F:PayPal.Log.LogConfiguration.PayPalLogKey"> <summary> Key for the loggers to be set in <appSettings><add key="PayPalLogger" value="PayPal.Log.DiagnosticsLogger, PayPal.Log.Log4netLogger"/></appSettings> in configuration file </summary> </member> <member name="F:PayPal.Log.LogConfiguration.PayPalLogDelimiterKey"> <summary> AppSettings configuration key that defines the delimiter to be used when specifying the list of loggers. </summary> </member> <member name="F:PayPal.Log.LogConfiguration.PayPalLogDefaultDelimiter"> <summary> Default delimiter to use for the <see cref="F:PayPal.Log.LogConfiguration.PayPalLogDelimiterKey"/> value. </summary> </member> <member name="P:PayPal.Log.LogConfiguration.LoggerListInConfiguration"> <summary> Gets the list of loggers from the config. </summary> </member> <member name="T:PayPal.Log.LogMessage"> <summary> Log message </summary> </member> <member name="P:PayPal.Log.LogMessage.Args"> <summary> Gets the arguments to be used in logging a formatted string. </summary> </member> <member name="P:PayPal.Log.LogMessage.Provider"> <summary> Gets the <seealso cref="T:System.IFormatProvider"/> that provides the formatted string. </summary> </member> <member name="P:PayPal.Log.LogMessage.Format"> <summary> Gets the string format to be used when logging. </summary> </member> <member name="M:PayPal.Log.LogMessage.#ctor(System.String)"> <summary> Constructor that logs the specified message. </summary> <param name="message"></param> </member> <member name="M:PayPal.Log.LogMessage.#ctor(System.String,System.Object[])"> <summary> Constructor that logs the specified formatted message. </summary> <param name="format"></param> <param name="args"></param> </member> <member name="M:PayPal.Log.LogMessage.#ctor(System.IFormatProvider,System.String,System.Object[])"> <summary> Constructor that logs the specified formatted message using the defined provider. </summary> <param name="provider"></param> <param name="format"></param> <param name="args"></param> </member> <member name="M:PayPal.Log.LogMessage.ToString"> <summary> Converts the stored message details into a string to be logged. </summary> <returns></returns> </member> <member name="M:PayPal.Log.Logger.Debug(System.String)"> <summary> Call loggers' Debug </summary> <param name="message"></param> </member> <member name="M:PayPal.Log.Logger.Debug(System.String,System.Exception)"> <summary> Call loggers' Debug </summary> <param name="message"></param> <param name="exception"></param> </member> <member name="M:PayPal.Log.Logger.DebugFormat(System.String,System.Object[])"> <summary> Call loggers' DebugFormat </summary> <param name="format"></param> <param name="args"></param> </member> <member name="M:PayPal.Log.Logger.Error(System.String)"> <summary> Call loggers' Error </summary> <param name="message"></param> </member> <member name="M:PayPal.Log.Logger.Error(System.String,System.Exception)"> <summary> Call loggers' Error </summary> <param name="message"></param> <param name="exception"></param> </member> <member name="M:PayPal.Log.Logger.ErrorFormat(System.String,System.Object[])"> <summary> Call loggers' ErrorFormat </summary> <param name="format"></param> <param name="args"></param> </member> <member name="M:PayPal.Log.Logger.Info(System.String)"> <summary> Call loggers' Info </summary> <param name="message"></param> </member> <member name="M:PayPal.Log.Logger.Info(System.String,System.Exception)"> <summary> Call loggers' Info </summary> <param name="message"></param> <param name="exception"></param> </member> <member name="M:PayPal.Log.Logger.InfoFormat(System.String,System.Object[])"> <summary> Call loggers' InfoFormat </summary> <param name="format"></param> <param name="args"></param> </member> <member name="M:PayPal.Log.Logger.Warn(System.String)"> <summary> Call loggers' Warn </summary> <param name="message"></param> </member> <member name="M:PayPal.Log.Logger.Warn(System.String,System.Exception)"> <summary> Call loggers' Warn </summary> <param name="message"></param> <param name="exception"></param> </member> <member name="M:PayPal.Log.Logger.WarnFormat(System.String,System.Object[])"> <summary> Call loggers' WarnFormat </summary> <param name="format"></param> <param name="args"></param> </member> <member name="M:PayPal.Log.Logger.Flush"> <summary> Flush the loggers </summary> </member> <member name="T:PayPal.Log.TraceSourceUtil"> <summary> Trace Source utility for the given Type having listener or the closest "parent" TraceRoute that has listeners </summary> </member> <member name="M:PayPal.Log.TraceSourceUtil.GetTraceSource(System.Type)"> <summary> Gets the TraceSource for the given Type having SourceLevels.All Returns null if there are no listeners configured for given Type or the closest "parent" TraceRoute that has listeners </summary> <param name="givenType"></param> <returns></returns> </member> <member name="M:PayPal.Log.TraceSourceUtil.GetTraceSource(System.Type,System.Diagnostics.SourceLevels)"> <summary> Gets the TraceSource for the given Type and SourceLevels Returns null if there are no listeners configured for given Type or the closest "parent" TraceRoute that has listeners </summary> <param name="givenType"></param> <param name="sourceLevels"></param> <returns></returns> </member> <member name="M:PayPal.Log.TraceSourceUtil.GetTraceSourceWithListeners(System.String,System.Diagnostics.SourceLevels)"> <summary> Gets the closest "parent" TraceRoute that has listeners, or null otherwise </summary> <param name="name"></param> <param name="sourceLevels"></param> <returns></returns> </member> <member name="M:PayPal.Log.TraceSourceUtil.GetTraceSourceWithListenersSyncLock(System.String,System.Diagnostics.SourceLevels)"> <summary> Gets the closest "parent" TraceRoute that has listeners, or null otherwise </summary> <param name="name"></param> <param name="sourceLevels"></param> <returns></returns> </member> <member name="T:PayPal.CertificateManager"> <summary> Manager class for storing X509 certificates. </summary> </member> <member name="F:PayPal.CertificateManager.logger"> <summary> Logger </summary> </member> <member name="F:PayPal.CertificateManager.certificates"> <summary> Cache of X509 certificates. </summary> </member> <member name="M:PayPal.CertificateManager.#ctor"> <summary> Private constructor prevent direct instantiation </summary> </member> <member name="F:PayPal.CertificateManager.instance"> <summary> Private static member for storing the single instance. </summary> </member> <member name="F:PayPal.CertificateManager.syncRoot"> <summary> Private static member for locking the singleton object while it's being instantiated. </summary> </member> <member name="P:PayPal.CertificateManager.Instance"> <summary> Gets the singleton instance for this class. </summary> </member> <member name="M:PayPal.CertificateManager.GetCertificatesFromUrl(System.String)"> <summary> Gets the certificate corresponding to the specified URL from the cache of certificates. If the cache doesn't contain the certificate, it is downloaded and verified. </summary> <param name="certUrl">The URL pointing to the certificate.</param> <returns>An <see cref="T:System.Security.Cryptography.X509Certificates.X509Certificate2"/> object containing the details of the certificate.</returns> <exception cref="T:PayPal.PayPalException">Thrown if the downloaded certificate cannot be verified.</exception> </member> <member name="M:PayPal.CertificateManager.GetTrustedCertificateFromFile(System.Collections.Generic.Dictionary{System.String,System.String})"> <summary> Gets the trusted certificate to be used in validating a certificate chain. </summary> <param name="config">Config containing an optional path to the trusted certificate file to use.</param> <returns>An <see cref="T:System.Security.Cryptography.X509Certificates.X509Certificate2"/> object containing the trusted certificate to use in validating a certificate chain.</returns> </member> <member name="M:PayPal.CertificateManager.ValidateCertificateChain(System.Security.Cryptography.X509Certificates.X509Certificate2,System.Security.Cryptography.X509Certificates.X509Certificate2Collection)"> <summary> Validates the certificate chain for the specified client certificate using a known, trusted certificate. </summary> <param name="trustedCert">Trusted certificate to use in validating the chain.</param> <param name="clientCerts">Client certificates to use in validating the chain.</param> <returns>True if the certificate chain is valid; false otherwise.</returns> </member> <member name="M:PayPal.CertificateManager.ValidatePayPalClientCertificate(System.Security.Cryptography.X509Certificates.X509Certificate2Collection)"> <summary> Validates the leaf client cert for the owner to be PayPal </summary> <param name="clientCerts"></param> <returns>True if leaf client certificate belongs to .paypal.com, false otherwise</returns> </member> <member name="T:PayPal.SDKConfigHandler"> <summary> Custom handler for SDK configuration section as defined in App.Config or Web.Config files </summary> </member> <member name="M:PayPal.SDKConfigHandler.#ctor"> <summary> Explicit default constructor </summary> </member> <member name="P:PayPal.SDKConfigHandler.Accounts"> <summary> Accounts Collection </summary> </member> <member name="P:PayPal.SDKConfigHandler.Settings"> <summary> PayPal application settings. </summary> </member> <member name="M:PayPal.SDKConfigHandler.Setting(System.String)"> <summary> Gets the setting with the specified name. If the setting is not found, returns null. </summary> <param name="name">The name of the setting to lookup.</param> <returns>The value associated with the setting name. If the name is not found, returns null.</returns> </member> <member name="T:PayPal.AccountCollection"> <summary> Account colleciton details. This is included for compatibility with the older Classic SDKs. </summary> </member> <member name="M:PayPal.AccountCollection.CreateNewElement"> <summary> Creates a new <see cref="T:PayPal.Account"/>. </summary> <returns>A new <see cref="T:PayPal.Account"/>.</returns> </member> <member name="M:PayPal.AccountCollection.GetElementKey(System.Configuration.ConfigurationElement)"> <summary> Gets the API username for the specified <seealso cref="T:System.Configuration.ConfigurationElement"/>. </summary> <param name="element">The element to be used.</param> <returns>The API user name.</returns> </member> <member name="M:PayPal.AccountCollection.Account(System.Int32)"> <summary> Gets the <see cref="T:PayPal.Account"/> at the specified index. </summary> <param name="index">Index of the <see cref="T:PayPal.Account"/>.</param> <returns>The <see cref="T:PayPal.Account"/> at the specified index.</returns> </member> <member name="M:PayPal.AccountCollection.Account(System.String)"> <summary> Gets the <see cref="T:PayPal.Account"/> for the specified value. </summary> <param name="value">The value of the <see cref="T:PayPal.Account"/>.</param> <returns>The <see cref="T:PayPal.Account"/> for the specified value.</returns> </member> <member name="P:PayPal.AccountCollection.Item(System.String)"> <summary> Index operator that looks up an <see cref="T:PayPal.Account"/> for the specified name. </summary> <param name="name"></param> <returns></returns> </member> <member name="P:PayPal.AccountCollection.Item(System.Int32)"> <summary> Index operator that looks up an <see cref="T:PayPal.Account"/> at the specified index. </summary> <param name="index"></param> <returns></returns> </member> <member name="T:PayPal.Account"> <summary> Account information </summary> </member> <member name="M:PayPal.Account.#ctor"> <summary> Default constructor that initializes all the properties for the account. </summary> </member> <member name="P:PayPal.Account.APIUserName"> <summary> API Username </summary> </member> <member name="P:PayPal.Account.APIPassword"> <summary> API password </summary> </member> <member name="P:PayPal.Account.ApplicationId"> <summary> Application Id </summary> </member> <member name="P:PayPal.Account.APISignature"> <summary> API signature </summary> </member> <member name="P:PayPal.Account.APICertificate"> <summary> Client certificate for SSL authentication </summary> </member> <member name="P:PayPal.Account.PrivateKeyPassword"> <summary> Private key password for SSL authentication </summary> </member> <member name="P:PayPal.Account.SignatureSubject"> <summary> Signature Subject </summary> </member> <member name="P:PayPal.Account.CertificateSubject"> <summary> Certificate Subject </summary> </member> <member name="T:PayPal.Util.ArgumentValidator"> <summary> Helper class that validates arguments. </summary> </member> <member name="M:PayPal.Util.ArgumentValidator.Validate(System.Object,System.String)"> <summary> Helper method for validating an argument that will be used by this API in any requests. </summary> <param name="argument">The object to be validated.</param> <param name="argumentName">The name of the argument. This will be placed in the exception message for easy reference.</param> </member> <member name="M:PayPal.Util.ArgumentValidator.ValidateAndSetupAPIContext(PayPal.Api.APIContext)"> <summary> Helper method for validating and setting up an APIContext object in preparation for it being used when sending an HTTP request. </summary> <param name="apiContext">APIContext used for API calls.</param> </member> <member name="T:PayPal.Util.Crc32"> <summary> Helper class for computing a CRC32 checksum value. </summary> </member> <member name="F:PayPal.Util.Crc32.table"> <summary> CRC32 polynomial table with 0xedb88320 seed. </summary> </member> <member name="M:PayPal.Util.Crc32.ComputeChecksum(System.String)"> <summary> Computes the CRC32 checksum value for the given text. </summary> <param name="text">The text for which the checksum will be calculated.</param> <returns>An unsigned 32-bit integer containing the checksum for the given text.</returns> </member> <member name="T:PayPal.Util.QueryParameters"> <summary> Helper class that can be converted into a URL query string. </summary> </member> <member name="M:PayPal.Util.QueryParameters.ToUrlFormattedString"> <summary> Converts the dictionary of query parameters to a URL-formatted string. Empty values are ommitted from the parameter list. </summary> <returns>A URL-formatted string containing the query parameters</returns> </member> <member name="T:PayPal.Util.SDKUtil"> <summary> Helper methods for this SDK. </summary> </member> <member name="M:PayPal.Util.SDKUtil.FormatURIPath(System.String,System.Object[])"> <summary> Formats the URI path for REST calls. </summary> <param name="pattern">URI path with placeholders that can be replaced with string's Format method</param> <param name="parameters">Parameters holding actual values for placeholders; They can be wrapper objects for specific query strings like QueryParameters, CreateFromAuthorizationCodeParameters, CreateFromRefreshTokenParameters, UserinfoParameters parameters or a simple Dictionary</param> <returns>Processed URI path, or null if pattern or parameters is null</returns> </member> <member name="M:PayPal.Util.SDKUtil.FormatURIPath(System.String,System.Collections.Generic.Dictionary{System.String,System.String})"> <summary> Formats the URI path for REST calls. Replaces any occurrences of the form {name} in pattern with the corresponding value of key name in the passed Dictionary </summary> <param name="pattern">URI pattern with named place holders</param> <param name="pathParameters">Dictionary</param> <returns>Processed URI path</returns> </member> <member name="M:PayPal.Util.SDKUtil.FormatURIPath(System.String,System.Collections.Generic.Dictionary{System.String,System.String},System.Collections.Generic.Dictionary{System.String,System.String})"> <summary> Formats the URI path for REST calls. Replaces any occurrences of the form {name} in pattern with the corresponding value of key name in the passed Dictionary. Query parameters are appended to the end of the URI path </summary> <param name="pattern">URI pattern with named place holders</param> <param name="pathParameters">Dictionary of Path parameters</param> <param name="queryParameters">Dictionary for Query parameters</param> <returns>Processed URI path</returns> </member> <member name="M:PayPal.Util.SDKUtil.RemoveNullsFromQueryString(System.String)"> <summary> Removes null entries from a given query string. </summary> <param name="formatString">A query string.</param> <returns>A query string with null entries removed.</returns> </member> <member name="M:PayPal.Util.SDKUtil.SplitParameters(System.String,System.Collections.Generic.Dictionary{System.String,System.String})"> <summary> Split the URI and form a Object array using the query string and values in the provided map. The return object array is populated only if the map contains valid value for the query name. The object array contains null values if there is no value found in the map </summary> <param name="pattern"></param> <param name="parameters"></param> <returns></returns> </member> <member name="M:PayPal.Util.SDKUtil.EscapeInvalidXmlCharsRegex(System.String)"> <summary> Escapes invalid XML characters using & escapes </summary> <param name="textContent">Text content to escape</param> <returns>Escaped XML string</returns> </member> <member name="M:PayPal.Util.SDKUtil.EscapeInvalidXmlCharsRegex(System.Nullable{System.Int32})"> <summary> Escapes invalid XML characters using & escapes </summary> <param name="intContent">Integer content to escape</param> <returns>Escaped XML string</returns> </member> <member name="M:PayPal.Util.SDKUtil.EscapeInvalidXmlCharsRegex(System.Nullable{System.Boolean})"> <summary> Escapes invalid XML characters using & escapes </summary> <param name="boolContent">Boolean content to escape</param> <returns>Escaped XML string</returns> </member> <member name="M:PayPal.Util.SDKUtil.EscapeInvalidXmlCharsRegex(System.Nullable{System.Single})"> <summary> Escapes invalid XML characters using & escapes </summary> <param name="floatContent">Float content to escape</param> <returns>Escaped XML string</returns> </member> <member name="M:PayPal.Util.SDKUtil.EscapeInvalidXmlCharsRegex(System.Nullable{System.Double})"> <summary> Escapes invalid XML characters using & escapes </summary> <param name="doubleContent">Double content to escape</param> <returns>Escaped XML string</returns> </member> <member name="M:PayPal.Util.SDKUtil.GetAssemblyVersionForType(System.Type)"> <summary> Gets the version number of the parent assembly for the specified object type. </summary> <param name="type">The object type to use in determining which assembly version should be returned.</param> <returns>A 3-digit version of the parent assembly.</returns> </member> <member name="M:PayPal.Util.SDKUtil.IsNet45OrLaterDetected"> <summary> Checks if .NET 4.5 or later is detected on the system. </summary> <returns>True if .NET 4.5 or later is detected; false otherwise.</returns> </member> <member name="M:PayPal.Util.SDKUtil.GetHighestInstalledNetVersion"> <summary> Gets the highest installed version of the .NET framework found on the system. </summary> <returns>A string containing the highest installed version of the .NET framework found on the system.</returns> </member> <member name="M:PayPal.Util.SDKUtil.GetTokenFromApprovalUrl(System.Collections.Generic.List{PayPal.Api.Links})"> <summary> Gets the resource token from an approval URL HATEOAS link, if found. </summary> <param name="links">The list of HATEOAS links objects to search.</param> <returns>A string containing the resource token associated with an approval URL.</returns> </member> </members> </doc> |