Skip navigation links
A B C D E F G H I J L M N O P Q R S T U V W 

A

AccessToken - Class in com.paypal.base.rest
 
AccessToken(String, long) - Constructor for class com.paypal.base.rest.AccessToken
 
ACCOUNT_PREFIX - Static variable in class com.paypal.base.Constants
 
addConfiguration(String, String) - Method in class com.paypal.base.rest.APIContext
Adds configuration
addConfiguration(String, String) - Method in class com.paypal.base.rest.OAuthTokenCredential
Adds configuration to list of configurations.
addConfigurations(Map<String, String>) - Method in class com.paypal.base.rest.APIContext
Adds configurations
addConfigurations(Map<String, String>) - Method in class com.paypal.base.rest.OAuthTokenCredential
Adds configurations to list of configurations.
addHeader(String, String) - Method in class com.paypal.base.rest.OAuthTokenCredential
Adds header to existing list of headers.
addHeaders(Map<String, String>) - Method in class com.paypal.base.rest.OAuthTokenCredential
Adds headers.
addHTTPHeader(String, String) - Method in class com.paypal.base.rest.APIContext
Adds HTTP Header to existing list
addHTTPHeaders(Map<String, String>) - Method in class com.paypal.base.rest.APIContext
Adds HTTP Headers to existing list
Address - Class in com.paypal.api.openidconnect
 
Address() - Constructor for class com.paypal.api.openidconnect.Address
Default Constructor
Address - Class in com.paypal.api.payments
 
Address() - Constructor for class com.paypal.api.payments.Address
 
Agreement - Class in com.paypal.api.payments
 
Agreement() - Constructor for class com.paypal.api.payments.Agreement
Default Constructor
Agreement(String, String, String, Payer, Plan) - Constructor for class com.paypal.api.payments.Agreement
Parameterized Constructor
AgreementDetails - Class in com.paypal.api.payments
 
AgreementDetails() - Constructor for class com.paypal.api.payments.AgreementDetails
Default Constructor
AgreementStateDescriptor - Class in com.paypal.api.payments
 
AgreementStateDescriptor() - Constructor for class com.paypal.api.payments.AgreementStateDescriptor
Default Constructor
AgreementStateDescriptor(Currency) - Constructor for class com.paypal.api.payments.AgreementStateDescriptor
Parameterized Constructor
AgreementTransaction - Class in com.paypal.api.payments
 
AgreementTransaction() - Constructor for class com.paypal.api.payments.AgreementTransaction
Default Constructor
AgreementTransaction(Currency, Currency, Currency) - Constructor for class com.paypal.api.payments.AgreementTransaction
Parameterized Constructor
AgreementTransactions - Class in com.paypal.api.payments
 
AgreementTransactions() - Constructor for class com.paypal.api.payments.AgreementTransactions
Default Constructor
AlternatePayment - Class in com.paypal.api.payments
 
AlternatePayment() - Constructor for class com.paypal.api.payments.AlternatePayment
Default Constructor
AlternatePayment(String) - Constructor for class com.paypal.api.payments.AlternatePayment
Parameterized Constructor
Amount - Class in com.paypal.api.payments
 
Amount() - Constructor for class com.paypal.api.payments.Amount
Default Constructor
Amount(String, String) - Constructor for class com.paypal.api.payments.Amount
Parameterized Constructor
APICallPreHandler - Interface in com.paypal.base
APICallPreHandler defines a high level abstraction for call specific operations.
APICallPreHandlerFactory - Interface in com.paypal.base
APICallPreHandlerFactory factory for returning implementations if APICallPreHandler
APIContext - Class in com.paypal.base.rest
APIContext wraps wire-level parameters for the API call.
APIContext() - Constructor for class com.paypal.base.rest.APIContext
Deprecated.
Please use APIContext.APIContext(String, String, String) instead. APIContext ideally needs more information than just accessToken to operate correctly. Now, you do not need to fetch accessToken from OAuthTokenCredential separately. Instead, just initialize APIContext with clientId, clientSecret and mode, with optional configurations, as shown below, and pass the context to paypal API methods:
 
 APIContext context = new APIContext(clientId, clientSecret, "sandbox");
 
 
APIContext(String, String, String) - Constructor for class com.paypal.base.rest.APIContext
Pass the clientID, secret and mode.
APIContext(String, String, String, Map<String, String>) - Constructor for class com.paypal.base.rest.APIContext
Pass the clientID, secret and mode along with additional configurations.
APIContext(String) - Constructor for class com.paypal.base.rest.APIContext
Deprecated.
Please use APIContext.APIContext(String, String, String) instead. APIContext ideally needs more information than just accessToken to operate correctly. Now, you do not need to fetch accessToken from OAuthTokenCredential separately. Instead, just initialize APIContext with clientId, clientSecret and mode, with optional configurations, as shown below, and pass the context to paypal API methods:
 
 APIContext context = new APIContext(clientId, clientSecret, "sandbox");
 
 
APIContext(String, String) - Constructor for class com.paypal.base.rest.APIContext
Deprecated.
Please use APIContext.APIContext(String, String, String) instead. APIContext ideally needs more information than just accessToken to operate correctly. Now, you do not need to fetch accessToken from OAuthTokenCredential separately. Instead, just initialize APIContext with clientId, clientSecret and mode, with optional configurations, as shown below, and pass the context to paypal API methods:
 
 APIContext context = new APIContext(clientId, clientSecret, "sandbox");
 
 
Authorization - Class in com.paypal.api.payments
 
Authorization() - Constructor for class com.paypal.api.payments.Authorization
Default Constructor
Authorization(Amount) - Constructor for class com.paypal.api.payments.Authorization
Parameterized Constructor
AUTHORIZATION_HEADER - Static variable in class com.paypal.base.Constants
 
authorize(String) - Method in class com.paypal.api.payments.Order
Deprecated.
Please use Order.authorize(APIContext) instead.
authorize(APIContext) - Method in class com.paypal.api.payments.Order
Authorizes an order, by ID.
availableEventTypes(String) - Static method in class com.paypal.api.payments.EventType
Deprecated.
availableEventTypes(APIContext) - Static method in class com.paypal.api.payments.EventType
Retrieves the master list of available Webhooks events-types resources for any webhook to subscribe to.

B

BAD_REQUEST - Static variable in class com.paypal.base.HttpStatusCodes
 
BankAccount - Class in com.paypal.api.payments
 
BankAccount() - Constructor for class com.paypal.api.payments.BankAccount
Default Constructor
BankAccount(String, String) - Constructor for class com.paypal.api.payments.BankAccount
Parameterized Constructor
BankToken - Class in com.paypal.api.payments
 
BankToken() - Constructor for class com.paypal.api.payments.BankToken
Default Constructor
BankToken(String, String) - Constructor for class com.paypal.api.payments.BankToken
Parameterized Constructor
Base64 - Class in com.paypal.base.codec.binary
Provides Base64 encoding and decoding as defined by RFC 2045.
Base64() - Constructor for class com.paypal.base.codec.binary.Base64
Creates a Base64 codec used for decoding (all modes) and encoding in URL-unsafe mode.
Base64(boolean) - Constructor for class com.paypal.base.codec.binary.Base64
Creates a Base64 codec used for decoding (all modes) and encoding in the given URL-safe mode.
Base64(int) - Constructor for class com.paypal.base.codec.binary.Base64
Creates a Base64 codec used for decoding (all modes) and encoding in URL-unsafe mode.
Base64(int, byte[]) - Constructor for class com.paypal.base.codec.binary.Base64
Creates a Base64 codec used for decoding (all modes) and encoding in URL-unsafe mode.
Base64(int, byte[], boolean) - Constructor for class com.paypal.base.codec.binary.Base64
Creates a Base64 codec used for decoding (all modes) and encoding in URL-unsafe mode.
BaseAddress - Class in com.paypal.api.payments
 
BaseAddress() - Constructor for class com.paypal.api.payments.BaseAddress
Default Constructor
BaseAddress(String, String) - Constructor for class com.paypal.api.payments.BaseAddress
Parameterized Constructor
BaseException - Exception in com.paypal.base.exception
BaseException for SDK
BaseException(String) - Constructor for exception com.paypal.base.exception.BaseException
 
BaseException(String, Throwable) - Constructor for exception com.paypal.base.exception.BaseException
 
BaseNCodec - Class in com.paypal.base.codec.binary
Abstract superclass for Base-N encoders and decoders.
BaseNCodec(int, int, int, int) - Constructor for class com.paypal.base.codec.binary.BaseNCodec
Note lineLength is rounded down to the nearest multiple of BaseNCodec.encodedBlockSize If chunkSeparatorLength is zero, then chunking is disabled.
billBalance(String, AgreementStateDescriptor) - Method in class com.paypal.api.payments.Agreement
billBalance(APIContext, AgreementStateDescriptor) - Method in class com.paypal.api.payments.Agreement
Bill an outstanding amount for an agreement by passing the ID of the agreement to the request URI.
Billing - Class in com.paypal.api.payments
 
Billing() - Constructor for class com.paypal.api.payments.Billing
Default Constructor
BillingAgreementToken - Class in com.paypal.api.payments
 
BillingAgreementToken() - Constructor for class com.paypal.api.payments.BillingAgreementToken
Default Constructor
BillingInfo - Class in com.paypal.api.payments
 
BillingInfo() - Constructor for class com.paypal.api.payments.BillingInfo
Default Constructor
BillingInfo(String) - Constructor for class com.paypal.api.payments.BillingInfo
Parameterized Constructor
BinaryDecoder - Interface in com.paypal.base.codec
Defines common decoding methods for byte array decoders.
BinaryEncoder - Interface in com.paypal.base.codec
Defines common encoding methods for byte array encoders.
buffer - Variable in class com.paypal.base.codec.binary.BaseNCodec
Buffer for streaming.

C

cancel(String, AgreementStateDescriptor) - Method in class com.paypal.api.payments.Agreement
cancel(APIContext, AgreementStateDescriptor) - Method in class com.paypal.api.payments.Agreement
Cancel a billing agreement by passing the ID of the agreement to the request URI.
cancel(String, CancelNotification) - Method in class com.paypal.api.payments.Invoice
Deprecated.
cancel(APIContext, CancelNotification) - Method in class com.paypal.api.payments.Invoice
Cancels an invoice, by ID.
cancel(String, String) - Static method in class com.paypal.api.payments.PayoutItem
Deprecated.
cancel(APIContext, String) - Static method in class com.paypal.api.payments.PayoutItem
Cancels the unclaimed payment using the items id passed in the request URI.
CancelNotification - Class in com.paypal.api.payments
 
CancelNotification() - Constructor for class com.paypal.api.payments.CancelNotification
Default Constructor
canEqual(Object) - Method in class com.paypal.api.payments.Address
 
canEqual(Object) - Method in class com.paypal.api.payments.Agreement
 
canEqual(Object) - Method in class com.paypal.api.payments.AgreementDetails
 
canEqual(Object) - Method in class com.paypal.api.payments.AgreementStateDescriptor
 
canEqual(Object) - Method in class com.paypal.api.payments.AgreementTransaction
 
canEqual(Object) - Method in class com.paypal.api.payments.AgreementTransactions
 
canEqual(Object) - Method in class com.paypal.api.payments.AlternatePayment
 
canEqual(Object) - Method in class com.paypal.api.payments.Amount
 
canEqual(Object) - Method in class com.paypal.api.payments.Authorization
 
canEqual(Object) - Method in class com.paypal.api.payments.BankAccount
 
canEqual(Object) - Method in class com.paypal.api.payments.BankToken
 
canEqual(Object) - Method in class com.paypal.api.payments.BaseAddress
 
canEqual(Object) - Method in class com.paypal.api.payments.Billing
 
canEqual(Object) - Method in class com.paypal.api.payments.BillingAgreementToken
 
canEqual(Object) - Method in class com.paypal.api.payments.BillingInfo
 
canEqual(Object) - Method in class com.paypal.api.payments.CancelNotification
 
canEqual(Object) - Method in class com.paypal.api.payments.Capture
 
canEqual(Object) - Method in class com.paypal.api.payments.Card3dSecureInfo
 
canEqual(Object) - Method in class com.paypal.api.payments.CarrierAccount
 
canEqual(Object) - Method in class com.paypal.api.payments.CarrierAccountToken
 
canEqual(Object) - Method in class com.paypal.api.payments.CartBase
 
canEqual(Object) - Method in class com.paypal.api.payments.ChargeModels
 
canEqual(Object) - Method in class com.paypal.api.payments.Cost
 
canEqual(Object) - Method in class com.paypal.api.payments.CountryCode
 
canEqual(Object) - Method in class com.paypal.api.payments.CreateProfileResponse
 
canEqual(Object) - Method in class com.paypal.api.payments.Credit
 
canEqual(Object) - Method in class com.paypal.api.payments.CreditCard
 
canEqual(Object) - Method in class com.paypal.api.payments.CreditCardHistory
 
canEqual(Object) - Method in class com.paypal.api.payments.CreditCardToken
 
canEqual(Object) - Method in class com.paypal.api.payments.CreditFinancingOffered
 
canEqual(Object) - Method in class com.paypal.api.payments.Currency
 
canEqual(Object) - Method in class com.paypal.api.payments.CurrencyConversion
 
canEqual(Object) - Method in class com.paypal.api.payments.CustomAmount
 
canEqual(Object) - Method in class com.paypal.api.payments.DefinitionsLinkdescription
 
canEqual(Object) - Method in class com.paypal.api.payments.DetailedRefund
 
canEqual(Object) - Method in class com.paypal.api.payments.Details
 
canEqual(Object) - Method in class com.paypal.api.payments.Error
 
canEqual(Object) - Method in class com.paypal.api.payments.ErrorDetails
 
canEqual(Object) - Method in class com.paypal.api.payments.Event
 
canEqual(Object) - Method in class com.paypal.api.payments.EventList
 
canEqual(Object) - Method in class com.paypal.api.payments.EventType
 
canEqual(Object) - Method in class com.paypal.api.payments.EventTypeList
 
canEqual(Object) - Method in class com.paypal.api.payments.ExtendedBankAccount
 
canEqual(Object) - Method in class com.paypal.api.payments.ExternalFunding
 
canEqual(Object) - Method in class com.paypal.api.payments.FileAttachment
 
canEqual(Object) - Method in class com.paypal.api.payments.FlowConfig
 
canEqual(Object) - Method in class com.paypal.api.payments.FmfDetails
 
canEqual(Object) - Method in class com.paypal.api.payments.FundingDetail
 
canEqual(Object) - Method in class com.paypal.api.payments.FundingInstrument
 
canEqual(Object) - Method in class com.paypal.api.payments.FundingOption
 
canEqual(Object) - Method in class com.paypal.api.payments.FundingSource
 
canEqual(Object) - Method in class com.paypal.api.payments.FuturePayment
 
canEqual(Object) - Method in class com.paypal.api.payments.HyperSchema
 
canEqual(Object) - Method in class com.paypal.api.payments.Image
 
canEqual(Object) - Method in class com.paypal.api.payments.Incentive
 
canEqual(Object) - Method in class com.paypal.api.payments.InputFields
 
canEqual(Object) - Method in class com.paypal.api.payments.InstallmentInfo
 
canEqual(Object) - Method in class com.paypal.api.payments.InstallmentOption
 
canEqual(Object) - Method in class com.paypal.api.payments.Invoice
 
canEqual(Object) - Method in class com.paypal.api.payments.InvoiceAddress
 
canEqual(Object) - Method in class com.paypal.api.payments.InvoiceItem
 
canEqual(Object) - Method in class com.paypal.api.payments.InvoiceNumber
 
canEqual(Object) - Method in class com.paypal.api.payments.Invoices
 
canEqual(Object) - Method in class com.paypal.api.payments.InvoicingMetaData
 
canEqual(Object) - Method in class com.paypal.api.payments.InvoicingNotification
 
canEqual(Object) - Method in class com.paypal.api.payments.InvoicingPaymentDetail
 
canEqual(Object) - Method in class com.paypal.api.payments.InvoicingRefundDetail
 
canEqual(Object) - Method in class com.paypal.api.payments.InvoicingSearch
 
canEqual(Object) - Method in class com.paypal.api.payments.Item
 
canEqual(Object) - Method in class com.paypal.api.payments.ItemList
 
canEqual(Object) - Method in class com.paypal.api.payments.Links
 
canEqual(Object) - Method in class com.paypal.api.payments.Measurement
 
canEqual(Object) - Method in class com.paypal.api.payments.MerchantInfo
 
canEqual(Object) - Method in class com.paypal.api.payments.MerchantPreferences
 
canEqual(Object) - Method in class com.paypal.api.payments.Metadata
 
canEqual(Object) - Method in class com.paypal.api.payments.NameValuePair
 
canEqual(Object) - Method in class com.paypal.api.payments.Notification
 
canEqual(Object) - Method in class com.paypal.api.payments.Order
 
canEqual(Object) - Method in class com.paypal.api.payments.OverrideChargeModel
 
canEqual(Object) - Method in class com.paypal.api.payments.Participant
 
canEqual(Object) - Method in class com.paypal.api.payments.Patch
 
canEqual(Object) - Method in class com.paypal.api.payments.PatchRequest
 
canEqual(Object) - Method in class com.paypal.api.payments.Payee
 
canEqual(Object) - Method in class com.paypal.api.payments.Payer
 
canEqual(Object) - Method in class com.paypal.api.payments.PayerInfo
 
canEqual(Object) - Method in class com.paypal.api.payments.PayerNotification
 
canEqual(Object) - Method in class com.paypal.api.payments.Payment
 
canEqual(Object) - Method in class com.paypal.api.payments.PaymentCard
 
canEqual(Object) - Method in class com.paypal.api.payments.PaymentCardToken
 
canEqual(Object) - Method in class com.paypal.api.payments.PaymentDefinition
 
canEqual(Object) - Method in class com.paypal.api.payments.PaymentDetail
 
canEqual(Object) - Method in class com.paypal.api.payments.PaymentExecution
 
canEqual(Object) - Method in class com.paypal.api.payments.PaymentHistory
 
canEqual(Object) - Method in class com.paypal.api.payments.PaymentInstruction
 
canEqual(Object) - Method in class com.paypal.api.payments.PaymentOptions
 
canEqual(Object) - Method in class com.paypal.api.payments.PaymentSummary
 
canEqual(Object) - Method in class com.paypal.api.payments.PaymentTerm
 
canEqual(Object) - Method in class com.paypal.api.payments.Payout
 
canEqual(Object) - Method in class com.paypal.api.payments.PayoutBatch
 
canEqual(Object) - Method in class com.paypal.api.payments.PayoutBatchHeader
 
canEqual(Object) - Method in class com.paypal.api.payments.PayoutItem
 
canEqual(Object) - Method in class com.paypal.api.payments.PayoutItemDetails
 
canEqual(Object) - Method in class com.paypal.api.payments.PayoutSenderBatchHeader
 
canEqual(Object) - Method in class com.paypal.api.payments.Percentage
 
canEqual(Object) - Method in class com.paypal.api.payments.Phone
 
canEqual(Object) - Method in class com.paypal.api.payments.Plan
 
canEqual(Object) - Method in class com.paypal.api.payments.PlanList
 
canEqual(Object) - Method in class com.paypal.api.payments.PotentialPayerInfo
 
canEqual(Object) - Method in class com.paypal.api.payments.Presentation
 
canEqual(Object) - Method in class com.paypal.api.payments.PrivateLabelCard
 
canEqual(Object) - Method in class com.paypal.api.payments.ProcessorResponse
 
canEqual(Object) - Method in class com.paypal.api.payments.RecipientBankingInstruction
 
canEqual(Object) - Method in class com.paypal.api.payments.RedirectUrls
 
canEqual(Object) - Method in class com.paypal.api.payments.Refund
 
canEqual(Object) - Method in class com.paypal.api.payments.RefundDetail
 
canEqual(Object) - Method in class com.paypal.api.payments.RefundRequest
 
canEqual(Object) - Method in class com.paypal.api.payments.RelatedResources
 
canEqual(Object) - Method in class com.paypal.api.payments.Sale
 
canEqual(Object) - Method in class com.paypal.api.payments.Search
 
canEqual(Object) - Method in class com.paypal.api.payments.ShippingAddress
 
canEqual(Object) - Method in class com.paypal.api.payments.ShippingCost
 
canEqual(Object) - Method in class com.paypal.api.payments.ShippingInfo
 
canEqual(Object) - Method in class com.paypal.api.payments.Tax
 
canEqual(Object) - Method in class com.paypal.api.payments.Template
 
canEqual(Object) - Method in class com.paypal.api.payments.TemplateData
 
canEqual(Object) - Method in class com.paypal.api.payments.Templates
 
canEqual(Object) - Method in class com.paypal.api.payments.TemplateSettings
 
canEqual(Object) - Method in class com.paypal.api.payments.TemplateSettingsMetadata
 
canEqual(Object) - Method in class com.paypal.api.payments.Terms
 
canEqual(Object) - Method in class com.paypal.api.payments.Transaction
 
canEqual(Object) - Method in class com.paypal.api.payments.TransactionBase
 
canEqual(Object) - Method in class com.paypal.api.payments.Transactions
 
canEqual(Object) - Method in class com.paypal.api.payments.Webhook
 
canEqual(Object) - Method in class com.paypal.api.payments.WebhookList
 
canEqual(Object) - Method in class com.paypal.api.payments.WebProfile
 
canEqual(Object) - Method in class com.paypal.api.payments.WebProfileList
 
canEqual(Object) - Method in class com.paypal.base.rest.AccessToken
 
canEqual(Object) - Method in class com.paypal.base.rest.PayPalModel
 
capture(String, Capture) - Method in class com.paypal.api.payments.Authorization
Deprecated.
capture(APIContext, Capture) - Method in class com.paypal.api.payments.Authorization
Captures and processes an authorization, by ID.
Capture - Class in com.paypal.api.payments
 
Capture() - Constructor for class com.paypal.api.payments.Capture
Default Constructor
capture(String, Capture) - Method in class com.paypal.api.payments.Order
Deprecated.
capture(APIContext, Capture) - Method in class com.paypal.api.payments.Order
Captures a payment for an order, by ID.
Card3dSecureInfo - Class in com.paypal.api.payments
 
Card3dSecureInfo() - Constructor for class com.paypal.api.payments.Card3dSecureInfo
Default Constructor
CarrierAccount - Class in com.paypal.api.payments
 
CarrierAccount() - Constructor for class com.paypal.api.payments.CarrierAccount
Default Constructor
CarrierAccount(String, CountryCode) - Constructor for class com.paypal.api.payments.CarrierAccount
Parameterized Constructor
CarrierAccountToken - Class in com.paypal.api.payments
 
CarrierAccountToken() - Constructor for class com.paypal.api.payments.CarrierAccountToken
Default Constructor
CarrierAccountToken(String, String) - Constructor for class com.paypal.api.payments.CarrierAccountToken
Parameterized Constructor
CartBase - Class in com.paypal.api.payments
 
CartBase() - Constructor for class com.paypal.api.payments.CartBase
Default Constructor
CartBase(Amount) - Constructor for class com.paypal.api.payments.CartBase
Parameterized Constructor
CharEncoding - Class in com.paypal.base.codec
Character encoding names required of every implementation of the Java platform.
CharEncoding() - Constructor for class com.paypal.base.codec.CharEncoding
 
ChargeModels - Class in com.paypal.api.payments
 
ChargeModels() - Constructor for class com.paypal.api.payments.ChargeModels
Default Constructor
ChargeModels(String, Currency) - Constructor for class com.paypal.api.payments.ChargeModels
Parameterized Constructor
CLIENT_ID - Static variable in class com.paypal.base.Constants
 
CLIENT_SECRET - Static variable in class com.paypal.base.Constants
 
ClientActionRequiredException - Exception in com.paypal.base.exception
ClientActionRequiredException, encapsulates instances where client has to take actions based or errors in API call.
ClientActionRequiredException(String) - Constructor for exception com.paypal.base.exception.ClientActionRequiredException
 
ClientActionRequiredException(String, Throwable) - Constructor for exception com.paypal.base.exception.ClientActionRequiredException
 
ClientActionRequiredException(int, String, String, Throwable) - Constructor for exception com.paypal.base.exception.ClientActionRequiredException
 
ClientCredentials - Class in com.paypal.base
ClientCredentials holds Client ID and Client Secret
ClientCredentials() - Constructor for class com.paypal.base.ClientCredentials
 
com.paypal.api.openidconnect - package com.paypal.api.openidconnect
 
com.paypal.api.payments - package com.paypal.api.payments
 
com.paypal.base - package com.paypal.base
 
com.paypal.base.codec - package com.paypal.base.codec
 
com.paypal.base.codec.binary - package com.paypal.base.codec.binary
 
com.paypal.base.credential - package com.paypal.base.credential
 
com.paypal.base.exception - package com.paypal.base.exception
 
com.paypal.base.rest - package com.paypal.base.rest
 
com.paypal.base.sdk.info - package com.paypal.base.sdk.info
 
com.paypal.base.util - package com.paypal.base.util
 
combineDefaultMap(Map<String, String>) - Static method in class com.paypal.base.SDKUtil
Combines some Map with default values.
combineDefaultProperties(Properties) - Static method in class com.paypal.base.ConfigManager
Combines some Properties with Default Properties
combineMap(Map<String, String>, Map<String, String>) - Static method in class com.paypal.base.SDKUtil
 
config - Variable in class com.paypal.base.HttpConnection
Subclasses must set the http configuration in the createAndconfigureHttpConnection() method.
ConfigManager - Class in com.paypal.base
ConfigManager loads configuration from 'sdk_config.properties' file found in the classpath.
configureAndExecute(String, HttpMethod, String, String, Class<T>) - Static method in class com.paypal.base.rest.PayPalResource
Deprecated.
Please use PayPalResource.configureAndExecute(APIContext, HttpMethod, String, String, Class) instead. Passing APIContext gives us better information than just raw access token.
configureAndExecute(APIContext, HttpMethod, String, String, Class<T>) - Static method in class com.paypal.base.rest.PayPalResource
Configures and executes REST call
configureAndExecute(APIContext, HttpMethod, String, String, Class<T>, String) - Static method in class com.paypal.base.rest.PayPalResource
Configures and executes REST call: Supports JSON
configureAndExecute(APIContext, HttpMethod, String, Map<String, String>, String, Class<T>) - Static method in class com.paypal.base.rest.PayPalResource
Deprecated.
Please use PayPalResource.configureAndExecute(APIContext, HttpMethod, String, String, Class) instead. Headers could be passed directly to #APIContext itself.
configureCustomSslContext(SSLContext) - Method in class com.paypal.base.ConnectionManager
 
connection - Variable in class com.paypal.base.HttpConnection
Subclasses must create and set the connection in the createAndconfigureHttpConnection() method.
ConnectionManager - Class in com.paypal.base
ConnectionManager acts as a interface to retrieve HttpConnection objects used by API service
Constants - Class in com.paypal.base
 
constructMap(Properties) - Static method in class com.paypal.base.SDKUtil
Constructs a Map from a Properties object by combining the default values.
containsAlphabetOrPad(byte[]) - Method in class com.paypal.base.codec.binary.BaseNCodec
Tests a given byte array to see if it contains any characters within the alphabet or PAD.
Cost - Class in com.paypal.api.payments
 
Cost() - Constructor for class com.paypal.api.payments.Cost
Default Constructor
CountryCode - Class in com.paypal.api.payments
 
CountryCode() - Constructor for class com.paypal.api.payments.CountryCode
Default Constructor
CountryCode(String) - Constructor for class com.paypal.api.payments.CountryCode
Parameterized Constructor
crc32(String) - Static method in class com.paypal.base.SSLUtil
Generates a CRC 32 Value of String passed
create(String) - Method in class com.paypal.api.payments.Agreement
Deprecated.
Please use Agreement.create(APIContext) instead.
create(APIContext) - Method in class com.paypal.api.payments.Agreement
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.
create(String) - Method in class com.paypal.api.payments.CreditCard
Deprecated.
Please use CreditCard.create(APIContext) instead.
create(APIContext) - Method in class com.paypal.api.payments.CreditCard
Creates a new Credit Card Resource (aka Tokenize).
create(String, String) - Method in class com.paypal.api.payments.FuturePayment
Creates a future payment using either authorization code or refresh token with correlation ID.
create(APIContext, String) - Method in class com.paypal.api.payments.FuturePayment
Creates a future payment using either authorization code or refresh token with correlation ID.
create(String) - Method in class com.paypal.api.payments.Invoice
Deprecated.
Please use Invoice.create(APIContext) instead.
create(APIContext) - Method in class com.paypal.api.payments.Invoice
Creates an invoice.
create(String) - Method in class com.paypal.api.payments.Payment
Deprecated.
Please use Payment.create(APIContext) instead.
create(APIContext) - Method in class com.paypal.api.payments.Payment
Creates and processes a payment.
create(String, Map<String, String>) - Method in class com.paypal.api.payments.Payout
Deprecated.
Please use Payout.create(APIContext, Map) instead.
create(APIContext, Map<String, String>) - Method in class com.paypal.api.payments.Payout
Create a payout batch resource by passing a sender_batch_header and an items array to the request URI.
create(String) - Method in class com.paypal.api.payments.Plan
Deprecated.
Please use Plan.create(APIContext) instead.
create(APIContext) - Method in class com.paypal.api.payments.Plan
Create a new billing plan by passing the details for the plan, including the plan name, description, and type, to the request URI.
create(APIContext) - Method in class com.paypal.api.payments.Template
Creates a template.
create(String, Webhook) - Method in class com.paypal.api.payments.Webhook
Deprecated.
create(APIContext, Webhook) - Method in class com.paypal.api.payments.Webhook
Subscribes your webhook listener to events.
create(String) - Method in class com.paypal.api.payments.WebProfile
Deprecated.
Please use WebProfile.create(APIContext) instead.
create(APIContext) - Method in class com.paypal.api.payments.WebProfile
Creates a web experience profile.
createAndconfigureHttpConnection(HttpConfiguration) - Method in class com.paypal.base.DefaultHttpConnection
 
createAndconfigureHttpConnection(HttpConfiguration) - Method in class com.paypal.base.GoogleAppEngineHttpConnection
 
createAndconfigureHttpConnection(HttpConfiguration) - Method in class com.paypal.base.HttpConnection
create and configure HttpsURLConnection object
createAPICallPreHandler() - Method in interface com.paypal.base.APICallPreHandlerFactory
Creates an instance of APICallPreHandler
createAPICallPreHandler(Map<String, String>, String, String, Map<String, String>, String, String, SDKVersion) - Static method in class com.paypal.base.rest.PayPalResource
Returns a implementation of APICallPreHandler for the underlying layer.
createFromAuthorizationCode(CreateFromAuthorizationCodeParameters) - Static method in class com.paypal.api.openidconnect.Tokeninfo
Deprecated.
Please use Tokeninfo.createFromAuthorizationCode(APIContext, String) instead. There is no more need for passing clientId and secret in the params object anymore.
createFromAuthorizationCode(APIContext, CreateFromAuthorizationCodeParameters) - Static method in class com.paypal.api.openidconnect.Tokeninfo
Deprecated.
Please use Tokeninfo.createFromAuthorizationCode(APIContext, String) instead. There is no more need for passing clientId and secret in the params object anymore.
createFromAuthorizationCode(APIContext, String) - Static method in class com.paypal.api.openidconnect.Tokeninfo
Creates an Access Token from an Authorization Code.
createFromAuthorizationCodeForFpp(APIContext, CreateFromAuthorizationCodeParameters) - Static method in class com.paypal.api.openidconnect.Tokeninfo
Creates an Access and a Refresh Tokens from an Authorization Code for future payment.
CreateFromAuthorizationCodeParameters - Class in com.paypal.api.openidconnect
 
CreateFromAuthorizationCodeParameters() - Constructor for class com.paypal.api.openidconnect.CreateFromAuthorizationCodeParameters
 
createFromHttpErrorException(HttpErrorException) - Static method in exception com.paypal.base.rest.PayPalRESTException
Utility method that creates a PayPalRESTException object from HttpErrorException.
createFromRefreshToken(CreateFromRefreshTokenParameters) - Method in class com.paypal.api.openidconnect.Tokeninfo
Creates an Access Token from an Refresh Token.
createFromRefreshToken(APIContext, CreateFromRefreshTokenParameters) - Method in class com.paypal.api.openidconnect.Tokeninfo
Creates an Access Token from an Refresh Token.
createFromRefreshTokenForFpp(APIContext) - Method in class com.paypal.api.openidconnect.Tokeninfo
Creates an Access Token from an Refresh Token for future payment.
CreateFromRefreshTokenParameters - Class in com.paypal.api.openidconnect
 
CreateFromRefreshTokenParameters() - Constructor for class com.paypal.api.openidconnect.CreateFromRefreshTokenParameters
 
CreateProfileResponse - Class in com.paypal.api.payments
 
CreateProfileResponse() - Constructor for class com.paypal.api.payments.CreateProfileResponse
Default Constructor
createSynchronous(String) - Method in class com.paypal.api.payments.Payout
Deprecated.
createSynchronous(APIContext) - Method in class com.paypal.api.payments.Payout
You can submit a payout with a synchronous API call, which immediately returns the results of a PayPal payment.
CREDENTIAL_APPLICATIONID_SUFFIX - Static variable in class com.paypal.base.Constants
 
CREDENTIAL_CERTKEY_SUFFIX - Static variable in class com.paypal.base.Constants
 
CREDENTIAL_CERTPATH_SUFFIX - Static variable in class com.paypal.base.Constants
 
CREDENTIAL_PASSWORD_SUFFIX - Static variable in class com.paypal.base.Constants
 
CREDENTIAL_SIGNATURE_SUFFIX - Static variable in class com.paypal.base.Constants
 
CREDENTIAL_SUBJECT_SUFFIX - Static variable in class com.paypal.base.Constants
 
CREDENTIAL_USERNAME_SUFFIX - Static variable in class com.paypal.base.Constants
 
Credit - Class in com.paypal.api.payments
 
Credit() - Constructor for class com.paypal.api.payments.Credit
Default Constructor
Credit(String) - Constructor for class com.paypal.api.payments.Credit
Parameterized Constructor
CreditCard - Class in com.paypal.api.payments
 
CreditCard() - Constructor for class com.paypal.api.payments.CreditCard
Default Constructor
CreditCard(String, String, int, int) - Constructor for class com.paypal.api.payments.CreditCard
Parameterized Constructor
CreditCardHistory - Class in com.paypal.api.payments
 
CreditCardHistory() - Constructor for class com.paypal.api.payments.CreditCardHistory
Default Constructor
CreditCardToken - Class in com.paypal.api.payments
 
CreditCardToken() - Constructor for class com.paypal.api.payments.CreditCardToken
Default Constructor
CreditCardToken(String) - Constructor for class com.paypal.api.payments.CreditCardToken
Parameterized Constructor
CreditFinancingOffered - Class in com.paypal.api.payments
 
CreditFinancingOffered() - Constructor for class com.paypal.api.payments.CreditFinancingOffered
Default Constructor
CreditFinancingOffered(Currency, float, Currency, Currency, Boolean) - Constructor for class com.paypal.api.payments.CreditFinancingOffered
Parameterized Constructor
Currency - Class in com.paypal.api.payments
 
Currency() - Constructor for class com.paypal.api.payments.Currency
Default Constructor
Currency(String, String) - Constructor for class com.paypal.api.payments.Currency
Parameterized Constructor
CurrencyConversion - Class in com.paypal.api.payments
 
CurrencyConversion() - Constructor for class com.paypal.api.payments.CurrencyConversion
Default Constructor
CurrencyConversion(String, String, String, String) - Constructor for class com.paypal.api.payments.CurrencyConversion
Parameterized Constructor
currentLinePos - Variable in class com.paypal.base.codec.binary.BaseNCodec
Variable tracks how many characters have been written to the current line.
CustomAmount - Class in com.paypal.api.payments
 
CustomAmount() - Constructor for class com.paypal.api.payments.CustomAmount
Default Constructor

D

decode(Object) - Method in class com.paypal.base.codec.binary.BaseNCodec
Decodes an Object using the Base-N algorithm.
decode(String) - Method in class com.paypal.base.codec.binary.BaseNCodec
Decodes a String containing characters in the Base-N alphabet.
decode(byte[]) - Method in class com.paypal.base.codec.binary.BaseNCodec
Decodes a byte[] containing characters in the Base-N alphabet.
decode(byte[]) - Method in interface com.paypal.base.codec.BinaryDecoder
Decodes a byte array and returns the results as a byte array.
decode(Object) - Method in interface com.paypal.base.codec.Decoder
Decodes an "encoded" Object and returns a "decoded" Object.
decode(String) - Static method in class com.paypal.base.NVPUtil
Utility method used to decode the nvp response String
decodeBase64(String) - Static method in class com.paypal.base.codec.binary.Base64
Decodes a Base64 String into octets
decodeBase64(byte[]) - Static method in class com.paypal.base.codec.binary.Base64
Decodes Base64 data into octets
decodeInteger(byte[]) - Static method in class com.paypal.base.codec.binary.Base64
Decodes a byte64-encoded integer according to crypto standards such as W3C's XML-Signature
Decoder - Interface in com.paypal.base.codec
Provides the highest level of abstraction for Decoders.
decodeResponseObject(Object, String) - Static method in class com.paypal.base.ReflectionUtil
 
DecoderException - Exception in com.paypal.base.codec
Thrown when there is a failure condition during the decoding process.
DecoderException() - Constructor for exception com.paypal.base.codec.DecoderException
Constructs a new exception with null as its detail message.
DecoderException(String) - Constructor for exception com.paypal.base.codec.DecoderException
Constructs a new exception with the specified detail message.
DecoderException(String, Throwable) - Constructor for exception com.paypal.base.codec.DecoderException
Constructsa new exception with the specified detail message and cause.
DecoderException(Throwable) - Constructor for exception com.paypal.base.codec.DecoderException
Constructs a new exception with the specified cause and a detail message of (cause==null ? null : cause.toString()) (which typically contains the class and detail message of cause).
DEFAULT_CONFIGURATION_FILE - Static variable in class com.paypal.base.Constants
 
DefaultHttpConnection - Class in com.paypal.base
Wrapper class used for HttpsURLConnection
DefaultHttpConnection() - Constructor for class com.paypal.base.DefaultHttpConnection
 
DefaultHttpConnection(SSLContext) - Constructor for class com.paypal.base.DefaultHttpConnection
 
DefinitionsLinkdescription - Class in com.paypal.api.payments
 
DefinitionsLinkdescription() - Constructor for class com.paypal.api.payments.DefinitionsLinkdescription
Default Constructor
DefinitionsLinkdescription(String, String) - Constructor for class com.paypal.api.payments.DefinitionsLinkdescription
Parameterized Constructor
delete(String) - Method in class com.paypal.api.payments.CreditCard
Deprecated.
Please use CreditCard.delete(APIContext) instead.
delete(APIContext) - Method in class com.paypal.api.payments.CreditCard
Delete the Credit Card resource for the given identifier.
delete(String) - Method in class com.paypal.api.payments.Invoice
Deprecated.
Please use Invoice.delete(APIContext) instead.
delete(APIContext) - Method in class com.paypal.api.payments.Invoice
Delete a particular invoice by passing the invoice ID to the request URI.
delete(APIContext) - Method in class com.paypal.api.payments.Template
Delete a particular template by passing the template ID to the request URI.
delete(String, String) - Method in class com.paypal.api.payments.Webhook
Deprecated.
delete(APIContext, String) - Method in class com.paypal.api.payments.Webhook
Deletes a webhook, by ID.
delete(String) - Method in class com.paypal.api.payments.WebProfile
Deprecated.
Please use WebProfile.delete(APIContext) instead.
delete(APIContext) - Method in class com.paypal.api.payments.WebProfile
Deletes a web experience profile, by ID.
deleteExternalPayment(APIContext) - Method in class com.paypal.api.payments.Invoice
Delete external payment.
deleteExternalRefund(APIContext) - Method in class com.paypal.api.payments.Invoice
Delete external refund.
DetailedRefund - Class in com.paypal.api.payments
 
DetailedRefund() - Constructor for class com.paypal.api.payments.DetailedRefund
Default Constructor
Details - Class in com.paypal.api.payments
 
Details() - Constructor for class com.paypal.api.payments.Details
Default Constructor
DEVICE_IP_ADDRESS - Static variable in class com.paypal.base.Constants
 
doVoid(String) - Method in class com.paypal.api.payments.Authorization
Deprecated.
doVoid(APIContext) - Method in class com.paypal.api.payments.Authorization
Voids, or cancels, an authorization, by ID.
doVoid(String) - Method in class com.paypal.api.payments.Order
Deprecated.
Please use Order.doVoid(APIContext) instead.
doVoid(APIContext) - Method in class com.paypal.api.payments.Order
Voids, or cancels, an order, by ID.
downloadCertificateFromPath(String) - Static method in class com.paypal.base.SSLUtil
Deprecated.
downloadCertificateFromPath(String, Map<String, String>) - Static method in class com.paypal.base.SSLUtil
Downloads Certificate from URL

E

EMPTY_STRING - Static variable in class com.paypal.base.Constants
 
encode(Object) - Method in class com.paypal.base.codec.binary.BaseNCodec
Encodes an Object using the Base-N algorithm.
encode(byte[]) - Method in class com.paypal.base.codec.binary.BaseNCodec
Encodes a byte[] containing binary data, into a byte[] containing characters in the alphabet.
encode(byte[]) - Method in interface com.paypal.base.codec.BinaryEncoder
Encodes a byte array and return the encoded data as a byte array.
encode(Object) - Method in interface com.paypal.base.codec.Encoder
Encodes an "Object" and returns the encoded content as an Object.
encode(String, String) - Static method in class com.paypal.base.util.PayPalURLEncoder
Encodes the given string s in a x-www-form-urlencoded string using the specified encoding scheme enc.
encodeAsString(byte[]) - Method in class com.paypal.base.codec.binary.BaseNCodec
Encodes a byte[] containing binary data, into a String containing characters in the appropriate alphabet.
encodeBase64(byte[]) - Static method in class com.paypal.base.codec.binary.Base64
Encodes binary data using the base64 algorithm but does not chunk the output.
encodeBase64(byte[], boolean) - Static method in class com.paypal.base.codec.binary.Base64
Encodes binary data using the base64 algorithm, optionally chunking the output into 76 character blocks.
encodeBase64(byte[], boolean, boolean) - Static method in class com.paypal.base.codec.binary.Base64
Encodes binary data using the base64 algorithm, optionally chunking the output into 76 character blocks.
encodeBase64(byte[], boolean, boolean, int) - Static method in class com.paypal.base.codec.binary.Base64
Encodes binary data using the base64 algorithm, optionally chunking the output into 76 character blocks.
encodeBase64Chunked(byte[]) - Static method in class com.paypal.base.codec.binary.Base64
Encodes binary data using the base64 algorithm and chunks the encoded output into 76 character blocks
encodeBase64String(byte[]) - Static method in class com.paypal.base.codec.binary.Base64
Encodes binary data using the base64 algorithm but does not chunk the output.
encodeBase64URLSafe(byte[]) - Static method in class com.paypal.base.codec.binary.Base64
Encodes binary data using a URL-safe variation of the base64 algorithm but does not chunk the output.
encodeBase64URLSafeString(byte[]) - Static method in class com.paypal.base.codec.binary.Base64
Encodes binary data using a URL-safe variation of the base64 algorithm but does not chunk the output.
encodeInteger(BigInteger) - Static method in class com.paypal.base.codec.binary.Base64
Encodes to a byte64-encoded integer according to crypto standards such as W3C's XML-Signature
Encoder - Interface in com.paypal.base.codec
Provides the highest level of abstraction for Encoders.
EncoderException - Exception in com.paypal.base.codec
Thrown when there is a failure condition during the encoding process.
EncoderException() - Constructor for exception com.paypal.base.codec.EncoderException
Constructs a new exception with null as its detail message.
EncoderException(String) - Constructor for exception com.paypal.base.codec.EncoderException
Constructs a new exception with the specified detail message.
EncoderException(String, Throwable) - Constructor for exception com.paypal.base.codec.EncoderException
Constructs a new exception with the specified detail message and cause.
EncoderException(Throwable) - Constructor for exception com.paypal.base.codec.EncoderException
Constructs a new exception with the specified cause and a detail message of (cause==null ? null : cause.toString()) (which typically contains the class and detail message of cause).
encodeToString(byte[]) - Method in class com.paypal.base.codec.binary.BaseNCodec
Encodes a byte[] containing binary data, into a String containing characters in the Base-N alphabet.
encodeUrl(String) - Static method in class com.paypal.base.NVPUtil
Utility method used to encode the value
ENCODING_FORMAT - Static variable in class com.paypal.base.Constants
 
ENDPOINT - Static variable in class com.paypal.base.Constants
 
ensureBufferSize(int) - Method in class com.paypal.base.codec.binary.BaseNCodec
Ensure that the buffer has room for size bytes
eof - Variable in class com.paypal.base.codec.binary.BaseNCodec
Boolean flag to indicate the EOF has been reached.
equals(Object) - Method in class com.paypal.api.payments.Address
 
equals(Object) - Method in class com.paypal.api.payments.Agreement
 
equals(Object) - Method in class com.paypal.api.payments.AgreementDetails
 
equals(Object) - Method in class com.paypal.api.payments.AgreementStateDescriptor
 
equals(Object) - Method in class com.paypal.api.payments.AgreementTransaction
 
equals(Object) - Method in class com.paypal.api.payments.AgreementTransactions
 
equals(Object) - Method in class com.paypal.api.payments.AlternatePayment
 
equals(Object) - Method in class com.paypal.api.payments.Amount
 
equals(Object) - Method in class com.paypal.api.payments.Authorization
 
equals(Object) - Method in class com.paypal.api.payments.BankAccount
 
equals(Object) - Method in class com.paypal.api.payments.BankToken
 
equals(Object) - Method in class com.paypal.api.payments.BaseAddress
 
equals(Object) - Method in class com.paypal.api.payments.Billing
 
equals(Object) - Method in class com.paypal.api.payments.BillingAgreementToken
 
equals(Object) - Method in class com.paypal.api.payments.BillingInfo
 
equals(Object) - Method in class com.paypal.api.payments.CancelNotification
 
equals(Object) - Method in class com.paypal.api.payments.Capture
 
equals(Object) - Method in class com.paypal.api.payments.Card3dSecureInfo
 
equals(Object) - Method in class com.paypal.api.payments.CarrierAccount
 
equals(Object) - Method in class com.paypal.api.payments.CarrierAccountToken
 
equals(Object) - Method in class com.paypal.api.payments.CartBase
 
equals(Object) - Method in class com.paypal.api.payments.ChargeModels
 
equals(Object) - Method in class com.paypal.api.payments.Cost
 
equals(Object) - Method in class com.paypal.api.payments.CountryCode
 
equals(Object) - Method in class com.paypal.api.payments.CreateProfileResponse
 
equals(Object) - Method in class com.paypal.api.payments.Credit
 
equals(Object) - Method in class com.paypal.api.payments.CreditCard
 
equals(Object) - Method in class com.paypal.api.payments.CreditCardHistory
 
equals(Object) - Method in class com.paypal.api.payments.CreditCardToken
 
equals(Object) - Method in class com.paypal.api.payments.CreditFinancingOffered
 
equals(Object) - Method in class com.paypal.api.payments.Currency
 
equals(Object) - Method in class com.paypal.api.payments.CurrencyConversion
 
equals(Object) - Method in class com.paypal.api.payments.CustomAmount
 
equals(Object) - Method in class com.paypal.api.payments.DefinitionsLinkdescription
 
equals(Object) - Method in class com.paypal.api.payments.DetailedRefund
 
equals(Object) - Method in class com.paypal.api.payments.Details
 
equals(Object) - Method in class com.paypal.api.payments.Error
 
equals(Object) - Method in class com.paypal.api.payments.ErrorDetails
 
equals(Object) - Method in class com.paypal.api.payments.Event
 
equals(Object) - Method in class com.paypal.api.payments.EventList
 
equals(Object) - Method in class com.paypal.api.payments.EventType
 
equals(Object) - Method in class com.paypal.api.payments.EventTypeList
 
equals(Object) - Method in class com.paypal.api.payments.ExtendedBankAccount
 
equals(Object) - Method in class com.paypal.api.payments.ExternalFunding
 
equals(Object) - Method in class com.paypal.api.payments.FileAttachment
 
equals(Object) - Method in class com.paypal.api.payments.FlowConfig
 
equals(Object) - Method in class com.paypal.api.payments.FmfDetails
 
equals(Object) - Method in class com.paypal.api.payments.FundingDetail
 
equals(Object) - Method in class com.paypal.api.payments.FundingInstrument
 
equals(Object) - Method in class com.paypal.api.payments.FundingOption
 
equals(Object) - Method in class com.paypal.api.payments.FundingSource
 
equals(Object) - Method in class com.paypal.api.payments.FuturePayment
 
equals(Object) - Method in class com.paypal.api.payments.HyperSchema
 
equals(Object) - Method in class com.paypal.api.payments.Image
 
equals(Object) - Method in class com.paypal.api.payments.Incentive
 
equals(Object) - Method in class com.paypal.api.payments.InputFields
 
equals(Object) - Method in class com.paypal.api.payments.InstallmentInfo
 
equals(Object) - Method in class com.paypal.api.payments.InstallmentOption
 
equals(Object) - Method in class com.paypal.api.payments.Invoice
 
equals(Object) - Method in class com.paypal.api.payments.InvoiceAddress
 
equals(Object) - Method in class com.paypal.api.payments.InvoiceItem
 
equals(Object) - Method in class com.paypal.api.payments.InvoiceNumber
 
equals(Object) - Method in class com.paypal.api.payments.Invoices
 
equals(Object) - Method in class com.paypal.api.payments.InvoicingMetaData
 
equals(Object) - Method in class com.paypal.api.payments.InvoicingNotification
 
equals(Object) - Method in class com.paypal.api.payments.InvoicingPaymentDetail
 
equals(Object) - Method in class com.paypal.api.payments.InvoicingRefundDetail
 
equals(Object) - Method in class com.paypal.api.payments.InvoicingSearch
 
equals(Object) - Method in class com.paypal.api.payments.Item
 
equals(Object) - Method in class com.paypal.api.payments.ItemList
 
equals(Object) - Method in class com.paypal.api.payments.Links
 
equals(Object) - Method in class com.paypal.api.payments.Measurement
 
equals(Object) - Method in class com.paypal.api.payments.MerchantInfo
 
equals(Object) - Method in class com.paypal.api.payments.MerchantPreferences
 
equals(Object) - Method in class com.paypal.api.payments.Metadata
 
equals(Object) - Method in class com.paypal.api.payments.NameValuePair
 
equals(Object) - Method in class com.paypal.api.payments.Notification
 
equals(Object) - Method in class com.paypal.api.payments.Order
 
equals(Object) - Method in class com.paypal.api.payments.OverrideChargeModel
 
equals(Object) - Method in class com.paypal.api.payments.Participant
 
equals(Object) - Method in class com.paypal.api.payments.Patch
 
equals(Object) - Method in class com.paypal.api.payments.PatchRequest
 
equals(Object) - Method in class com.paypal.api.payments.Payee
 
equals(Object) - Method in class com.paypal.api.payments.Payer
 
equals(Object) - Method in class com.paypal.api.payments.PayerInfo
 
equals(Object) - Method in class com.paypal.api.payments.PayerNotification
 
equals(Object) - Method in class com.paypal.api.payments.Payment
 
equals(Object) - Method in class com.paypal.api.payments.PaymentCard
 
equals(Object) - Method in class com.paypal.api.payments.PaymentCardToken
 
equals(Object) - Method in class com.paypal.api.payments.PaymentDefinition
 
equals(Object) - Method in class com.paypal.api.payments.PaymentDetail
 
equals(Object) - Method in class com.paypal.api.payments.PaymentExecution
 
equals(Object) - Method in class com.paypal.api.payments.PaymentHistory
 
equals(Object) - Method in class com.paypal.api.payments.PaymentInstruction
 
equals(Object) - Method in class com.paypal.api.payments.PaymentOptions
 
equals(Object) - Method in class com.paypal.api.payments.PaymentSummary
 
equals(Object) - Method in class com.paypal.api.payments.PaymentTerm
 
equals(Object) - Method in class com.paypal.api.payments.Payout
 
equals(Object) - Method in class com.paypal.api.payments.PayoutBatch
 
equals(Object) - Method in class com.paypal.api.payments.PayoutBatchHeader
 
equals(Object) - Method in class com.paypal.api.payments.PayoutItem
 
equals(Object) - Method in class com.paypal.api.payments.PayoutItemDetails
 
equals(Object) - Method in class com.paypal.api.payments.PayoutSenderBatchHeader
 
equals(Object) - Method in class com.paypal.api.payments.Percentage
 
equals(Object) - Method in class com.paypal.api.payments.Phone
 
equals(Object) - Method in class com.paypal.api.payments.Plan
 
equals(Object) - Method in class com.paypal.api.payments.PlanList
 
equals(Object) - Method in class com.paypal.api.payments.PotentialPayerInfo
 
equals(Object) - Method in class com.paypal.api.payments.Presentation
 
equals(Object) - Method in class com.paypal.api.payments.PrivateLabelCard
 
equals(Object) - Method in class com.paypal.api.payments.ProcessorResponse
 
equals(Object) - Method in class com.paypal.api.payments.RecipientBankingInstruction
 
equals(Object) - Method in class com.paypal.api.payments.RedirectUrls
 
equals(Object) - Method in class com.paypal.api.payments.Refund
 
equals(Object) - Method in class com.paypal.api.payments.RefundDetail
 
equals(Object) - Method in class com.paypal.api.payments.RefundRequest
 
equals(Object) - Method in class com.paypal.api.payments.RelatedResources
 
equals(Object) - Method in class com.paypal.api.payments.Sale
 
equals(Object) - Method in class com.paypal.api.payments.Search
 
equals(Object) - Method in class com.paypal.api.payments.ShippingAddress
 
equals(Object) - Method in class com.paypal.api.payments.ShippingCost
 
equals(Object) - Method in class com.paypal.api.payments.ShippingInfo
 
equals(Object) - Method in class com.paypal.api.payments.Tax
 
equals(Object) - Method in class com.paypal.api.payments.Template
 
equals(Object) - Method in class com.paypal.api.payments.TemplateData
 
equals(Object) - Method in class com.paypal.api.payments.Templates
 
equals(Object) - Method in class com.paypal.api.payments.TemplateSettings
 
equals(Object) - Method in class com.paypal.api.payments.TemplateSettingsMetadata
 
equals(Object) - Method in class com.paypal.api.payments.Terms
 
equals(Object) - Method in class com.paypal.api.payments.Transaction
 
equals(Object) - Method in class com.paypal.api.payments.TransactionBase
 
equals(Object) - Method in class com.paypal.api.payments.Transactions
 
equals(Object) - Method in class com.paypal.api.payments.Webhook
 
equals(Object) - Method in class com.paypal.api.payments.WebhookList
 
equals(Object) - Method in class com.paypal.api.payments.WebProfile
 
equals(Object) - Method in class com.paypal.api.payments.WebProfileList
 
equals(Object) - Method in class com.paypal.base.rest.AccessToken
 
equals(Object) - Method in class com.paypal.base.rest.PayPalModel
 
Error - Class in com.paypal.api.openidconnect
 
Error() - Constructor for class com.paypal.api.openidconnect.Error
Default Constructor
Error(String) - Constructor for class com.paypal.api.openidconnect.Error
Parameterized Constructor
Error - Class in com.paypal.api.payments
 
Error() - Constructor for class com.paypal.api.payments.Error
Default Constructor
Error(String, String, String, String) - Constructor for class com.paypal.api.payments.Error
Parameterized Constructor
ErrorDetails - Class in com.paypal.api.payments
 
ErrorDetails() - Constructor for class com.paypal.api.payments.ErrorDetails
Default Constructor
ErrorDetails(String, String) - Constructor for class com.paypal.api.payments.ErrorDetails
Parameterized Constructor
Event - Class in com.paypal.api.payments
 
Event() - Constructor for class com.paypal.api.payments.Event
Default Constructor
EventList - Class in com.paypal.api.payments
 
EventList() - Constructor for class com.paypal.api.payments.EventList
Default Constructor
EventType - Class in com.paypal.api.payments
 
EventType() - Constructor for class com.paypal.api.payments.EventType
Default Constructor
EventType(String) - Constructor for class com.paypal.api.payments.EventType
Parameterized Constructor
EventTypeList - Class in com.paypal.api.payments
 
EventTypeList() - Constructor for class com.paypal.api.payments.EventTypeList
Default Constructor
execute(String) - Method in class com.paypal.api.payments.Agreement
Deprecated.
execute(APIContext, String) - Static method in class com.paypal.api.payments.Agreement
Execute a billing agreement after buyer approval by passing the payment token to the request URI.
execute(String, PaymentExecution) - Method in class com.paypal.api.payments.Payment
Deprecated.
execute(APIContext, PaymentExecution) - Method in class com.paypal.api.payments.Payment
Executes, or completes, a PayPal payment that the payer has approved.
execute(String, String, Map<String, String>) - Method in class com.paypal.base.HttpConnection
Executes HTTP request
executeWithStream(String, String, Map<String, String>) - Method in class com.paypal.base.GoogleAppEngineHttpConnection
 
executeWithStream(String, String, Map<String, String>) - Method in class com.paypal.base.HttpConnection
Executes HTTP request
expiresIn() - Method in class com.paypal.base.rest.AccessToken
Specifies how long this token can be used for placing API calls.
expiresIn() - Method in class com.paypal.base.rest.OAuthTokenCredential
Specifies how long this token can be used for placing API calls.
ExtendedBankAccount - Class in com.paypal.api.payments
 
ExtendedBankAccount() - Constructor for class com.paypal.api.payments.ExtendedBankAccount
Default Constructor
ExternalFunding - Class in com.paypal.api.payments
 
ExternalFunding() - Constructor for class com.paypal.api.payments.ExternalFunding
Default Constructor
ExternalFunding(String, String, Amount) - Constructor for class com.paypal.api.payments.ExternalFunding
Parameterized Constructor

F

fetchAccessToken() - Method in class com.paypal.base.rest.APIContext
Returns the access Token.
fetchRefreshToken(APIContext, String) - Static method in class com.paypal.api.payments.FuturePayment
Fetches long lived refresh token from authorization code, for future payment use.
fetchRefreshToken(APIContext, String) - Static method in class com.paypal.api.payments.Invoice
Fetches long lived refresh token from authorization code, for third party merchant invoicing use.
FileAttachment - Class in com.paypal.api.payments
 
FileAttachment() - Constructor for class com.paypal.api.payments.FileAttachment
Default Constructor
FlowConfig - Class in com.paypal.api.payments
 
FlowConfig() - Constructor for class com.paypal.api.payments.FlowConfig
Default Constructor
FmfDetails - Class in com.paypal.api.payments
 
FmfDetails() - Constructor for class com.paypal.api.payments.FmfDetails
 
formatURIPath(String, Object[]) - Static method in class com.paypal.base.rest.RESTUtil
Formats the URI path for REST calls.
formatURIPath(String, Map<String, String>) - Static method in class com.paypal.base.rest.RESTUtil
Formats the URI path for REST calls.
formatURIPath(String, Map<String, String>, String...) - Static method in class com.paypal.base.rest.RESTUtil
Formats the URI path for REST calls.
formatURIPath(String, Map<String, String>, Map<String, String>) - Static method in class com.paypal.base.rest.RESTUtil
Formats the URI path for REST calls.
formUserAgentHeader() - Method in class com.paypal.base.rest.RESTAPICallPreHandler
Returns User-Agent header
fromJSON(String, Class<T>) - Static method in class com.paypal.base.rest.JSONFormatter
Converts a JSON String to object representation
FundingDetail - Class in com.paypal.api.payments
 
FundingDetail() - Constructor for class com.paypal.api.payments.FundingDetail
Default Constructor
FundingInstrument - Class in com.paypal.api.payments
 
FundingInstrument() - Constructor for class com.paypal.api.payments.FundingInstrument
Default Constructor
FundingOption - Class in com.paypal.api.payments
 
FundingOption() - Constructor for class com.paypal.api.payments.FundingOption
Default Constructor
FundingOption(String, List<FundingSource>) - Constructor for class com.paypal.api.payments.FundingOption
Parameterized Constructor
FundingSource - Class in com.paypal.api.payments
 
FundingSource() - Constructor for class com.paypal.api.payments.FundingSource
Default Constructor
FuturePayment - Class in com.paypal.api.payments
 
FuturePayment() - Constructor for class com.paypal.api.payments.FuturePayment
 

G

generateMapFromResponse(Object, String) - Static method in class com.paypal.base.ReflectionUtil
 
generateNumber(APIContext) - Method in class com.paypal.api.payments.Invoice
Generates the next invoice number.
get(String, String) - Static method in class com.paypal.api.payments.Agreement
Deprecated.
get(APIContext, String) - Static method in class com.paypal.api.payments.Agreement
Retrieve details for a particular billing agreement by passing the ID of the agreement to the request URI.
get(String, String) - Static method in class com.paypal.api.payments.Authorization
Deprecated.
get(APIContext, String) - Static method in class com.paypal.api.payments.Authorization
Shows details for an authorization, by ID.
get(String, String) - Static method in class com.paypal.api.payments.Capture
Deprecated.
get(APIContext, String) - Static method in class com.paypal.api.payments.Capture
Shows details for a captured payment, by ID.
get(String, String) - Static method in class com.paypal.api.payments.CreditCard
Deprecated.
get(APIContext, String) - Static method in class com.paypal.api.payments.CreditCard
Obtain the Credit Card resource for the given identifier.
get(String, String) - Static method in class com.paypal.api.payments.Event
Deprecated.
Please use Event.get(APIContext, String) instead.
get(APIContext, String) - Static method in class com.paypal.api.payments.Event
Retrieves the Webhooks event resource identified by event_id.
get(String, String) - Static method in class com.paypal.api.payments.Invoice
Deprecated.
get(APIContext, String) - Static method in class com.paypal.api.payments.Invoice
Gets the details for a specified invoice, by ID.
get(String, String) - Static method in class com.paypal.api.payments.Order
Deprecated.
Please use Order.get(APIContext, String) instead.
get(APIContext, String) - Static method in class com.paypal.api.payments.Order
Shows details for an order, by ID.
get(String, String) - Static method in class com.paypal.api.payments.Payment
Deprecated.
get(APIContext, String) - Static method in class com.paypal.api.payments.Payment
Shows details for a payment, by ID.
get(String, String) - Static method in class com.paypal.api.payments.Payout
Deprecated.
Please use Payout.get(APIContext, String) instead.
get(APIContext, String) - Static method in class com.paypal.api.payments.Payout
Obtain the status of a specific batch resource by passing the payout batch ID to the request URI.
get(String, String) - Static method in class com.paypal.api.payments.PayoutItem
Deprecated.
get(APIContext, String) - Static method in class com.paypal.api.payments.PayoutItem
Obtain the status of a payout item by passing the item ID to the request URI.
get(String, String) - Static method in class com.paypal.api.payments.Plan
Deprecated.
Please use Plan.get(APIContext, String) instead.
get(APIContext, String) - Static method in class com.paypal.api.payments.Plan
Retrieve the details for a particular billing plan by passing the billing plan ID to the request URI.
get(String, String) - Static method in class com.paypal.api.payments.Refund
Deprecated.
Please use Refund.get(APIContext, String) instead.
get(APIContext, String) - Static method in class com.paypal.api.payments.Refund
Shows details for a refund, by ID.
get(String, String) - Static method in class com.paypal.api.payments.Sale
Deprecated.
Please use Sale.get(APIContext, String) instead.
get(APIContext, String) - Static method in class com.paypal.api.payments.Sale
Shows details for a sale, by ID.
get(APIContext, String) - Static method in class com.paypal.api.payments.Template
Retrieve the details for a particular template by passing the template ID to the request URI.
get(APIContext, String) - Static method in class com.paypal.api.payments.Templates
Deprecated.
get(String, String) - Method in class com.paypal.api.payments.Webhook
Deprecated.
get(APIContext, String) - Method in class com.paypal.api.payments.Webhook
Shows details for a webhook, by ID.
get(String, String) - Static method in class com.paypal.api.payments.WebProfile
Deprecated.
get(APIContext, String) - Static method in class com.paypal.api.payments.WebProfile
Shows details for a web experience profile, by ID.
get3dSecureInfo() - Method in class com.paypal.api.payments.PaymentCard
Deprecated.
Please use PaymentCard.getCard3dSecureInfo() instead. Getter for 3dSecureInfo
getAcceptedPaymentType() - Method in class com.paypal.api.payments.MerchantPreferences
Payment types that are accepted for this plan.
getAccessToken() - Method in class com.paypal.api.openidconnect.Tokeninfo
Getter for just accessToken without type (e.g., "EEwJ6tF9x5WCIZDYzyZGaz6Khbw7raYRIBV_WxVvgmsG")
getAccessToken() - Method in class com.paypal.base.credential.TokenAuthorization
 
getAccessToken() - Method in class com.paypal.base.rest.AccessToken
 
getAccessToken() - Method in class com.paypal.base.rest.APIContext
Deprecated.
Please use APIContext.fetchAccessToken() instead. Previously, this was a dumb getter method. However, we enabled the feature to re-generate the access Token if null, or expired. This required us to throw proper PayPalRESTException, with error information on failure.
getAccessToken() - Method in class com.paypal.base.rest.OAuthTokenCredential
Computes Access Token by placing a call to OAuth server using ClientID and ClientSecret.
getAccessTokenWithType() - Method in class com.paypal.api.openidconnect.Tokeninfo
Getter for accessToken with token type (e.g., "Bearer: EEwJ6tF9x5WCIZDYzyZGaz6Khbw7raYRIBV_WxVvgmsG")
getAccountAge() - Method in class com.paypal.api.payments.Payer
Duration since the payer established account relationship with PayPal in days.
getAccountHolderName() - Method in class com.paypal.api.payments.RecipientBankingInstruction
Name of the account holder
getAccountName() - Method in class com.paypal.api.payments.BankAccount
A customer designated name.
getAccountNumber() - Method in class com.paypal.api.payments.BankAccount
Account number in either IBAN (max length 34) or BBAN (max length 17) format.
getAccountNumber() - Method in class com.paypal.api.payments.Payee
Unencrypted PayPal account Number of the Payee
getAccountNumber() - Method in class com.paypal.api.payments.PayerInfo
Deprecated.
getAccountNumber() - Method in class com.paypal.api.payments.PotentialPayerInfo
Account Number representing the potential payer
getAccountNumber() - Method in class com.paypal.api.payments.RecipientBankingInstruction
bank account number
getAccountNumberType() - Method in class com.paypal.api.payments.BankAccount
Type of the bank account number (International or Basic Bank Account Number).
getAccountType() - Method in class com.paypal.api.openidconnect.Userinfo
Account type.
getAccountType() - Method in class com.paypal.api.payments.BankAccount
Type of the bank account.
getAccountType() - Method in class com.paypal.api.payments.Payer
Type of account relationship payer has with PayPal.
getAdditionalData() - Method in class com.paypal.api.payments.Invoice
Any miscellaneous invoice data.
getAdditionalInfo() - Method in class com.paypal.api.payments.BillingInfo
Additional information, such as business hours.
getAdditionalInfo() - Method in class com.paypal.api.payments.MerchantInfo
Additional information, such as business hours.
getAdditionalInfo() - Method in class com.paypal.api.payments.Participant
Additional information, such as business hours.
getAdditionalInfoLabel() - Method in class com.paypal.api.payments.MerchantInfo
Option to provide a label to the additional_info field.
getAddress() - Method in class com.paypal.api.openidconnect.Userinfo
End-User's preferred address.
getAddress() - Method in class com.paypal.api.payments.BillingInfo
The invoice recipient address.
getAddress() - Method in class com.paypal.api.payments.MerchantInfo
The merchant address.
getAddress() - Method in class com.paypal.api.payments.Participant
The participant address.
getAddress() - Method in class com.paypal.api.payments.ShippingInfo
The invoice recipient address.
getAddresses() - Method in class com.paypal.api.payments.Templates
List of addresses in merchant's profile.
getAddressOverride() - Method in class com.paypal.api.payments.InputFields
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.
getAdviceCode() - Method in class com.paypal.api.payments.ProcessorResponse
Provides merchant advice on how to handle declines related to recurring payments
getAgeRange() - Method in class com.paypal.api.openidconnect.Userinfo
Account holder age range.
getAgreementDetails() - Method in class com.paypal.api.payments.Agreement
Details of the agreement.
getAgreementTransactionList() - Method in class com.paypal.api.payments.AgreementTransactions
Array of agreement_transaction object.
getAll(String) - Static method in class com.paypal.api.payments.Invoice
Deprecated.
Please use Invoice.getAll(APIContext) instead.
getAll(APIContext) - Static method in class com.paypal.api.payments.Invoice
Lists some or all merchant invoices.
getAll(APIContext, Map<String, String>) - Static method in class com.paypal.api.payments.Invoice
Lists some or all merchant invoices.
getAll(APIContext) - Static method in class com.paypal.api.payments.Template
Retrieves the template information of the merchant.
getAll(APIContext) - Static method in class com.paypal.api.payments.Templates
Retrieves the template information of the merchant.
getAll(String) - Method in class com.paypal.api.payments.WebhookList
Deprecated.
Please use WebhookList.getAll(APIContext) instead.
getAll(APIContext) - Method in class com.paypal.api.payments.WebhookList
Retrieves all Webhooks for the application associated with access token.
getAllowedPaymentMethod() - Method in class com.paypal.api.payments.PaymentOptions
Payment method requested for this purchase unit
getAllowNote() - Method in class com.paypal.api.payments.InputFields
Indicates whether the buyer can enter a note to the merchant on the PayPal page during checkout.
getAllowPartialPayment() - Method in class com.paypal.api.payments.Invoice
Indicates whether the invoice allows a partial payment.
getAllowPartialPayment() - Method in class com.paypal.api.payments.TemplateData
Indicates whether the invoice allows a partial payment.
getAlternatePayment() - Method in class com.paypal.api.payments.FundingInstrument
Alternate Payment information - Mostly regional payment providers.
getAlternatePaymentAccountId() - Method in class com.paypal.api.payments.AlternatePayment
The unique identifier of the alternate payment account.
getAlternatePaymentProviderId() - Method in class com.paypal.api.payments.AlternatePayment
Alternate Payment provider id.
getAmount() - Method in class com.paypal.api.payments.AgreementStateDescriptor
The amount and currency of the agreement.
getAmount() - Method in class com.paypal.api.payments.AgreementTransaction
Amount for this transaction.
getAmount() - Method in class com.paypal.api.payments.Authorization
Amount being authorized.
getAmount() - Method in class com.paypal.api.payments.Capture
The amount to capture.
getAmount() - Method in class com.paypal.api.payments.CartBase
Amount being collected.
getAmount() - Method in class com.paypal.api.payments.ChargeModels
Specific amount for this charge model.
getAmount() - Method in class com.paypal.api.payments.Cost
The cost, as an amount.
getAmount() - Method in class com.paypal.api.payments.CustomAmount
The custom amount value.
getAmount() - Method in class com.paypal.api.payments.ExternalFunding
Amount being funded by the external funding account
getAmount() - Method in class com.paypal.api.payments.Order
Amount being collected.
getAmount() - Method in class com.paypal.api.payments.OverrideChargeModel
Updated Amount to be associated with this charge model.
getAmount() - Method in class com.paypal.api.payments.PaymentDefinition
Amount that will be charged at the end of each cycle for this payment definition.
getAmount() - Method in class com.paypal.api.payments.PaymentDetail
The amount to record as payment against invoice.
getAmount() - Method in class com.paypal.api.payments.PaymentInstruction
Amount to be transferred
getAmount() - Method in class com.paypal.api.payments.PayoutBatchHeader
Total amount, in U.S.
getAmount() - Method in class com.paypal.api.payments.PayoutItem
The amount of money to pay the receiver.
getAmount() - Method in class com.paypal.api.payments.Refund
Details including both refunded amount (to payer) and refunded fee (to payee).
getAmount() - Method in class com.paypal.api.payments.RefundDetail
Amount to be recorded as refund against invoice.
getAmount() - Method in class com.paypal.api.payments.RefundRequest
Details including both refunded amount (to payer) and refunded fee (to payee).
getAmount() - Method in class com.paypal.api.payments.Sale
Amount being collected.
getAmount() - Method in class com.paypal.api.payments.ShippingCost
The shipping cost, as an amount.
getAmount() - Method in class com.paypal.api.payments.Tax
The tax as a monetary amount.
getAmount() - Method in class com.paypal.api.payments.Transactions
Amount being collected.
getAmountRange() - Method in class com.paypal.api.payments.Terms
Amount_range associated with this term.
getAppId() - Method in class com.paypal.api.openidconnect.Tokeninfo
Getter for appId
getArchived() - Method in class com.paypal.api.payments.Search
A flag indicating whether search is on invoices archived by merchant.
getAttachments() - Method in class com.paypal.api.payments.Invoice
List of files attached to the invoice.
getAttachments() - Method in class com.paypal.api.payments.TemplateData
List of files attached to the invoice.
getAuthCaptureTimestamp() - Method in class com.paypal.api.payments.BankAccount
Time at which the authorization (or check) was captured.
getAuthorization() - Method in class com.paypal.api.payments.RelatedResources
Authorization transaction
getAuthorizationHeader() - Method in class com.paypal.base.rest.OAuthTokenCredential
Computes Access Token by doing a Base64 encoding on the ClientID and ClientSecret.
getAuthStatus() - Method in class com.paypal.api.payments.Card3dSecureInfo
Authorization status from 3ds provider.
getAuthType() - Method in class com.paypal.api.payments.BankAccount
How the check was obtained from the customer, if check was the source of the information provided.
getAutoBillAmount() - Method in class com.paypal.api.payments.MerchantPreferences
Allow auto billing for the outstanding amount of the agreement in the next cycle.
getAvsCode() - Method in class com.paypal.api.payments.ProcessorResponse
Address Verification System response code.
getBackupFundingInstrument() - Method in class com.paypal.api.payments.FundingOption
Backup funding instrument which will be used for payment if primary fails.
getBankAccount() - Method in class com.paypal.api.payments.FundingInstrument
Bank Account information.
getBankAccountToken() - Method in class com.paypal.api.payments.FundingInstrument
Vaulted bank account instrument.
getBankId() - Method in class com.paypal.api.payments.BankToken
ID of a previously saved Bank resource using /vault/bank API.
getBankIdentifierCode() - Method in class com.paypal.api.payments.RecipientBankingInstruction
BIC identifier of the financial institution
getBankName() - Method in class com.paypal.api.payments.BankAccount
Name of the bank.
getBankName() - Method in class com.paypal.api.payments.RecipientBankingInstruction
Name of the financial institution.
getBankTxnPendingUrl() - Method in class com.paypal.api.payments.FlowConfig
The merchant site URL to display after a bank transfer payment.
getBaseURL() - Method in class com.paypal.base.rest.RESTAPICallPreHandler
Returns the base URL configured in application resources or Map passed for dynamic configuration
getBatchHeader() - Method in class com.paypal.api.payments.PayoutBatch
A batch header.
getBatchStatus() - Method in class com.paypal.api.payments.PayoutBatchHeader
The PayPal-generated batch payout status.
getBilling() - Method in class com.paypal.api.payments.FundingInstrument
Billing instrument that references pre-approval information for the payment
getBillingAddress() - Method in class com.paypal.api.payments.BankAccount
Billing address.
getBillingAddress() - Method in class com.paypal.api.payments.CreditCard
Billing Address associated with this card.
getBillingAddress() - Method in class com.paypal.api.payments.PayerInfo
Billing address of the Payer.
getBillingAddress() - Method in class com.paypal.api.payments.PaymentCard
The billing address for the card.
getBillingAddress() - Method in class com.paypal.api.payments.PotentialPayerInfo
Billing address of the potential payer.
getBillingAgreementId() - Method in class com.paypal.api.payments.Billing
Identifier of the instrument in PayPal Wallet
getBillingAgreementId() - Method in class com.paypal.api.payments.Sale
ID of the billing agreement used as reference to execute this transaction.
getBillingAgreementTokens() - Method in class com.paypal.api.payments.Payment
Collection of PayPal generated billing agreement tokens.
getBillingCountry() - Method in class com.paypal.api.payments.PaymentCard
The two-letter country code.
getBillingInfo() - Method in class com.paypal.api.payments.Invoice
The required invoice recipient email address and any optional billing information.
getBillingInfo() - Method in class com.paypal.api.payments.TemplateData
The required invoice recipient email address and any optional billing information.
getBirthdate() - Method in class com.paypal.api.openidconnect.Userinfo
Deprecated.
PayPal API returns 'birthday', use that instead
getBirthDate() - Method in class com.paypal.api.payments.BankAccount
Birth date of the bank account holder.
getBirthDate() - Method in class com.paypal.api.payments.PayerInfo
Birth date of the Payer in ISO8601 format (yyyy-mm-dd).
getBirthday() - Method in class com.paypal.api.openidconnect.Userinfo
End-User's birthday, represented as an YYYY-MM-DD format.
getBrandName() - Method in class com.paypal.api.payments.Presentation
A label that overrides the business name in the PayPal account on the PayPal pages.
getBusinessName() - Method in class com.paypal.api.payments.BillingInfo
The invoice recipient company business name.
getBusinessName() - Method in class com.paypal.api.payments.MerchantInfo
The merchant company business name.
getBusinessName() - Method in class com.paypal.api.payments.Participant
The participant company business name.
getBusinessName() - Method in class com.paypal.api.payments.ShippingInfo
The invoice recipient company business name.
getBuyerAccountNumber() - Method in class com.paypal.api.payments.PayerInfo
Account Number representing the Payer
getBuyerEditable() - Method in class com.paypal.api.payments.Terms
Buyer's ability to edit the amount in this term.
getBytesIso8859_1(String) - Static method in class com.paypal.base.codec.binary.StringUtils
Encodes the given string into a sequence of bytes using the ISO-8859-1 charset, storing the result into a new byte array.
getBytesUnchecked(String, String) - Static method in class com.paypal.base.codec.binary.StringUtils
Encodes the given string into a sequence of bytes using the named charset, storing the result into a new byte array.
getBytesUsAscii(String) - Static method in class com.paypal.base.codec.binary.StringUtils
Encodes the given string into a sequence of bytes using the US-ASCII charset, storing the result into a new byte array.
getBytesUtf16(String) - Static method in class com.paypal.base.codec.binary.StringUtils
Encodes the given string into a sequence of bytes using the UTF-16 charset, storing the result into a new byte array.
getBytesUtf16Be(String) - Static method in class com.paypal.base.codec.binary.StringUtils
Encodes the given string into a sequence of bytes using the UTF-16BE charset, storing the result into a new byte array.
getBytesUtf16Le(String) - Static method in class com.paypal.base.codec.binary.StringUtils
Encodes the given string into a sequence of bytes using the UTF-16LE charset, storing the result into a new byte array.
getBytesUtf8(String) - Static method in class com.paypal.base.codec.binary.StringUtils
Encodes the given string into a sequence of bytes using the UTF-8 charset, storing the result into a new byte array.
getCancelledBy() - Method in class com.paypal.api.payments.InvoicingMetaData
Actor who cancelled the resource.
getCancelledBy() - Method in class com.paypal.api.payments.Metadata
The actor who cancelled the resource.
getCancelledDate() - Method in class com.paypal.api.payments.InvoicingMetaData
Date when the resource was cancelled.
getCancelledDate() - Method in class com.paypal.api.payments.Metadata
The date and time when the resource was cancelled.
getCancelUrl() - Method in class com.paypal.api.payments.MerchantPreferences
Redirect URL on cancellation of agreement request.
getCancelUrl() - Method in class com.paypal.api.payments.RedirectUrls
Url where the payer would be redirected to after canceling the payment.
getCapture() - Method in class com.paypal.api.payments.RelatedResources
Capture transaction
getCaptureId() - Method in class com.paypal.api.payments.Refund
ID of the sale transaction being refunded.
getCard3dSecureInfo() - Method in class com.paypal.api.payments.PaymentCard
Fields required to support 3d secure information when processing credit card payments.
getCardNumber() - Method in class com.paypal.api.payments.PrivateLabelCard
last 4 digits of the card number.
getCardProductClass() - Method in class com.paypal.api.payments.PaymentCard
The product class of the financial instrument issuer.
getCarrierAccount() - Method in class com.paypal.api.payments.FundingInstrument
Carrier account instrument
getCarrierAccountId() - Method in class com.paypal.api.payments.CarrierAccountToken
ID of a previously saved carrier account resource.
getCarrierAccountId() - Method in class com.paypal.api.payments.PaymentExecution
Carrier account id for a carrier billing payment.
getCarrierAccountToken() - Method in class com.paypal.api.payments.FundingInstrument
Carrier account token instrument.
getCart() - Method in class com.paypal.api.payments.Payment
ID of the cart to execute the payment.
getCartAmountImmutable() - Method in class com.paypal.api.payments.CreditFinancingOffered
Indicates whether the cart amount is editable after payer's acceptance on PayPal side
getCategory() - Method in class com.paypal.api.payments.Item
Category type of the item.
getCavv() - Method in class com.paypal.api.payments.Card3dSecureInfo
Cardholder Authentication Verification Value (used by VISA).
getCcEmails() - Method in class com.paypal.api.payments.CancelNotification
Applicable for invoices created with Cc emails.
getCcEmails() - Method in class com.paypal.api.payments.Notification
Applicable for invoices created with Cc emails.
getCcInfo() - Method in class com.paypal.api.payments.Invoice
For invoices sent by email, one or more email addresses to which to send a Cc: copy of the notification.
getCcInfo() - Method in class com.paypal.api.payments.TemplateData
For invoices sent by email, one or more email addresses to which to send a Cc: copy of the notification.
getCertificateFromStream(InputStream) - Static method in class com.paypal.base.SSLUtil
Generate Collection of Certificate from Input Stream
getChargeId() - Method in class com.paypal.api.payments.OverrideChargeModel
ID of charge model.
getChargeModels() - Method in class com.paypal.api.payments.PaymentDefinition
Array of charge_models for this payment definition.
getCharSet() - Method in class com.paypal.api.payments.MerchantPreferences
char_set for this plan.
getCheckType() - Method in class com.paypal.api.payments.BankAccount
Type of the check when this information was obtained through a check by the facilitator or merchant.
getCity() - Method in class com.paypal.api.payments.BaseAddress
City name.
getClearingTime() - Method in class com.paypal.api.payments.FundingDetail
Expected clearing time
getClearingTime() - Method in class com.paypal.api.payments.Sale
Expected clearing time for eCheck Transactions.
getClientCredential() - Method in class com.paypal.base.rest.PayPalResource
Deprecated.
Please use static method `getCredential` instead. Returns ClientCredentials with client id and client secret from configuration Map.
getClientID() - Method in class com.paypal.base.ClientCredentials
 
getClientID() - Method in class com.paypal.base.rest.APIContext
 
getClientID() - Method in class com.paypal.base.rest.OAuthTokenCredential
Returns clientID
getClientID() - Static method in class com.paypal.base.rest.PayPalResource
Return Client ID from configuration Map
getClientSecret() - Method in class com.paypal.base.ClientCredentials
 
getClientSecret() - Method in class com.paypal.base.rest.APIContext
 
getClientSecret() - Method in class com.paypal.base.rest.OAuthTokenCredential
Returns clientSecret
getClientSecret() - Static method in class com.paypal.base.rest.PayPalResource
Returns Client Secret from configuration Map
getCode() - Method in class com.paypal.api.payments.Error
Deprecated.
This property is not available publicly PayPal internal error code.
getCode() - Method in class com.paypal.api.payments.ErrorDetails
Deprecated.
This property is not publicly available PayPal internal error code.
getCode() - Method in class com.paypal.api.payments.ExternalFunding
Generic identifier for the external funding
getCode() - Method in class com.paypal.api.payments.Incentive
Code that identifies the incentive.
getConfiguration(String) - Method in class com.paypal.base.rest.APIContext
Returns string value of specific configuration.
getConfiguration(String) - Method in class com.paypal.base.rest.OAuthTokenCredential
Returns specific configuration.
getConfigurationMap() - Method in interface com.paypal.base.APICallPreHandler
Return configurationMap
getConfigurationMap() - Method in class com.paypal.base.ConfigManager
Constructs a Map object from the underlying Properties.
getConfigurationMap() - Method in class com.paypal.base.rest.APIContext
Returns Configuration Map
getConfigurationMap() - Method in class com.paypal.base.rest.RESTAPICallPreHandler
Return configurationMap
getConfigurations() - Method in class com.paypal.base.rest.OAuthTokenCredential
Returns list of configurations.
getConfigurations() - Static method in class com.paypal.base.rest.PayPalResource
 
getConfirmationStatus() - Method in class com.paypal.api.payments.BankAccount
Confirmation status of a bank account.
getConnection() - Method in class com.paypal.base.ConnectionManager
 
getConnection(HttpConfiguration) - Method in class com.paypal.base.ConnectionManager
Overloaded method used factory to load GoogleAppEngineSpecific connection
getConnectionTimeout() - Method in class com.paypal.base.HttpConfiguration
 
getContainerMap() - Method in class com.paypal.api.openidconnect.CreateFromAuthorizationCodeParameters
 
getContainerMap() - Method in class com.paypal.api.openidconnect.CreateFromRefreshTokenParameters
 
getContainerMap() - Method in class com.paypal.api.openidconnect.UserinfoParameters
 
getContainerMap() - Method in class com.paypal.base.rest.QueryParameters
 
getContentEncoding() - Method in class com.paypal.api.payments.HyperSchema
 
getContentType() - Method in class com.paypal.base.HttpConfiguration
Deprecated.
Set/Get Content-Type HTTP Header in APIContext HTTPHeaders parameter
getConversionDate() - Method in class com.paypal.api.payments.CurrencyConversion
Date of validity for the conversion rate.
getConversionType() - Method in class com.paypal.api.payments.CurrencyConversion
Field indicating conversion type applied.
getConversionTypeChangeable() - Method in class com.paypal.api.payments.CurrencyConversion
Allow Payer to change conversion type.
getCount() - Method in class com.paypal.api.payments.EventList
Number of items returned in each range of results.
getCount() - Method in class com.paypal.api.payments.PaymentHistory
Number of items returned in each range of results.
getCountry() - Method in class com.paypal.api.openidconnect.Address
Getter for country
getCountryCode() - Method in class com.paypal.api.payments.BankAccount
2 letter country code of the Bank.
getCountryCode() - Method in class com.paypal.api.payments.BaseAddress
2 letter country code.
getCountryCode() - Method in class com.paypal.api.payments.CarrierAccount
The ISO 3166-1 alpha-2 country code where the phone number is registered.
getCountryCode() - Method in class com.paypal.api.payments.CountryCode
ISO country code based on 2-character IS0-3166-1 codes.
getCountryCode() - Method in class com.paypal.api.payments.PayerInfo
Two-letter registered country code of the payer to identify the buyer country.
getCountryCode() - Method in class com.paypal.api.payments.Phone
Country code (from in E.164 format)
getCreatedBy() - Method in class com.paypal.api.payments.InvoicingMetaData
Email address of the account that created the resource.
getCreatedBy() - Method in class com.paypal.api.payments.Metadata
The email address of the account that created the resource.
getCreatedDate() - Method in class com.paypal.api.payments.InvoicingMetaData
Date when the resource was created.
getCreatedDate() - Method in class com.paypal.api.payments.Metadata
The date and time when the resource was created.
getCreateTime() - Method in class com.paypal.api.payments.Agreement
Date and time that this resource was created.
getCreateTime() - Method in class com.paypal.api.payments.Authorization
Time of authorization as defined in [RFC 3339 Section 5.6](http://tools.ietf.org/html/rfc3339#section-5.6).
getCreateTime() - Method in class com.paypal.api.payments.BankAccount
Time the resource was created.
getCreateTime() - Method in class com.paypal.api.payments.Capture
The date and time of capture, as defined in [RFC 3339 Section 5.6](http://tools.ietf.org/html/rfc3339#section-5.6).
getCreateTime() - Method in class com.paypal.api.payments.Event
Time the resource was created.
getCreateTime() - Method in class com.paypal.api.payments.Order
Time the resource was created in UTC ISO8601 format.
getCreateTime() - Method in class com.paypal.api.payments.Payment
Payment creation time as defined in [RFC 3339 Section 5.6](http://tools.ietf.org/html/rfc3339#section-5.6).
getCreateTime() - Method in class com.paypal.api.payments.Plan
Time when the billing plan was created.
getCreateTime() - Method in class com.paypal.api.payments.Refund
Time of refund as defined in [RFC 3339 Section 5.6](http://tools.ietf.org/html/rfc3339#section-5.6).
getCreateTime() - Method in class com.paypal.api.payments.Sale
Time of sale as defined in [RFC 3339 Section 5.6](http://tools.ietf.org/html/rfc3339#section-5.6)
getCredential() - Method in interface com.paypal.base.APICallPreHandler
Returns OAuthTokenCredential configured for the api call
getCredential() - Static method in class com.paypal.base.rest.PayPalResource
Returns ClientCredentials with client id and client secret from configuration Map
getCredential() - Method in class com.paypal.base.rest.RESTAPICallPreHandler
 
getCredit() - Method in class com.paypal.api.payments.FundingInstrument
PayPal credit funding instrument.
getCreditCard() - Method in class com.paypal.api.payments.FundingInstrument
Credit Card instrument.
getCreditCardId() - Method in class com.paypal.api.payments.CreditCardToken
ID of credit card previously stored using `/vault/credit-card`.
getCreditCardToken() - Method in class com.paypal.api.payments.FundingInstrument
PayPal vaulted credit Card instrument.
getCreditFinancingOffered() - Method in class com.paypal.api.payments.Payment
Credit financing offered to payer on PayPal side.
getCurrency() - Method in class com.paypal.api.payments.Amount
3-letter [currency code](https://developer.paypal.com/docs/integration/direct/rest_api_payment_country_currency_support/).
getCurrency() - Method in class com.paypal.api.payments.Currency
3 letter currency code as defined by ISO 4217.
getCurrency() - Method in class com.paypal.api.payments.Item
3-letter [currency code](https://developer.paypal.com/docs/integration/direct/rest_api_payment_country_currency_support/).
getCurrencyConversion() - Method in class com.paypal.api.payments.FundingOption
Currency conversion applicable to this funding option.
getCustom() - Method in class com.paypal.api.payments.CartBase
free-form field for the use of clients
getCustom() - Method in class com.paypal.api.payments.DetailedRefund
free-form field for the use of clients
getCustom() - Method in class com.paypal.api.payments.Invoice
The custom amount to apply on an invoice.
getCustom() - Method in class com.paypal.api.payments.Template
Indicates whether this is a custom template created by the merchant.
getCustom() - Method in class com.paypal.api.payments.TemplateData
The custom amount to apply on an invoice.
getCvv2() - Method in class com.paypal.api.payments.CreditCard
Deprecated.
Please use CreditCard.getCvv2String() instead. Getter for cvv2 Returns -1 if cvv2 is null. Not autogenerating using lombok as it includes logic to return -1 on null.
getCvv2() - Method in class com.paypal.api.payments.PaymentCard
The validation code for the card.
getCvv2String() - Method in class com.paypal.api.payments.CreditCard
Returns the cvv2
getCvvCode() - Method in class com.paypal.api.payments.ProcessorResponse
CVV System response code.
getCycles() - Method in class com.paypal.api.payments.PaymentDefinition
Number of cycles in this payment definition.
getCyclesCompleted() - Method in class com.paypal.api.payments.AgreementDetails
Number of cycles completed for this agreement.
getCyclesRemaining() - Method in class com.paypal.api.payments.AgreementDetails
Number of cycles remaining for this agreement.
getDate() - Method in class com.paypal.api.payments.InvoiceItem
The date when the item or service was provided.
getDate() - Method in class com.paypal.api.payments.InvoicingPaymentDetail
Date when the invoice was paid.
getDate() - Method in class com.paypal.api.payments.InvoicingRefundDetail
Date when the invoice was marked as refunded.
getDate() - Method in class com.paypal.api.payments.PaymentDetail
The date when the invoice was paid.
getDate() - Method in class com.paypal.api.payments.RefundDetail
Date on which the invoice was refunded.
getDebugId() - Method in class com.paypal.api.payments.Error
PayPal internal identifier used for correlation purposes.
getDefaultAddress() - Method in class com.paypal.api.payments.ShippingAddress
Default shipping address of the Payer.
getDefaultBufferSize() - Method in class com.paypal.base.codec.binary.BaseNCodec
Get the default buffer size.
getDefaultProperties() - Static method in class com.paypal.base.ConfigManager
Returns the Default Properties of System Configuration
getDefaultSDKMap() - Static method in class com.paypal.base.ConfigManager
Returns a Map view of Default Properties
getDescription() - Method in class com.paypal.api.payments.Agreement
Description of the agreement.
getDescription() - Method in class com.paypal.api.payments.CartBase
Description of what is being paid for.
getDescription() - Method in class com.paypal.api.payments.EventType
Human readable description of the event-type
getDescription() - Method in class com.paypal.api.payments.FmfDetails
Description of the filter.
getDescription() - Method in class com.paypal.api.payments.Incentive
Description of the incentive.
getDescription() - Method in class com.paypal.api.payments.InvoiceItem
Description of the item.
getDescription() - Method in class com.paypal.api.payments.Item
Description of the item.
getDescription() - Method in class com.paypal.api.payments.Plan
Description of the billing plan.
getDescription() - Method in class com.paypal.api.payments.Refund
Description of what is being refunded for.
getDescription() - Method in class com.paypal.api.payments.RefundRequest
Description of what is being refunded for.
getDetails() - Method in class com.paypal.api.payments.Amount
Additional details of the payment amount.
getDetails() - Method in class com.paypal.api.payments.Error
Additional details of the error
getDetails() - Method in exception com.paypal.base.rest.PayPalRESTException
 
getDiscount() - Method in class com.paypal.api.payments.Invoice
The invoice level discount, as a percent or an amount value.
getDiscount() - Method in class com.paypal.api.payments.InvoiceItem
The item discount, as a percent or an amount value.
getDiscount() - Method in class com.paypal.api.payments.TemplateData
The invoice level discount, as a percent or an amount value.
getDiscountAmount() - Method in class com.paypal.api.payments.InstallmentOption
Discount amount applied to the payment, if any
getDiscountPercentage() - Method in class com.paypal.api.payments.InstallmentOption
Discount percentage applied to the payment, if any
getDisplayPreference() - Method in class com.paypal.api.payments.TemplateSettings
Settings metadata for each field.
getDisplayText() - Method in class com.paypal.api.payments.ExternalFunding
Description of the external funding being applied
getDueDate() - Method in class com.paypal.api.payments.PaymentTerm
The date when the invoice payment is due.
getEci() - Method in class com.paypal.api.payments.Card3dSecureInfo
Numeric flag to indicate how the payment should be processed in relationship to 3d-secure.
getEciSubmitted() - Method in class com.paypal.api.payments.ProcessorResponse
Response back from the authorization.
getEmail() - Method in class com.paypal.api.openidconnect.Userinfo
End-User's preferred e-mail address.
getEmail() - Method in class com.paypal.api.payments.BillingInfo
The invoice recipient email address.
getEmail() - Method in class com.paypal.api.payments.InvoicingSearch
Initial letters of the email address.
getEmail() - Method in class com.paypal.api.payments.MerchantInfo
The merchant email address.
getEmail() - Method in class com.paypal.api.payments.Participant
The participant email address.
getEmail() - Method in class com.paypal.api.payments.Payee
Email Address associated with the Payee's PayPal Account.
getEmail() - Method in class com.paypal.api.payments.PayerInfo
Email address representing the payer.
getEmail() - Method in class com.paypal.api.payments.PayerNotification
Email Address associated with the Payer's PayPal Account.
getEmail() - Method in class com.paypal.api.payments.PotentialPayerInfo
Email address representing the potential payer.
getEmail() - Method in class com.paypal.api.payments.Search
The initial letters of the email address.
getEmails() - Method in class com.paypal.api.payments.Templates
List of emails in merchant's profile.
getEmailSubject() - Method in class com.paypal.api.payments.PayoutSenderBatchHeader
The subject line text for the email that PayPal sends when a payout item completes.
getEmailVerified() - Method in class com.paypal.api.openidconnect.Userinfo
True if the End-User's e-mail address has been verified; otherwise false.
getEncodedLength(byte[]) - Method in class com.paypal.base.codec.binary.BaseNCodec
Calculates the amount of space needed to encode the supplied array.
getEncType() - Method in class com.paypal.api.payments.DefinitionsLinkdescription
The media type in which to submit data along with the request
getEnctype() - Method in class com.paypal.api.payments.Links
 
getEndCreationDate() - Method in class com.paypal.api.payments.InvoicingSearch
End invoice creation date.
getEndCreationDate() - Method in class com.paypal.api.payments.Search
The end creation date for the invoice.
getEndDueDate() - Method in class com.paypal.api.payments.InvoicingSearch
End invoice due date.
getEndDueDate() - Method in class com.paypal.api.payments.Search
The end due date for the invoice.
getEndInvoiceDate() - Method in class com.paypal.api.payments.InvoicingSearch
End invoice date.
getEndInvoiceDate() - Method in class com.paypal.api.payments.Search
The end date for the invoice.
getEndPaymentDate() - Method in class com.paypal.api.payments.InvoicingSearch
End invoice payment date.
getEndPaymentDate() - Method in class com.paypal.api.payments.Search
The end payment date for the invoice.
getEndPoint() - Method in interface com.paypal.base.APICallPreHandler
Returns the endpoint for the API call.
getEndPoint() - Method in class com.paypal.base.rest.RESTAPICallPreHandler
 
getEndPointUrl() - Method in class com.paypal.base.HttpConfiguration
 
getError() - Method in class com.paypal.api.openidconnect.Error
Getter for error
getError() - Method in class com.paypal.api.payments.PayoutItemDetails
Getter for error.
getError() - Method in exception com.paypal.base.exception.OAuthException
 
getErrorDescription() - Method in class com.paypal.api.openidconnect.Error
Getter for errorDescription
getErrorResponse() - Method in exception com.paypal.base.exception.HttpErrorException
 
getErrors() - Method in class com.paypal.api.payments.PayoutBatchHeader
 
getErrors() - Method in class com.paypal.api.payments.PayoutItemDetails
 
getErrorUri() - Method in class com.paypal.api.openidconnect.Error
Getter for errorUri
getEvents() - Method in class com.paypal.api.payments.EventList
A list of Webhooks event resources
getEventType() - Method in class com.paypal.api.payments.Event
Name of the event type that occurred on resource, identified by data_resource element, to trigger the Webhooks event.
getEventTypes() - Method in class com.paypal.api.payments.EventTypeList
A list of Webhooks event-types
getEventTypes() - Method in class com.paypal.api.payments.Webhook
A list of up to ten events to which to subscribe your webhook.
getExchangeRate() - Method in class com.paypal.api.payments.Sale
Exchange rate applied for this transaction.
getExperienceProfileId() - Method in class com.paypal.api.payments.Payment
PayPal generated identifier for the merchant's payment experience profile.
getExpireMonth() - Method in class com.paypal.api.payments.CreditCard
Expiration month with no leading zero.
getExpireMonth() - Method in class com.paypal.api.payments.CreditCardToken
Expiration month with no leading zero.
getExpireMonth() - Method in class com.paypal.api.payments.PaymentCard
The two-digit expiry month for the card.
getExpireMonth() - Method in class com.paypal.api.payments.PaymentCardToken
card expiry month from the saved card with value 1 - 12
getExpires() - Method in class com.paypal.base.rest.AccessToken
 
getExpiresIn() - Method in class com.paypal.api.openidconnect.Tokeninfo
Getter for expiresIn
getExpireYear() - Method in class com.paypal.api.payments.CreditCard
4-digit expiration year.
getExpireYear() - Method in class com.paypal.api.payments.CreditCardToken
4-digit expiration year.
getExpireYear() - Method in class com.paypal.api.payments.PaymentCard
The four-digit expiry year for the card.
getExpireYear() - Method in class com.paypal.api.payments.PaymentCardToken
4 digit card expiry year from the saved card
getExpiryDate() - Method in class com.paypal.api.payments.Incentive
expiry date of the incentive.
getExtension() - Method in class com.paypal.api.payments.Phone
Phone extension
getExternalCustomerId() - Method in class com.paypal.api.payments.AlternatePayment
The unique identifier of the payer
getExternalCustomerId() - Method in class com.paypal.api.payments.BankAccount
A unique identifier of the customer to whom this bank account belongs to.
getExternalCustomerId() - Method in class com.paypal.api.payments.BankToken
The unique identifier of the payer used when saving this bank using /vault/bank API.
getExternalCustomerId() - Method in class com.paypal.api.payments.CarrierAccount
The ID of the customer, as created by the merchant.
getExternalCustomerId() - Method in class com.paypal.api.payments.CarrierAccountToken
The unique identifier of the payer used when saving this carrier account instrument.
getExternalCustomerId() - Method in class com.paypal.api.payments.CreditCard
A unique identifier of the customer to whom this bank account belongs.
getExternalCustomerId() - Method in class com.paypal.api.payments.PaymentCard
The ID of the customer who owns this card account.
getExternalCustomerId() - Method in class com.paypal.api.payments.PaymentCardToken
The unique identifier of the payer used when saving this payment card.
getExternalFunding() - Method in class com.paypal.api.payments.CartBase
List of external funding being applied to the purchase unit.
getExternalFunding() - Method in class com.paypal.api.payments.FundingInstrument
External funding instrument.
getExternalRememberMeId() - Method in class com.paypal.api.payments.PayerInfo
External Remember Me id representing the payer
getExternalRememberMeId() - Method in class com.paypal.api.payments.PotentialPayerInfo
ExternalRememberMe id representing the potential payer
getExternalSelectedFundingInstrumentType() - Method in class com.paypal.api.payments.Payer
Instrument type pre-selected by the user outside of PayPal and passed along the payment creation.
getFailedPaymentCount() - Method in class com.paypal.api.payments.AgreementDetails
Total number of failed payments for this agreement.
getFailedTransactions() - Method in class com.paypal.api.payments.Payment
Applicable for advanced payments like multi seller payment (MSP) to support partial failures
getFailureReason() - Method in class com.paypal.api.payments.Payment
Failure reason code returned when the payment failed for some valid reasons.
getFamilyName() - Method in class com.paypal.api.openidconnect.Userinfo
Surname(s) or last name(s) of the End-User.
getFax() - Method in class com.paypal.api.payments.MerchantInfo
The merchant fax number.
getFax() - Method in class com.paypal.api.payments.Participant
The participant fax number.
getFee() - Method in class com.paypal.api.payments.Details
Fee charged by PayPal.
getFeeAmount() - Method in class com.paypal.api.payments.AgreementTransaction
Fee amount for this transaction.
getFees() - Method in class com.paypal.api.payments.PayoutBatchHeader
Total estimate in U.S.
getField() - Method in class com.paypal.api.payments.ErrorDetails
Name of the field that caused the error.
getFieldName() - Method in class com.paypal.api.payments.TemplateSettings
The field name (for any field in template_data) for which the corresponding display preferences will be mapped to.
getFilterId() - Method in class com.paypal.api.payments.FmfDetails
Filter Identifier.
getFilterType() - Method in class com.paypal.api.payments.FmfDetails
Type of filter.
getFinalPaymentDate() - Method in class com.paypal.api.payments.AgreementDetails
Last payment date for this agreement, represented as 2015-02-19T10:00:00Z format.
getFirstName() - Method in class com.paypal.api.payments.BankAccount
Account holder's first name.
getFirstName() - Method in class com.paypal.api.payments.BillingInfo
The invoice recipient first name.
getFirstName() - Method in class com.paypal.api.payments.CreditCard
Cardholder's first name.
getFirstName() - Method in class com.paypal.api.payments.MerchantInfo
The merchant first name.
getFirstName() - Method in class com.paypal.api.payments.Participant
The participant first name.
getFirstName() - Method in class com.paypal.api.payments.Payee
First Name of the Payee.
getFirstName() - Method in class com.paypal.api.payments.PayerInfo
First name of the payer.
getFirstName() - Method in class com.paypal.api.payments.PaymentCard
The first name of the card holder.
getFirstName() - Method in class com.paypal.api.payments.ShippingInfo
The invoice recipient first name.
getFirstSentDate() - Method in class com.paypal.api.payments.InvoicingMetaData
Date when the resource was first sent.
getFirstSentDate() - Method in class com.paypal.api.payments.Metadata
The date and time when the resource was first sent.
getFlowConfig() - Method in class com.paypal.api.payments.WebProfile
Parameters for flow configuration.
getFmfDetails() - Method in class com.paypal.api.payments.Authorization
Fraud Management Filter (FMF) details applied for the payment that could result in accept, deny, or pending action.
getFmfDetails() - Method in class com.paypal.api.payments.Error
Deprecated.
This property is not available publicly Fraud filter details. Only supported when the `payment_method` is set to `credit_card`
getFmfDetails() - Method in class com.paypal.api.payments.Order
Fraud Management Filter (FMF) details applied for the payment that could result in accept/deny/pending action.
getFmfDetails() - Method in class com.paypal.api.payments.Sale
Fraud Management Filter (FMF) details applied for the payment that could result in accept, deny, or pending action.
getFragmentResolution() - Method in class com.paypal.api.payments.HyperSchema
 
getFrequency() - Method in class com.paypal.api.payments.PaymentDefinition
Frequency of the payment definition offered.
getFrequencyInterval() - Method in class com.paypal.api.payments.PaymentDefinition
How frequently the customer should be charged.
getFrom() - Method in class com.paypal.api.payments.Patch
A string containing a JSON Pointer value that references the location in the target document to move the value from.
getFrom() - Method in class com.paypal.api.payments.PatchRequest
A string containing a JSON Pointer value that references the location in the target document to move the value from.
getFromAmount() - Method in class com.paypal.api.payments.CurrencyConversion
Amount participating in currency conversion, set to 1 as default
getFromCurrency() - Method in class com.paypal.api.payments.CurrencyConversion
3 letter currency code
getFundingAccountId() - Method in class com.paypal.api.payments.ExternalFunding
Encrypted PayPal Account identifier for the funding account
getFundingInstruction() - Method in class com.paypal.api.payments.ExternalFunding
Indicates that the Payment should be fully funded by External Funded Incentive
getFundingInstruments() - Method in class com.paypal.api.payments.Payer
List of funding instruments to fund the payment.
getFundingOption() - Method in class com.paypal.api.payments.Payer
Deprecated.
getFundingOptionId() - Method in class com.paypal.api.payments.Payer
Id of user selected funding option for the payment.'OneOf' funding_instruments,funding_option_id to be used to identify the specifics of payment method passed.
getFundingSources() - Method in class com.paypal.api.payments.FundingOption
List of funding sources that contributes to a payment.
getGender() - Method in class com.paypal.api.openidconnect.Userinfo
End-User's gender.
getGiftWrap() - Method in class com.paypal.api.payments.Details
Amount being charged as gift wrap fee.
getGivenName() - Method in class com.paypal.api.openidconnect.Userinfo
Given name(s) or first name(s) of the End-User
getGratuity() - Method in class com.paypal.api.payments.Invoice
Gratuity to include with the invoice.
getHandlingFee() - Method in class com.paypal.api.payments.Details
Amount being charged for the handling fee.
getHeader(String) - Method in class com.paypal.base.rest.OAuthTokenCredential
Returns the header value
getHeader() - Method in class com.paypal.base.util.UserAgentHeader
 
getHeaderMap() - Method in interface com.paypal.base.APICallPreHandler
Returns headers for HTTP call
getHeaderMap() - Method in class com.paypal.base.rest.RESTAPICallPreHandler
Returns HTTP headers as a Map
getHeaders() - Method in class com.paypal.base.rest.OAuthTokenCredential
Returns the list of headers
getHeadersMap() - Method in class com.paypal.base.rest.APIContext
Deprecated.
Use getHTTPHeaders() instead
getHeight() - Method in class com.paypal.api.payments.Item
Height of the item.
getHidden() - Method in class com.paypal.api.payments.TemplateSettingsMetadata
Indicates whether this field should be hidden.
getHref() - Method in class com.paypal.api.payments.DefinitionsLinkdescription
a URI template, as defined by RFC 6570, with the addition of the $, ( and ) characters for pre-processing
getHref() - Method in class com.paypal.api.payments.Links
 
getHTTPHeader(String) - Method in class com.paypal.base.rest.APIContext
 
getHTTPHeaders() - Method in class com.paypal.base.rest.APIContext
Returns HTTP Headers.
getHttpMethod() - Method in class com.paypal.base.HttpConfiguration
 
getId() - Method in class com.paypal.api.payments.Agreement
Identifier of the agreement.
getId() - Method in class com.paypal.api.payments.Authorization
ID of the authorization transaction.
getId() - Method in class com.paypal.api.payments.BankAccount
ID of the bank account being saved for later use.
getId() - Method in class com.paypal.api.payments.Capture
The ID of the capture transaction.
getId() - Method in class com.paypal.api.payments.CarrierAccount
The ID of the carrier account of the payer.
getId() - Method in class com.paypal.api.payments.ChargeModels
Identifier of the charge model.
getId() - Method in class com.paypal.api.payments.Credit
Unique identifier of credit resource.
getId() - Method in class com.paypal.api.payments.CreditCard
ID of the credit card.
getId() - Method in class com.paypal.api.payments.Event
Identifier of the Webhooks event resource.
getId() - Method in class com.paypal.api.payments.FundingOption
id of the funding option.
getId() - Method in class com.paypal.api.payments.Incentive
Identifier of the instrument in PayPal Wallet
getId() - Method in class com.paypal.api.payments.Invoice
The unique invoice resource identifier.
getId() - Method in class com.paypal.api.payments.MerchantPreferences
Identifier of the merchant_preferences.
getId() - Method in class com.paypal.api.payments.Order
Identifier of the order transaction.
getId() - Method in class com.paypal.api.payments.Payment
Identifier of the payment resource created.
getId() - Method in class com.paypal.api.payments.PaymentCard
The ID of a credit card to save for later use.
getId() - Method in class com.paypal.api.payments.PaymentDefinition
Identifier of the payment_definition.
getId() - Method in class com.paypal.api.payments.Plan
Identifier of the billing plan.
getId() - Method in class com.paypal.api.payments.PrivateLabelCard
encrypted identifier of the private label card instrument.
getId() - Method in class com.paypal.api.payments.Refund
ID of the refund transaction.
getId() - Method in class com.paypal.api.payments.Sale
Identifier of the sale transaction.
getId() - Method in class com.paypal.api.payments.ShippingAddress
Address ID assigned in PayPal system.
getId() - Method in class com.paypal.api.payments.Tax
The resource ID.
getId() - Method in class com.paypal.api.payments.Terms
Identifier of the terms.
getId() - Method in class com.paypal.api.payments.Webhook
The ID of the webhook.
getId() - Method in class com.paypal.api.payments.WebProfile
The unique ID of the web experience profile.
getImage() - Method in class com.paypal.api.payments.Image
Image as base64 encoded String
getImageKey() - Method in class com.paypal.api.payments.PrivateLabelCard
This value indicates URL to access PLCC program logo image
getImageUrl() - Method in class com.paypal.api.payments.InvoiceItem
The image URL.
getIncentive() - Method in class com.paypal.api.payments.FundingInstrument
Incentive funding instrument.
getInformationLink() - Method in class com.paypal.api.payments.Error
URI for detailed information related to this error for the developer.
getInitialFailAmountAction() - Method in class com.paypal.api.payments.MerchantPreferences
Action to take if a failure occurs during initial payment.
getInputFields() - Method in class com.paypal.api.payments.WebProfile
Parameters for input fields customization.
getInputStream() - Method in class com.paypal.base.util.ResourceLoader
 
getInstallmentId() - Method in class com.paypal.api.payments.InstallmentInfo
Installment id.
getInstallmentInfo() - Method in class com.paypal.api.payments.FundingOption
Installment options available for a funding option.
getInstallmentOptions() - Method in class com.paypal.api.payments.InstallmentInfo
List of available installment options and the cost associated with each one.
getInstance() - Static method in class com.paypal.base.ConfigManager
Singleton accessor method
getInstance() - Static method in class com.paypal.base.ConnectionManager
Singleton accessor method
getInstructionType() - Method in class com.paypal.api.payments.PaymentInstruction
Type of payment instruction
getInsurance() - Method in class com.paypal.api.payments.Details
Amount being charged for the insurance fee.
getIntent() - Method in class com.paypal.api.payments.Payment
Payment intent.
getInternationalBankAccountNumber() - Method in class com.paypal.api.payments.RecipientBankingInstruction
IBAN equivalent of the bank
getInvoiceDate() - Method in class com.paypal.api.payments.Invoice
The date when the invoice was enabled.
getInvoiceNumber() - Method in class com.paypal.api.payments.Capture
The invoice number to track this payment.
getInvoiceNumber() - Method in class com.paypal.api.payments.CartBase
invoice number to track this payment
getInvoiceNumber() - Method in class com.paypal.api.payments.Refund
Your own invoice or tracking ID number.
getInvoiceNumber() - Method in class com.paypal.api.payments.RefundRequest
The invoice number that is used to track this payment.
getInvoices() - Method in class com.paypal.api.payments.Invoices
List of invoices belonging to a merchant.
getIpAddress() - Method in class com.paypal.base.HttpConfiguration
 
getIsDefault() - Method in class com.paypal.api.payments.Template
Indicates that this template is merchant's default.
getIsFinalCapture() - Method in class com.paypal.api.payments.Capture
Indicates whether to release all remaining funds that the authorization holds in the funding instrument.
getIsNonPlatformTransaction() - Method in class com.paypal.api.payments.RefundRequest
It indicates that the resource id passed is not processed by payments platform
getIssue() - Method in class com.paypal.api.payments.ErrorDetails
Reason for the error.
getIssueNumber() - Method in class com.paypal.api.payments.PaymentCard
The one- to two-digit card issue number.
getIssuer() - Method in class com.paypal.api.payments.InstallmentInfo
Credit card issuer.
getIssuerId() - Method in class com.paypal.api.payments.PrivateLabelCard
Merchants providing private label store cards have associated issuer account.
getIssuerName() - Method in class com.paypal.api.payments.PrivateLabelCard
Merchants providing private label store cards have associated issuer account.
getItemList() - Method in class com.paypal.api.payments.CartBase
List of items being paid for.
getItems() - Method in class com.paypal.api.payments.CreditCardHistory
A list of credit card resources
getItems() - Method in class com.paypal.api.payments.Invoice
The list of items to include in the invoice.
getItems() - Method in class com.paypal.api.payments.ItemList
List of items.
getItems() - Method in class com.paypal.api.payments.Payout
An array of payout items (that is, a set of individual payouts).
getItems() - Method in class com.paypal.api.payments.PayoutBatch
An array of items in a batch payout.
getItems() - Method in class com.paypal.api.payments.TemplateData
The list of items to include in the invoice.
getLabel() - Method in class com.paypal.api.payments.CustomAmount
The custom amount label.
getLandingPageType() - Method in class com.paypal.api.payments.FlowConfig
The type of landing page to display on the PayPal site for user checkout.
getLanguage() - Method in class com.paypal.api.payments.BillingInfo
The language in which the email was sent to the payer.
getLast4() - Method in class com.paypal.api.payments.CreditCardToken
Last four digits of the stored credit card number.
getLast4() - Method in class com.paypal.api.payments.PaymentCardToken
Last 4 digits of the card number from the saved card.
getLastName() - Method in class com.paypal.api.payments.BankAccount
Account holder's last name.
getLastName() - Method in class com.paypal.api.payments.BillingInfo
The invoice recipient last name.
getLastName() - Method in class com.paypal.api.payments.CreditCard
Cardholder's last name.
getLastName() - Method in class com.paypal.api.payments.MerchantInfo
The merchant last name.
getLastName() - Method in class com.paypal.api.payments.Participant
The participant last name.
getLastName() - Method in class com.paypal.api.payments.Payee
Last Name of the Payee.
getLastName() - Method in class com.paypal.api.payments.PayerInfo
Last name of the payer.
getLastName() - Method in class com.paypal.api.payments.PaymentCard
The last name of the card holder.
getLastName() - Method in class com.paypal.api.payments.ShippingInfo
The invoice recipient last name.
getLastPaymentAmount() - Method in class com.paypal.api.payments.AgreementDetails
Last payment amount for this agreement.
getLastPaymentDate() - Method in class com.paypal.api.payments.AgreementDetails
Last payment date for this agreement, represented as 2014-06-09T09:42:31Z format.
getLastRequest() - Static method in class com.paypal.base.rest.PayPalResource
Returns the last request sent to the Service
getLastResponse() - Static method in class com.paypal.base.rest.PayPalResource
Returns the last response returned by the Service
getLastSentBy() - Method in class com.paypal.api.payments.InvoicingMetaData
Email address of the account that last sent the resource.
getLastSentBy() - Method in class com.paypal.api.payments.Metadata
The email address of the account that last sent the resource.
getLastSentDate() - Method in class com.paypal.api.payments.InvoicingMetaData
Date when the resource was last sent.
getLastSentDate() - Method in class com.paypal.api.payments.Metadata
The date and time when the resource was last sent.
getLastUpdatedBy() - Method in class com.paypal.api.payments.InvoicingMetaData
Email address of the account that last edited the resource.
getLastUpdatedBy() - Method in class com.paypal.api.payments.Metadata
The email address of the account that last edited the resource.
getLastUpdatedDate() - Method in class com.paypal.api.payments.InvoicingMetaData
Date when the resource was last edited.
getLastUpdatedDate() - Method in class com.paypal.api.payments.Metadata
The date and time when the resource was last edited.
getLength() - Method in class com.paypal.api.payments.Item
Length of the item.
getLine1() - Method in class com.paypal.api.payments.BaseAddress
Line 1 of the Address (eg.
getLine2() - Method in class com.paypal.api.payments.BaseAddress
Optional line 2 of the Address (eg.
getLinks() - Method in class com.paypal.api.payments.Agreement
 
getLinks() - Method in class com.paypal.api.payments.Authorization
 
getLinks() - Method in class com.paypal.api.payments.BankAccount
 
getLinks() - Method in class com.paypal.api.payments.Capture
 
getLinks() - Method in class com.paypal.api.payments.CreditCard
 
getLinks() - Method in class com.paypal.api.payments.CreditCardHistory
HATEOAS links related to this call.
getLinks() - Method in class com.paypal.api.payments.CurrencyConversion
 
getLinks() - Method in class com.paypal.api.payments.Error
Links
getLinks() - Method in class com.paypal.api.payments.Event
Hateoas links.
getLinks() - Method in class com.paypal.api.payments.EventList
 
getLinks() - Method in class com.paypal.api.payments.FundingOption
 
getLinks() - Method in class com.paypal.api.payments.HyperSchema
 
getLinks() - Method in class com.paypal.api.payments.Invoice
HATEOS links representing all the actions over the invoice resource based on the current invoice status.
getLinks() - Method in class com.paypal.api.payments.Order
 
getLinks() - Method in class com.paypal.api.payments.Payment
 
getLinks() - Method in class com.paypal.api.payments.PaymentCard
 
getLinks() - Method in class com.paypal.api.payments.PaymentInstruction
 
getLinks() - Method in class com.paypal.api.payments.Payout
 
getLinks() - Method in class com.paypal.api.payments.PayoutBatch
 
getLinks() - Method in class com.paypal.api.payments.PayoutBatchHeader
 
getLinks() - Method in class com.paypal.api.payments.PayoutItemDetails
The HATEOAS links related to the call.
getLinks() - Method in class com.paypal.api.payments.Plan
 
getLinks() - Method in class com.paypal.api.payments.PlanList
 
getLinks() - Method in class com.paypal.api.payments.Refund
 
getLinks() - Method in class com.paypal.api.payments.Sale
 
getLinks() - Method in class com.paypal.api.payments.Templates
HATEOS links representing all the actions over the template list returned.
getLinks() - Method in class com.paypal.api.payments.Webhook
The HATEOAS links related to this call.
getList(String) - Static method in class com.paypal.api.payments.WebProfile
Deprecated.
Please use WebProfile.getList(APIContext) instead.
getList(APIContext) - Static method in class com.paypal.api.payments.WebProfile
Lists all web experience profiles for a merchant or subject.
getLocale() - Method in class com.paypal.api.openidconnect.Userinfo
End-User's locale.
getLocaleCode() - Method in class com.paypal.api.payments.Presentation
The locale of pages displayed by PayPal payment experience.
getLocality() - Method in class com.paypal.api.openidconnect.Address
Getter for locality
getLogoImage() - Method in class com.paypal.api.payments.Presentation
A URL to the logo image.
getLogoImageUrl() - Method in class com.paypal.api.payments.Incentive
Logo image url for the incentive.
getLogoUrl() - Method in class com.paypal.api.payments.Invoice
Full URL of an external image to use as the logo.
getLogoUrl() - Method in class com.paypal.api.payments.TemplateData
Full URL of an external image to use as the logo.
getLogoutUrl(String, String, APIContext) - Static method in class com.paypal.api.openidconnect.Session
Returns the URL to which the user must be redirected to logout from the OpenID provider (i.e.
getLowerTotalAmount() - Method in class com.paypal.api.payments.InvoicingSearch
Lower limit of total amount.
getLowerTotalAmount() - Method in class com.paypal.api.payments.Search
The lower limit of the total amount.
getMandateReferenceNumber() - Method in class com.paypal.api.payments.BankToken
Identifier of the direct debit mandate to validate.
getMandateReferenceNumber() - Method in class com.paypal.api.payments.ExtendedBankAccount
Identifier of the direct debit mandate to validate.
getMaxBillingAmount() - Method in class com.paypal.api.payments.Terms
Max Amount associated with this term.
getMaxFailAttempts() - Method in class com.paypal.api.payments.MerchantPreferences
Total number of failed attempts allowed.
getMaxHttpConnection() - Method in class com.paypal.base.HttpConfiguration
 
getMaxRetry() - Method in class com.paypal.base.HttpConfiguration
 
getMediaType() - Method in class com.paypal.api.payments.DefinitionsLinkdescription
media type (as defined by RFC 2046) describing the link target
getMediaType() - Method in class com.paypal.api.payments.HyperSchema
 
getMerchantId() - Method in class com.paypal.api.payments.BankAccount
A unique identifier of the merchant for which this bank account has been stored for.
getMerchantId() - Method in class com.paypal.api.payments.Payee
Encrypted PayPal account identifier for the Payee.
getMerchantInfo() - Method in class com.paypal.api.payments.Invoice
Information about the merchant who is sending the invoice.
getMerchantInfo() - Method in class com.paypal.api.payments.TemplateData
Information about the merchant who is sending the invoice.
getMerchantMemo() - Method in class com.paypal.api.payments.Invoice
A private bookkeeping memo for the merchant.
getMerchantMemo() - Method in class com.paypal.api.payments.TemplateData
A private bookkeeping memo for the merchant.
getMerchantPreferences() - Method in class com.paypal.api.payments.Plan
Specific preferences such as: set up fee, max fail attempts, autobill amount, and others that are configured for this billing plan.
getMessage() - Method in class com.paypal.api.payments.Error
Message describing the error.
getMetadata() - Method in class com.paypal.api.payments.Invoice
Audit information for the invoice.
getMethod() - Method in class com.paypal.api.payments.DefinitionsLinkdescription
method for requesting the target of the link (e.g.
getMethod() - Method in class com.paypal.api.payments.InvoicingPaymentDetail
Payment mode or method.
getMethod() - Method in class com.paypal.api.payments.Links
 
getMethod() - Method in class com.paypal.api.payments.PaymentDetail
The payment mode or method.
getMiddleName() - Method in class com.paypal.api.openidconnect.Userinfo
Middle name(s) of the End-User.
getMiddleName() - Method in class com.paypal.api.payments.PayerInfo
Middle name of the payer.
getMinimumAmountDue() - Method in class com.paypal.api.payments.Invoice
If `allow_partial_payment` is set to `true`, the minimum amount allowed for a partial payment.
getMinimumAmountDue() - Method in class com.paypal.api.payments.TemplateData
If `allow_partial_payment` is set to `true`, the minimum amount allowed for a partial payment.
getMinimumPurchaseAmount() - Method in class com.paypal.api.payments.Incentive
Indicates incentive is applicable for this minimum purchase amount.
getMonthlyPayment() - Method in class com.paypal.api.payments.CreditFinancingOffered
This is the estimated amount per month that the customer will need to pay including fees and interest.
getMonthlyPayment() - Method in class com.paypal.api.payments.InstallmentOption
Monthly payment
getMpiVendor() - Method in class com.paypal.api.payments.Card3dSecureInfo
Name of the actual 3ds vendor who processed the 3ds request, e.g.
getName() - Method in class com.paypal.api.openidconnect.Userinfo
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.
getName() - Method in class com.paypal.api.payments.Agreement
Name of the agreement.
getName() - Method in class com.paypal.api.payments.Error
Human readable, unique name of the error.
getName() - Method in class com.paypal.api.payments.EventType
Unique event-type name.
getName() - Method in class com.paypal.api.payments.FileAttachment
Name of the file attached.
getName() - Method in class com.paypal.api.payments.FmfDetails
Name of the filter
getName() - Method in class com.paypal.api.payments.Incentive
Name of the incentive.
getName() - Method in class com.paypal.api.payments.InvoiceItem
Name of the item.
getName() - Method in class com.paypal.api.payments.Item
Item name.
getName() - Method in class com.paypal.api.payments.NameValuePair
Key for the name value pair.
getName() - Method in class com.paypal.api.payments.PaymentDefinition
Name of the payment definition.
getName() - Method in class com.paypal.api.payments.Plan
Name of the billing plan.
getName() - Method in class com.paypal.api.payments.Tax
The tax name.
getName() - Method in class com.paypal.api.payments.Template
Name of the template.
getName() - Method in class com.paypal.api.payments.WebProfile
The web experience profile name.
getNationalNumber() - Method in class com.paypal.api.payments.Phone
In-country phone number (from in E.164 format)
getNetAmount() - Method in class com.paypal.api.payments.AgreementTransaction
Net amount for this transaction.
getNetwork() - Method in class com.paypal.api.payments.InstallmentInfo
Credit card network.
getNextBillingDate() - Method in class com.paypal.api.payments.AgreementDetails
The next billing date for this agreement, represented as 2014-02-19T10:00:00Z format.
getNextId() - Method in class com.paypal.api.payments.PaymentHistory
Identifier of the next element to get the next range of results.
getNormalizationStatus() - Method in class com.paypal.api.payments.BaseAddress
BaseAddress normalization status, returned only for payers from Brazil.
getNoShipping() - Method in class com.paypal.api.payments.InputFields
Indicates whether PayPal displays shipping address fields on the experience pages.
getNote() - Method in class com.paypal.api.payments.AgreementStateDescriptor
Reason for changing the state of the agreement.
getNote() - Method in class com.paypal.api.payments.CancelNotification
Note to the payer.
getNote() - Method in class com.paypal.api.payments.Invoice
Note to the payer.
getNote() - Method in class com.paypal.api.payments.InvoicingNotification
Note to the payer.
getNote() - Method in class com.paypal.api.payments.InvoicingPaymentDetail
Optional note associated with the payment.
getNote() - Method in class com.paypal.api.payments.InvoicingRefundDetail
Optional note associated with the refund.
getNote() - Method in class com.paypal.api.payments.Notification
Note to the payer.
getNote() - Method in class com.paypal.api.payments.PaymentDetail
Optional.
getNote() - Method in class com.paypal.api.payments.PaymentInstruction
Additional text regarding payment handling
getNote() - Method in class com.paypal.api.payments.PayoutItem
Optional.
getNote() - Method in class com.paypal.api.payments.RefundDetail
Optional note associated with the refund.
getNote() - Method in class com.paypal.api.payments.TemplateData
Note to the payer.
getNoteToPayee() - Method in class com.paypal.api.payments.CartBase
Note to the recipient of the funds in this transaction.
getNoteToPayer() - Method in class com.paypal.api.payments.Payment
free-form field for the use of clients to pass in a message to the payer
getNoteToSellerLabel() - Method in class com.paypal.api.payments.Presentation
A label to use as the title for the note to seller field.
getNotificationChannel() - Method in class com.paypal.api.payments.BillingInfo
Preferred notification channel of the payer.
getNotifyUrl() - Method in class com.paypal.api.payments.CartBase
URL to send payment notifications
getNotifyUrl() - Method in class com.paypal.api.payments.MerchantPreferences
Notify URL on agreement creation.
getNumber() - Method in class com.paypal.api.payments.CreditCard
Credit card number.
getNumber() - Method in class com.paypal.api.payments.Invoice
Unique number that appears on the invoice.
getNumber() - Method in class com.paypal.api.payments.InvoiceNumber
The next invoice number
getNumber() - Method in class com.paypal.api.payments.InvoicingSearch
The invoice number that appears on the invoice.
getNumber() - Method in class com.paypal.api.payments.PaymentCard
The card number.
getNumber() - Method in class com.paypal.api.payments.Search
The invoice number.
getNumOfAcct() - Method in class com.paypal.base.ConfigManager
Deprecated.
This code is not used anymore. This was used for older sdk_config.properties parsing.
getOAuthHttpConfiguration() - Method in class com.paypal.base.rest.OAuthTokenCredential
 
getOAuthTokenCredential() - Static method in class com.paypal.base.rest.PayPalResource
Returns OAuthTokenCredential instance using client ID and client secret loaded from configuration.
getOccurrences() - Method in class com.paypal.api.payments.Terms
How many times money can be pulled during this term.
getOp() - Method in class com.paypal.api.payments.Patch
The operation to perform.
getOp() - Method in class com.paypal.api.payments.PatchRequest
The operation to perform.
getOrder() - Method in class com.paypal.api.payments.RelatedResources
Order transaction
getOrderUrl() - Method in class com.paypal.api.payments.CartBase
Url on merchant site pertaining to this payment.
getOther() - Method in class com.paypal.api.payments.PaymentSummary
Total Amount paid/refunded via other sources.
getOutstandingBalance() - Method in class com.paypal.api.payments.AgreementDetails
The outstanding balance for this agreement.
getOverrideChargeModels() - Method in class com.paypal.api.payments.Agreement
Array of override_charge_model for this agreement if needed to change the default models from the billing plan.
getOverrideMerchantPreferences() - Method in class com.paypal.api.payments.Agreement
Default merchant preferences from the billing plan are used, unless override preferences are provided here.
getPage() - Method in class com.paypal.api.payments.InvoicingSearch
Offset of the search results.
getPage() - Method in class com.paypal.api.payments.Search
The offset for the search results.
getPageSize() - Method in class com.paypal.api.payments.InvoicingSearch
Page size of the search results.
getPageSize() - Method in class com.paypal.api.payments.Search
The page size for the search results.
getPaidAmount() - Method in class com.paypal.api.payments.Invoice
Payment summary of the invoice including amount paid through PayPal and other sources.
getParentPayment() - Method in class com.paypal.api.payments.Authorization
ID of the Payment resource that this transaction is based on.
getParentPayment() - Method in class com.paypal.api.payments.Capture
The ID of the payment on which this transaction is based.
getParentPayment() - Method in class com.paypal.api.payments.Order
ID of the Payment resource that this transaction is based on.
getParentPayment() - Method in class com.paypal.api.payments.Refund
ID of the payment resource on which this transaction is based.
getParentPayment() - Method in class com.paypal.api.payments.Sale
ID of the payment resource on which this transaction is based.
getPath() - Method in class com.paypal.api.payments.Patch
A JSON pointer that references a location in the target document where the operation is performed.
getPath() - Method in class com.paypal.api.payments.PatchRequest
string containing a JSON-Pointer value that references a location within the target document (the target location) where the operation is performed.
getPathStart() - Method in class com.paypal.api.payments.HyperSchema
 
getPayee() - Method in class com.paypal.api.payments.CartBase
Recipient of the funds in this transaction.
getPayee() - Method in class com.paypal.api.payments.Payment
Receiver of funds for this payment.
getPayer() - Method in class com.paypal.api.payments.Agreement
Details of the buyer who is enrolling in this agreement.
getPayer() - Method in class com.paypal.api.payments.Payment
Source of the funds for this payment represented by a PayPal account or a direct credit card.
getPayerAcceptance() - Method in class com.paypal.api.payments.CreditFinancingOffered
Status on whether the customer ultimately was approved for and chose to make the payment using the approved installment credit.
getPayerEmail() - Method in class com.paypal.api.payments.AgreementTransaction
Email id of payer.
getPayerId() - Method in class com.paypal.api.openidconnect.Userinfo
Account payer identifier.
getPayerId() - Method in class com.paypal.api.payments.BankAccount
[DEPRECATED] Use external_customer_id instead.
getPayerId() - Method in class com.paypal.api.payments.CreditCard
Payer ID
getPayerId() - Method in class com.paypal.api.payments.CreditCardToken
A unique identifier that you can assign and track when storing a credit card or using a stored credit card.
getPayerId() - Method in class com.paypal.api.payments.PayerInfo
PayPal assigned encrypted Payer ID.
getPayerId() - Method in class com.paypal.api.payments.PaymentExecution
The ID of the Payer, passed in the `return_url` by PayPal.
getPayerInfo() - Method in class com.paypal.api.payments.Payer
Information related to the Payer.
getPayerName() - Method in class com.paypal.api.payments.AgreementTransaction
Business name of payer.
getPayerViewUrl() - Method in class com.paypal.api.payments.Metadata
URL representing the payer's view of the invoice.
getPayLoad() - Method in interface com.paypal.base.APICallPreHandler
Returns the payload for the API call.
getPayLoad() - Method in class com.paypal.base.rest.RESTAPICallPreHandler
 
getPaymentCard() - Method in class com.paypal.api.payments.FundingInstrument
Payment Card information.
getPaymentCardId() - Method in class com.paypal.api.payments.PaymentCardToken
ID of a previously saved Payment Card resource.
getPaymentDebitDate() - Method in class com.paypal.api.payments.FundingDetail
Date when funds will be debited from the payer's account
getPaymentDefinitions() - Method in class com.paypal.api.payments.Plan
Array of payment definitions for this billing plan.
getPaymentDetails() - Method in class com.paypal.api.payments.Invoice
Deprecated.
Please use Invoice.getPayments() instead.
getPaymentDueDate() - Method in class com.paypal.api.payments.PaymentInstruction
Date by which payment should be received
getPaymentHoldDate() - Method in class com.paypal.api.payments.FundingDetail
[DEPRECATED] Hold-off duration of the payment.
getPaymentHoldReasons() - Method in class com.paypal.api.payments.Sale
Reasons for PayPal holding recipient fund.
getPaymentHoldStatus() - Method in class com.paypal.api.payments.Sale
Status of the Recipient Fund.
getPaymentInstruction() - Method in class com.paypal.api.payments.Payment
Instructions for the payer to complete this payment.
getPaymentMethod() - Method in class com.paypal.api.payments.Payer
Payment method being used - PayPal Wallet payment, Bank Direct Debit or Direct Credit card.
getPaymentMode() - Method in class com.paypal.api.payments.Authorization
Specifies the payment mode of the transaction.
getPaymentMode() - Method in class com.paypal.api.payments.Order
specifies payment mode of the transaction
getPaymentMode() - Method in class com.paypal.api.payments.Sale
Specifies payment mode of the transaction.
getPaymentOptions() - Method in class com.paypal.api.payments.CartBase
Payment options requested for this purchase unit
getPayments() - Method in class com.paypal.api.payments.Invoice
List of payment details for the invoice.
getPayments() - Method in class com.paypal.api.payments.PaymentHistory
A list of Payment resources
getPaymentTerm() - Method in class com.paypal.api.payments.Invoice
Optional.
getPaymentTerm() - Method in class com.paypal.api.payments.TemplateData
Optional.
getPayoutBatchId() - Method in class com.paypal.api.payments.PayoutBatchHeader
The PayPal-generated ID for a batch payout.
getPayoutBatchId() - Method in class com.paypal.api.payments.PayoutItemDetails
The PayPal-generated ID for the batch payout.
getPayoutItem() - Method in class com.paypal.api.payments.PayoutItemDetails
The sender-provided information for the payout item.
getPayoutItemFee() - Method in class com.paypal.api.payments.PayoutItemDetails
The amount of money, in U.S.
getPayoutItemId() - Method in class com.paypal.api.payments.PayoutItemDetails
The ID for the payout item.
getPaypal() - Method in class com.paypal.api.payments.PaymentSummary
Total Amount paid/refunded via PayPal.
getPendingReason() - Method in class com.paypal.api.payments.Authorization
[DEPRECATED] Reason code for the transaction state being Pending.Obsolete.
getPendingReason() - Method in class com.paypal.api.payments.Order
Deprecated.
Reason code for the transaction state being Pending. Obsolete. Retained for backward compatability. Use reason_code field above instead.
getPercent() - Method in class com.paypal.api.payments.Cost
Cost in percent.
getPercent() - Method in class com.paypal.api.payments.Tax
The rate of the specified tax.
getPhone() - Method in class com.paypal.api.payments.Address
Phone number in E.123 format.
getPhone() - Method in class com.paypal.api.payments.BillingInfo
Mobile Phone number of the recipient to which SMS will be sent if notification_channel is SMS.
getPhone() - Method in class com.paypal.api.payments.InvoiceAddress
Phone number in E.123 format.
getPhone() - Method in class com.paypal.api.payments.MerchantInfo
The merchant phone number.
getPhone() - Method in class com.paypal.api.payments.Participant
The participant phone number.
getPhone() - Method in class com.paypal.api.payments.Payee
Information related to the Payee.
getPhone() - Method in class com.paypal.api.payments.PayerInfo
Phone number representing the payer.
getPhone() - Method in class com.paypal.api.payments.ShippingInfo
The invoice recipient phone number.
getPhoneNumber() - Method in class com.paypal.api.openidconnect.Userinfo
End-User's preferred telephone number.
getPhoneNumber() - Method in class com.paypal.api.payments.CarrierAccount
The phone number of the payer, in E.164 format.
getPhones() - Method in class com.paypal.api.payments.Templates
List of phone numbers in merchant's profile.
getPhoneSource() - Method in class com.paypal.api.payments.CarrierAccount
The method used to obtain the phone number.
getPhoneType() - Method in class com.paypal.api.payments.PayerInfo
Phone type
getPicture() - Method in class com.paypal.api.openidconnect.Userinfo
URL of the End-User's profile picture.
getPlan() - Method in class com.paypal.api.payments.Agreement
Plan details for this agreement.
getPlans() - Method in class com.paypal.api.payments.PlanList
Array of billing plans.
getPostalCode() - Method in class com.paypal.api.openidconnect.Address
Getter for postalCode
getPostalCode() - Method in class com.paypal.api.payments.BaseAddress
Zip code or equivalent is usually required for countries that have them.
getPostbackData() - Method in class com.paypal.api.payments.Item
Set of optional data used for PayPal post-transaction notifications.
getPotentialPayerInfo() - Method in class com.paypal.api.payments.Payment
Information that the merchant knows about the payer.
getPresentation() - Method in class com.paypal.api.payments.WebProfile
Parameters for style and presentation.
getPrice() - Method in class com.paypal.api.payments.Item
Item cost.
getPrivateLabelCard() - Method in class com.paypal.api.payments.FundingInstrument
Private Label Card funding instrument.
getProcessedHeaderMap() - Method in class com.paypal.base.rest.RESTAPICallPreHandler
Override this method to return a Map of HTTP headers
getProcessedPayLoad() - Method in class com.paypal.base.rest.RESTAPICallPreHandler
Override this method to process payload for processing
getProcessingType() - Method in class com.paypal.api.payments.FundingDetail
Processing type of the payment card
getProcessorResponse() - Method in class com.paypal.api.payments.Error
Deprecated.
This property is not available publicly response codes returned from a payment processor such as avs, cvv, etc. Only supported when the `payment_method` is set to `credit_card`.
getProcessorResponse() - Method in class com.paypal.api.payments.Sale
Response codes returned by the processor concerning the submitted payment.
getProtectionEligibility() - Method in class com.paypal.api.payments.Authorization
The level of seller protection in force for the transaction.
getProtectionEligibility() - Method in class com.paypal.api.payments.Order
The level of seller protection in force for the transaction.
getProtectionEligibility() - Method in class com.paypal.api.payments.Sale
The level of seller protection in force for the transaction.
getProtectionEligibilityType() - Method in class com.paypal.api.payments.Authorization
The kind of seller protection in force for the transaction.
getProtectionEligibilityType() - Method in class com.paypal.api.payments.Order
The kind of seller protection in force for the transaction.
getProtectionEligibilityType() - Method in class com.paypal.api.payments.Sale
The kind of seller protection in force for the transaction.
getProxyHost() - Method in class com.paypal.base.HttpConfiguration
 
getProxyPassword() - Method in class com.paypal.base.HttpConfiguration
 
getProxyPort() - Method in class com.paypal.base.HttpConfiguration
 
getProxyUserName() - Method in class com.paypal.base.HttpConfiguration
 
getPurchaseUnitReferenceId() - Method in class com.paypal.api.payments.Error
Deprecated.
This property is not available publicly Reference ID of the purchase_unit associated with this error
getPurchaseUnitReferenceId() - Method in class com.paypal.api.payments.ErrorDetails
Deprecated.
This property is not publicly available Reference ID of the purchase_unit associated with this error
getPurchaseUnitReferenceId() - Method in class com.paypal.api.payments.Order
Identifier to the purchase unit associated with this object.
getPurchaseUnitReferenceId() - Method in class com.paypal.api.payments.Sale
Identifier to the purchase or transaction unit corresponding to this sale transaction.
getPurchaseUnitReferenceId() - Method in class com.paypal.api.payments.TransactionBase
Identifier to the purchase unit corresponding to this sale transaction.
getQuantity() - Method in class com.paypal.api.payments.InvoiceItem
Quantity of the item.
getQuantity() - Method in class com.paypal.api.payments.Item
Number of a particular item.
getReadonly() - Method in class com.paypal.api.payments.HyperSchema
 
getReadTimeout() - Method in class com.paypal.base.HttpConfiguration
 
getReason() - Method in class com.paypal.api.payments.Refund
Reason description for the Sale transaction being refunded.
getReason() - Method in class com.paypal.api.payments.RefundRequest
Reason description for the Sale transaction being refunded.
getReasonCode() - Method in class com.paypal.api.payments.Authorization
Reason code, `AUTHORIZATION`, for a transaction state of `pending`.
getReasonCode() - Method in class com.paypal.api.payments.Capture
The reason code that describes why the transaction state is pending or reversed.
getReasonCode() - Method in class com.paypal.api.payments.Order
Reason code for the transaction state being Pending or Reversed.
getReasonCode() - Method in class com.paypal.api.payments.Refund
The reason code for the refund state being pending
getReasonCode() - Method in class com.paypal.api.payments.Sale
Reason code for the transaction state being Pending or Reversed.
getReceiptId() - Method in class com.paypal.api.payments.Authorization
Receipt id is 16 digit number payment identification number returned for guest users to identify the payment.
getReceiptId() - Method in class com.paypal.api.payments.Sale
Receipt id is a payment identification number returned for guest users to identify the payment.
getReceivableAmount() - Method in class com.paypal.api.payments.Sale
Net amount the merchant receives for this transaction in their receivable currency.
getReceiver() - Method in class com.paypal.api.payments.PayoutItem
The receiver of the payment.
getRecipientBankingInstruction() - Method in class com.paypal.api.payments.PaymentInstruction
Recipient bank Details.
getRecipientBusinessName() - Method in class com.paypal.api.payments.InvoicingSearch
Initial letters of the recipient's business name.
getRecipientBusinessName() - Method in class com.paypal.api.payments.Search
The initial letters of the recipient's business name.
getRecipientFirstName() - Method in class com.paypal.api.payments.InvoicingSearch
Initial letters of the recipient's first name.
getRecipientFirstName() - Method in class com.paypal.api.payments.Search
The initial letters of the recipient's first name.
getRecipientLastName() - Method in class com.paypal.api.payments.InvoicingSearch
Initial letters of the recipient's last name.
getRecipientLastName() - Method in class com.paypal.api.payments.Search
The initial letters of the recipient's last name.
getRecipientName() - Method in class com.paypal.api.payments.ShippingAddress
Name of the recipient at this address.
getRecipientType() - Method in class com.paypal.api.payments.PayoutItem
The type of ID that identifies the payment receiver.
getRecipientType() - Method in class com.paypal.api.payments.PayoutSenderBatchHeader
The type of ID that identifies the payment receiver.
getRecurringFlag() - Method in class com.paypal.api.payments.PaymentOptions
Indicator if this payment request is a recurring payment.
getRedirectURL(String, List<String>, APIContext) - Static method in class com.paypal.api.openidconnect.Session
Returns the PayPal URL to which the user must be redirected to start the authentication / authorization process.
getRedirectURL(String, List<String>, APIContext, ClientCredentials) - Static method in class com.paypal.api.openidconnect.Session
 
getRedirectUrls() - Method in class com.paypal.api.payments.Payment
Set of redirect URLs you provide only for PayPal-based payments.
getReference() - Method in class com.paypal.api.payments.Invoice
Reference data, such as PO number, to add to the invoice.
getReference() - Method in class com.paypal.api.payments.TemplateData
Reference data, such as PO number, to add to the invoice.
getReferenceId() - Method in class com.paypal.api.payments.Authorization
Identifier to the purchase or transaction unit corresponding to this authorization transaction.
getReferenceId() - Method in class com.paypal.api.payments.CartBase
Merchant identifier to the purchase unit.
getReferenceId() - Method in class com.paypal.api.payments.ExternalFunding
Unique identifier for the external funding
getReferenceId() - Method in class com.paypal.api.payments.Order
Deprecated.
Use Order.purchaseUnitReferenceId instead Identifier to the purchase unit associated with this object. Obsolete. Use one in cart_base.
getReferenceNumber() - Method in class com.paypal.api.payments.PaymentInstruction
ID of payment instruction
getRefreshToken() - Method in class com.paypal.api.openidconnect.Tokeninfo
Getter for refreshToken
getRefund() - Method in class com.paypal.api.payments.RelatedResources
Refund transaction
getRefundAdvice() - Method in class com.paypal.api.payments.RefundRequest
Flag to indicate that the buyer was already given store credit for a given transaction.
getRefundDetails() - Method in class com.paypal.api.payments.Invoice
Deprecated.
Please use Invoice.getRefunds() instead.
getRefundedAmount() - Method in class com.paypal.api.payments.Invoice
Payment summary of the invoice including amount refunded through PayPal and other sources.
getRefundFromReceivedAmount() - Method in class com.paypal.api.payments.DetailedRefund
Amount subtracted from PayPal balance of the original recipient of payment, to make this refund.
getRefundFromTransactionFee() - Method in class com.paypal.api.payments.DetailedRefund
Transaction fee refunded to original recipient of payment.
getRefunds() - Method in class com.paypal.api.payments.Invoice
List of refund details for the invoice.
getRefundSource() - Method in class com.paypal.api.payments.RefundRequest
Type of PayPal funding source (balance or eCheck) that can be used for auto refund.
getRefundToExternalFunding() - Method in class com.paypal.api.payments.DetailedRefund
List of external funding that were refunded by the Refund call.
getRefundToPayer() - Method in class com.paypal.api.payments.DetailedRefund
Amount refunded to payer of the original transaction, in the current Refund call
getRefundType() - Method in class com.paypal.api.payments.RefundRequest
Type of refund you are making.
getRegion() - Method in class com.paypal.api.openidconnect.Address
Getter for region
getRel() - Method in class com.paypal.api.payments.DefinitionsLinkdescription
relation to the target resource of the link
getRel() - Method in class com.paypal.api.payments.Links
 
getRelatedFundingOption() - Method in class com.paypal.api.payments.Payer
Funding option related to default funding option.
getRelatedResources() - Method in class com.paypal.api.payments.TransactionBase
List of financial transactions (Sale, Authorization, Capture, Refund) related to the payment.
getRequestId() - Method in class com.paypal.base.rest.APIContext
Returns the unique requestId set during creation, if not available and if maskRequestId is set to false returns a generated one, else returns null.
getRequestPayload() - Method in class com.paypal.base.rest.OAuthTokenCredential
Returns the request payload for OAuth Service.
getResource() - Method in class com.paypal.api.payments.Event
This contains the resource that is identified by resource_type element.
getResourceType() - Method in class com.paypal.api.payments.Event
Name of the resource contained in resource element.
getResponseCode() - Method in class com.paypal.api.payments.ProcessorResponse
Paypal normalized response code, generated from the processor's specific response code
getResponsecode() - Method in exception com.paypal.base.exception.HttpErrorException
 
getResponsecode() - Method in exception com.paypal.base.rest.PayPalRESTException
 
getResponseHeaderMap() - Method in class com.paypal.base.HttpConnection
 
getRetryDelay() - Method in class com.paypal.base.HttpConfiguration
 
getReturnUriHttpMethod() - Method in class com.paypal.api.payments.FlowConfig
Defines the HTTP method to use to redirect the user to a return URL.
getReturnUrl() - Method in class com.paypal.api.payments.MerchantPreferences
Redirect URL on creation of agreement request.
getReturnUrl() - Method in class com.paypal.api.payments.RedirectUrls
Url where the payer would be redirected to after approving the payment.
getReturnUrlLabel() - Method in class com.paypal.api.payments.Presentation
A label to use as hypertext for the return to merchant link.
getRoutingNumber() - Method in class com.paypal.api.payments.BankAccount
Routing transit number (aka Bank Code) of the bank (typically for domestic use only - for international use, IBAN includes bank code).
getRoutingNumber() - Method in class com.paypal.api.payments.RecipientBankingInstruction
bank routing number
getSale() - Method in class com.paypal.api.payments.RelatedResources
Sale transaction
getSaleId() - Method in class com.paypal.api.payments.Refund
ID of the Sale transaction being refunded.
getSalutation() - Method in class com.paypal.api.payments.PayerInfo
Salutation of the payer.
getSchema() - Method in class com.paypal.api.payments.DefinitionsLinkdescription
Schema describing the data to submit along with the request
getSchema() - Method in class com.paypal.api.payments.Links
 
getScope() - Method in class com.paypal.api.openidconnect.Tokeninfo
Getter for scope
getSDKId() - Method in class com.paypal.base.sdk.info.SDKVersionImpl
 
getSDKId() - Method in interface com.paypal.base.SDKVersion
Returns the SDK Id
getSdkVersion() - Method in class com.paypal.base.rest.APIContext
 
getSDKVersion() - Method in class com.paypal.base.sdk.info.SDKVersionImpl
 
getSDKVersion() - Method in interface com.paypal.base.SDKVersion
Returns the SDK Version
getSelectedInstallmentOption() - Method in class com.paypal.api.payments.Billing
Selected installment option for issuer based installments (BR and MX).
getSenderBatchHeader() - Method in class com.paypal.api.payments.Payout
The original batch header as provided by the payment sender.
getSenderBatchHeader() - Method in class com.paypal.api.payments.PayoutBatchHeader
The original batch header as provided by the payment sender.
getSenderBatchId() - Method in class com.paypal.api.payments.PayoutItemDetails
A sender-specified ID number.
getSenderBatchId() - Method in class com.paypal.api.payments.PayoutSenderBatchHeader
A sender-specified ID number.
getSenderItemId() - Method in class com.paypal.api.payments.PayoutItem
A sender-specified ID number.
getSendToMerchant() - Method in class com.paypal.api.payments.CancelNotification
Indicates whether to send a copy of the notification to the merchant.
getSendToMerchant() - Method in class com.paypal.api.payments.InvoicingNotification
A flag indicating whether a copy of the email has to be sent to the merchant.
getSendToMerchant() - Method in class com.paypal.api.payments.Notification
Indicates whether to send a copy of the email to the merchant.
getSendToPayer() - Method in class com.paypal.api.payments.CancelNotification
Indicates whether to send a copy of the notification to the payer.
getSettings() - Method in class com.paypal.api.payments.Template
Settings for each template
getSetupFee() - Method in class com.paypal.api.payments.MerchantPreferences
Setup fee amount.
getShipping() - Method in class com.paypal.api.payments.Details
Amount charged for shipping.
getShippingAddress() - Method in class com.paypal.api.payments.Agreement
Shipping address object of the agreement, which should be provided if it is different from the default address.
getShippingAddress() - Method in class com.paypal.api.payments.ItemList
Shipping address.
getShippingAddress() - Method in class com.paypal.api.payments.PayerInfo
Deprecated.
Use shipping address present in purchase unit or at root level of checkout Session.
getShippingCost() - Method in class com.paypal.api.payments.Invoice
The shipping cost, as a percent or an amount value.
getShippingCost() - Method in class com.paypal.api.payments.TemplateData
The shipping cost, as a percent or an amount value.
getShippingDiscount() - Method in class com.paypal.api.payments.Details
Amount being discounted for the shipping fee.
getShippingInfo() - Method in class com.paypal.api.payments.Invoice
The shipping information for entities to whom items are being shipped.
getShippingInfo() - Method in class com.paypal.api.payments.TemplateData
The shipping information for entities to whom items are being shipped.
getShippingMethod() - Method in class com.paypal.api.payments.ItemList
Shipping method used for this payment like USPSParcel etc.
getShippingPhoneNumber() - Method in class com.paypal.api.payments.ItemList
Allows merchant's to share payer’s contact number with PayPal for the current payment.
getSkipFmf() - Method in class com.paypal.api.payments.PaymentOptions
Indicator if fraud management filters (fmf) should be skipped for this transaction.
getSku() - Method in class com.paypal.api.payments.Item
Stock keeping unit corresponding (SKU) to item.
getSoftDescriptor() - Method in class com.paypal.api.payments.CartBase
Soft descriptor used when charging this funding source.
getSoftDescriptorCity() - Method in class com.paypal.api.payments.CartBase
Soft descriptor city used when charging this funding source.
getSSLContext(KeyManager[]) - Static method in class com.paypal.base.SSLUtil
Returns a SSLContext
getStartCreationDate() - Method in class com.paypal.api.payments.InvoicingSearch
Start invoice creation date.
getStartCreationDate() - Method in class com.paypal.api.payments.Search
The start creation date for the invoice.
getStartDate() - Method in class com.paypal.api.payments.Agreement
Start date of the agreement.
getStartDueDate() - Method in class com.paypal.api.payments.InvoicingSearch
Start invoice due date.
getStartDueDate() - Method in class com.paypal.api.payments.Search
The start due date for the invoice.
getStartInvoiceDate() - Method in class com.paypal.api.payments.InvoicingSearch
Start invoice date.
getStartInvoiceDate() - Method in class com.paypal.api.payments.Search
The start date for the invoice.
getStartMonth() - Method in class com.paypal.api.payments.PaymentCard
The two-digit start month for the card.
getStartPaymentDate() - Method in class com.paypal.api.payments.InvoicingSearch
Start invoice payment date.
getStartPaymentDate() - Method in class com.paypal.api.payments.Search
The start payment date for the invoice.
getStartYear() - Method in class com.paypal.api.payments.PaymentCard
The four-digit start year for the card.
getState() - Method in class com.paypal.api.payments.Agreement
State of the agreement
getState() - Method in class com.paypal.api.payments.Authorization
State of the authorization.
getState() - Method in class com.paypal.api.payments.BankAccount
State of this funding instrument.
getState() - Method in class com.paypal.api.payments.BaseAddress
2 letter code for US states, and the equivalent for other countries.
getState() - Method in class com.paypal.api.payments.Capture
The state of the capture.
getState() - Method in class com.paypal.api.payments.CreditCard
State of the credit card funding instrument.
getState() - Method in class com.paypal.api.payments.Order
State of the order transaction.
getState() - Method in class com.paypal.api.payments.Payment
The state of the payment, authorization, or order transaction.
getState() - Method in class com.paypal.api.payments.Plan
Status of the billing plan.
getState() - Method in class com.paypal.api.payments.Refund
State of the refund.
getState() - Method in class com.paypal.api.payments.Sale
State of the sale transaction.
getStatus() - Method in class com.paypal.api.payments.AgreementTransaction
State of the subscription at this time.
getStatus() - Method in class com.paypal.api.payments.BaseAddress
BaseAddress status
getStatus() - Method in class com.paypal.api.payments.Invoice
Status of the invoice.
getStatus() - Method in class com.paypal.api.payments.InvoicingSearch
Status of the invoice.
getStatus() - Method in class com.paypal.api.payments.Payer
Status of payer's PayPal Account.
getStatus() - Method in class com.paypal.api.payments.PaymentCard
The state of the funding instrument.
getStatus() - Method in class com.paypal.api.payments.Search
The invoice status.
getStreetAddress() - Method in class com.paypal.api.openidconnect.Address
Getter for streetAddress
getSub() - Method in class com.paypal.api.openidconnect.Userinfo
Subject - Identifier for the End-User at the Issuer.
getSubject() - Method in class com.paypal.api.payments.CancelNotification
Subject of the notification.
getSubject() - Method in class com.paypal.api.payments.InvoicingNotification
Subject of the notification.
getSubject() - Method in class com.paypal.api.payments.Notification
Subject of the notification.
getSubtotal() - Method in class com.paypal.api.payments.Details
Amount of the subtotal of the items.
getSuffix() - Method in class com.paypal.api.payments.PayerInfo
Suffix of the payer.
getSummary() - Method in class com.paypal.api.payments.Event
A summary description of the event.
getSupplementaryData() - Method in class com.paypal.api.payments.Item
Set of optional data used for PayPal risk determination.
getTargetSchema() - Method in class com.paypal.api.payments.DefinitionsLinkdescription
JSON Schema describing the link target
getTargetSchema() - Method in class com.paypal.api.payments.Links
 
getTax() - Method in class com.paypal.api.payments.Details
Amount charged for tax.
getTax() - Method in class com.paypal.api.payments.InvoiceItem
Tax associated with the item.
getTax() - Method in class com.paypal.api.payments.Item
Tax of the item.
getTax() - Method in class com.paypal.api.payments.ShippingCost
The tax percentage on the shipping amount.
getTaxCalculatedAfterDiscount() - Method in class com.paypal.api.payments.Invoice
Indicates whether tax is calculated before or after a discount.
getTaxCalculatedAfterDiscount() - Method in class com.paypal.api.payments.TemplateData
Indicates whether tax is calculated before or after a discount.
getTaxId() - Method in class com.paypal.api.payments.MerchantInfo
The merchant tax ID.
getTaxId() - Method in class com.paypal.api.payments.PayerInfo
Payer’s tax ID.
getTaxIdType() - Method in class com.paypal.api.payments.PayerInfo
Payer’s tax ID type.
getTaxInclusive() - Method in class com.paypal.api.payments.Invoice
Indicates whether the unit price includes tax.
getTaxInclusive() - Method in class com.paypal.api.payments.TemplateData
Indicates whether the unit price includes tax.
getTemplateData() - Method in class com.paypal.api.payments.Template
Customized invoice data which is saved as template
getTemplateId() - Method in class com.paypal.api.payments.Invoice
The template ID used for the invoice.
getTemplateId() - Method in class com.paypal.api.payments.Template
Unique identifier id of the template.
getTemplates() - Method in class com.paypal.api.payments.Templates
Array of templates.
getTemporary() - Method in class com.paypal.api.payments.WebProfile
Indicates whether the profile persists for three hours or permanently.
getTerm() - Method in class com.paypal.api.payments.CreditFinancingOffered
Length of financing terms in month
getTerm() - Method in class com.paypal.api.payments.InstallmentOption
Number of installments
getTerms() - Method in class com.paypal.api.payments.Incentive
URI to the associated terms
getTerms() - Method in class com.paypal.api.payments.Invoice
General terms of the invoice.
getTerms() - Method in class com.paypal.api.payments.Plan
Array of terms for this billing plan.
getTerms() - Method in class com.paypal.api.payments.TemplateData
General terms of the invoice.
getTermType() - Method in class com.paypal.api.payments.PaymentTerm
The terms by which the invoice payment is due.
getTimeCompleted() - Method in class com.paypal.api.payments.PayoutBatchHeader
The time that processing for the batch was completed.
getTimeCreated() - Method in class com.paypal.api.payments.PayoutBatchHeader
The time the batch entered processing.
getTimeProcessed() - Method in class com.paypal.api.payments.PayoutItemDetails
The date and time when this item was last processed.
getTimeStamp() - Method in class com.paypal.api.payments.AgreementTransaction
Time at which this transaction happened.
getTimeUpdated() - Method in class com.paypal.api.payments.AgreementTransaction
Deprecated.
use getTimeStamp instead. Getter for timeUpdated
getTimeZone() - Method in class com.paypal.api.payments.AgreementTransaction
Time zone of time_updated field.
getTitle() - Method in class com.paypal.api.payments.DefinitionsLinkdescription
a title for the link
getToAmount() - Method in class com.paypal.api.payments.CurrencyConversion
Amount resulting from currency conversion.
getToCurrency() - Method in class com.paypal.api.payments.CurrencyConversion
3 letter currency code
getToken() - Method in class com.paypal.api.payments.Agreement
Payment token
getTokeninfo(CreateFromAuthorizationCodeParameters) - Method in class com.paypal.api.payments.FuturePayment
Deprecated.
Please use FuturePayment.fetchRefreshToken(APIContext, String) instead. In this method, we need to pass clientID, secret information that is already known to apiContext. The newer method allows for better code readability, and make it less error prone.
getTokeninfo(CreateFromRefreshTokenParameters, Tokeninfo) - Method in class com.paypal.api.payments.FuturePayment
Deprecated.
Please use FuturePayment.fetchRefreshToken(APIContext, String) instead. In this method, we need to pass clientID, secret information that is already known to apiContext. The newer method allows for better code readability, and make it less error prone.
getTokenSecret() - Method in class com.paypal.base.credential.TokenAuthorization
 
getTokenType() - Method in class com.paypal.api.openidconnect.Tokeninfo
Getter for tokenType
getTotal() - Method in class com.paypal.api.payments.Amount
Total amount charged from the payer to the payee.
getTotalAmount() - Method in class com.paypal.api.payments.Invoice
The total amount of the invoice.
getTotalAmount() - Method in class com.paypal.api.payments.TemplateData
The total amount of the invoice.
getTotalCost() - Method in class com.paypal.api.payments.CreditFinancingOffered
This is the estimated total payment amount including interest and fees the user will pay during the lifetime of the loan.
getTotalCount() - Method in class com.paypal.api.payments.Invoices
 
getTotalCountRequired() - Method in class com.paypal.api.payments.InvoicingSearch
A flag indicating whether total count is required in the response.
getTotalCountRequired() - Method in class com.paypal.api.payments.Search
Indicates whether the total count appears in the response.
getTotalInterest() - Method in class com.paypal.api.payments.CreditFinancingOffered
Estimated interest or fees amount the payer will have to pay during the lifetime of the loan.
getTotalItems() - Method in class com.paypal.api.payments.CreditCardHistory
Total number of items.
getTotalItems() - Method in class com.paypal.api.payments.PlanList
Total number of items.
getTotalPages() - Method in class com.paypal.api.payments.CreditCardHistory
Total number of pages.
getTotalPages() - Method in class com.paypal.api.payments.PlanList
Total number of pages.
getTotalRefundedAmount() - Method in class com.paypal.api.payments.DetailedRefund
Total amount refunded so far from the original purchase.
getTransactionFee() - Method in class com.paypal.api.payments.Capture
The transaction fee for this payment.
getTransactionFee() - Method in class com.paypal.api.payments.Sale
Transaction fee applicable for this payment.
getTransactionId() - Method in class com.paypal.api.payments.AgreementTransaction
Id corresponding to this transaction.
getTransactionId() - Method in class com.paypal.api.payments.InvoicingPaymentDetail
PayPal payment transaction id.
getTransactionId() - Method in class com.paypal.api.payments.PaymentDetail
The PayPal payment transaction ID.
getTransactionId() - Method in class com.paypal.api.payments.PayoutItemDetails
The PayPal-generated ID for the transaction.
getTransactionId() - Method in class com.paypal.api.payments.RefundDetail
The PayPal refund transaction ID.
getTransactions() - Method in class com.paypal.api.payments.Payment
Transactional details including the amount and item details.
getTransactions() - Method in class com.paypal.api.payments.PaymentExecution
Transactional details including the amount and item details.
getTransactions() - Method in class com.paypal.api.payments.Transaction
Financial transactions related to a payment.
getTransactionStatus() - Method in class com.paypal.api.payments.PayoutItemDetails
The transaction status.
getTransactionType() - Method in class com.paypal.api.payments.AgreementTransaction
Type of transaction, usually Recurring Payment.
getTransactionType() - Method in class com.paypal.api.payments.InvoicingPaymentDetail
Type of the transaction.
getTransactionType() - Method in class com.paypal.api.payments.PaymentDetail
Type of the transaction.
getType() - Method in class com.paypal.api.payments.Address
Type of address (e.g., HOME_OR_WORK, GIFT etc).
getType() - Method in class com.paypal.api.payments.ChargeModels
Type of charge model.
getType() - Method in class com.paypal.api.payments.Credit
specifies type of credit
getType() - Method in class com.paypal.api.payments.CreditCard
Credit card type.
getType() - Method in class com.paypal.api.payments.CreditCardToken
Credit card type.
getType() - Method in class com.paypal.api.payments.Incentive
Specifies type of incentive
getType() - Method in class com.paypal.api.payments.InvoicingPaymentDetail
PayPal payment detail indicating whether payment was made in an invoicing flow via PayPal or externally.
getType() - Method in class com.paypal.api.payments.InvoicingRefundDetail
PayPal refund type indicating whether refund was done in invoicing flow via PayPal or externally.
getType() - Method in class com.paypal.api.payments.PaymentCard
The card type.
getType() - Method in class com.paypal.api.payments.PaymentCardToken
Type of the Card.
getType() - Method in class com.paypal.api.payments.PaymentDefinition
Type of the payment definition.
getType() - Method in class com.paypal.api.payments.PaymentDetail
The PayPal payment detail.
getType() - Method in class com.paypal.api.payments.Plan
Type of the billing plan.
getType() - Method in class com.paypal.api.payments.RefundDetail
The PayPal refund type.
getType() - Method in class com.paypal.api.payments.Terms
Term type.
getUnit() - Method in class com.paypal.api.payments.Measurement
Unit in which the value is represented.
getUnitOfMeasure() - Method in class com.paypal.api.payments.InvoiceItem
The unit of measure of the item being invoiced.
getUnitOfMeasure() - Method in class com.paypal.api.payments.Template
Unit of measure for the template, possible values are Quantity, Hours, Amount.
getUnitPrice() - Method in class com.paypal.api.payments.InvoiceItem
Unit price of the item.
getUpdateTime() - Method in class com.paypal.api.payments.Agreement
Date and time that this resource was updated.
getUpdateTime() - Method in class com.paypal.api.payments.Authorization
Time that the resource was last updated.
getUpdateTime() - Method in class com.paypal.api.payments.BankAccount
Time the resource was last updated.
getUpdateTime() - Method in class com.paypal.api.payments.Capture
The date and time when the resource was last updated.
getUpdateTime() - Method in class com.paypal.api.payments.Order
Time the resource was last updated in UTC ISO8601 format.
getUpdateTime() - Method in class com.paypal.api.payments.Payment
Payment update time as defined in [RFC 3339 Section 5.6](http://tools.ietf.org/html/rfc3339#section-5.6).
getUpdateTime() - Method in class com.paypal.api.payments.Plan
Time when this billing plan was updated.
getUpdateTime() - Method in class com.paypal.api.payments.Refund
Time that the resource was last updated.
getUpdateTime() - Method in class com.paypal.api.payments.Sale
Time the resource was last updated in UTC ISO8601 format.
getUpperTotalAmount() - Method in class com.paypal.api.payments.InvoicingSearch
Upper limit of total amount.
getUpperTotalAmount() - Method in class com.paypal.api.payments.Search
The upper limit of total amount.
getUri() - Method in class com.paypal.api.payments.Invoice
URI of the invoice resource.
getUrl() - Method in class com.paypal.api.payments.FileAttachment
URL of the attached file that can be downloaded.
getUrl() - Method in class com.paypal.api.payments.Item
URL linking to item information.
getUrl() - Method in class com.paypal.api.payments.Webhook
The URL that is configured to listen on `localhost` for incoming `POST` notification messages that contain event information.
getUserAction() - Method in class com.paypal.api.payments.FlowConfig
Defines whether buyers can complete purchases on the PayPal or merchant website.
getUserId() - Method in class com.paypal.api.openidconnect.Userinfo
Subject - Identifier for the End-User at the Issuer.
getUserinfo(String) - Static method in class com.paypal.api.openidconnect.Userinfo
Deprecated.
getUserinfo(APIContext) - Static method in class com.paypal.api.openidconnect.Userinfo
Returns user details
getValidUntil() - Method in class com.paypal.api.payments.Authorization
Authorization expiration time and date as defined in [RFC 3339 Section 5.6](http://tools.ietf.org/html/rfc3339#section-5.6).
getValidUntil() - Method in class com.paypal.api.payments.BankAccount
Date/Time until this resource can be used to fund a payment.
getValidUntil() - Method in class com.paypal.api.payments.CreditCard
Funding instrument expiration date.
getValidUntil() - Method in class com.paypal.api.payments.PaymentCard
The date and time until when this instrument can be used fund a payment.
getValue() - Method in class com.paypal.api.payments.Currency
amount up to N digit after the decimals separator as defined in ISO 4217 for the appropriate currency code.
getValue() - Method in class com.paypal.api.payments.Measurement
Value this measurement represents.
getValue() - Method in class com.paypal.api.payments.NameValuePair
Value for the name value pair.
getValue() - Method in class com.paypal.api.payments.Patch
New value to apply based on the operation.
getValue() - Method in class com.paypal.api.payments.PatchRequest
New value to apply based on the operation.
getValue(String) - Method in class com.paypal.base.ConfigManager
Deprecated.
This code was used for older integrations. Not valid anymore. To be removed in the next major release.
getValuesByCategory(String) - Method in class com.paypal.base.ConfigManager
Deprecated.
This code was used for older integrations. Not valid anymore. To be removed in the next major release.
getValueWithDefault(String, String) - Method in class com.paypal.base.ConfigManager
Deprecated.
This code was used for older integrations. Not valid anymore. To be removed in the next major release.
getVerifiedAccount() - Method in class com.paypal.api.openidconnect.Userinfo
Verified account status.
getVpas() - Method in class com.paypal.api.payments.ProcessorResponse
Visa Payer Authentication Service status.
getWebhooks() - Method in class com.paypal.api.payments.WebhookList
A list of webhooks.
getWebProfiles() - Method in class com.paypal.api.payments.WebProfileList
 
getWebsite() - Method in class com.paypal.api.payments.MerchantInfo
The merchant website.
getWebsite() - Method in class com.paypal.api.payments.Participant
The participant website.
getWebUrl() - Method in class com.paypal.api.payments.CurrencyConversion
Base URL to web applications endpoint
getWeight() - Method in class com.paypal.api.payments.Item
Weight of the item.
getWidth() - Method in class com.paypal.api.payments.Item
Width of the item.
getXid() - Method in class com.paypal.api.payments.Card3dSecureInfo
Transaction identifier from authenticator.
getZoneinfo() - Method in class com.paypal.api.openidconnect.Userinfo
Time zone database representing the End-User's time zone
GOOGLE_APP_ENGINE - Static variable in class com.paypal.base.Constants
 
GoogleAppEngineHttpConnection - Class in com.paypal.base
A special HttpConnection for use on Google App Engine.
GoogleAppEngineHttpConnection() - Constructor for class com.paypal.base.GoogleAppEngineHttpConnection
 
GSON - Static variable in class com.paypal.base.rest.JSONFormatter
Gson

H

hasCredentials() - Method in class com.paypal.base.rest.OAuthTokenCredential
Checks if clientID and secret are set.
hashCode() - Method in class com.paypal.api.payments.Address
 
hashCode() - Method in class com.paypal.api.payments.Agreement
 
hashCode() - Method in class com.paypal.api.payments.AgreementDetails
 
hashCode() - Method in class com.paypal.api.payments.AgreementStateDescriptor
 
hashCode() - Method in class com.paypal.api.payments.AgreementTransaction
 
hashCode() - Method in class com.paypal.api.payments.AgreementTransactions
 
hashCode() - Method in class com.paypal.api.payments.AlternatePayment
 
hashCode() - Method in class com.paypal.api.payments.Amount
 
hashCode() - Method in class com.paypal.api.payments.Authorization
 
hashCode() - Method in class com.paypal.api.payments.BankAccount
 
hashCode() - Method in class com.paypal.api.payments.BankToken
 
hashCode() - Method in class com.paypal.api.payments.BaseAddress
 
hashCode() - Method in class com.paypal.api.payments.Billing
 
hashCode() - Method in class com.paypal.api.payments.BillingAgreementToken
 
hashCode() - Method in class com.paypal.api.payments.BillingInfo
 
hashCode() - Method in class com.paypal.api.payments.CancelNotification
 
hashCode() - Method in class com.paypal.api.payments.Capture
 
hashCode() - Method in class com.paypal.api.payments.Card3dSecureInfo
 
hashCode() - Method in class com.paypal.api.payments.CarrierAccount
 
hashCode() - Method in class com.paypal.api.payments.CarrierAccountToken
 
hashCode() - Method in class com.paypal.api.payments.CartBase
 
hashCode() - Method in class com.paypal.api.payments.ChargeModels
 
hashCode() - Method in class com.paypal.api.payments.Cost
 
hashCode() - Method in class com.paypal.api.payments.CountryCode
 
hashCode() - Method in class com.paypal.api.payments.CreateProfileResponse
 
hashCode() - Method in class com.paypal.api.payments.Credit
 
hashCode() - Method in class com.paypal.api.payments.CreditCard
 
hashCode() - Method in class com.paypal.api.payments.CreditCardHistory
 
hashCode() - Method in class com.paypal.api.payments.CreditCardToken
 
hashCode() - Method in class com.paypal.api.payments.CreditFinancingOffered
 
hashCode() - Method in class com.paypal.api.payments.Currency
 
hashCode() - Method in class com.paypal.api.payments.CurrencyConversion
 
hashCode() - Method in class com.paypal.api.payments.CustomAmount
 
hashCode() - Method in class com.paypal.api.payments.DefinitionsLinkdescription
 
hashCode() - Method in class com.paypal.api.payments.DetailedRefund
 
hashCode() - Method in class com.paypal.api.payments.Details
 
hashCode() - Method in class com.paypal.api.payments.Error
 
hashCode() - Method in class com.paypal.api.payments.ErrorDetails
 
hashCode() - Method in class com.paypal.api.payments.Event
 
hashCode() - Method in class com.paypal.api.payments.EventList
 
hashCode() - Method in class com.paypal.api.payments.EventType
 
hashCode() - Method in class com.paypal.api.payments.EventTypeList
 
hashCode() - Method in class com.paypal.api.payments.ExtendedBankAccount
 
hashCode() - Method in class com.paypal.api.payments.ExternalFunding
 
hashCode() - Method in class com.paypal.api.payments.FileAttachment
 
hashCode() - Method in class com.paypal.api.payments.FlowConfig
 
hashCode() - Method in class com.paypal.api.payments.FmfDetails
 
hashCode() - Method in class com.paypal.api.payments.FundingDetail
 
hashCode() - Method in class com.paypal.api.payments.FundingInstrument
 
hashCode() - Method in class com.paypal.api.payments.FundingOption
 
hashCode() - Method in class com.paypal.api.payments.FundingSource
 
hashCode() - Method in class com.paypal.api.payments.FuturePayment
 
hashCode() - Method in class com.paypal.api.payments.HyperSchema
 
hashCode() - Method in class com.paypal.api.payments.Image
 
hashCode() - Method in class com.paypal.api.payments.Incentive
 
hashCode() - Method in class com.paypal.api.payments.InputFields
 
hashCode() - Method in class com.paypal.api.payments.InstallmentInfo
 
hashCode() - Method in class com.paypal.api.payments.InstallmentOption
 
hashCode() - Method in class com.paypal.api.payments.Invoice
 
hashCode() - Method in class com.paypal.api.payments.InvoiceAddress
 
hashCode() - Method in class com.paypal.api.payments.InvoiceItem
 
hashCode() - Method in class com.paypal.api.payments.InvoiceNumber
 
hashCode() - Method in class com.paypal.api.payments.Invoices
 
hashCode() - Method in class com.paypal.api.payments.InvoicingMetaData
 
hashCode() - Method in class com.paypal.api.payments.InvoicingNotification
 
hashCode() - Method in class com.paypal.api.payments.InvoicingPaymentDetail
 
hashCode() - Method in class com.paypal.api.payments.InvoicingRefundDetail
 
hashCode() - Method in class com.paypal.api.payments.InvoicingSearch
 
hashCode() - Method in class com.paypal.api.payments.Item
 
hashCode() - Method in class com.paypal.api.payments.ItemList
 
hashCode() - Method in class com.paypal.api.payments.Links
 
hashCode() - Method in class com.paypal.api.payments.Measurement
 
hashCode() - Method in class com.paypal.api.payments.MerchantInfo
 
hashCode() - Method in class com.paypal.api.payments.MerchantPreferences
 
hashCode() - Method in class com.paypal.api.payments.Metadata
 
hashCode() - Method in class com.paypal.api.payments.NameValuePair
 
hashCode() - Method in class com.paypal.api.payments.Notification
 
hashCode() - Method in class com.paypal.api.payments.Order
 
hashCode() - Method in class com.paypal.api.payments.OverrideChargeModel
 
hashCode() - Method in class com.paypal.api.payments.Participant
 
hashCode() - Method in class com.paypal.api.payments.Patch
 
hashCode() - Method in class com.paypal.api.payments.PatchRequest
 
hashCode() - Method in class com.paypal.api.payments.Payee
 
hashCode() - Method in class com.paypal.api.payments.Payer
 
hashCode() - Method in class com.paypal.api.payments.PayerInfo
 
hashCode() - Method in class com.paypal.api.payments.PayerNotification
 
hashCode() - Method in class com.paypal.api.payments.Payment
 
hashCode() - Method in class com.paypal.api.payments.PaymentCard
 
hashCode() - Method in class com.paypal.api.payments.PaymentCardToken
 
hashCode() - Method in class com.paypal.api.payments.PaymentDefinition
 
hashCode() - Method in class com.paypal.api.payments.PaymentDetail
 
hashCode() - Method in class com.paypal.api.payments.PaymentExecution
 
hashCode() - Method in class com.paypal.api.payments.PaymentHistory
 
hashCode() - Method in class com.paypal.api.payments.PaymentInstruction
 
hashCode() - Method in class com.paypal.api.payments.PaymentOptions
 
hashCode() - Method in class com.paypal.api.payments.PaymentSummary
 
hashCode() - Method in class com.paypal.api.payments.PaymentTerm
 
hashCode() - Method in class com.paypal.api.payments.Payout
 
hashCode() - Method in class com.paypal.api.payments.PayoutBatch
 
hashCode() - Method in class com.paypal.api.payments.PayoutBatchHeader
 
hashCode() - Method in class com.paypal.api.payments.PayoutItem
 
hashCode() - Method in class com.paypal.api.payments.PayoutItemDetails
 
hashCode() - Method in class com.paypal.api.payments.PayoutSenderBatchHeader
 
hashCode() - Method in class com.paypal.api.payments.Percentage
 
hashCode() - Method in class com.paypal.api.payments.Phone
 
hashCode() - Method in class com.paypal.api.payments.Plan
 
hashCode() - Method in class com.paypal.api.payments.PlanList
 
hashCode() - Method in class com.paypal.api.payments.PotentialPayerInfo
 
hashCode() - Method in class com.paypal.api.payments.Presentation
 
hashCode() - Method in class com.paypal.api.payments.PrivateLabelCard
 
hashCode() - Method in class com.paypal.api.payments.ProcessorResponse
 
hashCode() - Method in class com.paypal.api.payments.RecipientBankingInstruction
 
hashCode() - Method in class com.paypal.api.payments.RedirectUrls
 
hashCode() - Method in class com.paypal.api.payments.Refund
 
hashCode() - Method in class com.paypal.api.payments.RefundDetail
 
hashCode() - Method in class com.paypal.api.payments.RefundRequest
 
hashCode() - Method in class com.paypal.api.payments.RelatedResources
 
hashCode() - Method in class com.paypal.api.payments.Sale
 
hashCode() - Method in class com.paypal.api.payments.Search
 
hashCode() - Method in class com.paypal.api.payments.ShippingAddress
 
hashCode() - Method in class com.paypal.api.payments.ShippingCost
 
hashCode() - Method in class com.paypal.api.payments.ShippingInfo
 
hashCode() - Method in class com.paypal.api.payments.Tax
 
hashCode() - Method in class com.paypal.api.payments.Template
 
hashCode() - Method in class com.paypal.api.payments.TemplateData
 
hashCode() - Method in class com.paypal.api.payments.Templates
 
hashCode() - Method in class com.paypal.api.payments.TemplateSettings
 
hashCode() - Method in class com.paypal.api.payments.TemplateSettingsMetadata
 
hashCode() - Method in class com.paypal.api.payments.Terms
 
hashCode() - Method in class com.paypal.api.payments.Transaction
 
hashCode() - Method in class com.paypal.api.payments.TransactionBase
 
hashCode() - Method in class com.paypal.api.payments.Transactions
 
hashCode() - Method in class com.paypal.api.payments.Webhook
 
hashCode() - Method in class com.paypal.api.payments.WebhookList
 
hashCode() - Method in class com.paypal.api.payments.WebProfile
 
hashCode() - Method in class com.paypal.api.payments.WebProfileList
 
hashCode() - Method in class com.paypal.base.rest.AccessToken
 
hashCode() - Method in class com.paypal.base.rest.PayPalModel
 
HTTP_ACCEPT_HEADER - Static variable in class com.paypal.base.Constants
 
HTTP_CONFIG_DEFAULT_CONTENT_TYPE - Static variable in class com.paypal.base.Constants
 
HTTP_CONFIG_DEFAULT_HTTP_METHOD - Static variable in class com.paypal.base.Constants
 
HTTP_CONNECTION_MAX_CONNECTION - Static variable in class com.paypal.base.Constants
 
HTTP_CONNECTION_READ_TIMEOUT - Static variable in class com.paypal.base.Constants
 
HTTP_CONNECTION_RETRY - Static variable in class com.paypal.base.Constants
 
HTTP_CONNECTION_TIMEOUT - Static variable in class com.paypal.base.Constants
 
HTTP_CONTENT_TYPE_HEADER - Static variable in class com.paypal.base.Constants
 
HTTP_CONTENT_TYPE_JSON - Static variable in class com.paypal.base.Constants
 
HTTP_CONTENT_TYPE_PATCH_JSON - Static variable in class com.paypal.base.Constants
 
HTTP_CONTENT_TYPE_XML - Static variable in class com.paypal.base.Constants
 
HTTP_PROXY_HOST - Static variable in class com.paypal.base.Constants
 
HTTP_PROXY_PASSWORD - Static variable in class com.paypal.base.Constants
 
HTTP_PROXY_PORT - Static variable in class com.paypal.base.Constants
 
HTTP_PROXY_USERNAME - Static variable in class com.paypal.base.Constants
 
HttpConfiguration - Class in com.paypal.base
Class contains http specific configuration parameters
HttpConfiguration() - Constructor for class com.paypal.base.HttpConfiguration
 
HttpConnection - Class in com.paypal.base
Base HttpConnection class
HttpConnection() - Constructor for class com.paypal.base.HttpConnection
 
HttpErrorException - Exception in com.paypal.base.exception
HttpErrorException denotes errors that occur in HTTP call
HttpErrorException(String) - Constructor for exception com.paypal.base.exception.HttpErrorException
 
HttpErrorException(String, Throwable) - Constructor for exception com.paypal.base.exception.HttpErrorException
 
HttpErrorException(int, String, String, Throwable) - Constructor for exception com.paypal.base.exception.HttpErrorException
 
HttpMethod - Enum in com.paypal.base.rest
HttpMethod enums used for HTTP method verbs
HttpStatusCodes - Class in com.paypal.base
 
HttpStatusCodes() - Constructor for class com.paypal.base.HttpStatusCodes
 
HyperSchema - Class in com.paypal.api.payments
 
HyperSchema() - Constructor for class com.paypal.api.payments.HyperSchema
Default Constructor

I

Image - Class in com.paypal.api.payments
 
Image() - Constructor for class com.paypal.api.payments.Image
Default Constructor
Incentive - Class in com.paypal.api.payments
 
Incentive() - Constructor for class com.paypal.api.payments.Incentive
Default Constructor
initConfig(File) - Static method in class com.paypal.base.rest.PayPalResource
Initialize the system using a File(Properties file).
initConfig(Properties) - Static method in class com.paypal.base.rest.PayPalResource
Initialize using Properties.
initConfig(InputStream) - Static method in class com.paypal.base.rest.PayPalResource
Initialize using InputStream(of a Properties file)..
initializeToDefault() - Static method in class com.paypal.base.rest.PayPalResource
Initialize to default properties
InputFields - Class in com.paypal.api.payments
 
InputFields() - Constructor for class com.paypal.api.payments.InputFields
Default Constructor
InstallmentInfo - Class in com.paypal.api.payments
 
InstallmentInfo() - Constructor for class com.paypal.api.payments.InstallmentInfo
Default Constructor
InstallmentInfo(List<InstallmentOption>) - Constructor for class com.paypal.api.payments.InstallmentInfo
Parameterized Constructor
InstallmentOption - Class in com.paypal.api.payments
 
InstallmentOption() - Constructor for class com.paypal.api.payments.InstallmentOption
Default Constructor
InstallmentOption(int, Currency) - Constructor for class com.paypal.api.payments.InstallmentOption
Parameterized Constructor
InvalidCredentialException - Exception in com.paypal.base.exception
InvalidCredentialException used to denote errors in credentials used in API call
InvalidCredentialException(String) - Constructor for exception com.paypal.base.exception.InvalidCredentialException
 
InvalidCredentialException(String, Throwable) - Constructor for exception com.paypal.base.exception.InvalidCredentialException
 
InvalidResponseDataException - Exception in com.paypal.base.exception
InvalidResponseException used to denote errors in response data
InvalidResponseDataException(String) - Constructor for exception com.paypal.base.exception.InvalidResponseDataException
 
InvalidResponseDataException(String, Throwable) - Constructor for exception com.paypal.base.exception.InvalidResponseDataException
 
Invoice - Class in com.paypal.api.payments
 
Invoice() - Constructor for class com.paypal.api.payments.Invoice
Default Constructor
Invoice(MerchantInfo) - Constructor for class com.paypal.api.payments.Invoice
Parameterized Constructor
InvoiceAddress - Class in com.paypal.api.payments
 
InvoiceAddress() - Constructor for class com.paypal.api.payments.InvoiceAddress
Default Constructor
InvoiceItem - Class in com.paypal.api.payments
 
InvoiceItem() - Constructor for class com.paypal.api.payments.InvoiceItem
Default Constructor
InvoiceItem(String, float, Currency) - Constructor for class com.paypal.api.payments.InvoiceItem
Parameterized Constructor
InvoiceNumber - Class in com.paypal.api.payments
 
InvoiceNumber() - Constructor for class com.paypal.api.payments.InvoiceNumber
Default Constructor
Invoices - Class in com.paypal.api.payments
 
Invoices() - Constructor for class com.paypal.api.payments.Invoices
Default Constructor
InvoicingMetaData - Class in com.paypal.api.payments
 
InvoicingMetaData() - Constructor for class com.paypal.api.payments.InvoicingMetaData
Default Constructor
InvoicingNotification - Class in com.paypal.api.payments
 
InvoicingNotification() - Constructor for class com.paypal.api.payments.InvoicingNotification
Default Constructor
InvoicingPaymentDetail - Class in com.paypal.api.payments
 
InvoicingPaymentDetail() - Constructor for class com.paypal.api.payments.InvoicingPaymentDetail
Default Constructor
InvoicingPaymentDetail(String) - Constructor for class com.paypal.api.payments.InvoicingPaymentDetail
Parameterized Constructor
InvoicingRefundDetail - Class in com.paypal.api.payments
 
InvoicingRefundDetail() - Constructor for class com.paypal.api.payments.InvoicingRefundDetail
Default Constructor
InvoicingRefundDetail(String) - Constructor for class com.paypal.api.payments.InvoicingRefundDetail
Parameterized Constructor
InvoicingSearch - Class in com.paypal.api.payments
 
InvoicingSearch() - Constructor for class com.paypal.api.payments.InvoicingSearch
Default Constructor
IPN_ENDPOINT - Static variable in class com.paypal.base.Constants
 
IPN_LIVE_ENDPOINT - Static variable in class com.paypal.base.Constants
 
IPN_SANDBOX_ENDPOINT - Static variable in class com.paypal.base.Constants
 
isArrayByteBase64(byte[]) - Static method in class com.paypal.base.codec.binary.Base64
Deprecated.
1.5 Use Base64.isBase64(byte[]), will be removed in 2.0.
isBase64(byte) - Static method in class com.paypal.base.codec.binary.Base64
Returns whether or not the octet is in the base 64 alphabet.
isBase64(String) - Static method in class com.paypal.base.codec.binary.Base64
Tests a given String to see if it contains only valid characters within the Base64 alphabet.
isBase64(byte[]) - Static method in class com.paypal.base.codec.binary.Base64
Tests a given byte array to see if it contains only valid characters within the Base64 alphabet.
isGoogleAppEngine() - Method in class com.paypal.base.HttpConfiguration
 
isInAlphabet(byte) - Method in class com.paypal.base.codec.binary.Base64
Returns whether or not the octet is in the Base32 alphabet.
isInAlphabet(byte) - Method in class com.paypal.base.codec.binary.BaseNCodec
Returns whether or not the octet is in the current alphabet.
isInAlphabet(byte[], boolean) - Method in class com.paypal.base.codec.binary.BaseNCodec
Tests a given byte array to see if it contains only valid characters within the alphabet.
isInAlphabet(String) - Method in class com.paypal.base.codec.binary.BaseNCodec
Tests a given String to see if it contains only valid characters within the alphabet.
ISO_8859_1 - Static variable in class com.paypal.base.codec.CharEncoding
CharEncodingISO Latin Alphabet No.
isPropertyLoaded() - Method in class com.paypal.base.ConfigManager
Deprecated.
This code was used for older integrations. Not valid anymore. To be removed in the next major release.
isProxySet() - Method in class com.paypal.base.HttpConfiguration
 
isUrlSafe() - Method in class com.paypal.base.codec.binary.Base64
Returns our current encode mode.
isWhiteSpace(byte) - Static method in class com.paypal.base.codec.binary.BaseNCodec
Checks if a byte value is whitespace or not.
Item - Class in com.paypal.api.payments
 
Item() - Constructor for class com.paypal.api.payments.Item
Default Constructor
Item(String, String, String, String) - Constructor for class com.paypal.api.payments.Item
Parameterized Constructor
ItemList - Class in com.paypal.api.payments
 
ItemList() - Constructor for class com.paypal.api.payments.ItemList
Default Constructor

J

JSONFormatter - Class in com.paypal.base.rest
JSONFormatter converts objects to JSON representation and vice-versa.

L

lineLength - Variable in class com.paypal.base.codec.binary.BaseNCodec
Chunksize for encoding.
Links - Class in com.paypal.api.payments
 
Links() - Constructor for class com.paypal.api.payments.Links
Default Constructor
Links(String, String) - Constructor for class com.paypal.api.payments.Links
Parameterized Constructor
list(String, Map<String, String>) - Static method in class com.paypal.api.payments.CreditCard
Deprecated.
list(APIContext, Map<String, String>) - Static method in class com.paypal.api.payments.CreditCard
Retrieves a list of Credit Card resources.
list(APIContext) - Static method in class com.paypal.api.payments.CreditCard
Retrieves a list of Credit Card resources.
list(String) - Static method in class com.paypal.api.payments.CreditCard
Deprecated.
list(String, String) - Static method in class com.paypal.api.payments.Event
Deprecated.
Please use Event.list(APIContext, String) instead.
list(APIContext, String) - Static method in class com.paypal.api.payments.Event
Retrieves the list of Webhooks events resources for the application associated with token.
list(String, Map<String, String>) - Static method in class com.paypal.api.payments.Payment
Deprecated.
Please use Payment.list(APIContext, Map) instead.
list(APIContext, Map<String, String>) - Static method in class com.paypal.api.payments.Payment
List payments that were made to the merchant who issues the request.
list(String, Map<String, String>) - Static method in class com.paypal.api.payments.Plan
Deprecated.
Please use Plan.list(APIContext, Map) instead.
list(APIContext, Map<String, String>) - Static method in class com.paypal.api.payments.Plan
List billing plans according to optional query string parameters specified.
LIVE - Static variable in class com.paypal.base.Constants
 
load(InputStream) - Method in class com.paypal.base.ConfigManager
Deprecated.
This code was used for older integrations. Not valid anymore. To be removed in the next major release.
load(Properties) - Method in class com.paypal.base.ConfigManager
Deprecated.
This code was used for older integrations. Not valid anymore. To be removed in the next major release.

M

MASK_8BITS - Static variable in class com.paypal.base.codec.binary.BaseNCodec
Mask used to extract 8 bits, used in decoding bytes
Measurement - Class in com.paypal.api.payments
 
Measurement() - Constructor for class com.paypal.api.payments.Measurement
 
MERCHANT_LIVE_CERTIFICATE_ENDPOINT - Static variable in class com.paypal.base.Constants
 
MERCHANT_LIVE_SIGNATURE_ENDPOINT - Static variable in class com.paypal.base.Constants
 
MERCHANT_SANDBOX_CERTIFICATE_ENDPOINT - Static variable in class com.paypal.base.Constants
 
MERCHANT_SANDBOX_SIGNATURE_ENDPOINT - Static variable in class com.paypal.base.Constants
 
MerchantInfo - Class in com.paypal.api.payments
 
MerchantInfo() - Constructor for class com.paypal.api.payments.MerchantInfo
Default Constructor
MerchantInfo(String) - Constructor for class com.paypal.api.payments.MerchantInfo
Parameterized Constructor
MerchantPreferences - Class in com.paypal.api.payments
 
MerchantPreferences() - Constructor for class com.paypal.api.payments.MerchantPreferences
Default Constructor
MerchantPreferences(String, String) - Constructor for class com.paypal.api.payments.MerchantPreferences
Parameterized Constructor
Metadata - Class in com.paypal.api.payments
 
Metadata() - Constructor for class com.paypal.api.payments.Metadata
Default Constructor
MIME_CHUNK_SIZE - Static variable in class com.paypal.base.codec.binary.BaseNCodec
MIME chunk size per RFC 2045 section 6.8.
MissingCredentialException - Exception in com.paypal.base.exception
MissingCredentialException is throw when the credential used are wrongly configured or not found in the application properties
MissingCredentialException(String) - Constructor for exception com.paypal.base.exception.MissingCredentialException
 
MissingCredentialException(String, Throwable) - Constructor for exception com.paypal.base.exception.MissingCredentialException
 
MODE - Static variable in class com.paypal.base.Constants
 
modulus - Variable in class com.paypal.base.codec.binary.BaseNCodec
Writes to the buffer only occur after every 3/5 reads when encoding, and every 4/8 reads when decoding.

N

NameValuePair - Class in com.paypal.api.payments
 
NameValuePair() - Constructor for class com.paypal.api.payments.NameValuePair
Default Constructor
NameValuePair(String, String) - Constructor for class com.paypal.api.payments.NameValuePair
Parameterized Constructor
newString(byte[], String) - Static method in class com.paypal.base.codec.binary.StringUtils
Constructs a new String by decoding the specified array of bytes using the given charset.
newStringIso8859_1(byte[]) - Static method in class com.paypal.base.codec.binary.StringUtils
Constructs a new String by decoding the specified array of bytes using the ISO-8859-1 charset.
newStringUsAscii(byte[]) - Static method in class com.paypal.base.codec.binary.StringUtils
Constructs a new String by decoding the specified array of bytes using the US-ASCII charset.
newStringUtf16(byte[]) - Static method in class com.paypal.base.codec.binary.StringUtils
Constructs a new String by decoding the specified array of bytes using the UTF-16 charset.
newStringUtf16Be(byte[]) - Static method in class com.paypal.base.codec.binary.StringUtils
Constructs a new String by decoding the specified array of bytes using the UTF-16BE charset.
newStringUtf16Le(byte[]) - Static method in class com.paypal.base.codec.binary.StringUtils
Constructs a new String by decoding the specified array of bytes using the UTF-16LE charset.
newStringUtf8(byte[]) - Static method in class com.paypal.base.codec.binary.StringUtils
Constructs a new String by decoding the specified array of bytes using the UTF-8 charset.
Notification - Class in com.paypal.api.payments
 
Notification() - Constructor for class com.paypal.api.payments.Notification
Default Constructor
NVPUtil - Class in com.paypal.base
 

O

OAUTH_ENDPOINT - Static variable in class com.paypal.base.Constants
 
OAuthException - Exception in com.paypal.base.exception
 
OAuthException(String) - Constructor for exception com.paypal.base.exception.OAuthException
Constructs a new exception with the specified detail message.
OAuthException(String, Throwable) - Constructor for exception com.paypal.base.exception.OAuthException
 
OAuthTokenCredential - Class in com.paypal.base.rest
OAuthTokenCredential is used for generation of OAuth Token used by PayPal REST API service.
OAuthTokenCredential(String, String) - Constructor for class com.paypal.base.rest.OAuthTokenCredential
Pass clientId and secret to OAuthTokenCredential.
OAuthTokenCredential(String, String, Map<String, String>) - Constructor for class com.paypal.base.rest.OAuthTokenCredential
Configuration Constructor for dynamic configuration
OPENID_REDIRECT_URI - Static variable in class com.paypal.base.Constants
 
OPENID_REDIRECT_URI_CONSTANT_LIVE - Static variable in class com.paypal.base.Constants
 
OPENID_REDIRECT_URI_CONSTANT_SANDBOX - Static variable in class com.paypal.base.Constants
 
Order - Class in com.paypal.api.payments
 
Order() - Constructor for class com.paypal.api.payments.Order
Default Constructor
Order(Amount) - Constructor for class com.paypal.api.payments.Order
Parameterized Constructor
OverrideChargeModel - Class in com.paypal.api.payments
 
OverrideChargeModel() - Constructor for class com.paypal.api.payments.OverrideChargeModel
Default Constructor

P

PAD - Variable in class com.paypal.base.codec.binary.BaseNCodec
 
PAD_DEFAULT - Static variable in class com.paypal.base.codec.binary.BaseNCodec
Byte used to pad output.
partialUpdate(String, PatchRequest) - Method in class com.paypal.api.payments.WebProfile
partialUpdate(APIContext, PatchRequest) - Method in class com.paypal.api.payments.WebProfile
Partially-updates a web experience profile.
Participant - Class in com.paypal.api.payments
 
Participant() - Constructor for class com.paypal.api.payments.Participant
Default Constructor
Participant(String) - Constructor for class com.paypal.api.payments.Participant
Parameterized Constructor
Patch - Class in com.paypal.api.payments
 
Patch() - Constructor for class com.paypal.api.payments.Patch
Default Constructor
Patch(String, String) - Constructor for class com.paypal.api.payments.Patch
Parameterized Constructor
PatchRequest - Class in com.paypal.api.payments
 
PatchRequest() - Constructor for class com.paypal.api.payments.PatchRequest
Default Constructor
PatchRequest(String, String) - Constructor for class com.paypal.api.payments.PatchRequest
Parameterized Constructor
Payee - Class in com.paypal.api.payments
 
Payee() - Constructor for class com.paypal.api.payments.Payee
Default Constructor
Payer - Class in com.paypal.api.payments
 
Payer() - Constructor for class com.paypal.api.payments.Payer
Default Constructor
PayerInfo - Class in com.paypal.api.payments
 
PayerInfo() - Constructor for class com.paypal.api.payments.PayerInfo
Default Constructor
PayerNotification - Class in com.paypal.api.payments
 
PayerNotification() - Constructor for class com.paypal.api.payments.PayerNotification
Default Constructor
PAYLOAD_FORMAT_NVP - Static variable in class com.paypal.base.Constants
 
PAYLOAD_FORMAT_SOAP - Static variable in class com.paypal.base.Constants
 
Payment - Class in com.paypal.api.payments
 
Payment() - Constructor for class com.paypal.api.payments.Payment
Default Constructor
Payment(String, Payer) - Constructor for class com.paypal.api.payments.Payment
Parameterized Constructor
PaymentCard - Class in com.paypal.api.payments
 
PaymentCard() - Constructor for class com.paypal.api.payments.PaymentCard
Default Constructor
PaymentCardToken - Class in com.paypal.api.payments
 
PaymentCardToken() - Constructor for class com.paypal.api.payments.PaymentCardToken
Default Constructor
PaymentCardToken(String, String, String) - Constructor for class com.paypal.api.payments.PaymentCardToken
Parameterized Constructor
PaymentDefinition - Class in com.paypal.api.payments
 
PaymentDefinition() - Constructor for class com.paypal.api.payments.PaymentDefinition
Default Constructor
PaymentDefinition(String, String, String, String, String, Currency) - Constructor for class com.paypal.api.payments.PaymentDefinition
Parameterized Constructor
PaymentDetail - Class in com.paypal.api.payments
 
PaymentDetail() - Constructor for class com.paypal.api.payments.PaymentDetail
Default Constructor
PaymentDetail(String) - Constructor for class com.paypal.api.payments.PaymentDetail
Parameterized Constructor
PaymentExecution - Class in com.paypal.api.payments
 
PaymentExecution() - Constructor for class com.paypal.api.payments.PaymentExecution
Default Constructor
PaymentHistory - Class in com.paypal.api.payments
 
PaymentHistory() - Constructor for class com.paypal.api.payments.PaymentHistory
Default Constructor
PaymentInstruction - Class in com.paypal.api.payments
 
PaymentInstruction(String, String, RecipientBankingInstruction, Currency) - Constructor for class com.paypal.api.payments.PaymentInstruction
Parameterized Constructor
PaymentOptions - Class in com.paypal.api.payments
 
PaymentOptions() - Constructor for class com.paypal.api.payments.PaymentOptions
Default Constructor
PaymentSummary - Class in com.paypal.api.payments
 
PaymentSummary() - Constructor for class com.paypal.api.payments.PaymentSummary
Default Constructor
PaymentTerm - Class in com.paypal.api.payments
 
PaymentTerm() - Constructor for class com.paypal.api.payments.PaymentTerm
Default Constructor
Payout - Class in com.paypal.api.payments
 
Payout() - Constructor for class com.paypal.api.payments.Payout
Default Constructor
Payout(PayoutSenderBatchHeader, List<PayoutItem>) - Constructor for class com.paypal.api.payments.Payout
Parameterized Constructor
PayoutBatch - Class in com.paypal.api.payments
 
PayoutBatch() - Constructor for class com.paypal.api.payments.PayoutBatch
Default Constructor
PayoutBatch(PayoutBatchHeader, List<PayoutItemDetails>) - Constructor for class com.paypal.api.payments.PayoutBatch
Parameterized Constructor
PayoutBatchHeader - Class in com.paypal.api.payments
 
PayoutBatchHeader() - Constructor for class com.paypal.api.payments.PayoutBatchHeader
Default Constructor
PayoutBatchHeader(String, String, String, PayoutSenderBatchHeader, Currency, Currency) - Constructor for class com.paypal.api.payments.PayoutBatchHeader
Parameterized Constructor
PayoutItem - Class in com.paypal.api.payments
 
PayoutItem() - Constructor for class com.paypal.api.payments.PayoutItem
Default Constructor
PayoutItem(Currency, String) - Constructor for class com.paypal.api.payments.PayoutItem
Parameterized Constructor
PayoutItemDetails - Class in com.paypal.api.payments
 
PayoutItemDetails() - Constructor for class com.paypal.api.payments.PayoutItemDetails
Default Constructor
PayoutItemDetails(String, String, PayoutItem, String) - Constructor for class com.paypal.api.payments.PayoutItemDetails
Parameterized Constructor
PayoutSenderBatchHeader - Class in com.paypal.api.payments
 
PayoutSenderBatchHeader() - Constructor for class com.paypal.api.payments.PayoutSenderBatchHeader
Default Constructor
PAYPAL_APPLICATION_ID_HEADER - Static variable in class com.paypal.base.Constants
 
PAYPAL_AUTHORIZATION_MERCHANT_HEADER - Static variable in class com.paypal.base.Constants
 
PAYPAL_AUTHORIZATION_PLATFORM_HEADER - Static variable in class com.paypal.base.Constants
 
PAYPAL_DEVICE_IPADDRESS_HEADER - Static variable in class com.paypal.base.Constants
 
PAYPAL_HEADER_AUTH_ALGO - Static variable in class com.paypal.base.Constants
 
PAYPAL_HEADER_CERT_URL - Static variable in class com.paypal.base.Constants
 
PAYPAL_HEADER_TRANSMISSION_ID - Static variable in class com.paypal.base.Constants
 
PAYPAL_HEADER_TRANSMISSION_SIG - Static variable in class com.paypal.base.Constants
 
PAYPAL_HEADER_TRANSMISSION_TIME - Static variable in class com.paypal.base.Constants
 
PAYPAL_REQUEST_DATA_FORMAT_HEADER - Static variable in class com.paypal.base.Constants
 
PAYPAL_REQUEST_ID_HEADER - Static variable in class com.paypal.base.Constants
 
PAYPAL_REQUEST_SOURCE_HEADER - Static variable in class com.paypal.base.Constants
 
PAYPAL_RESPONSE_DATA_FORMAT_HEADER - Static variable in class com.paypal.base.Constants
 
PAYPAL_SANDBOX_EMAIL_ADDRESS_HEADER - Static variable in class com.paypal.base.Constants
 
PAYPAL_SECURITY_PASSWORD_HEADER - Static variable in class com.paypal.base.Constants
 
PAYPAL_SECURITY_SIGNATURE_HEADER - Static variable in class com.paypal.base.Constants
 
PAYPAL_SECURITY_USERID_HEADER - Static variable in class com.paypal.base.Constants
 
PAYPAL_TRUST_CERT_URL - Static variable in class com.paypal.base.Constants
 
PAYPAL_TRUST_DEFAULT_CERT - Static variable in class com.paypal.base.Constants
 
PAYPAL_WEBHOOK_CERTIFICATE_AUTHTYPE - Static variable in class com.paypal.base.Constants
 
PAYPAL_WEBHOOK_ID - Static variable in class com.paypal.base.Constants
 
PayPalException - Exception in com.paypal.base.exception
A PayPalException is thrown to signal a problem during SDK execution.
PayPalException() - Constructor for exception com.paypal.base.exception.PayPalException
 
PayPalException(String) - Constructor for exception com.paypal.base.exception.PayPalException
 
PayPalException(String, Throwable) - Constructor for exception com.paypal.base.exception.PayPalException
 
PayPalModel - Class in com.paypal.base.rest
 
PayPalModel() - Constructor for class com.paypal.base.rest.PayPalModel
 
PayPalResource - Class in com.paypal.base.rest
PayPalResource acts as a base class for REST enabled resources.
PayPalResource() - Constructor for class com.paypal.base.rest.PayPalResource
 
PayPalRESTException - Exception in com.paypal.base.rest
PayPalException handles all exceptions related to REST services
PayPalRESTException(String) - Constructor for exception com.paypal.base.rest.PayPalRESTException
 
PayPalRESTException(String, Throwable) - Constructor for exception com.paypal.base.rest.PayPalRESTException
 
PayPalRESTException(Throwable) - Constructor for exception com.paypal.base.rest.PayPalRESTException
 
PayPalURLEncoder - Class in com.paypal.base.util
 
PEM_CHUNK_SIZE - Static variable in class com.paypal.base.codec.binary.BaseNCodec
PEM chunk size per RFC 1421 section 4.3.2.4.
Percentage - Class in com.paypal.api.payments
 
Percentage() - Constructor for class com.paypal.api.payments.Percentage
Default Constructor
Phone - Class in com.paypal.api.payments
 
Phone() - Constructor for class com.paypal.api.payments.Phone
Default Constructor
Phone(String, String) - Constructor for class com.paypal.api.payments.Phone
Parameterized Constructor
Plan - Class in com.paypal.api.payments
 
Plan() - Constructor for class com.paypal.api.payments.Plan
Default Constructor
Plan(String, String, String) - Constructor for class com.paypal.api.payments.Plan
Parameterized Constructor
PlanList - Class in com.paypal.api.payments
 
PlanList() - Constructor for class com.paypal.api.payments.PlanList
Default Constructor
PLATFORM_LIVE_ENDPOINT - Static variable in class com.paypal.base.Constants
 
PLATFORM_SANDBOX_ENDPOINT - Static variable in class com.paypal.base.Constants
 
pos - Variable in class com.paypal.base.codec.binary.BaseNCodec
Position where next character should be written in the buffer.
PotentialPayerInfo - Class in com.paypal.api.payments
 
PotentialPayerInfo() - Constructor for class com.paypal.api.payments.PotentialPayerInfo
Default Constructor
Presentation - Class in com.paypal.api.payments
 
Presentation() - Constructor for class com.paypal.api.payments.Presentation
Default Constructor
PrivateLabelCard - Class in com.paypal.api.payments
 
PrivateLabelCard() - Constructor for class com.paypal.api.payments.PrivateLabelCard
Default Constructor
ProcessorResponse - Class in com.paypal.api.payments
 
ProcessorResponse() - Constructor for class com.paypal.api.payments.ProcessorResponse
Default Constructor
ProcessorResponse(String) - Constructor for class com.paypal.api.payments.ProcessorResponse
Parameterized Constructor

Q

qrCode(APIContext, String) - Static method in class com.paypal.api.payments.Invoice
Deprecated.
qrCode(APIContext, String, Map<String, String>) - Static method in class com.paypal.api.payments.Invoice
Generates a QR code for an invoice, by ID.
QueryParameters - Class in com.paypal.base.rest
QueryParameters holds query parameters used for retrieving PaymentHistory object.
QueryParameters() - Constructor for class com.paypal.base.rest.QueryParameters
 

R

reActivate(String, AgreementStateDescriptor) - Method in class com.paypal.api.payments.Agreement
reActivate(APIContext, AgreementStateDescriptor) - Method in class com.paypal.api.payments.Agreement
Reactivate a suspended billing agreement by passing the ID of the agreement to the appropriate URI.
read(BufferedReader) - Method in class com.paypal.base.HttpConnection
 
reauthorize(String) - Method in class com.paypal.api.payments.Authorization
Deprecated.
reauthorize(APIContext) - Method in class com.paypal.api.payments.Authorization
Reauthorizes a PayPal account payment, by authorization ID.
RecipientBankingInstruction - Class in com.paypal.api.payments
 
RecipientBankingInstruction() - Constructor for class com.paypal.api.payments.RecipientBankingInstruction
Default Constructor
RecipientBankingInstruction(String, String, String) - Constructor for class com.paypal.api.payments.RecipientBankingInstruction
Parameterized Constructor
recordPayment(String, PaymentDetail) - Method in class com.paypal.api.payments.Invoice
Deprecated.
recordPayment(APIContext, PaymentDetail) - Method in class com.paypal.api.payments.Invoice
Marks the status of a specified invoice, by ID, as paid.
recordRefund(String, RefundDetail) - Method in class com.paypal.api.payments.Invoice
Deprecated.
recordRefund(APIContext, RefundDetail) - Method in class com.paypal.api.payments.Invoice
Marks the status of a specified invoice, by ID, as refunded.
RedirectUrls - Class in com.paypal.api.payments
 
RedirectUrls() - Constructor for class com.paypal.api.payments.RedirectUrls
Default Constructor
ReflectionUtil - Class in com.paypal.base
 
refund(String, Refund) - Method in class com.paypal.api.payments.Capture
Deprecated.
refund(APIContext, Refund) - Method in class com.paypal.api.payments.Capture
Deprecated.
Please use Capture.refund(APIContext, RefundRequest) instead Refunds a captured payment, by ID. Include an `amount` object in the JSON request body.
refund(APIContext, RefundRequest) - Method in class com.paypal.api.payments.Capture
Refunds a captured payment, by ID.
Refund - Class in com.paypal.api.payments
 
Refund() - Constructor for class com.paypal.api.payments.Refund
Default Constructor
refund(String, Refund) - Method in class com.paypal.api.payments.Sale
Deprecated.
refund(APIContext, Refund) - Method in class com.paypal.api.payments.Sale
Deprecated.
Please use Sale.refund(APIContext, RefundRequest) instead 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.
refund(APIContext, RefundRequest) - Method in class com.paypal.api.payments.Sale
Refunds a sale, by ID.
RefundDetail - Class in com.paypal.api.payments
 
RefundDetail() - Constructor for class com.paypal.api.payments.RefundDetail
Default Constructor
RefundDetail(String) - Constructor for class com.paypal.api.payments.RefundDetail
Parameterized Constructor
RefundRequest - Class in com.paypal.api.payments
 
RefundRequest() - Constructor for class com.paypal.api.payments.RefundRequest
Default Constructor
RelatedResources - Class in com.paypal.api.payments
 
RelatedResources() - Constructor for class com.paypal.api.payments.RelatedResources
Default Constructor
remind(String, Notification) - Method in class com.paypal.api.payments.Invoice
Deprecated.
remind(APIContext, Notification) - Method in class com.paypal.api.payments.Invoice
Sends a reminder about a specific invoice, by ID, to a recipient.
resend(String) - Method in class com.paypal.api.payments.Event
Deprecated.
Please use Event.resend(APIContext) instead.
resend(APIContext) - Method in class com.paypal.api.payments.Event
Resends the Webhooks event resource identified by event_id.
ResourceLoader - Class in com.paypal.base.util
A class to locate resources and retrieve their contents.
ResourceLoader(String) - Constructor for class com.paypal.base.util.ResourceLoader
ResourceLoader to load the resource specified by name
REST_LIVE_ENDPOINT - Static variable in class com.paypal.base.Constants
 
REST_SANDBOX_ENDPOINT - Static variable in class com.paypal.base.Constants
 
RESTAPICallPreHandler - Class in com.paypal.base.rest
RESTApiCallPreHandler acts as a APICallPreHandler for REST API calls.
RESTAPICallPreHandler(Map<String, String>) - Constructor for class com.paypal.base.rest.RESTAPICallPreHandler
Constructor using configurations dynamically
RESTAPICallPreHandler(Map<String, String>, Map<String, String>) - Constructor for class com.paypal.base.rest.RESTAPICallPreHandler
Constructor using a Map of headers for forming custom headers
RESTUtil - Class in com.paypal.base.rest
RESTUtil acts as utility class used by REST API system

S

Sale - Class in com.paypal.api.payments
 
Sale() - Constructor for class com.paypal.api.payments.Sale
Default Constructor
Sale(String, Amount, String, String, String) - Constructor for class com.paypal.api.payments.Sale
Parameterized Constructor
SANDBOX - Static variable in class com.paypal.base.Constants
 
SANDBOX_EMAIL_ADDRESS - Static variable in class com.paypal.base.Constants
 
saveToFile(String) - Method in class com.paypal.api.payments.Image
Saves the image to a file.
SDKUtil - Class in com.paypal.base
SDKUtil class holds utility methods for processing data transformation
SDKVersion - Interface in com.paypal.base
 
SDKVersionImpl - Class in com.paypal.base.sdk.info
Implementation of SDKVersion
SDKVersionImpl() - Constructor for class com.paypal.base.sdk.info.SDKVersionImpl
 
search(String, Search) - Method in class com.paypal.api.payments.Invoice
Deprecated.
search(APIContext, Search) - Method in class com.paypal.api.payments.Invoice
Searches for an invoice or invoices.
Search - Class in com.paypal.api.payments
 
Search() - Constructor for class com.paypal.api.payments.Search
Default Constructor
send(String) - Method in class com.paypal.api.payments.Invoice
Deprecated.
Please use Invoice.send(APIContext) instead.
send(APIContext) - Method in class com.paypal.api.payments.Invoice
Sends an invoice, by ID, to a recipient.
SERVICE_DEVCENTRAL_ENDPOINT - Static variable in class com.paypal.base.Constants
 
SERVICE_REDIRECT_ENDPOINT - Static variable in class com.paypal.base.Constants
 
Session - Class in com.paypal.api.openidconnect
 
set3dSecureInfo(Card3dSecureInfo) - Method in class com.paypal.api.payments.PaymentCard
Deprecated.
Please use PaymentCard.setCard3dSecureInfo(Card3dSecureInfo) instead. Setter for 3dSecureInfo
setAcceptedPaymentType(String) - Method in class com.paypal.api.payments.MerchantPreferences
Payment types that are accepted for this plan.
setAccessToken(String) - Method in class com.paypal.api.openidconnect.Tokeninfo
Setter for accessToken
setAccessToken(String) - Method in class com.paypal.api.openidconnect.UserinfoParameters
Set the accessToken
setAccountAge(String) - Method in class com.paypal.api.payments.Payer
Duration since the payer established account relationship with PayPal in days.
setAccountHolderName(String) - Method in class com.paypal.api.payments.RecipientBankingInstruction
Name of the account holder
setAccountName(String) - Method in class com.paypal.api.payments.BankAccount
A customer designated name.
setAccountNumber(String) - Method in class com.paypal.api.payments.BankAccount
Account number in either IBAN (max length 34) or BBAN (max length 17) format.
setAccountNumber(String) - Method in class com.paypal.api.payments.Payee
Unencrypted PayPal account Number of the Payee
setAccountNumber(String) - Method in class com.paypal.api.payments.PayerInfo
Deprecated.
setAccountNumber(String) - Method in class com.paypal.api.payments.PotentialPayerInfo
Account Number representing the potential payer
setAccountNumber(String) - Method in class com.paypal.api.payments.RecipientBankingInstruction
bank account number
setAccountNumberType(String) - Method in class com.paypal.api.payments.BankAccount
Type of the bank account number (International or Basic Bank Account Number).
setAccountType(String) - Method in class com.paypal.api.openidconnect.Userinfo
Account type.
setAccountType(String) - Method in class com.paypal.api.payments.BankAccount
Type of the bank account.
setAccountType(String) - Method in class com.paypal.api.payments.Payer
Type of account relationship payer has with PayPal.
setAdditionalData(String) - Method in class com.paypal.api.payments.Invoice
Any miscellaneous invoice data.
setAdditionalInfo(String) - Method in class com.paypal.api.payments.BillingInfo
Additional information, such as business hours.
setAdditionalInfo(String) - Method in class com.paypal.api.payments.MerchantInfo
Additional information, such as business hours.
setAdditionalInfo(String) - Method in class com.paypal.api.payments.Participant
Additional information, such as business hours.
setAdditionalInfoLabel(String) - Method in class com.paypal.api.payments.MerchantInfo
Option to provide a label to the additional_info field.
setAddress(Address) - Method in class com.paypal.api.openidconnect.Userinfo
End-User's preferred address.
setAddress(InvoiceAddress) - Method in class com.paypal.api.payments.BillingInfo
The invoice recipient address.
setAddress(InvoiceAddress) - Method in class com.paypal.api.payments.MerchantInfo
The merchant address.
setAddress(InvoiceAddress) - Method in class com.paypal.api.payments.Participant
The participant address.
setAddress(InvoiceAddress) - Method in class com.paypal.api.payments.ShippingInfo
The invoice recipient address.
setAddresses(List<Address>) - Method in class com.paypal.api.payments.Templates
List of addresses in merchant's profile.
setAddressOverride(int) - Method in class com.paypal.api.payments.InputFields
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.
setAdviceCode(String) - Method in class com.paypal.api.payments.ProcessorResponse
Provides merchant advice on how to handle declines related to recurring payments
setAgeRange(String) - Method in class com.paypal.api.openidconnect.Userinfo
Account holder age range.
setAgreementDetails(AgreementDetails) - Method in class com.paypal.api.payments.Agreement
Details of the agreement.
setAgreementTransactionList(List<AgreementTransaction>) - Method in class com.paypal.api.payments.AgreementTransactions
Array of agreement_transaction object.
setAllowedPaymentMethod(String) - Method in class com.paypal.api.payments.PaymentOptions
Payment method requested for this purchase unit
setAllowNote(Boolean) - Method in class com.paypal.api.payments.InputFields
Indicates whether the buyer can enter a note to the merchant on the PayPal page during checkout.
setAllowPartialPayment(Boolean) - Method in class com.paypal.api.payments.Invoice
Indicates whether the invoice allows a partial payment.
setAllowPartialPayment(Boolean) - Method in class com.paypal.api.payments.TemplateData
Indicates whether the invoice allows a partial payment.
setAlternatePayment(AlternatePayment) - Method in class com.paypal.api.payments.FundingInstrument
Alternate Payment information - Mostly regional payment providers.
setAlternatePaymentAccountId(String) - Method in class com.paypal.api.payments.AlternatePayment
The unique identifier of the alternate payment account.
setAlternatePaymentProviderId(String) - Method in class com.paypal.api.payments.AlternatePayment
Alternate Payment provider id.
setAmount(Currency) - Method in class com.paypal.api.payments.AgreementStateDescriptor
The amount and currency of the agreement.
setAmount(Currency) - Method in class com.paypal.api.payments.AgreementTransaction
Amount for this transaction.
setAmount(Amount) - Method in class com.paypal.api.payments.Authorization
Amount being authorized.
setAmount(Amount) - Method in class com.paypal.api.payments.Capture
The amount to capture.
setAmount(Amount) - Method in class com.paypal.api.payments.CartBase
Amount being collected.
setAmount(Currency) - Method in class com.paypal.api.payments.ChargeModels
Specific amount for this charge model.
setAmount(Currency) - Method in class com.paypal.api.payments.Cost
The cost, as an amount.
setAmount(Currency) - Method in class com.paypal.api.payments.CustomAmount
The custom amount value.
setAmount(Amount) - Method in class com.paypal.api.payments.ExternalFunding
Amount being funded by the external funding account
setAmount(Amount) - Method in class com.paypal.api.payments.Order
Amount being collected.
setAmount(Currency) - Method in class com.paypal.api.payments.OverrideChargeModel
Updated Amount to be associated with this charge model.
setAmount(Currency) - Method in class com.paypal.api.payments.PaymentDefinition
Amount that will be charged at the end of each cycle for this payment definition.
setAmount(Currency) - Method in class com.paypal.api.payments.PaymentDetail
The amount to record as payment against invoice.
setAmount(Currency) - Method in class com.paypal.api.payments.PaymentInstruction
Amount to be transferred
setAmount(Currency) - Method in class com.paypal.api.payments.PayoutBatchHeader
Total amount, in U.S.
setAmount(Currency) - Method in class com.paypal.api.payments.PayoutItem
The amount of money to pay the receiver.
setAmount(Amount) - Method in class com.paypal.api.payments.Refund
Details including both refunded amount (to payer) and refunded fee (to payee).
setAmount(Currency) - Method in class com.paypal.api.payments.RefundDetail
Amount to be recorded as refund against invoice.
setAmount(Amount) - Method in class com.paypal.api.payments.RefundRequest
Details including both refunded amount (to payer) and refunded fee (to payee).
setAmount(Amount) - Method in class com.paypal.api.payments.Sale
Amount being collected.
setAmount(Currency) - Method in class com.paypal.api.payments.ShippingCost
The shipping cost, as an amount.
setAmount(Currency) - Method in class com.paypal.api.payments.Tax
The tax as a monetary amount.
setAmount(Amount) - Method in class com.paypal.api.payments.Transactions
Amount being collected.
setAmountRange(Currency) - Method in class com.paypal.api.payments.Terms
Amount_range associated with this term.
setAppId(String) - Method in class com.paypal.api.openidconnect.Tokeninfo
Setter for appId
setArchived(Boolean) - Method in class com.paypal.api.payments.Search
A flag indicating whether search is on invoices archived by merchant.
setAttachments(List<FileAttachment>) - Method in class com.paypal.api.payments.Invoice
List of files attached to the invoice.
setAttachments(List<FileAttachment>) - Method in class com.paypal.api.payments.TemplateData
List of files attached to the invoice.
setAuthCaptureTimestamp(String) - Method in class com.paypal.api.payments.BankAccount
Time at which the authorization (or check) was captured.
setAuthorization(Authorization) - Method in class com.paypal.api.payments.RelatedResources
Authorization transaction
setAuthorizationToken(String) - Method in class com.paypal.base.rest.RESTAPICallPreHandler
 
setAuthStatus(String) - Method in class com.paypal.api.payments.Card3dSecureInfo
Authorization status from 3ds provider.
setAuthType(String) - Method in class com.paypal.api.payments.BankAccount
How the check was obtained from the customer, if check was the source of the information provided.
setAutoBillAmount(String) - Method in class com.paypal.api.payments.MerchantPreferences
Allow auto billing for the outstanding amount of the agreement in the next cycle.
setAvsCode(String) - Method in class com.paypal.api.payments.ProcessorResponse
Address Verification System response code.
setBackupFundingInstrument(FundingInstrument) - Method in class com.paypal.api.payments.FundingOption
Backup funding instrument which will be used for payment if primary fails.
setBalance(String, Currency) - Method in class com.paypal.api.payments.Agreement
Deprecated.
setBalance(APIContext, Currency) - Method in class com.paypal.api.payments.Agreement
Set the balance for an agreement by passing the ID of the agreement to the request URI.
setBankAccount(ExtendedBankAccount) - Method in class com.paypal.api.payments.FundingInstrument
Bank Account information.
setBankAccountToken(BankToken) - Method in class com.paypal.api.payments.FundingInstrument
Vaulted bank account instrument.
setBankId(String) - Method in class com.paypal.api.payments.BankToken
ID of a previously saved Bank resource using /vault/bank API.
setBankIdentifierCode(String) - Method in class com.paypal.api.payments.RecipientBankingInstruction
BIC identifier of the financial institution
setBankName(String) - Method in class com.paypal.api.payments.BankAccount
Name of the bank.
setBankName(String) - Method in class com.paypal.api.payments.RecipientBankingInstruction
Name of the financial institution.
setBankTxnPendingUrl(String) - Method in class com.paypal.api.payments.FlowConfig
The merchant site URL to display after a bank transfer payment.
setBatchHeader(PayoutBatchHeader) - Method in class com.paypal.api.payments.PayoutBatch
A batch header.
setBatchStatus(String) - Method in class com.paypal.api.payments.PayoutBatchHeader
The PayPal-generated batch payout status.
setBilling(Billing) - Method in class com.paypal.api.payments.FundingInstrument
Billing instrument that references pre-approval information for the payment
setBillingAddress(Address) - Method in class com.paypal.api.payments.BankAccount
Billing address.
setBillingAddress(Address) - Method in class com.paypal.api.payments.CreditCard
Billing Address associated with this card.
setBillingAddress(Address) - Method in class com.paypal.api.payments.PayerInfo
Billing address of the Payer.
setBillingAddress(Address) - Method in class com.paypal.api.payments.PaymentCard
The billing address for the card.
setBillingAddress(Address) - Method in class com.paypal.api.payments.PotentialPayerInfo
Billing address of the potential payer.
setBillingAgreementId(String) - Method in class com.paypal.api.payments.Billing
Identifier of the instrument in PayPal Wallet
setBillingAgreementId(String) - Method in class com.paypal.api.payments.Sale
ID of the billing agreement used as reference to execute this transaction.
setBillingAgreementTokens(List<BillingAgreementToken>) - Method in class com.paypal.api.payments.Payment
Collection of PayPal generated billing agreement tokens.
setBillingCountry(CountryCode) - Method in class com.paypal.api.payments.PaymentCard
The two-letter country code.
setBillingInfo(List<BillingInfo>) - Method in class com.paypal.api.payments.Invoice
The required invoice recipient email address and any optional billing information.
setBillingInfo(List<BillingInfo>) - Method in class com.paypal.api.payments.TemplateData
The required invoice recipient email address and any optional billing information.
setBirthdate(String) - Method in class com.paypal.api.openidconnect.Userinfo
Deprecated.
PayPal API returns 'birthday', use that instead
setBirthDate(String) - Method in class com.paypal.api.payments.BankAccount
Birth date of the bank account holder.
setBirthDate(String) - Method in class com.paypal.api.payments.PayerInfo
Birth date of the Payer in ISO8601 format (yyyy-mm-dd).
setBirthday(String) - Method in class com.paypal.api.openidconnect.Userinfo
End-User's birthday, represented as an YYYY-MM-DD format.
setBrandName(String) - Method in class com.paypal.api.payments.Presentation
A label that overrides the business name in the PayPal account on the PayPal pages.
setBusinessName(String) - Method in class com.paypal.api.payments.BillingInfo
The invoice recipient company business name.
setBusinessName(String) - Method in class com.paypal.api.payments.MerchantInfo
The merchant company business name.
setBusinessName(String) - Method in class com.paypal.api.payments.Participant
The participant company business name.
setBusinessName(String) - Method in class com.paypal.api.payments.ShippingInfo
The invoice recipient company business name.
setBuyerAccountNumber(String) - Method in class com.paypal.api.payments.PayerInfo
Account Number representing the Payer
setBuyerEditable(String) - Method in class com.paypal.api.payments.Terms
Buyer's ability to edit the amount in this term.
setCancelledBy(String) - Method in class com.paypal.api.payments.InvoicingMetaData
Actor who cancelled the resource.
setCancelledBy(String) - Method in class com.paypal.api.payments.Metadata
The actor who cancelled the resource.
setCancelledDate(String) - Method in class com.paypal.api.payments.InvoicingMetaData
Date when the resource was cancelled.
setCancelledDate(String) - Method in class com.paypal.api.payments.Metadata
The date and time when the resource was cancelled.
setCancelUrl(String) - Method in class com.paypal.api.payments.MerchantPreferences
Redirect URL on cancellation of agreement request.
setCancelUrl(String) - Method in class com.paypal.api.payments.RedirectUrls
Url where the payer would be redirected to after canceling the payment.
setCapture(Capture) - Method in class com.paypal.api.payments.RelatedResources
Capture transaction
setCaptureId(String) - Method in class com.paypal.api.payments.Refund
ID of the sale transaction being refunded.
setCard3dSecureInfo(Card3dSecureInfo) - Method in class com.paypal.api.payments.PaymentCard
Fields required to support 3d secure information when processing credit card payments.
setCardNumber(String) - Method in class com.paypal.api.payments.PrivateLabelCard
last 4 digits of the card number.
setCardProductClass(String) - Method in class com.paypal.api.payments.PaymentCard
The product class of the financial instrument issuer.
setCarrierAccount(CarrierAccount) - Method in class com.paypal.api.payments.FundingInstrument
Carrier account instrument
setCarrierAccountId(String) - Method in class com.paypal.api.payments.CarrierAccountToken
ID of a previously saved carrier account resource.
setCarrierAccountId(String) - Method in class com.paypal.api.payments.PaymentExecution
Carrier account id for a carrier billing payment.
setCarrierAccountToken(CarrierAccountToken) - Method in class com.paypal.api.payments.FundingInstrument
Carrier account token instrument.
setCart(String) - Method in class com.paypal.api.payments.Payment
ID of the cart to execute the payment.
setCartAmountImmutable(Boolean) - Method in class com.paypal.api.payments.CreditFinancingOffered
Indicates whether the cart amount is editable after payer's acceptance on PayPal side
setCategory(String) - Method in class com.paypal.api.payments.Item
Category type of the item.
setCavv(String) - Method in class com.paypal.api.payments.Card3dSecureInfo
Cardholder Authentication Verification Value (used by VISA).
setCcEmails(List<String>) - Method in class com.paypal.api.payments.CancelNotification
Applicable for invoices created with Cc emails.
setCcEmails(List<String>) - Method in class com.paypal.api.payments.Notification
Applicable for invoices created with Cc emails.
setCcInfo(List<Participant>) - Method in class com.paypal.api.payments.Invoice
For invoices sent by email, one or more email addresses to which to send a Cc: copy of the notification.
setCcInfo(List<String>) - Method in class com.paypal.api.payments.TemplateData
For invoices sent by email, one or more email addresses to which to send a Cc: copy of the notification.
setChargeId(String) - Method in class com.paypal.api.payments.OverrideChargeModel
ID of charge model.
setChargeModels(List<ChargeModels>) - Method in class com.paypal.api.payments.PaymentDefinition
Array of charge_models for this payment definition.
setCharSet(String) - Method in class com.paypal.api.payments.MerchantPreferences
char_set for this plan.
setCheckType(String) - Method in class com.paypal.api.payments.BankAccount
Type of the check when this information was obtained through a check by the facilitator or merchant.
setCity(String) - Method in class com.paypal.api.payments.BaseAddress
City name.
setClearingTime(String) - Method in class com.paypal.api.payments.FundingDetail
Expected clearing time
setClearingTime(String) - Method in class com.paypal.api.payments.Sale
Expected clearing time for eCheck Transactions.
setClientID(String) - Method in class com.paypal.base.ClientCredentials
 
setClientSecret(String) - Method in class com.paypal.base.ClientCredentials
 
setCode(String) - Method in class com.paypal.api.openidconnect.CreateFromAuthorizationCodeParameters
Set the code
setCode(String) - Method in class com.paypal.api.payments.Error
Deprecated.
This property is not available publicly PayPal internal error code.
setCode(String) - Method in class com.paypal.api.payments.ErrorDetails
Deprecated.
This property is not publicly available PayPal internal error code.
setCode(String) - Method in class com.paypal.api.payments.ExternalFunding
Generic identifier for the external funding
setCode(String) - Method in class com.paypal.api.payments.Incentive
Code that identifies the incentive.
setConfigurationMap(Map<String, String>) - Method in class com.paypal.base.rest.APIContext
Replaces the existing configurations with provided one
setConfigurations(Map<String, String>) - Method in class com.paypal.base.rest.OAuthTokenCredential
Replaces existing configurations with provided map of configurations.
setConfirmationStatus(String) - Method in class com.paypal.api.payments.BankAccount
Confirmation status of a bank account.
setConnectionTimeout(int) - Method in class com.paypal.base.HttpConfiguration
Sets the connectionTimeout
setContentEncoding(String) - Method in class com.paypal.api.payments.HyperSchema
 
setContentType(String) - Method in class com.paypal.base.HttpConfiguration
Deprecated.
Set/Get Content-Type HTTP Header in APIContext HTTPHeaders parameter
setConversionDate(String) - Method in class com.paypal.api.payments.CurrencyConversion
Date of validity for the conversion rate.
setConversionType(String) - Method in class com.paypal.api.payments.CurrencyConversion
Field indicating conversion type applied.
setConversionTypeChangeable(Boolean) - Method in class com.paypal.api.payments.CurrencyConversion
Allow Payer to change conversion type.
setCount(int) - Method in class com.paypal.api.payments.EventList
Number of items returned in each range of results.
setCount(int) - Method in class com.paypal.api.payments.PaymentHistory
Number of items returned in each range of results.
setCount(String) - Method in class com.paypal.base.rest.QueryParameters
Set the count
setCountry(String) - Method in class com.paypal.api.openidconnect.Address
Setter for country
setCountryCode(String) - Method in class com.paypal.api.payments.BankAccount
2 letter country code of the Bank.
setCountryCode(String) - Method in class com.paypal.api.payments.BaseAddress
2 letter country code.
setCountryCode(CountryCode) - Method in class com.paypal.api.payments.CarrierAccount
The ISO 3166-1 alpha-2 country code where the phone number is registered.
setCountryCode(String) - Method in class com.paypal.api.payments.CountryCode
ISO country code based on 2-character IS0-3166-1 codes.
setCountryCode(String) - Method in class com.paypal.api.payments.PayerInfo
Two-letter registered country code of the payer to identify the buyer country.
setCountryCode(String) - Method in class com.paypal.api.payments.Phone
Country code (from in E.164 format)
setCreatedBy(String) - Method in class com.paypal.api.payments.InvoicingMetaData
Email address of the account that created the resource.
setCreatedBy(String) - Method in class com.paypal.api.payments.Metadata
The email address of the account that created the resource.
setCreatedDate(String) - Method in class com.paypal.api.payments.InvoicingMetaData
Date when the resource was created.
setCreatedDate(String) - Method in class com.paypal.api.payments.Metadata
The date and time when the resource was created.
setCreateTime(String) - Method in class com.paypal.api.payments.Agreement
Date and time that this resource was created.
setCreateTime(String) - Method in class com.paypal.api.payments.Authorization
Time of authorization as defined in [RFC 3339 Section 5.6](http://tools.ietf.org/html/rfc3339#section-5.6).
setCreateTime(String) - Method in class com.paypal.api.payments.BankAccount
Time the resource was created.
setCreateTime(String) - Method in class com.paypal.api.payments.Capture
The date and time of capture, as defined in [RFC 3339 Section 5.6](http://tools.ietf.org/html/rfc3339#section-5.6).
setCreateTime(String) - Method in class com.paypal.api.payments.Event
Time the resource was created.
setCreateTime(String) - Method in class com.paypal.api.payments.Order
Time the resource was created in UTC ISO8601 format.
setCreateTime(String) - Method in class com.paypal.api.payments.Payment
Payment creation time as defined in [RFC 3339 Section 5.6](http://tools.ietf.org/html/rfc3339#section-5.6).
setCreateTime(String) - Method in class com.paypal.api.payments.Plan
Time when the billing plan was created.
setCreateTime(String) - Method in class com.paypal.api.payments.Refund
Time of refund as defined in [RFC 3339 Section 5.6](http://tools.ietf.org/html/rfc3339#section-5.6).
setCreateTime(String) - Method in class com.paypal.api.payments.Sale
Time of sale as defined in [RFC 3339 Section 5.6](http://tools.ietf.org/html/rfc3339#section-5.6)
setCredit(Credit) - Method in class com.paypal.api.payments.FundingInstrument
PayPal credit funding instrument.
setCreditCard(CreditCard) - Method in class com.paypal.api.payments.FundingInstrument
Credit Card instrument.
setCreditCardId(String) - Method in class com.paypal.api.payments.CreditCardToken
ID of credit card previously stored using `/vault/credit-card`.
setCreditCardToken(CreditCardToken) - Method in class com.paypal.api.payments.FundingInstrument
PayPal vaulted credit Card instrument.
setCreditFinancingOffered(CreditFinancingOffered) - Method in class com.paypal.api.payments.Payment
Credit financing offered to payer on PayPal side.
setCurrency(String) - Method in class com.paypal.api.payments.Amount
3-letter [currency code](https://developer.paypal.com/docs/integration/direct/rest_api_payment_country_currency_support/).
setCurrency(String) - Method in class com.paypal.api.payments.Currency
3 letter currency code as defined by ISO 4217.
setCurrency(String) - Method in class com.paypal.api.payments.Item
3-letter [currency code](https://developer.paypal.com/docs/integration/direct/rest_api_payment_country_currency_support/).
setCurrencyConversion(CurrencyConversion) - Method in class com.paypal.api.payments.FundingOption
Currency conversion applicable to this funding option.
setCustom(String) - Method in class com.paypal.api.payments.CartBase
free-form field for the use of clients
setCustom(String) - Method in class com.paypal.api.payments.DetailedRefund
free-form field for the use of clients
setCustom(CustomAmount) - Method in class com.paypal.api.payments.Invoice
The custom amount to apply on an invoice.
setCustom(Boolean) - Method in class com.paypal.api.payments.Template
Indicates whether this is a custom template created by the merchant.
setCustom(CustomAmount) - Method in class com.paypal.api.payments.TemplateData
The custom amount to apply on an invoice.
setCvv2(Integer) - Method in class com.paypal.api.payments.CreditCard
Deprecated.
The cvv2 needs to be a string, as any cvv2 starting with 0 is sent invalid to servers. Please use CreditCard.setCvv2(String) instead.
setCvv2(String) - Method in class com.paypal.api.payments.CreditCard
 
setCvv2(String) - Method in class com.paypal.api.payments.PaymentCard
The validation code for the card.
setCvvCode(String) - Method in class com.paypal.api.payments.ProcessorResponse
CVV System response code.
setCycles(String) - Method in class com.paypal.api.payments.PaymentDefinition
Number of cycles in this payment definition.
setCyclesCompleted(String) - Method in class com.paypal.api.payments.AgreementDetails
Number of cycles completed for this agreement.
setCyclesRemaining(String) - Method in class com.paypal.api.payments.AgreementDetails
Number of cycles remaining for this agreement.
setDate(String) - Method in class com.paypal.api.payments.InvoiceItem
The date when the item or service was provided.
setDate(String) - Method in class com.paypal.api.payments.InvoicingPaymentDetail
Date when the invoice was paid.
setDate(String) - Method in class com.paypal.api.payments.InvoicingRefundDetail
Date when the invoice was marked as refunded.
setDate(String) - Method in class com.paypal.api.payments.PaymentDetail
The date when the invoice was paid.
setDate(String) - Method in class com.paypal.api.payments.RefundDetail
Date on which the invoice was refunded.
setDebugId(String) - Method in class com.paypal.api.payments.Error
PayPal internal identifier used for correlation purposes.
setDefaultAddress(Boolean) - Method in class com.paypal.api.payments.ShippingAddress
Default shipping address of the Payer.
setDescription(String) - Method in class com.paypal.api.payments.Agreement
Description of the agreement.
setDescription(String) - Method in class com.paypal.api.payments.CartBase
Description of what is being paid for.
setDescription(String) - Method in class com.paypal.api.payments.EventType
Human readable description of the event-type
setDescription(String) - Method in class com.paypal.api.payments.FmfDetails
Description of the filter.
setDescription(String) - Method in class com.paypal.api.payments.Incentive
Description of the incentive.
setDescription(String) - Method in class com.paypal.api.payments.InvoiceItem
Description of the item.
setDescription(String) - Method in class com.paypal.api.payments.Item
Description of the item.
setDescription(String) - Method in class com.paypal.api.payments.Plan
Description of the billing plan.
setDescription(String) - Method in class com.paypal.api.payments.Refund
Description of what is being refunded for.
setDescription(String) - Method in class com.paypal.api.payments.RefundRequest
Description of what is being refunded for.
setDetails(Details) - Method in class com.paypal.api.payments.Amount
Additional details of the payment amount.
setDetails(List<ErrorDetails>) - Method in class com.paypal.api.payments.Error
Additional details of the error
setDetails(Error) - Method in exception com.paypal.base.rest.PayPalRESTException
 
setDiscount(Cost) - Method in class com.paypal.api.payments.Invoice
The invoice level discount, as a percent or an amount value.
setDiscount(Cost) - Method in class com.paypal.api.payments.InvoiceItem
The item discount, as a percent or an amount value.
setDiscount(Cost) - Method in class com.paypal.api.payments.TemplateData
The invoice level discount, as a percent or an amount value.
setDiscountAmount(Currency) - Method in class com.paypal.api.payments.InstallmentOption
Discount amount applied to the payment, if any
setDiscountPercentage(Percentage) - Method in class com.paypal.api.payments.InstallmentOption
Discount percentage applied to the payment, if any
setDisplayPreference(TemplateSettingsMetadata) - Method in class com.paypal.api.payments.TemplateSettings
Settings metadata for each field.
setDisplayText(String) - Method in class com.paypal.api.payments.ExternalFunding
Description of the external funding being applied
setDueDate(String) - Method in class com.paypal.api.payments.PaymentTerm
The date when the invoice payment is due.
setEci(String) - Method in class com.paypal.api.payments.Card3dSecureInfo
Numeric flag to indicate how the payment should be processed in relationship to 3d-secure.
setEciSubmitted(String) - Method in class com.paypal.api.payments.ProcessorResponse
Response back from the authorization.
setEmail(String) - Method in class com.paypal.api.openidconnect.Userinfo
End-User's preferred e-mail address.
setEmail(String) - Method in class com.paypal.api.payments.BillingInfo
The invoice recipient email address.
setEmail(String) - Method in class com.paypal.api.payments.InvoicingSearch
Initial letters of the email address.
setEmail(String) - Method in class com.paypal.api.payments.MerchantInfo
The merchant email address.
setEmail(String) - Method in class com.paypal.api.payments.Participant
The participant email address.
setEmail(String) - Method in class com.paypal.api.payments.Payee
Email Address associated with the Payee's PayPal Account.
setEmail(String) - Method in class com.paypal.api.payments.PayerInfo
Email address representing the payer.
setEmail(String) - Method in class com.paypal.api.payments.PayerNotification
Email Address associated with the Payer's PayPal Account.
setEmail(String) - Method in class com.paypal.api.payments.PotentialPayerInfo
Email address representing the potential payer.
setEmail(String) - Method in class com.paypal.api.payments.Search
The initial letters of the email address.
setEmails(List<String>) - Method in class com.paypal.api.payments.Templates
List of emails in merchant's profile.
setEmailSubject(String) - Method in class com.paypal.api.payments.PayoutSenderBatchHeader
The subject line text for the email that PayPal sends when a payout item completes.
setEmailVerified(Boolean) - Method in class com.paypal.api.openidconnect.Userinfo
True if the End-User's e-mail address has been verified; otherwise false.
setEncType(String) - Method in class com.paypal.api.payments.DefinitionsLinkdescription
The media type in which to submit data along with the request
setEnctype(String) - Method in class com.paypal.api.payments.Links
 
setEndCreationDate(String) - Method in class com.paypal.api.payments.InvoicingSearch
End invoice creation date.
setEndCreationDate(String) - Method in class com.paypal.api.payments.Search
The end creation date for the invoice.
setEndDueDate(String) - Method in class com.paypal.api.payments.InvoicingSearch
End invoice due date.
setEndDueDate(String) - Method in class com.paypal.api.payments.Search
The end due date for the invoice.
setEndInvoiceDate(String) - Method in class com.paypal.api.payments.InvoicingSearch
End invoice date.
setEndInvoiceDate(String) - Method in class com.paypal.api.payments.Search
The end date for the invoice.
setEndPaymentDate(String) - Method in class com.paypal.api.payments.InvoicingSearch
End invoice payment date.
setEndPaymentDate(String) - Method in class com.paypal.api.payments.Search
The end payment date for the invoice.
setEndPointUrl(String) - Method in class com.paypal.base.HttpConfiguration
Sets the endPointUrl
setEndTime(String) - Method in class com.paypal.base.rest.QueryParameters
Set the endTime
setError(String) - Method in class com.paypal.api.openidconnect.Error
Setter for error
setError(Error) - Method in class com.paypal.api.payments.PayoutItemDetails
Setter for error.
setErrorDescription(String) - Method in class com.paypal.api.openidconnect.Error
Setter for errorDescription
setErrors(Error) - Method in class com.paypal.api.payments.PayoutBatchHeader
 
setErrors(Error) - Method in class com.paypal.api.payments.PayoutItemDetails
 
setErrorUri(String) - Method in class com.paypal.api.openidconnect.Error
Setter for errorUri
setEvents(List<Event>) - Method in class com.paypal.api.payments.EventList
A list of Webhooks event resources
setEventType(String) - Method in class com.paypal.api.payments.Event
Name of the event type that occurred on resource, identified by data_resource element, to trigger the Webhooks event.
setEventTypes(List<EventType>) - Method in class com.paypal.api.payments.EventTypeList
A list of Webhooks event-types
setEventTypes(List<EventType>) - Method in class com.paypal.api.payments.Webhook
A list of up to ten events to which to subscribe your webhook.
setExchangeRate(String) - Method in class com.paypal.api.payments.Sale
Exchange rate applied for this transaction.
setExperienceProfileId(String) - Method in class com.paypal.api.payments.Payment
PayPal generated identifier for the merchant's payment experience profile.
setExpireMonth(int) - Method in class com.paypal.api.payments.CreditCard
Expiration month with no leading zero.
setExpireMonth(int) - Method in class com.paypal.api.payments.CreditCardToken
Expiration month with no leading zero.
setExpireMonth(String) - Method in class com.paypal.api.payments.PaymentCard
The two-digit expiry month for the card.
setExpireMonth(int) - Method in class com.paypal.api.payments.PaymentCardToken
card expiry month from the saved card with value 1 - 12
setExpiresIn(Integer) - Method in class com.paypal.api.openidconnect.Tokeninfo
Setter for expiresIn
setExpireYear(int) - Method in class com.paypal.api.payments.CreditCard
4-digit expiration year.
setExpireYear(int) - Method in class com.paypal.api.payments.CreditCardToken
4-digit expiration year.
setExpireYear(String) - Method in class com.paypal.api.payments.PaymentCard
The four-digit expiry year for the card.
setExpireYear(int) - Method in class com.paypal.api.payments.PaymentCardToken
4 digit card expiry year from the saved card
setExpiryDate(String) - Method in class com.paypal.api.payments.Incentive
expiry date of the incentive.
setExtension(String) - Method in class com.paypal.api.payments.Phone
Phone extension
setExternalCustomerId(String) - Method in class com.paypal.api.payments.AlternatePayment
The unique identifier of the payer
setExternalCustomerId(String) - Method in class com.paypal.api.payments.BankAccount
A unique identifier of the customer to whom this bank account belongs to.
setExternalCustomerId(String) - Method in class com.paypal.api.payments.BankToken
The unique identifier of the payer used when saving this bank using /vault/bank API.
setExternalCustomerId(String) - Method in class com.paypal.api.payments.CarrierAccount
The ID of the customer, as created by the merchant.
setExternalCustomerId(String) - Method in class com.paypal.api.payments.CarrierAccountToken
The unique identifier of the payer used when saving this carrier account instrument.
setExternalCustomerId(String) - Method in class com.paypal.api.payments.CreditCard
A unique identifier of the customer to whom this bank account belongs.
setExternalCustomerId(String) - Method in class com.paypal.api.payments.PaymentCard
The ID of the customer who owns this card account.
setExternalCustomerId(String) - Method in class com.paypal.api.payments.PaymentCardToken
The unique identifier of the payer used when saving this payment card.
setExternalFunding(List<ExternalFunding>) - Method in class com.paypal.api.payments.CartBase
List of external funding being applied to the purchase unit.
setExternalFunding(ExternalFunding) - Method in class com.paypal.api.payments.FundingInstrument
External funding instrument.
setExternalRememberMeId(String) - Method in class com.paypal.api.payments.PayerInfo
External Remember Me id representing the payer
setExternalRememberMeId(String) - Method in class com.paypal.api.payments.PotentialPayerInfo
ExternalRememberMe id representing the potential payer
setExternalSelectedFundingInstrumentType(String) - Method in class com.paypal.api.payments.Payer
Instrument type pre-selected by the user outside of PayPal and passed along the payment creation.
setFailedPaymentCount(String) - Method in class com.paypal.api.payments.AgreementDetails
Total number of failed payments for this agreement.
setFailedTransactions(List<Error>) - Method in class com.paypal.api.payments.Payment
Applicable for advanced payments like multi seller payment (MSP) to support partial failures
setFailureReason(String) - Method in class com.paypal.api.payments.Payment
Failure reason code returned when the payment failed for some valid reasons.
setFamilyName(String) - Method in class com.paypal.api.openidconnect.Userinfo
Surname(s) or last name(s) of the End-User.
setFax(Phone) - Method in class com.paypal.api.payments.MerchantInfo
The merchant fax number.
setFax(Phone) - Method in class com.paypal.api.payments.Participant
The participant fax number.
setFee(String) - Method in class com.paypal.api.payments.Details
Fee charged by PayPal.
setFeeAmount(Currency) - Method in class com.paypal.api.payments.AgreementTransaction
Fee amount for this transaction.
setFees(Currency) - Method in class com.paypal.api.payments.PayoutBatchHeader
Total estimate in U.S.
setField(String) - Method in class com.paypal.api.payments.ErrorDetails
Name of the field that caused the error.
setFIELD_NAMING_POLICY(FieldNamingPolicy) - Static method in class com.paypal.base.rest.JSONFormatter
Set a format for gson FIELD_NAMING_POLICY.
setFieldName(String) - Method in class com.paypal.api.payments.TemplateSettings
The field name (for any field in template_data) for which the corresponding display preferences will be mapped to.
setFilterId(String) - Method in class com.paypal.api.payments.FmfDetails
Filter Identifier.
setFilterType(String) - Method in class com.paypal.api.payments.FmfDetails
Type of filter.
setFinalPaymentDate(String) - Method in class com.paypal.api.payments.AgreementDetails
Last payment date for this agreement, represented as 2015-02-19T10:00:00Z format.
setFirstName(String) - Method in class com.paypal.api.payments.BankAccount
Account holder's first name.
setFirstName(String) - Method in class com.paypal.api.payments.BillingInfo
The invoice recipient first name.
setFirstName(String) - Method in class com.paypal.api.payments.CreditCard
Cardholder's first name.
setFirstName(String) - Method in class com.paypal.api.payments.MerchantInfo
The merchant first name.
setFirstName(String) - Method in class com.paypal.api.payments.Participant
The participant first name.
setFirstName(String) - Method in class com.paypal.api.payments.Payee
First Name of the Payee.
setFirstName(String) - Method in class com.paypal.api.payments.PayerInfo
First name of the payer.
setFirstName(String) - Method in class com.paypal.api.payments.PaymentCard
The first name of the card holder.
setFirstName(String) - Method in class com.paypal.api.payments.ShippingInfo
The invoice recipient first name.
setFirstSentDate(String) - Method in class com.paypal.api.payments.InvoicingMetaData
Date when the resource was first sent.
setFirstSentDate(String) - Method in class com.paypal.api.payments.Metadata
The date and time when the resource was first sent.
setFlowConfig(FlowConfig) - Method in class com.paypal.api.payments.WebProfile
Parameters for flow configuration.
setFmfDetails(FmfDetails) - Method in class com.paypal.api.payments.Authorization
Fraud Management Filter (FMF) details applied for the payment that could result in accept, deny, or pending action.
setFmfDetails(FmfDetails) - Method in class com.paypal.api.payments.Error
Deprecated.
This property is not available publicly Fraud filter details. Only supported when the `payment_method` is set to `credit_card`
setFmfDetails(FmfDetails) - Method in class com.paypal.api.payments.Order
Fraud Management Filter (FMF) details applied for the payment that could result in accept/deny/pending action.
setFmfDetails(FmfDetails) - Method in class com.paypal.api.payments.Sale
Fraud Management Filter (FMF) details applied for the payment that could result in accept, deny, or pending action.
setFragmentResolution(String) - Method in class com.paypal.api.payments.HyperSchema
 
setFrequency(String) - Method in class com.paypal.api.payments.PaymentDefinition
Frequency of the payment definition offered.
setFrequencyInterval(String) - Method in class com.paypal.api.payments.PaymentDefinition
How frequently the customer should be charged.
setFrom(String) - Method in class com.paypal.api.payments.Patch
A string containing a JSON Pointer value that references the location in the target document to move the value from.
setFrom(String) - Method in class com.paypal.api.payments.PatchRequest
A string containing a JSON Pointer value that references the location in the target document to move the value from.
setFromAmount(String) - Method in class com.paypal.api.payments.CurrencyConversion
Amount participating in currency conversion, set to 1 as default
setFromCurrency(String) - Method in class com.paypal.api.payments.CurrencyConversion
3 letter currency code
setFundingAccountId(String) - Method in class com.paypal.api.payments.ExternalFunding
Encrypted PayPal Account identifier for the funding account
setFundingInstruction(String) - Method in class com.paypal.api.payments.ExternalFunding
Indicates that the Payment should be fully funded by External Funded Incentive
setFundingInstruments(List<FundingInstrument>) - Method in class com.paypal.api.payments.Payer
List of funding instruments to fund the payment.
setFundingOption(FundingOption) - Method in class com.paypal.api.payments.Payer
Deprecated.
setFundingOptionId(String) - Method in class com.paypal.api.payments.Payer
Id of user selected funding option for the payment.'OneOf' funding_instruments,funding_option_id to be used to identify the specifics of payment method passed.
setFundingSources(List<FundingSource>) - Method in class com.paypal.api.payments.FundingOption
List of funding sources that contributes to a payment.
setGender(String) - Method in class com.paypal.api.openidconnect.Userinfo
End-User's gender.
setGiftWrap(String) - Method in class com.paypal.api.payments.Details
Amount being charged as gift wrap fee.
setGivenName(String) - Method in class com.paypal.api.openidconnect.Userinfo
Given name(s) or first name(s) of the End-User
setGoogleAppEngine(boolean) - Method in class com.paypal.base.HttpConfiguration
Sets the googleAppEngine
setGrantType(String) - Method in class com.paypal.api.openidconnect.CreateFromAuthorizationCodeParameters
Set the Grant Type
setGrantType(String) - Method in class com.paypal.api.openidconnect.CreateFromRefreshTokenParameters
Set the Grant Type
setGratuity(Currency) - Method in class com.paypal.api.payments.Invoice
Gratuity to include with the invoice.
setHandlingFee(String) - Method in class com.paypal.api.payments.Details
Amount being charged for the handling fee.
setHeaders(Map<String, String>) - Method in class com.paypal.base.rest.OAuthTokenCredential
Sets Headers for every calls.
setHeadersMap(Map<String, String>) - Method in class com.paypal.base.rest.APIContext
setHeight(Measurement) - Method in class com.paypal.api.payments.Item
Height of the item.
setHidden(Boolean) - Method in class com.paypal.api.payments.TemplateSettingsMetadata
Indicates whether this field should be hidden.
setHref(String) - Method in class com.paypal.api.payments.DefinitionsLinkdescription
a URI template, as defined by RFC 6570, with the addition of the $, ( and ) characters for pre-processing
setHref(String) - Method in class com.paypal.api.payments.Links
 
setHttpHeaders(Map<String, String>) - Method in class com.paypal.base.HttpConnection
Set headers for HttpsURLConnection object
setHTTPHeaders(Map<String, String>) - Method in class com.paypal.base.rest.APIContext
Replaces existing headers with provided one.
setHttpMethod(String) - Method in class com.paypal.base.HttpConfiguration
 
setId(String) - Method in class com.paypal.api.payments.Agreement
Identifier of the agreement.
setId(String) - Method in class com.paypal.api.payments.Authorization
ID of the authorization transaction.
setId(String) - Method in class com.paypal.api.payments.BankAccount
ID of the bank account being saved for later use.
setId(String) - Method in class com.paypal.api.payments.Capture
The ID of the capture transaction.
setId(String) - Method in class com.paypal.api.payments.CarrierAccount
The ID of the carrier account of the payer.
setId(String) - Method in class com.paypal.api.payments.ChargeModels
Identifier of the charge model.
setId(String) - Method in class com.paypal.api.payments.Credit
Unique identifier of credit resource.
setId(String) - Method in class com.paypal.api.payments.CreditCard
ID of the credit card.
setId(String) - Method in class com.paypal.api.payments.Event
Identifier of the Webhooks event resource.
setId(String) - Method in class com.paypal.api.payments.FundingOption
id of the funding option.
setId(String) - Method in class com.paypal.api.payments.Incentive
Identifier of the instrument in PayPal Wallet
setId(String) - Method in class com.paypal.api.payments.Invoice
The unique invoice resource identifier.
setId(String) - Method in class com.paypal.api.payments.MerchantPreferences
Identifier of the merchant_preferences.
setId(String) - Method in class com.paypal.api.payments.Order
Identifier of the order transaction.
setId(String) - Method in class com.paypal.api.payments.Payment
Identifier of the payment resource created.
setId(String) - Method in class com.paypal.api.payments.PaymentCard
The ID of a credit card to save for later use.
setId(String) - Method in class com.paypal.api.payments.PaymentDefinition
Identifier of the payment_definition.
setId(String) - Method in class com.paypal.api.payments.Plan
Identifier of the billing plan.
setId(String) - Method in class com.paypal.api.payments.PrivateLabelCard
encrypted identifier of the private label card instrument.
setId(String) - Method in class com.paypal.api.payments.Refund
ID of the refund transaction.
setId(String) - Method in class com.paypal.api.payments.Sale
Identifier of the sale transaction.
setId(String) - Method in class com.paypal.api.payments.ShippingAddress
Address ID assigned in PayPal system.
setId(String) - Method in class com.paypal.api.payments.Tax
The resource ID.
setId(String) - Method in class com.paypal.api.payments.Terms
Identifier of the terms.
setId(String) - Method in class com.paypal.api.payments.Webhook
The ID of the webhook.
setId(String) - Method in class com.paypal.api.payments.WebProfile
The unique ID of the web experience profile.
setImage(String) - Method in class com.paypal.api.payments.Image
Image as base64 encoded String
setImageKey(String) - Method in class com.paypal.api.payments.PrivateLabelCard
This value indicates URL to access PLCC program logo image
setImageUrl(String) - Method in class com.paypal.api.payments.InvoiceItem
The image URL.
setIncentive(Incentive) - Method in class com.paypal.api.payments.FundingInstrument
Incentive funding instrument.
setInformationLink(String) - Method in class com.paypal.api.payments.Error
URI for detailed information related to this error for the developer.
setInitialFailAmountAction(String) - Method in class com.paypal.api.payments.MerchantPreferences
Action to take if a failure occurs during initial payment.
setInputFields(InputFields) - Method in class com.paypal.api.payments.WebProfile
Parameters for input fields customization.
setInstallmentId(String) - Method in class com.paypal.api.payments.InstallmentInfo
Installment id.
setInstallmentInfo(InstallmentInfo) - Method in class com.paypal.api.payments.FundingOption
Installment options available for a funding option.
setInstallmentOptions(List<InstallmentOption>) - Method in class com.paypal.api.payments.InstallmentInfo
List of available installment options and the cost associated with each one.
setInstructionType(String) - Method in class com.paypal.api.payments.PaymentInstruction
Type of payment instruction
setInsurance(String) - Method in class com.paypal.api.payments.Details
Amount being charged for the insurance fee.
setIntent(String) - Method in class com.paypal.api.payments.Payment
Payment intent.
setInternationalBankAccountNumber(String) - Method in class com.paypal.api.payments.RecipientBankingInstruction
IBAN equivalent of the bank
setInvoiceDate(String) - Method in class com.paypal.api.payments.Invoice
The date when the invoice was enabled.
setInvoiceNumber(String) - Method in class com.paypal.api.payments.Capture
The invoice number to track this payment.
setInvoiceNumber(String) - Method in class com.paypal.api.payments.CartBase
invoice number to track this payment
setInvoiceNumber(String) - Method in class com.paypal.api.payments.Refund
Your own invoice or tracking ID number.
setInvoiceNumber(String) - Method in class com.paypal.api.payments.RefundRequest
The invoice number that is used to track this payment.
setInvoices(List<Invoice>) - Method in class com.paypal.api.payments.Invoices
List of invoices belonging to a merchant.
setIpAddress(String) - Method in class com.paypal.base.HttpConfiguration
 
setIsDefault(Boolean) - Method in class com.paypal.api.payments.Template
Indicates that this template is merchant's default.
setIsFinalCapture(Boolean) - Method in class com.paypal.api.payments.Capture
Indicates whether to release all remaining funds that the authorization holds in the funding instrument.
setIsNonPlatformTransaction(String) - Method in class com.paypal.api.payments.RefundRequest
It indicates that the resource id passed is not processed by payments platform
setIssue(String) - Method in class com.paypal.api.payments.ErrorDetails
Reason for the error.
setIssueNumber(String) - Method in class com.paypal.api.payments.PaymentCard
The one- to two-digit card issue number.
setIssuer(String) - Method in class com.paypal.api.payments.InstallmentInfo
Credit card issuer.
setIssuerId(String) - Method in class com.paypal.api.payments.PrivateLabelCard
Merchants providing private label store cards have associated issuer account.
setIssuerName(String) - Method in class com.paypal.api.payments.PrivateLabelCard
Merchants providing private label store cards have associated issuer account.
setItemList(ItemList) - Method in class com.paypal.api.payments.CartBase
List of items being paid for.
setItems(List<CreditCard>) - Method in class com.paypal.api.payments.CreditCardHistory
A list of credit card resources
setItems(List<InvoiceItem>) - Method in class com.paypal.api.payments.Invoice
The list of items to include in the invoice.
setItems(List<Item>) - Method in class com.paypal.api.payments.ItemList
List of items.
setItems(List<PayoutItem>) - Method in class com.paypal.api.payments.Payout
An array of payout items (that is, a set of individual payouts).
setItems(List<PayoutItemDetails>) - Method in class com.paypal.api.payments.PayoutBatch
An array of items in a batch payout.
setItems(List<InvoiceItem>) - Method in class com.paypal.api.payments.TemplateData
The list of items to include in the invoice.
setLabel(String) - Method in class com.paypal.api.payments.CustomAmount
The custom amount label.
setLandingPageType(String) - Method in class com.paypal.api.payments.FlowConfig
The type of landing page to display on the PayPal site for user checkout.
setLanguage(String) - Method in class com.paypal.api.payments.BillingInfo
The language in which the email was sent to the payer.
setLast4(String) - Method in class com.paypal.api.payments.CreditCardToken
Last four digits of the stored credit card number.
setLast4(String) - Method in class com.paypal.api.payments.PaymentCardToken
Last 4 digits of the card number from the saved card.
setLastName(String) - Method in class com.paypal.api.payments.BankAccount
Account holder's last name.
setLastName(String) - Method in class com.paypal.api.payments.BillingInfo
The invoice recipient last name.
setLastName(String) - Method in class com.paypal.api.payments.CreditCard
Cardholder's last name.
setLastName(String) - Method in class com.paypal.api.payments.MerchantInfo
The merchant last name.
setLastName(String) - Method in class com.paypal.api.payments.Participant
The participant last name.
setLastName(String) - Method in class com.paypal.api.payments.Payee
Last Name of the Payee.
setLastName(String) - Method in class com.paypal.api.payments.PayerInfo
Last name of the payer.
setLastName(String) - Method in class com.paypal.api.payments.PaymentCard
The last name of the card holder.
setLastName(String) - Method in class com.paypal.api.payments.ShippingInfo
The invoice recipient last name.
setLastPaymentAmount(Currency) - Method in class com.paypal.api.payments.AgreementDetails
Last payment amount for this agreement.
setLastPaymentDate(String) - Method in class com.paypal.api.payments.AgreementDetails
Last payment date for this agreement, represented as 2014-06-09T09:42:31Z format.
setLastSentBy(String) - Method in class com.paypal.api.payments.InvoicingMetaData
Email address of the account that last sent the resource.
setLastSentBy(String) - Method in class com.paypal.api.payments.Metadata
The email address of the account that last sent the resource.
setLastSentDate(String) - Method in class com.paypal.api.payments.InvoicingMetaData
Date when the resource was last sent.
setLastSentDate(String) - Method in class com.paypal.api.payments.Metadata
The date and time when the resource was last sent.
setLastUpdatedBy(String) - Method in class com.paypal.api.payments.InvoicingMetaData
Email address of the account that last edited the resource.
setLastUpdatedBy(String) - Method in class com.paypal.api.payments.Metadata
The email address of the account that last edited the resource.
setLastUpdatedDate(String) - Method in class com.paypal.api.payments.InvoicingMetaData
Date when the resource was last edited.
setLastUpdatedDate(String) - Method in class com.paypal.api.payments.Metadata
The date and time when the resource was last edited.
setLength(Measurement) - Method in class com.paypal.api.payments.Item
Length of the item.
setLine1(String) - Method in class com.paypal.api.payments.BaseAddress
Line 1 of the Address (eg.
setLine2(String) - Method in class com.paypal.api.payments.BaseAddress
Optional line 2 of the Address (eg.
setLinks(List<Links>) - Method in class com.paypal.api.payments.Agreement
 
setLinks(List<Links>) - Method in class com.paypal.api.payments.Authorization
 
setLinks(List<DefinitionsLinkdescription>) - Method in class com.paypal.api.payments.BankAccount
 
setLinks(List<Links>) - Method in class com.paypal.api.payments.Capture
 
setLinks(List<Links>) - Method in class com.paypal.api.payments.CreditCard
 
setLinks(List<Links>) - Method in class com.paypal.api.payments.CreditCardHistory
HATEOAS links related to this call.
setLinks(List<DefinitionsLinkdescription>) - Method in class com.paypal.api.payments.CurrencyConversion
 
setLinks(List<DefinitionsLinkdescription>) - Method in class com.paypal.api.payments.Error
Links
setLinks(List<Links>) - Method in class com.paypal.api.payments.Event
Hateoas links.
setLinks(List<Links>) - Method in class com.paypal.api.payments.EventList
 
setLinks(List<DefinitionsLinkdescription>) - Method in class com.paypal.api.payments.FundingOption
 
setLinks(List<Links>) - Method in class com.paypal.api.payments.HyperSchema
 
setLinks(List<Links>) - Method in class com.paypal.api.payments.Invoice
HATEOS links representing all the actions over the invoice resource based on the current invoice status.
setLinks(List<Links>) - Method in class com.paypal.api.payments.Order
 
setLinks(List<Links>) - Method in class com.paypal.api.payments.Payment
 
setLinks(List<DefinitionsLinkdescription>) - Method in class com.paypal.api.payments.PaymentCard
 
setLinks(List<Links>) - Method in class com.paypal.api.payments.PaymentInstruction
 
setLinks(List<Links>) - Method in class com.paypal.api.payments.Payout
 
setLinks(List<Links>) - Method in class com.paypal.api.payments.PayoutBatch
 
setLinks(List<Links>) - Method in class com.paypal.api.payments.PayoutBatchHeader
 
setLinks(List<Links>) - Method in class com.paypal.api.payments.PayoutItemDetails
The HATEOAS links related to the call.
setLinks(List<Links>) - Method in class com.paypal.api.payments.Plan
 
setLinks(List<Links>) - Method in class com.paypal.api.payments.PlanList
 
setLinks(List<Links>) - Method in class com.paypal.api.payments.Refund
 
setLinks(List<Links>) - Method in class com.paypal.api.payments.Sale
 
setLinks(List<Links>) - Method in class com.paypal.api.payments.Templates
HATEOS links representing all the actions over the template list returned.
setLinks(List<Links>) - Method in class com.paypal.api.payments.Webhook
The HATEOAS links related to this call.
setLocale(String) - Method in class com.paypal.api.openidconnect.Userinfo
End-User's locale.
setLocaleCode(String) - Method in class com.paypal.api.payments.Presentation
The locale of pages displayed by PayPal payment experience.
setLocality(String) - Method in class com.paypal.api.openidconnect.Address
Setter for locality
setLogoImage(String) - Method in class com.paypal.api.payments.Presentation
A URL to the logo image.
setLogoImageUrl(String) - Method in class com.paypal.api.payments.Incentive
Logo image url for the incentive.
setLogoUrl(String) - Method in class com.paypal.api.payments.Invoice
Full URL of an external image to use as the logo.
setLogoUrl(String) - Method in class com.paypal.api.payments.TemplateData
Full URL of an external image to use as the logo.
setLowerTotalAmount(Currency) - Method in class com.paypal.api.payments.InvoicingSearch
Lower limit of total amount.
setLowerTotalAmount(Currency) - Method in class com.paypal.api.payments.Search
The lower limit of the total amount.
setMandateReferenceNumber(String) - Method in class com.paypal.api.payments.BankToken
Identifier of the direct debit mandate to validate.
setMandateReferenceNumber(String) - Method in class com.paypal.api.payments.ExtendedBankAccount
Identifier of the direct debit mandate to validate.
setMaskRequestId(boolean) - Method in class com.paypal.base.rest.APIContext
 
setMaxBillingAmount(Currency) - Method in class com.paypal.api.payments.Terms
Max Amount associated with this term.
setMaxFailAttempts(String) - Method in class com.paypal.api.payments.MerchantPreferences
Total number of failed attempts allowed.
setMaxHttpConnection(int) - Method in class com.paypal.base.HttpConfiguration
Sets the maxHttpConnection
setMaxRetry(int) - Method in class com.paypal.base.HttpConfiguration
Sets the maxRetry
setMediaType(String) - Method in class com.paypal.api.payments.DefinitionsLinkdescription
media type (as defined by RFC 2046) describing the link target
setMediaType(String) - Method in class com.paypal.api.payments.HyperSchema
 
setMerchantId(String) - Method in class com.paypal.api.payments.BankAccount
A unique identifier of the merchant for which this bank account has been stored for.
setMerchantId(String) - Method in class com.paypal.api.payments.Payee
Encrypted PayPal account identifier for the Payee.
setMerchantInfo(MerchantInfo) - Method in class com.paypal.api.payments.Invoice
Information about the merchant who is sending the invoice.
setMerchantInfo(MerchantInfo) - Method in class com.paypal.api.payments.TemplateData
Information about the merchant who is sending the invoice.
setMerchantMemo(String) - Method in class com.paypal.api.payments.Invoice
A private bookkeeping memo for the merchant.
setMerchantMemo(String) - Method in class com.paypal.api.payments.TemplateData
A private bookkeeping memo for the merchant.
setMerchantPreferences(MerchantPreferences) - Method in class com.paypal.api.payments.Plan
Specific preferences such as: set up fee, max fail attempts, autobill amount, and others that are configured for this billing plan.
setMessage(String) - Method in class com.paypal.api.payments.Error
Message describing the error.
setMetadata(Metadata) - Method in class com.paypal.api.payments.Invoice
Audit information for the invoice.
setMethod(String) - Method in class com.paypal.api.payments.DefinitionsLinkdescription
method for requesting the target of the link (e.g.
setMethod(String) - Method in class com.paypal.api.payments.InvoicingPaymentDetail
Payment mode or method.
setMethod(String) - Method in class com.paypal.api.payments.Links
 
setMethod(String) - Method in class com.paypal.api.payments.PaymentDetail
The payment mode or method.
setMiddleName(String) - Method in class com.paypal.api.openidconnect.Userinfo
Middle name(s) of the End-User.
setMiddleName(String) - Method in class com.paypal.api.payments.PayerInfo
Middle name of the payer.
setMinimumAmountDue(Currency) - Method in class com.paypal.api.payments.Invoice
If `allow_partial_payment` is set to `true`, the minimum amount allowed for a partial payment.
setMinimumAmountDue(Currency) - Method in class com.paypal.api.payments.TemplateData
If `allow_partial_payment` is set to `true`, the minimum amount allowed for a partial payment.
setMinimumPurchaseAmount(Currency) - Method in class com.paypal.api.payments.Incentive
Indicates incentive is applicable for this minimum purchase amount.
setMode(String) - Method in class com.paypal.base.rest.APIContext
Sets mode to either `live` or `sandbox`.
setMonthlyPayment(Currency) - Method in class com.paypal.api.payments.CreditFinancingOffered
This is the estimated amount per month that the customer will need to pay including fees and interest.
setMonthlyPayment(Currency) - Method in class com.paypal.api.payments.InstallmentOption
Monthly payment
setMpiVendor(String) - Method in class com.paypal.api.payments.Card3dSecureInfo
Name of the actual 3ds vendor who processed the 3ds request, e.g.
setName(String) - Method in class com.paypal.api.openidconnect.Userinfo
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.
setName(String) - Method in class com.paypal.api.payments.Agreement
Name of the agreement.
setName(String) - Method in class com.paypal.api.payments.Error
Human readable, unique name of the error.
setName(String) - Method in class com.paypal.api.payments.EventType
Unique event-type name.
setName(String) - Method in class com.paypal.api.payments.FileAttachment
Name of the file attached.
setName(String) - Method in class com.paypal.api.payments.FmfDetails
Name of the filter
setName(String) - Method in class com.paypal.api.payments.Incentive
Name of the incentive.
setName(String) - Method in class com.paypal.api.payments.InvoiceItem
Name of the item.
setName(String) - Method in class com.paypal.api.payments.Item
Item name.
setName(String) - Method in class com.paypal.api.payments.NameValuePair
Key for the name value pair.
setName(String) - Method in class com.paypal.api.payments.PaymentDefinition
Name of the payment definition.
setName(String) - Method in class com.paypal.api.payments.Plan
Name of the billing plan.
setName(String) - Method in class com.paypal.api.payments.Tax
The tax name.
setName(String) - Method in class com.paypal.api.payments.Template
Name of the template.
setName(String) - Method in class com.paypal.api.payments.WebProfile
The web experience profile name.
setNationalNumber(String) - Method in class com.paypal.api.payments.Phone
In-country phone number (from in E.164 format)
setNetAmount(Currency) - Method in class com.paypal.api.payments.AgreementTransaction
Net amount for this transaction.
setNetwork(String) - Method in class com.paypal.api.payments.InstallmentInfo
Credit card network.
setNextBillingDate(String) - Method in class com.paypal.api.payments.AgreementDetails
The next billing date for this agreement, represented as 2014-02-19T10:00:00Z format.
setNextId(String) - Method in class com.paypal.api.payments.PaymentHistory
Identifier of the next element to get the next range of results.
setNormalizationStatus(String) - Method in class com.paypal.api.payments.BaseAddress
BaseAddress normalization status, returned only for payers from Brazil.
setNoShipping(int) - Method in class com.paypal.api.payments.InputFields
Indicates whether PayPal displays shipping address fields on the experience pages.
setNote(String) - Method in class com.paypal.api.payments.AgreementStateDescriptor
Reason for changing the state of the agreement.
setNote(String) - Method in class com.paypal.api.payments.CancelNotification
Note to the payer.
setNote(String) - Method in class com.paypal.api.payments.Invoice
Note to the payer.
setNote(String) - Method in class com.paypal.api.payments.InvoicingNotification
Note to the payer.
setNote(String) - Method in class com.paypal.api.payments.InvoicingPaymentDetail
Optional note associated with the payment.
setNote(String) - Method in class com.paypal.api.payments.InvoicingRefundDetail
Optional note associated with the refund.
setNote(String) - Method in class com.paypal.api.payments.Notification
Note to the payer.
setNote(String) - Method in class com.paypal.api.payments.PaymentDetail
Optional.
setNote(String) - Method in class com.paypal.api.payments.PaymentInstruction
Additional text regarding payment handling
setNote(String) - Method in class com.paypal.api.payments.PayoutItem
Optional.
setNote(String) - Method in class com.paypal.api.payments.RefundDetail
Optional note associated with the refund.
setNote(String) - Method in class com.paypal.api.payments.TemplateData
Note to the payer.
setNoteToPayee(String) - Method in class com.paypal.api.payments.CartBase
Note to the recipient of the funds in this transaction.
setNoteToPayer(String) - Method in class com.paypal.api.payments.Payment
free-form field for the use of clients to pass in a message to the payer
setNoteToSellerLabel(String) - Method in class com.paypal.api.payments.Presentation
A label to use as the title for the note to seller field.
setNotificationChannel(String) - Method in class com.paypal.api.payments.BillingInfo
Preferred notification channel of the payer.
setNotifyUrl(String) - Method in class com.paypal.api.payments.CartBase
URL to send payment notifications
setNotifyUrl(String) - Method in class com.paypal.api.payments.MerchantPreferences
Notify URL on agreement creation.
setNumber(String) - Method in class com.paypal.api.payments.CreditCard
Credit card number.
setNumber(String) - Method in class com.paypal.api.payments.Invoice
Unique number that appears on the invoice.
setNumber(String) - Method in class com.paypal.api.payments.InvoiceNumber
The next invoice number
setNumber(String) - Method in class com.paypal.api.payments.InvoicingSearch
The invoice number that appears on the invoice.
setNumber(String) - Method in class com.paypal.api.payments.PaymentCard
The card number.
setNumber(String) - Method in class com.paypal.api.payments.Search
The invoice number.
setOAUTH_TOKEN_PATH(String) - Static method in class com.paypal.base.rest.OAuthTokenCredential
Sets the URI path for the OAuth Token service.
setOccurrences(String) - Method in class com.paypal.api.payments.Terms
How many times money can be pulled during this term.
setOp(String) - Method in class com.paypal.api.payments.Patch
The operation to perform.
setOp(String) - Method in class com.paypal.api.payments.PatchRequest
The operation to perform.
setOrder(Order) - Method in class com.paypal.api.payments.RelatedResources
Order transaction
setOrderUrl(String) - Method in class com.paypal.api.payments.CartBase
Url on merchant site pertaining to this payment.
setOther(Currency) - Method in class com.paypal.api.payments.PaymentSummary
Total Amount paid/refunded via other sources.
setOutstandingBalance(Currency) - Method in class com.paypal.api.payments.AgreementDetails
The outstanding balance for this agreement.
setOverrideChargeModels(List<OverrideChargeModel>) - Method in class com.paypal.api.payments.Agreement
Array of override_charge_model for this agreement if needed to change the default models from the billing plan.
setOverrideMerchantPreferences(MerchantPreferences) - Method in class com.paypal.api.payments.Agreement
Default merchant preferences from the billing plan are used, unless override preferences are provided here.
setPage(float) - Method in class com.paypal.api.payments.InvoicingSearch
Offset of the search results.
setPage(float) - Method in class com.paypal.api.payments.Search
The offset for the search results.
setPageSize(float) - Method in class com.paypal.api.payments.InvoicingSearch
Page size of the search results.
setPageSize(float) - Method in class com.paypal.api.payments.Search
The page size for the search results.
setPaidAmount(PaymentSummary) - Method in class com.paypal.api.payments.Invoice
Payment summary of the invoice including amount paid through PayPal and other sources.
setParentPayment(String) - Method in class com.paypal.api.payments.Authorization
ID of the Payment resource that this transaction is based on.
setParentPayment(String) - Method in class com.paypal.api.payments.Capture
The ID of the payment on which this transaction is based.
setParentPayment(String) - Method in class com.paypal.api.payments.Order
ID of the Payment resource that this transaction is based on.
setParentPayment(String) - Method in class com.paypal.api.payments.Refund
ID of the payment resource on which this transaction is based.
setParentPayment(String) - Method in class com.paypal.api.payments.Sale
ID of the payment resource on which this transaction is based.
setPath(String) - Method in class com.paypal.api.payments.Patch
A JSON pointer that references a location in the target document where the operation is performed.
setPath(String) - Method in class com.paypal.api.payments.PatchRequest
string containing a JSON-Pointer value that references a location within the target document (the target location) where the operation is performed.
setPathStart(String) - Method in class com.paypal.api.payments.HyperSchema
 
setPayee(Payee) - Method in class com.paypal.api.payments.CartBase
Recipient of the funds in this transaction.
setPayee(Payee) - Method in class com.paypal.api.payments.Payment
Receiver of funds for this payment.
setPayeeId(String) - Method in class com.paypal.base.rest.QueryParameters
Set the payeeId
setPayer(Payer) - Method in class com.paypal.api.payments.Agreement
Details of the buyer who is enrolling in this agreement.
setPayer(Payer) - Method in class com.paypal.api.payments.Payment
Source of the funds for this payment represented by a PayPal account or a direct credit card.
setPayerAcceptance(Boolean) - Method in class com.paypal.api.payments.CreditFinancingOffered
Status on whether the customer ultimately was approved for and chose to make the payment using the approved installment credit.
setPayerEmail(String) - Method in class com.paypal.api.payments.AgreementTransaction
Email id of payer.
setPayerId(String) - Method in class com.paypal.api.openidconnect.Userinfo
Account payer identifier.
setPayerId(String) - Method in class com.paypal.api.payments.BankAccount
[DEPRECATED] Use external_customer_id instead.
setPayerId(String) - Method in class com.paypal.api.payments.CreditCard
Payer ID
setPayerId(String) - Method in class com.paypal.api.payments.CreditCardToken
A unique identifier that you can assign and track when storing a credit card or using a stored credit card.
setPayerId(String) - Method in class com.paypal.api.payments.PayerInfo
PayPal assigned encrypted Payer ID.
setPayerId(String) - Method in class com.paypal.api.payments.PaymentExecution
The ID of the Payer, passed in the `return_url` by PayPal.
setPayerInfo(PayerInfo) - Method in class com.paypal.api.payments.Payer
Information related to the Payer.
setPayerName(String) - Method in class com.paypal.api.payments.AgreementTransaction
Business name of payer.
setPayerViewUrl(String) - Method in class com.paypal.api.payments.Metadata
URL representing the payer's view of the invoice.
setPayLoad(String) - Method in class com.paypal.base.rest.RESTAPICallPreHandler
 
setPaymentCard(PaymentCard) - Method in class com.paypal.api.payments.FundingInstrument
Payment Card information.
setPaymentCardId(String) - Method in class com.paypal.api.payments.PaymentCardToken
ID of a previously saved Payment Card resource.
setPaymentDebitDate(String) - Method in class com.paypal.api.payments.FundingDetail
Date when funds will be debited from the payer's account
setPaymentDefinitions(List<PaymentDefinition>) - Method in class com.paypal.api.payments.Plan
Array of payment definitions for this billing plan.
setPaymentDetails(List<PaymentDetail>) - Method in class com.paypal.api.payments.Invoice
Deprecated.
Please use Invoice.setPayments(List) instead.
setPaymentDueDate(String) - Method in class com.paypal.api.payments.PaymentInstruction
Date by which payment should be received
setPaymentHoldDate(String) - Method in class com.paypal.api.payments.FundingDetail
[DEPRECATED] Hold-off duration of the payment.
setPaymentHoldReasons(List<String>) - Method in class com.paypal.api.payments.Sale
Reasons for PayPal holding recipient fund.
setPaymentHoldStatus(String) - Method in class com.paypal.api.payments.Sale
Status of the Recipient Fund.
setPaymentInstruction(PaymentInstruction) - Method in class com.paypal.api.payments.Payment
Instructions for the payer to complete this payment.
setPaymentMethod(String) - Method in class com.paypal.api.payments.Payer
Payment method being used - PayPal Wallet payment, Bank Direct Debit or Direct Credit card.
setPaymentMode(String) - Method in class com.paypal.api.payments.Authorization
Specifies the payment mode of the transaction.
setPaymentMode(String) - Method in class com.paypal.api.payments.Order
specifies payment mode of the transaction
setPaymentMode(String) - Method in class com.paypal.api.payments.Sale
Specifies payment mode of the transaction.
setPaymentOptions(PaymentOptions) - Method in class com.paypal.api.payments.CartBase
Payment options requested for this purchase unit
setPayments(List<PaymentDetail>) - Method in class com.paypal.api.payments.Invoice
List of payment details for the invoice.
setPayments(List<Payment>) - Method in class com.paypal.api.payments.PaymentHistory
A list of Payment resources
setPaymentTerm(PaymentTerm) - Method in class com.paypal.api.payments.Invoice
Optional.
setPaymentTerm(PaymentTerm) - Method in class com.paypal.api.payments.TemplateData
Optional.
setPayoutBatchId(String) - Method in class com.paypal.api.payments.PayoutBatchHeader
The PayPal-generated ID for a batch payout.
setPayoutBatchId(String) - Method in class com.paypal.api.payments.PayoutItemDetails
The PayPal-generated ID for the batch payout.
setPayoutItem(PayoutItem) - Method in class com.paypal.api.payments.PayoutItemDetails
The sender-provided information for the payout item.
setPayoutItemFee(Currency) - Method in class com.paypal.api.payments.PayoutItemDetails
The amount of money, in U.S.
setPayoutItemId(String) - Method in class com.paypal.api.payments.PayoutItemDetails
The ID for the payout item.
setPaypal(Currency) - Method in class com.paypal.api.payments.PaymentSummary
Total Amount paid/refunded via PayPal.
setPendingReason(String) - Method in class com.paypal.api.payments.Authorization
[DEPRECATED] Reason code for the transaction state being Pending.Obsolete.
setPendingReason(String) - Method in class com.paypal.api.payments.Order
Deprecated.
Reason code for the transaction state being Pending. Obsolete. Retained for backward compatability. Use reason_code field above instead.
setPercent(float) - Method in class com.paypal.api.payments.Cost
Cost in percent.
setPercent(float) - Method in class com.paypal.api.payments.Tax
The rate of the specified tax.
setPhone(String) - Method in class com.paypal.api.payments.Address
Phone number in E.123 format.
setPhone(Phone) - Method in class com.paypal.api.payments.BillingInfo
Mobile Phone number of the recipient to which SMS will be sent if notification_channel is SMS.
setPhone(Phone) - Method in class com.paypal.api.payments.InvoiceAddress
Phone number in E.123 format.
setPhone(Phone) - Method in class com.paypal.api.payments.MerchantInfo
The merchant phone number.
setPhone(Phone) - Method in class com.paypal.api.payments.Participant
The participant phone number.
setPhone(Phone) - Method in class com.paypal.api.payments.Payee
Information related to the Payee.
setPhone(String) - Method in class com.paypal.api.payments.PayerInfo
Phone number representing the payer.
setPhone(Phone) - Method in class com.paypal.api.payments.ShippingInfo
The invoice recipient phone number.
setPhoneNumber(String) - Method in class com.paypal.api.openidconnect.Userinfo
End-User's preferred telephone number.
setPhoneNumber(String) - Method in class com.paypal.api.payments.CarrierAccount
The phone number of the payer, in E.164 format.
setPhones(List<Phone>) - Method in class com.paypal.api.payments.Templates
List of phone numbers in merchant's profile.
setPhoneSource(String) - Method in class com.paypal.api.payments.CarrierAccount
The method used to obtain the phone number.
setPhoneType(String) - Method in class com.paypal.api.payments.PayerInfo
Phone type
setPicture(String) - Method in class com.paypal.api.openidconnect.Userinfo
URL of the End-User's profile picture.
setPlan(Plan) - Method in class com.paypal.api.payments.Agreement
Plan details for this agreement.
setPlans(List<Plan>) - Method in class com.paypal.api.payments.PlanList
Array of billing plans.
setPostalCode(String) - Method in class com.paypal.api.openidconnect.Address
Setter for postalCode
setPostalCode(String) - Method in class com.paypal.api.payments.BaseAddress
Zip code or equivalent is usually required for countries that have them.
setPostbackData(List<NameValuePair>) - Method in class com.paypal.api.payments.Item
Set of optional data used for PayPal post-transaction notifications.
setPotentialPayerInfo(PotentialPayerInfo) - Method in class com.paypal.api.payments.Payment
Information that the merchant knows about the payer.
setPresentation(Presentation) - Method in class com.paypal.api.payments.WebProfile
Parameters for style and presentation.
setPrice(String) - Method in class com.paypal.api.payments.Item
Item cost.
setPrivateLabelCard(PrivateLabelCard) - Method in class com.paypal.api.payments.FundingInstrument
Private Label Card funding instrument.
setProcessingType(String) - Method in class com.paypal.api.payments.FundingDetail
Processing type of the payment card
setProcessorResponse(ProcessorResponse) - Method in class com.paypal.api.payments.Error
Deprecated.
This property is not available publicly response codes returned from a payment processor such as avs, cvv, etc. Only supported when the `payment_method` is set to `credit_card`.
setProcessorResponse(ProcessorResponse) - Method in class com.paypal.api.payments.Sale
Response codes returned by the processor concerning the submitted payment.
setProtectionEligibility(String) - Method in class com.paypal.api.payments.Authorization
The level of seller protection in force for the transaction.
setProtectionEligibility(String) - Method in class com.paypal.api.payments.Order
The level of seller protection in force for the transaction.
setProtectionEligibility(String) - Method in class com.paypal.api.payments.Sale
The level of seller protection in force for the transaction.
setProtectionEligibilityType(String) - Method in class com.paypal.api.payments.Authorization
The kind of seller protection in force for the transaction.
setProtectionEligibilityType(String) - Method in class com.paypal.api.payments.Order
The kind of seller protection in force for the transaction.
setProtectionEligibilityType(String) - Method in class com.paypal.api.payments.Sale
The kind of seller protection in force for the transaction.
setProxyHost(String) - Method in class com.paypal.base.HttpConfiguration
Sets the proxyHost
setProxyPassword(String) - Method in class com.paypal.base.HttpConfiguration
Sets the proxyPassword
setProxyPort(int) - Method in class com.paypal.base.HttpConfiguration
Sets the proxyPort
setProxySet(boolean) - Method in class com.paypal.base.HttpConfiguration
Sets the proxySet
setProxyUserName(String) - Method in class com.paypal.base.HttpConfiguration
Sets the proxyUserName
setPurchaseUnitReferenceId(String) - Method in class com.paypal.api.payments.Error
Deprecated.
This property is not available publicly Reference ID of the purchase_unit associated with this error
setPurchaseUnitReferenceId(String) - Method in class com.paypal.api.payments.ErrorDetails
Deprecated.
This property is not publicly available Reference ID of the purchase_unit associated with this error
setPurchaseUnitReferenceId(String) - Method in class com.paypal.api.payments.Order
Identifier to the purchase unit associated with this object.
setPurchaseUnitReferenceId(String) - Method in class com.paypal.api.payments.Sale
Identifier to the purchase or transaction unit corresponding to this sale transaction.
setPurchaseUnitReferenceId(String) - Method in class com.paypal.api.payments.TransactionBase
Identifier to the purchase unit corresponding to this sale transaction.
setQuantity(float) - Method in class com.paypal.api.payments.InvoiceItem
Quantity of the item.
setQuantity(String) - Method in class com.paypal.api.payments.Item
Number of a particular item.
setReadonly(Boolean) - Method in class com.paypal.api.payments.HyperSchema
 
setReadTimeout(int) - Method in class com.paypal.base.HttpConfiguration
Sets the readTimeout
setReason(String) - Method in class com.paypal.api.payments.Refund
Reason description for the Sale transaction being refunded.
setReason(String) - Method in class com.paypal.api.payments.RefundRequest
Reason description for the Sale transaction being refunded.
setReasonCode(String) - Method in class com.paypal.api.payments.Authorization
Reason code, `AUTHORIZATION`, for a transaction state of `pending`.
setReasonCode(String) - Method in class com.paypal.api.payments.Capture
The reason code that describes why the transaction state is pending or reversed.
setReasonCode(String) - Method in class com.paypal.api.payments.Order
Reason code for the transaction state being Pending or Reversed.
setReasonCode(String) - Method in class com.paypal.api.payments.Refund
The reason code for the refund state being pending
setReasonCode(String) - Method in class com.paypal.api.payments.Sale
Reason code for the transaction state being Pending or Reversed.
setReceiptId(String) - Method in class com.paypal.api.payments.Authorization
Receipt id is 16 digit number payment identification number returned for guest users to identify the payment.
setReceiptId(String) - Method in class com.paypal.api.payments.Sale
Receipt id is a payment identification number returned for guest users to identify the payment.
setReceivableAmount(Currency) - Method in class com.paypal.api.payments.Sale
Net amount the merchant receives for this transaction in their receivable currency.
setReceiver(String) - Method in class com.paypal.api.payments.PayoutItem
The receiver of the payment.
setRecipientBankingInstruction(RecipientBankingInstruction) - Method in class com.paypal.api.payments.PaymentInstruction
Recipient bank Details.
setRecipientBusinessName(String) - Method in class com.paypal.api.payments.InvoicingSearch
Initial letters of the recipient's business name.
setRecipientBusinessName(String) - Method in class com.paypal.api.payments.Search
The initial letters of the recipient's business name.
setRecipientFirstName(String) - Method in class com.paypal.api.payments.InvoicingSearch
Initial letters of the recipient's first name.
setRecipientFirstName(String) - Method in class com.paypal.api.payments.Search
The initial letters of the recipient's first name.
setRecipientLastName(String) - Method in class com.paypal.api.payments.InvoicingSearch
Initial letters of the recipient's last name.
setRecipientLastName(String) - Method in class com.paypal.api.payments.Search
The initial letters of the recipient's last name.
setRecipientName(String) - Method in class com.paypal.api.payments.ShippingAddress
Name of the recipient at this address.
setRecipientType(String) - Method in class com.paypal.api.payments.PayoutItem
The type of ID that identifies the payment receiver.
setRecipientType(String) - Method in class com.paypal.api.payments.PayoutSenderBatchHeader
The type of ID that identifies the payment receiver.
setRecurringFlag(Boolean) - Method in class com.paypal.api.payments.PaymentOptions
Indicator if this payment request is a recurring payment.
setRedirectURI(String) - Method in class com.paypal.api.openidconnect.CreateFromAuthorizationCodeParameters
Set the redirect URI
setRedirectUrls(RedirectUrls) - Method in class com.paypal.api.payments.Payment
Set of redirect URLs you provide only for PayPal-based payments.
setReference(String) - Method in class com.paypal.api.payments.Invoice
Reference data, such as PO number, to add to the invoice.
setReference(String) - Method in class com.paypal.api.payments.TemplateData
Reference data, such as PO number, to add to the invoice.
setReferenceId(String) - Method in class com.paypal.api.payments.Authorization
Identifier to the purchase or transaction unit corresponding to this authorization transaction.
setReferenceId(String) - Method in class com.paypal.api.payments.CartBase
Merchant identifier to the purchase unit.
setReferenceId(String) - Method in class com.paypal.api.payments.ExternalFunding
Unique identifier for the external funding
setReferenceId(String) - Method in class com.paypal.api.payments.Order
Deprecated.
Use Order.purchaseUnitReferenceId instead Identifier to the purchase unit associated with this object. Obsolete. Use one in cart_base.
setReferenceNumber(String) - Method in class com.paypal.api.payments.PaymentInstruction
ID of payment instruction
setRefreshToken(String) - Method in class com.paypal.api.openidconnect.Tokeninfo
Setter for refreshToken
setRefreshToken(String) - Method in class com.paypal.base.rest.APIContext
Sets refresh token to be used for third party OAuth operations.
setRefund(Refund) - Method in class com.paypal.api.payments.RelatedResources
Refund transaction
setRefundAdvice(Boolean) - Method in class com.paypal.api.payments.RefundRequest
Flag to indicate that the buyer was already given store credit for a given transaction.
setRefundDetails(List<RefundDetail>) - Method in class com.paypal.api.payments.Invoice
Deprecated.
Please use Invoice.setRefunds(List) instead.
setRefundedAmount(PaymentSummary) - Method in class com.paypal.api.payments.Invoice
Payment summary of the invoice including amount refunded through PayPal and other sources.
setRefundFromReceivedAmount(Currency) - Method in class com.paypal.api.payments.DetailedRefund
Amount subtracted from PayPal balance of the original recipient of payment, to make this refund.
setRefundFromTransactionFee(Currency) - Method in class com.paypal.api.payments.DetailedRefund
Transaction fee refunded to original recipient of payment.
setRefunds(List<RefundDetail>) - Method in class com.paypal.api.payments.Invoice
List of refund details for the invoice.
setRefundSource(String) - Method in class com.paypal.api.payments.RefundRequest
Type of PayPal funding source (balance or eCheck) that can be used for auto refund.
setRefundToExternalFunding(List<ExternalFunding>) - Method in class com.paypal.api.payments.DetailedRefund
List of external funding that were refunded by the Refund call.
setRefundToPayer(Currency) - Method in class com.paypal.api.payments.DetailedRefund
Amount refunded to payer of the original transaction, in the current Refund call
setRefundType(String) - Method in class com.paypal.api.payments.RefundRequest
Type of refund you are making.
setRegion(String) - Method in class com.paypal.api.openidconnect.Address
Setter for region
setRel(String) - Method in class com.paypal.api.payments.DefinitionsLinkdescription
relation to the target resource of the link
setRel(String) - Method in class com.paypal.api.payments.Links
 
setRelatedFundingOption(FundingOption) - Method in class com.paypal.api.payments.Payer
Funding option related to default funding option.
setRelatedResources(List<RelatedResources>) - Method in class com.paypal.api.payments.TransactionBase
List of financial transactions (Sale, Authorization, Capture, Refund) related to the payment.
setRequestId(String) - Method in class com.paypal.base.rest.APIContext
Sets the requestId to be sent on each request.
setRequestId(String) - Method in class com.paypal.base.rest.RESTAPICallPreHandler
 
setResource(Object) - Method in class com.paypal.api.payments.Event
This contains the resource that is identified by resource_type element.
setResourcePath(String) - Method in class com.paypal.base.rest.RESTAPICallPreHandler
 
setResourceType(String) - Method in class com.paypal.api.payments.Event
Name of the resource contained in resource element.
setResponseCode(String) - Method in class com.paypal.api.payments.ProcessorResponse
Paypal normalized response code, generated from the processor's specific response code
setResponsecode(int) - Method in exception com.paypal.base.rest.PayPalRESTException
 
setRetryDelay(int) - Method in class com.paypal.base.HttpConfiguration
Sets the retryDelay
setReturnUriHttpMethod(String) - Method in class com.paypal.api.payments.FlowConfig
Defines the HTTP method to use to redirect the user to a return URL.
setReturnUrl(String) - Method in class com.paypal.api.payments.MerchantPreferences
Redirect URL on creation of agreement request.
setReturnUrl(String) - Method in class com.paypal.api.payments.RedirectUrls
Url where the payer would be redirected to after approving the payment.
setReturnUrlLabel(String) - Method in class com.paypal.api.payments.Presentation
A label to use as hypertext for the return to merchant link.
setRoutingNumber(String) - Method in class com.paypal.api.payments.BankAccount
Routing transit number (aka Bank Code) of the bank (typically for domestic use only - for international use, IBAN includes bank code).
setRoutingNumber(String) - Method in class com.paypal.api.payments.RecipientBankingInstruction
bank routing number
setSale(Sale) - Method in class com.paypal.api.payments.RelatedResources
Sale transaction
setSaleId(String) - Method in class com.paypal.api.payments.Refund
ID of the Sale transaction being refunded.
setSalutation(String) - Method in class com.paypal.api.payments.PayerInfo
Salutation of the payer.
setSchema(DefinitionsLinkdescription) - Method in class com.paypal.api.payments.DefinitionsLinkdescription
Schema describing the data to submit along with the request
setSchema(HyperSchema) - Method in class com.paypal.api.payments.Links
 
setScope(String) - Method in class com.paypal.api.openidconnect.CreateFromRefreshTokenParameters
Set the Scope
setScope(String) - Method in class com.paypal.api.openidconnect.Tokeninfo
Setter for scope
setSdkVersion(SDKVersion) - Method in class com.paypal.base.rest.APIContext
 
setSdkVersion(SDKVersion) - Method in class com.paypal.base.rest.RESTAPICallPreHandler
 
setSelectedInstallmentOption(InstallmentOption) - Method in class com.paypal.api.payments.Billing
Selected installment option for issuer based installments (BR and MX).
setSenderBatchHeader(PayoutSenderBatchHeader) - Method in class com.paypal.api.payments.Payout
The original batch header as provided by the payment sender.
setSenderBatchHeader(PayoutSenderBatchHeader) - Method in class com.paypal.api.payments.PayoutBatchHeader
The original batch header as provided by the payment sender.
setSenderBatchId(String) - Method in class com.paypal.api.payments.PayoutItemDetails
A sender-specified ID number.
setSenderBatchId(String) - Method in class com.paypal.api.payments.PayoutSenderBatchHeader
A sender-specified ID number.
setSenderItemId(String) - Method in class com.paypal.api.payments.PayoutItem
A sender-specified ID number.
setSendToMerchant(Boolean) - Method in class com.paypal.api.payments.CancelNotification
Indicates whether to send a copy of the notification to the merchant.
setSendToMerchant(Boolean) - Method in class com.paypal.api.payments.InvoicingNotification
A flag indicating whether a copy of the email has to be sent to the merchant.
setSendToMerchant(Boolean) - Method in class com.paypal.api.payments.Notification
Indicates whether to send a copy of the email to the merchant.
setSendToPayer(Boolean) - Method in class com.paypal.api.payments.CancelNotification
Indicates whether to send a copy of the notification to the payer.
setSettings(List<TemplateSettings>) - Method in class com.paypal.api.payments.Template
Settings for each template
setSetupFee(Currency) - Method in class com.paypal.api.payments.MerchantPreferences
Setup fee amount.
setShipping(String) - Method in class com.paypal.api.payments.Details
Amount charged for shipping.
setShippingAddress(Address) - Method in class com.paypal.api.payments.Agreement
Shipping address object of the agreement, which should be provided if it is different from the default address.
setShippingAddress(ShippingAddress) - Method in class com.paypal.api.payments.ItemList
Shipping address.
setShippingAddress(ShippingAddress) - Method in class com.paypal.api.payments.PayerInfo
Deprecated.
Use shipping address present in purchase unit or at root level of checkout Session.
setShippingCost(ShippingCost) - Method in class com.paypal.api.payments.Invoice
The shipping cost, as a percent or an amount value.
setShippingCost(ShippingCost) - Method in class com.paypal.api.payments.TemplateData
The shipping cost, as a percent or an amount value.
setShippingDiscount(String) - Method in class com.paypal.api.payments.Details
Amount being discounted for the shipping fee.
setShippingInfo(ShippingInfo) - Method in class com.paypal.api.payments.Invoice
The shipping information for entities to whom items are being shipped.
setShippingInfo(ShippingInfo) - Method in class com.paypal.api.payments.TemplateData
The shipping information for entities to whom items are being shipped.
setShippingMethod(String) - Method in class com.paypal.api.payments.ItemList
Shipping method used for this payment like USPSParcel etc.
setShippingPhoneNumber(String) - Method in class com.paypal.api.payments.ItemList
Allows merchant's to share payer’s contact number with PayPal for the current payment.
setSkipFmf(Boolean) - Method in class com.paypal.api.payments.PaymentOptions
Indicator if fraud management filters (fmf) should be skipped for this transaction.
setSku(String) - Method in class com.paypal.api.payments.Item
Stock keeping unit corresponding (SKU) to item.
setSoftDescriptor(String) - Method in class com.paypal.api.payments.CartBase
Soft descriptor used when charging this funding source.
setSoftDescriptorCity(String) - Method in class com.paypal.api.payments.CartBase
Soft descriptor city used when charging this funding source.
setSortBy(String) - Method in class com.paypal.base.rest.QueryParameters
Set the sortBy
setSortOrder(String) - Method in class com.paypal.base.rest.QueryParameters
Set the sortOrder
setStartCreationDate(String) - Method in class com.paypal.api.payments.InvoicingSearch
Start invoice creation date.
setStartCreationDate(String) - Method in class com.paypal.api.payments.Search
The start creation date for the invoice.
setStartDate(String) - Method in class com.paypal.api.payments.Agreement
Start date of the agreement.
setStartDueDate(String) - Method in class com.paypal.api.payments.InvoicingSearch
Start invoice due date.
setStartDueDate(String) - Method in class com.paypal.api.payments.Search
The start due date for the invoice.
setStartId(String) - Method in class com.paypal.base.rest.QueryParameters
Set the startId
setStartIndex(String) - Method in class com.paypal.base.rest.QueryParameters
Set the startIndex
setStartInvoiceDate(String) - Method in class com.paypal.api.payments.InvoicingSearch
Start invoice date.
setStartInvoiceDate(String) - Method in class com.paypal.api.payments.Search
The start date for the invoice.
setStartMonth(String) - Method in class com.paypal.api.payments.PaymentCard
The two-digit start month for the card.
setStartPaymentDate(String) - Method in class com.paypal.api.payments.InvoicingSearch
Start invoice payment date.
setStartPaymentDate(String) - Method in class com.paypal.api.payments.Search
The start payment date for the invoice.
setStartTime(String) - Method in class com.paypal.base.rest.QueryParameters
Set the startTime
setStartYear(String) - Method in class com.paypal.api.payments.PaymentCard
The four-digit start year for the card.
setState(String) - Method in class com.paypal.api.payments.Agreement
State of the agreement
setState(String) - Method in class com.paypal.api.payments.Authorization
State of the authorization.
setState(String) - Method in class com.paypal.api.payments.BankAccount
State of this funding instrument.
setState(String) - Method in class com.paypal.api.payments.BaseAddress
2 letter code for US states, and the equivalent for other countries.
setState(String) - Method in class com.paypal.api.payments.Capture
The state of the capture.
setState(String) - Method in class com.paypal.api.payments.CreditCard
State of the credit card funding instrument.
setState(String) - Method in class com.paypal.api.payments.Order
State of the order transaction.
setState(String) - Method in class com.paypal.api.payments.Payment
The state of the payment, authorization, or order transaction.
setState(String) - Method in class com.paypal.api.payments.Plan
Status of the billing plan.
setState(String) - Method in class com.paypal.api.payments.Refund
State of the refund.
setState(String) - Method in class com.paypal.api.payments.Sale
State of the sale transaction.
setStatus(String) - Method in class com.paypal.api.payments.AgreementTransaction
State of the subscription at this time.
setStatus(String) - Method in class com.paypal.api.payments.BaseAddress
BaseAddress status
setStatus(String) - Method in class com.paypal.api.payments.Invoice
Status of the invoice.
setStatus(String) - Method in class com.paypal.api.payments.InvoicingSearch
Status of the invoice.
setStatus(String) - Method in class com.paypal.api.payments.Payer
Status of payer's PayPal Account.
setStatus(String) - Method in class com.paypal.api.payments.PaymentCard
The state of the funding instrument.
setStatus(String) - Method in class com.paypal.api.payments.Search
The invoice status.
setStreetAddress(String) - Method in class com.paypal.api.openidconnect.Address
Setter for streetAddress
setSub(String) - Method in class com.paypal.api.openidconnect.Userinfo
Subject - Identifier for the End-User at the Issuer.
setSubject(String) - Method in class com.paypal.api.payments.CancelNotification
Subject of the notification.
setSubject(String) - Method in class com.paypal.api.payments.InvoicingNotification
Subject of the notification.
setSubject(String) - Method in class com.paypal.api.payments.Notification
Subject of the notification.
setSubtotal(String) - Method in class com.paypal.api.payments.Details
Amount of the subtotal of the items.
setSuffix(String) - Method in class com.paypal.api.payments.PayerInfo
Suffix of the payer.
setSummary(String) - Method in class com.paypal.api.payments.Event
A summary description of the event.
setSupplementaryData(List<NameValuePair>) - Method in class com.paypal.api.payments.Item
Set of optional data used for PayPal risk determination.
setTargetSchema(DefinitionsLinkdescription) - Method in class com.paypal.api.payments.DefinitionsLinkdescription
JSON Schema describing the link target
setTargetSchema(HyperSchema) - Method in class com.paypal.api.payments.Links
 
setTax(String) - Method in class com.paypal.api.payments.Details
Amount charged for tax.
setTax(Tax) - Method in class com.paypal.api.payments.InvoiceItem
Tax associated with the item.
setTax(String) - Method in class com.paypal.api.payments.Item
Tax of the item.
setTax(Tax) - Method in class com.paypal.api.payments.ShippingCost
The tax percentage on the shipping amount.
setTaxCalculatedAfterDiscount(Boolean) - Method in class com.paypal.api.payments.Invoice
Indicates whether tax is calculated before or after a discount.
setTaxCalculatedAfterDiscount(Boolean) - Method in class com.paypal.api.payments.TemplateData
Indicates whether tax is calculated before or after a discount.
setTaxId(String) - Method in class com.paypal.api.payments.MerchantInfo
The merchant tax ID.
setTaxId(String) - Method in class com.paypal.api.payments.PayerInfo
Payer’s tax ID.
setTaxIdType(String) - Method in class com.paypal.api.payments.PayerInfo
Payer’s tax ID type.
setTaxInclusive(Boolean) - Method in class com.paypal.api.payments.Invoice
Indicates whether the unit price includes tax.
setTaxInclusive(Boolean) - Method in class com.paypal.api.payments.TemplateData
Indicates whether the unit price includes tax.
setTemplateData(TemplateData) - Method in class com.paypal.api.payments.Template
Customized invoice data which is saved as template
setTemplateId(String) - Method in class com.paypal.api.payments.Invoice
The template ID used for the invoice.
setTemplateId(String) - Method in class com.paypal.api.payments.Template
Unique identifier id of the template.
setTemplates(List<Template>) - Method in class com.paypal.api.payments.Templates
Array of templates.
setTemporary(Boolean) - Method in class com.paypal.api.payments.WebProfile
Indicates whether the profile persists for three hours or permanently.
setTerm(float) - Method in class com.paypal.api.payments.CreditFinancingOffered
Length of financing terms in month
setTerm(int) - Method in class com.paypal.api.payments.InstallmentOption
Number of installments
setTerms(String) - Method in class com.paypal.api.payments.Incentive
URI to the associated terms
setTerms(String) - Method in class com.paypal.api.payments.Invoice
General terms of the invoice.
setTerms(List<Terms>) - Method in class com.paypal.api.payments.Plan
Array of terms for this billing plan.
setTerms(String) - Method in class com.paypal.api.payments.TemplateData
General terms of the invoice.
setTermType(String) - Method in class com.paypal.api.payments.PaymentTerm
The terms by which the invoice payment is due.
setTimeCompleted(String) - Method in class com.paypal.api.payments.PayoutBatchHeader
The time that processing for the batch was completed.
setTimeCreated(String) - Method in class com.paypal.api.payments.PayoutBatchHeader
The time the batch entered processing.
setTimeProcessed(String) - Method in class com.paypal.api.payments.PayoutItemDetails
The date and time when this item was last processed.
setTimeStamp(String) - Method in class com.paypal.api.payments.AgreementTransaction
Time at which this transaction happened.
setTimeUpdated(String) - Method in class com.paypal.api.payments.AgreementTransaction
Deprecated.
use setTimeStamp instead. Setter for timeUpdated
setTimeZone(String) - Method in class com.paypal.api.payments.AgreementTransaction
Time zone of time_updated field.
setTitle(String) - Method in class com.paypal.api.payments.DefinitionsLinkdescription
a title for the link
setToAmount(String) - Method in class com.paypal.api.payments.CurrencyConversion
Amount resulting from currency conversion.
setToCurrency(String) - Method in class com.paypal.api.payments.CurrencyConversion
3 letter currency code
setToken(String) - Method in class com.paypal.api.payments.Agreement
Payment token
setTokenType(String) - Method in class com.paypal.api.openidconnect.Tokeninfo
Setter for tokenType
setTotal(String) - Method in class com.paypal.api.payments.Amount
Total amount charged from the payer to the payee.
setTotalAmount(Currency) - Method in class com.paypal.api.payments.Invoice
The total amount of the invoice.
setTotalAmount(Currency) - Method in class com.paypal.api.payments.TemplateData
The total amount of the invoice.
setTotalCost(Currency) - Method in class com.paypal.api.payments.CreditFinancingOffered
This is the estimated total payment amount including interest and fees the user will pay during the lifetime of the loan.
setTotalCount(int) - Method in class com.paypal.api.payments.Invoices
 
setTotalCountRequired(Boolean) - Method in class com.paypal.api.payments.InvoicingSearch
A flag indicating whether total count is required in the response.
setTotalCountRequired(Boolean) - Method in class com.paypal.api.payments.Search
Indicates whether the total count appears in the response.
setTotalInterest(Currency) - Method in class com.paypal.api.payments.CreditFinancingOffered
Estimated interest or fees amount the payer will have to pay during the lifetime of the loan.
setTotalItems(int) - Method in class com.paypal.api.payments.CreditCardHistory
Total number of items.
setTotalItems(String) - Method in class com.paypal.api.payments.PlanList
Total number of items.
setTotalPages(int) - Method in class com.paypal.api.payments.CreditCardHistory
Total number of pages.
setTotalPages(String) - Method in class com.paypal.api.payments.PlanList
Total number of pages.
setTotalRefundedAmount(Currency) - Method in class com.paypal.api.payments.DetailedRefund
Total amount refunded so far from the original purchase.
setTransactionFee(Currency) - Method in class com.paypal.api.payments.Capture
The transaction fee for this payment.
setTransactionFee(Currency) - Method in class com.paypal.api.payments.Sale
Transaction fee applicable for this payment.
setTransactionId(String) - Method in class com.paypal.api.payments.AgreementTransaction
Id corresponding to this transaction.
setTransactionId(String) - Method in class com.paypal.api.payments.InvoicingPaymentDetail
PayPal payment transaction id.
setTransactionId(String) - Method in class com.paypal.api.payments.PaymentDetail
The PayPal payment transaction ID.
setTransactionId(String) - Method in class com.paypal.api.payments.PayoutItemDetails
The PayPal-generated ID for the transaction.
setTransactionId(String) - Method in class com.paypal.api.payments.RefundDetail
The PayPal refund transaction ID.
setTransactions(List<Transaction>) - Method in class com.paypal.api.payments.Payment
Transactional details including the amount and item details.
setTransactions(List<Transactions>) - Method in class com.paypal.api.payments.PaymentExecution
Transactional details including the amount and item details.
setTransactions(List<Transaction>) - Method in class com.paypal.api.payments.Transaction
Financial transactions related to a payment.
setTransactionStatus(String) - Method in class com.paypal.api.payments.PayoutItemDetails
The transaction status.
setTransactionType(String) - Method in class com.paypal.api.payments.AgreementTransaction
Type of transaction, usually Recurring Payment.
setTransactionType(String) - Method in class com.paypal.api.payments.InvoicingPaymentDetail
Type of the transaction.
setTransactionType(String) - Method in class com.paypal.api.payments.PaymentDetail
Type of the transaction.
setType(String) - Method in class com.paypal.api.payments.Address
Type of address (e.g., HOME_OR_WORK, GIFT etc).
setType(String) - Method in class com.paypal.api.payments.ChargeModels
Type of charge model.
setType(String) - Method in class com.paypal.api.payments.Credit
specifies type of credit
setType(String) - Method in class com.paypal.api.payments.CreditCard
Credit card type.
setType(String) - Method in class com.paypal.api.payments.CreditCardToken
Credit card type.
setType(String) - Method in class com.paypal.api.payments.Incentive
Specifies type of incentive
setType(String) - Method in class com.paypal.api.payments.InvoicingPaymentDetail
PayPal payment detail indicating whether payment was made in an invoicing flow via PayPal or externally.
setType(String) - Method in class com.paypal.api.payments.InvoicingRefundDetail
PayPal refund type indicating whether refund was done in invoicing flow via PayPal or externally.
setType(String) - Method in class com.paypal.api.payments.PaymentCard
The card type.
setType(String) - Method in class com.paypal.api.payments.PaymentCardToken
Type of the Card.
setType(String) - Method in class com.paypal.api.payments.PaymentDefinition
Type of the payment definition.
setType(String) - Method in class com.paypal.api.payments.PaymentDetail
The PayPal payment detail.
setType(String) - Method in class com.paypal.api.payments.Plan
Type of the billing plan.
setType(String) - Method in class com.paypal.api.payments.RefundDetail
The PayPal refund type.
setType(String) - Method in class com.paypal.api.payments.Terms
Term type.
setUnit(String) - Method in class com.paypal.api.payments.Measurement
Unit in which the value is represented.
setUnitOfMeasure(String) - Method in class com.paypal.api.payments.InvoiceItem
The unit of measure of the item being invoiced.
setUnitOfMeasure(String) - Method in class com.paypal.api.payments.Template
Unit of measure for the template, possible values are Quantity, Hours, Amount.
setUnitPrice(Currency) - Method in class com.paypal.api.payments.InvoiceItem
Unit price of the item.
setupClientSSL(String, String) - Method in class com.paypal.base.DefaultHttpConnection
 
setupClientSSL(String, String) - Method in class com.paypal.base.GoogleAppEngineHttpConnection
 
setupClientSSL(String, String) - Method in class com.paypal.base.HttpConnection
Set ssl parameters for client authentication
setupClientSSL(String, String) - Static method in class com.paypal.base.SSLUtil
Create a SSLContext with provided client certificate
setUpdateTime(String) - Method in class com.paypal.api.payments.Agreement
Date and time that this resource was updated.
setUpdateTime(String) - Method in class com.paypal.api.payments.Authorization
Time that the resource was last updated.
setUpdateTime(String) - Method in class com.paypal.api.payments.BankAccount
Time the resource was last updated.
setUpdateTime(String) - Method in class com.paypal.api.payments.Capture
The date and time when the resource was last updated.
setUpdateTime(String) - Method in class com.paypal.api.payments.Order
Time the resource was last updated in UTC ISO8601 format.
setUpdateTime(String) - Method in class com.paypal.api.payments.Payment
Payment update time as defined in [RFC 3339 Section 5.6](http://tools.ietf.org/html/rfc3339#section-5.6).
setUpdateTime(String) - Method in class com.paypal.api.payments.Plan
Time when this billing plan was updated.
setUpdateTime(String) - Method in class com.paypal.api.payments.Refund
Time that the resource was last updated.
setUpdateTime(String) - Method in class com.paypal.api.payments.Sale
Time the resource was last updated in UTC ISO8601 format.
setUpperTotalAmount(Currency) - Method in class com.paypal.api.payments.InvoicingSearch
Upper limit of total amount.
setUpperTotalAmount(Currency) - Method in class com.paypal.api.payments.Search
The upper limit of total amount.
setUri(String) - Method in class com.paypal.api.payments.Invoice
URI of the invoice resource.
setUrl(String) - Method in class com.paypal.api.payments.FileAttachment
URL of the attached file that can be downloaded.
setUrl(String) - Method in class com.paypal.api.payments.Item
URL linking to item information.
setUrl(String) - Method in class com.paypal.api.payments.Webhook
The URL that is configured to listen on `localhost` for incoming `POST` notification messages that contain event information.
setUrl(String) - Method in class com.paypal.base.rest.RESTAPICallPreHandler
 
setUserAction(String) - Method in class com.paypal.api.payments.FlowConfig
Defines whether buyers can complete purchases on the PayPal or merchant website.
setUserId(String) - Method in class com.paypal.api.openidconnect.Userinfo
Subject - Identifier for the End-User at the Issuer.
setValidUntil(String) - Method in class com.paypal.api.payments.Authorization
Authorization expiration time and date as defined in [RFC 3339 Section 5.6](http://tools.ietf.org/html/rfc3339#section-5.6).
setValidUntil(String) - Method in class com.paypal.api.payments.BankAccount
Date/Time until this resource can be used to fund a payment.
setValidUntil(String) - Method in class com.paypal.api.payments.CreditCard
Funding instrument expiration date.
setValidUntil(String) - Method in class com.paypal.api.payments.PaymentCard
The date and time until when this instrument can be used fund a payment.
setValue(String) - Method in class com.paypal.api.payments.Currency
amount up to N digit after the decimals separator as defined in ISO 4217 for the appropriate currency code.
setValue(String) - Method in class com.paypal.api.payments.Measurement
Value this measurement represents.
setValue(String) - Method in class com.paypal.api.payments.NameValuePair
Value for the name value pair.
setValue(Object) - Method in class com.paypal.api.payments.Patch
New value to apply based on the operation.
setValue(String) - Method in class com.paypal.api.payments.PatchRequest
New value to apply based on the operation.
setVerifiedAccount(Boolean) - Method in class com.paypal.api.openidconnect.Userinfo
Verified account status.
setVpas(String) - Method in class com.paypal.api.payments.ProcessorResponse
Visa Payer Authentication Service status.
setWebhooks(List<Webhook>) - Method in class com.paypal.api.payments.WebhookList
A list of webhooks.
setWebProfiles(List<WebProfile>) - Method in class com.paypal.api.payments.WebProfileList
 
setWebsite(String) - Method in class com.paypal.api.payments.MerchantInfo
The merchant website.
setWebsite(String) - Method in class com.paypal.api.payments.Participant
The participant website.
setWebUrl(String) - Method in class com.paypal.api.payments.CurrencyConversion
Base URL to web applications endpoint
setWeight(Measurement) - Method in class com.paypal.api.payments.Item
Weight of the item.
setWidth(Measurement) - Method in class com.paypal.api.payments.Item
Width of the item.
setXid(String) - Method in class com.paypal.api.payments.Card3dSecureInfo
Transaction identifier from authenticator.
setZoneinfo(String) - Method in class com.paypal.api.openidconnect.Userinfo
Time zone database representing the End-User's time zone
ShippingAddress - Class in com.paypal.api.payments
 
ShippingAddress() - Constructor for class com.paypal.api.payments.ShippingAddress
Default Constructor
ShippingAddress(String) - Constructor for class com.paypal.api.payments.ShippingAddress
Parameterized Constructor
ShippingCost - Class in com.paypal.api.payments
 
ShippingCost() - Constructor for class com.paypal.api.payments.ShippingCost
Default Constructor
ShippingInfo - Class in com.paypal.api.payments
 
ShippingInfo() - Constructor for class com.paypal.api.payments.ShippingInfo
Default Constructor
SSLConfigurationException - Exception in com.paypal.base.exception
SSLConfigurationException is thrown for error caused during SSL connection
SSLConfigurationException(String) - Constructor for exception com.paypal.base.exception.SSLConfigurationException
 
SSLConfigurationException(String, Throwable) - Constructor for exception com.paypal.base.exception.SSLConfigurationException
 
SSLUtil - Class in com.paypal.base
Class SSLUtil
SSLUtil() - Constructor for class com.paypal.base.SSLUtil
 
SSLUTIL_JRE - Static variable in class com.paypal.base.Constants
 
SSLUTIL_PROTOCOL - Static variable in class com.paypal.base.Constants
 
StringUtils - Class in com.paypal.base.codec.binary
Converts String to and from bytes using the encodings required by the Java specification.
StringUtils() - Constructor for class com.paypal.base.codec.binary.StringUtils
 
subscribedEventTypes(String, String) - Static method in class com.paypal.api.payments.EventType
subscribedEventTypes(APIContext, String) - Static method in class com.paypal.api.payments.EventType
Retrieves the list of events-types subscribed by the given Webhook.
suspend(String, AgreementStateDescriptor) - Method in class com.paypal.api.payments.Agreement
suspend(APIContext, AgreementStateDescriptor) - Method in class com.paypal.api.payments.Agreement
Suspend a particular billing agreement by passing the ID of the agreement to the request URI.

T

Tax - Class in com.paypal.api.payments
 
Tax() - Constructor for class com.paypal.api.payments.Tax
Default Constructor
Tax(String, float) - Constructor for class com.paypal.api.payments.Tax
Parameterized Constructor
Template - Class in com.paypal.api.payments
 
Template() - Constructor for class com.paypal.api.payments.Template
Default Constructor
TemplateData - Class in com.paypal.api.payments
 
TemplateData() - Constructor for class com.paypal.api.payments.TemplateData
Default Constructor
TemplateData(MerchantInfo) - Constructor for class com.paypal.api.payments.TemplateData
Parameterized Constructor
Templates - Class in com.paypal.api.payments
 
Templates() - Constructor for class com.paypal.api.payments.Templates
Default Constructor
TemplateSettings - Class in com.paypal.api.payments
 
TemplateSettings() - Constructor for class com.paypal.api.payments.TemplateSettings
Default Constructor
TemplateSettingsMetadata - Class in com.paypal.api.payments
 
TemplateSettingsMetadata() - Constructor for class com.paypal.api.payments.TemplateSettingsMetadata
Default Constructor
Terms - Class in com.paypal.api.payments
 
Terms() - Constructor for class com.paypal.api.payments.Terms
Default Constructor
Terms(String, Currency, String, Currency, String) - Constructor for class com.paypal.api.payments.Terms
Parameterized Constructor
toJSON(T) - Static method in class com.paypal.base.rest.JSONFormatter
Converts a Raw Type to JSON String
toJSON() - Method in class com.paypal.base.rest.PayPalModel
Returns a JSON string corresponding to object state
TokenAuthorization - Class in com.paypal.base.credential
TokenAuthorization encapsulates third party token authorization.
TokenAuthorization(String, String) - Constructor for class com.paypal.base.credential.TokenAuthorization
Token based third party authorization used in MERCHANT or PLATFORM APIs
Tokeninfo - Class in com.paypal.api.openidconnect
Class Tokeninfo
Tokeninfo() - Constructor for class com.paypal.api.openidconnect.Tokeninfo
Default Constructor
Tokeninfo(String, String, Integer) - Constructor for class com.paypal.api.openidconnect.Tokeninfo
Parameterized Constructor
toString() - Method in class com.paypal.api.payments.Error
 
toString() - Method in class com.paypal.api.payments.Image
 
toString() - Method in class com.paypal.api.payments.InvoiceNumber
 
toString() - Method in exception com.paypal.base.exception.ClientActionRequiredException
 
toString() - Method in class com.paypal.base.rest.PayPalModel
 
toString() - Method in exception com.paypal.base.rest.PayPalRESTException
 
Transaction - Class in com.paypal.api.payments
 
Transaction() - Constructor for class com.paypal.api.payments.Transaction
Default Constructor
TransactionBase - Class in com.paypal.api.payments
 
TransactionBase() - Constructor for class com.paypal.api.payments.TransactionBase
Default Constructor
transactions(String, String, Date, Date) - Static method in class com.paypal.api.payments.Agreement
transactions(APIContext, String, Date, Date) - Static method in class com.paypal.api.payments.Agreement
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.
Transactions - Class in com.paypal.api.payments
 
Transactions() - Constructor for class com.paypal.api.payments.Transactions
Default Constructor

U

update(String, List<Patch>) - Method in class com.paypal.api.payments.Agreement
Deprecated.
update(APIContext, List<Patch>) - Method in class com.paypal.api.payments.Agreement
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.
update(String, List<Patch>) - Method in class com.paypal.api.payments.CreditCard
Deprecated.
update(APIContext, List<Patch>) - Method in class com.paypal.api.payments.CreditCard
Update information in a previously saved card.
update(String) - Method in class com.paypal.api.payments.Invoice
Deprecated.
Please use Invoice.update(APIContext) instead.
update(APIContext) - Method in class com.paypal.api.payments.Invoice
Fully updates an invoice by passing the invoice ID to the request URI.
update(String, List<Patch>) - Method in class com.paypal.api.payments.Payment
Deprecated.
update(APIContext, List<Patch>) - Method in class com.paypal.api.payments.Payment
Partially update a payment resource by by passing the payment_id in the request URI.
update(String, List<Patch>) - Method in class com.paypal.api.payments.Plan
Deprecated.
Please use Plan.update(APIContext, List) instead.
update(APIContext, List<Patch>) - Method in class com.paypal.api.payments.Plan
Replace specific fields within a billing plan by passing the ID of the billing plan to the request URI.
update(APIContext) - Method in class com.paypal.api.payments.Template
Update an existing template by passing the template ID to the request URI.
update(String, String, String) - Method in class com.paypal.api.payments.Webhook
Deprecated.
update(APIContext, String, String) - Method in class com.paypal.api.payments.Webhook
Replaces webhook fields with new values.
update(String) - Method in class com.paypal.api.payments.WebProfile
Deprecated.
Please use WebProfile.update(APIContext) instead.
update(APIContext) - Method in class com.paypal.api.payments.WebProfile
Updates a web experience profile.
US_ASCII - Static variable in class com.paypal.base.codec.CharEncoding
Seven-bit ASCII, also known as ISO646-US, also known as the Basic Latin block of the Unicode character set.
USE_HTTP_PROXY - Static variable in class com.paypal.base.Constants
 
USER_AGENT_HEADER - Static variable in class com.paypal.base.Constants
 
UserAgentHeader - Class in com.paypal.base.util
 
UserAgentHeader(String, String) - Constructor for class com.paypal.base.util.UserAgentHeader
UserAgentHeader
Userinfo - Class in com.paypal.api.openidconnect
Class Userinfo
Userinfo() - Constructor for class com.paypal.api.openidconnect.Userinfo
 
UserinfoParameters - Class in com.paypal.api.openidconnect
Class UserinfoParameters
UserinfoParameters() - Constructor for class com.paypal.api.openidconnect.UserinfoParameters
 
usingGoogleAppEngine(boolean) - Method in class com.paypal.base.rest.APIContext
Enables settings for Google App Engine.
UTF_16 - Static variable in class com.paypal.base.codec.CharEncoding
Sixteen-bit Unicode Transformation Format, The byte order specified by a mandatory initial byte-order mark (either order accepted on input, big-endian used on output)
UTF_16BE - Static variable in class com.paypal.base.codec.CharEncoding
Sixteen-bit Unicode Transformation Format, big-endian byte order.
UTF_16LE - Static variable in class com.paypal.base.codec.CharEncoding
Sixteen-bit Unicode Transformation Format, little-endian byte order.
UTF_8 - Static variable in class com.paypal.base.codec.CharEncoding
Eight-bit Unicode Transformation Format.

V

validate() - Method in interface com.paypal.base.APICallPreHandler
Validates settings and integrity before call
validate() - Method in class com.paypal.base.rest.RESTAPICallPreHandler
 
validateAndGet(Map<String, String>, String) - Static method in class com.paypal.base.SDKUtil
Utility method to validate if the key exists in the provided map, and returns string value of the object
validateCertificateChain(Collection<X509Certificate>, Collection<X509Certificate>, String) - Static method in class com.paypal.base.SSLUtil
Performs Certificate Chain Validation on provided certificates.
validateData(Collection<X509Certificate>, String, String, String, String, String) - Static method in class com.paypal.base.SSLUtil
Validates Webhook Signature validation based on https://developer.paypal.com/docs/integration/direct/rest-webhooks-overview/#event-signature Returns true if signature is valid
validateReceivedEvent(APIContext, Map<String, String>, String) - Static method in class com.paypal.api.payments.Event
Validates received event received from PayPal to webhook endpoint set for particular webhook Id with PayPal trust source, to verify Data and Certificate integrity.
valueOf(String) - Static method in enum com.paypal.base.rest.HttpMethod
Returns the enum constant of this type with the specified name.
values() - Static method in enum com.paypal.base.rest.HttpMethod
Returns an array containing the constants of this enum type, in the order they are declared.

W

Webhook - Class in com.paypal.api.payments
 
Webhook() - Constructor for class com.paypal.api.payments.Webhook
Default Constructor
Webhook(String, List<EventType>) - Constructor for class com.paypal.api.payments.Webhook
Parameterized Constructor
WebhookList - Class in com.paypal.api.payments
 
WebhookList() - Constructor for class com.paypal.api.payments.WebhookList
Default Constructor
WebProfile - Class in com.paypal.api.payments
 
WebProfile() - Constructor for class com.paypal.api.payments.WebProfile
Default Constructor
WebProfile(String) - Constructor for class com.paypal.api.payments.WebProfile
Parameterized Constructor
WebProfileList - Class in com.paypal.api.payments
 
WebProfileList() - Constructor for class com.paypal.api.payments.WebProfileList
Default Constructor
A B C D E F G H I J L M N O P Q R S T U V W 
Skip navigation links