Serialized Form (REST API SDK 1.6.0 API)

Package com.paypal.api.openidconnect
- Class com.paypal.api.openidconnect.Address extends PayPalModel implements Serializable
  - Serialized Fields
    - streetAddress
```
String streetAddress
```
      Full street address component, which may include house number, street name.
    - locality
```
String locality
```
      City or locality component.
    - region
```
String region
```
      State, province, prefecture or region component.
    - postalCode
```
String postalCode
```
      Zip code or postal code component.
    - country
```
String country
```
      Country name component.
- Class com.paypal.api.openidconnect.Error extends PayPalModel implements Serializable
  - Serialized Fields
    - error
```
String error
```
      A single ASCII error code from the following enum.
    - errorDescription
```
String errorDescription
```
      A resource ID that indicates the starting resource in the returned results.
    - errorUri
```
String errorUri
```
      A URI identifying a human-readable web page with information about the error, used to provide the client developer with additional information about the error.
- Class com.paypal.api.openidconnect.Tokeninfo extends PayPalResource implements Serializable
  - Serialized Fields
    - scope
```
String scope
```
      OPTIONAL, if identical to the scope requested by the client; otherwise, REQUIRED.
    - accessToken
```
String accessToken
```
      The access token issued by the authorization server.
    - refreshToken
```
String refreshToken
```
      The refresh token, which can be used to obtain new access tokens using the same authorization grant as described in OAuth2.0 RFC6749 in Section 6.
    - tokenType
```
String tokenType
```
      The type of the token issued as described in OAuth2.0 RFC6749 (Section 7.1). Value is case insensitive.
    - expiresIn
```
Integer expiresIn
```
      The lifetime in seconds of the access token.
    - appId
```
String appId
```
      APP ID associated with this token
- Class com.paypal.api.openidconnect.Userinfo extends PayPalResource implements Serializable
  - Serialized Fields
    - userId
```
String userId
```
      Subject - Identifier for the End-User at the Issuer.
    - sub
```
String sub
```
      Subject - Identifier for the End-User at the Issuer.
    - name
```
String name
```
      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.
    - givenName
```
String givenName
```
      Given name(s) or first name(s) of the End-User
    - familyName
```
String familyName
```
      Surname(s) or last name(s) of the End-User.
    - middleName
```
String middleName
```
      Middle name(s) of the End-User.
    - picture
```
String picture
```
      URL of the End-User's profile picture.
    - email
```
String email
```
      End-User's preferred e-mail address.
    - emailVerified
```
Boolean emailVerified
```
      True if the End-User's e-mail address has been verified; otherwise false.
    - gender
```
String gender
```
      End-User's gender.
    - birthdate
```
String birthdate
```
      End-User's birthday, represented as an YYYY-MM-DD format. They year MAY be 0000, indicating it is omited. To represent only the year, YYYY format would be used.
    - zoneinfo
```
String zoneinfo
```
      Time zone database representing the End-User's time zone
    - locale
```
String locale
```
      End-User's locale.
    - phoneNumber
```
String phoneNumber
```
      End-User's preferred telephone number.
    - address
```
Address address
```
      End-User's preferred address.
    - verifiedAccount
```
Boolean verifiedAccount
```
      Verified account status.
    - accountType
```
String accountType
```
      Account type.
    - ageRange
```
String ageRange
```
      Account holder age range.
    - payerId
```
String payerId
```
      Account payer identifier.
Package com.paypal.api.payments
- Class com.paypal.api.payments.Address extends BaseAddress implements Serializable
  - Serialized Fields
    - phone
```
String phone
```
      Phone number in E.123 format.
- Class com.paypal.api.payments.Agreement extends PayPalResource implements Serializable
  - Serialized Fields
    - id
```
String id
```
      Identifier of the agreement.
    - state
```
String state
```
      State of the agreement
    - name
```
String name
```
      Name of the agreement.
    - description
```
String description
```
      Description of the agreement.
    - startDate
```
String startDate
```
      Start date of the agreement. Date format yyyy-MM-dd z, as defined in [ISO8601](http://tools.ietf.org/html/rfc3339#section-5.6).
    - agreementDetails
```
AgreementDetails agreementDetails
```
      Details of the agreement.
    - payer
```
Payer payer
```
      Details of the buyer who is enrolling in this agreement. This information is gathered from execution of the approval URL.
    - shippingAddress
```
Address shippingAddress
```
      Shipping address object of the agreement, which should be provided if it is different from the default address.
    - overrideMerchantPreferences
```
MerchantPreferences overrideMerchantPreferences
```
      Default merchant preferences from the billing plan are used, unless override preferences are provided here.
    - overrideChargeModels
```
List<E> overrideChargeModels
```
      Array of override_charge_model for this agreement if needed to change the default models from the billing plan.
    - plan
```
Plan plan
```
      Plan details for this agreement.
    - createTime
```
String createTime
```
      Date and time that this resource was created. Date format yyyy-MM-dd z, as defined in [ISO8601](http://tools.ietf.org/html/rfc3339#section-5.6).
    - updateTime
```
String updateTime
```
      Date and time that this resource was updated. Date format yyyy-MM-dd z, as defined in [ISO8601](http://tools.ietf.org/html/rfc3339#section-5.6).
    - token
```
String token
```
      Payment token
    - links
```
List<E> links
```
- Class com.paypal.api.payments.AgreementDetails extends PayPalModel implements Serializable
  - Serialized Fields
    - outstandingBalance
```
Currency outstandingBalance
```
      The outstanding balance for this agreement.
    - cyclesRemaining
```
String cyclesRemaining
```
      Number of cycles remaining for this agreement.
    - cyclesCompleted
```
String cyclesCompleted
```
      Number of cycles completed for this agreement.
    - nextBillingDate
```
String nextBillingDate
```
      The next billing date for this agreement, represented as 2014-02-19T10:00:00Z format.
    - lastPaymentDate
```
String lastPaymentDate
```
      Last payment date for this agreement, represented as 2014-06-09T09:42:31Z format.
    - lastPaymentAmount
```
Currency lastPaymentAmount
```
      Last payment amount for this agreement.
    - finalPaymentDate
```
String finalPaymentDate
```
      Last payment date for this agreement, represented as 2015-02-19T10:00:00Z format.
    - failedPaymentCount
```
String failedPaymentCount
```
      Total number of failed payments for this agreement.
- Class com.paypal.api.payments.AgreementStateDescriptor extends PayPalModel implements Serializable
  - Serialized Fields
    - note
```
String note
```
      Reason for changing the state of the agreement.
    - amount
```
Currency amount
```
      The amount and currency of the agreement.
- Class com.paypal.api.payments.AgreementTransaction extends PayPalModel implements Serializable
  - Serialized Fields
    - transactionId
```
String transactionId
```
      Id corresponding to this transaction.
    - status
```
String status
```
      State of the subscription at this time.
    - transactionType
```
String transactionType
```
      Type of transaction, usually Recurring Payment.
    - amount
```
Currency amount
```
      Amount for this transaction.
    - feeAmount
```
Currency feeAmount
```
      Fee amount for this transaction.
    - netAmount
```
Currency netAmount
```
      Net amount for this transaction.
    - payerEmail
```
String payerEmail
```
      Email id of payer.
    - payerName
```
String payerName
```
      Business name of payer.
    - timeUpdated
```
String timeUpdated
```
      Deprecated. use timeUpdated instead. Time at which this transaction happened.
    - timeZone
```
String timeZone
```
      Time zone of time_updated field.
    - timeStamp
```
String timeStamp
```
      Time at which this transaction happened.
- Class com.paypal.api.payments.AgreementTransactions extends PayPalModel implements Serializable
  - Serialized Fields
    - agreementTransactionList
```
List<E> agreementTransactionList
```
      Array of agreement_transaction object.
- Class com.paypal.api.payments.AlternatePayment extends PayPalModel implements Serializable
  - Serialized Fields
    - alternatePaymentAccountId
```
String alternatePaymentAccountId
```
      The unique identifier of the alternate payment account.
    - externalCustomerId
```
String externalCustomerId
```
      The unique identifier of the payer
    - alternatePaymentProviderId
```
String alternatePaymentProviderId
```
      Alternate Payment provider id. This is an optional attribute needed only for certain alternate providers e.g Ideal
- Class com.paypal.api.payments.Amount extends PayPalModel implements Serializable
  - Serialized Fields
    - currency
```
String currency
```
      3-letter [currency code](https://developer.paypal.com/docs/integration/direct/rest_api_payment_country_currency_support/). PayPal does not support all currencies.
    - total
```
String total
```
      Total amount charged from the payer to the payee. In case of a refund, this is the refunded amount to the original payer from the payee. 10 characters max with support for 2 decimal places.
    - details
```
Details details
```
      Additional details of the payment amount.
- Class com.paypal.api.payments.Authorization extends PayPalResource implements Serializable
  - Serialized Fields
    - id
```
String id
```
      ID of the authorization transaction.
    - amount
```
Amount amount
```
      Amount being authorized.
    - paymentMode
```
String paymentMode
```
      Specifies the payment mode of the transaction.
    - state
```
String state
```
      State of the authorization.
    - reasonCode
```
String reasonCode
```
      Reason code, `AUTHORIZATION`, for a transaction state of `pending`.
    - pendingReason
```
String pendingReason
```
      [DEPRECATED] Reason code for the transaction state being Pending.Obsolete. use reason_code field instead.
    - protectionEligibility
```
String protectionEligibility
```
      The level of seller protection in force for the transaction. Only supported when the `payment_method` is set to `paypal`. Allowed values:
      `ELIGIBLE`- Merchant is protected by PayPal's Seller Protection Policy for Unauthorized Payments and Item Not Received.
      `PARTIALLY_ELIGIBLE`- Merchant is protected by PayPal's Seller Protection Policy for Item Not Received or Unauthorized Payments. Refer to `protection_eligibility_type` for specifics.
      `INELIGIBLE`- Merchant is not protected under the Seller Protection Policy.
    - protectionEligibilityType
```
String protectionEligibilityType
```
      The kind of seller protection in force for the transaction. This property is returned only when the `protection_eligibility` property is set to `ELIGIBLE`or `PARTIALLY_ELIGIBLE`. Only supported when the `payment_method` is set to `paypal`. Allowed values:
      `ITEM_NOT_RECEIVED_ELIGIBLE`- Sellers are protected against claims for items not received.
      `UNAUTHORIZED_PAYMENT_ELIGIBLE`- Sellers are protected against claims for unauthorized payments.
      One or both of the allowed values can be returned.
    - fmfDetails
```
FmfDetails fmfDetails
```
      Fraud Management Filter (FMF) details applied for the payment that could result in accept, deny, or pending action. Returned in a payment response only if the merchant has enabled FMF in the profile settings and one of the fraud filters was triggered based on those settings. See [Fraud Management Filters Summary](https://developer.paypal.com/docs/classic/fmf/integration-guide/FMFSummary/) for more information.
    - parentPayment
```
String parentPayment
```
      ID of the Payment resource that this transaction is based on.
    - validUntil
```
String validUntil
```
      Authorization expiration time and date as defined in [RFC 3339 Section 5.6](http://tools.ietf.org/html/rfc3339#section-5.6).
    - createTime
```
String createTime
```
      Time of authorization as defined in [RFC 3339 Section 5.6](http://tools.ietf.org/html/rfc3339#section-5.6).
    - updateTime
```
String updateTime
```
      Time that the resource was last updated.
    - links
```
List<E> links
```
- Class com.paypal.api.payments.BankAccount extends PayPalModel implements Serializable
  - Serialized Fields
    - id
```
String id
```
      ID of the bank account being saved for later use.
    - accountNumber
```
String accountNumber
```
      Account number in either IBAN (max length 34) or BBAN (max length 17) format.
    - accountNumberType
```
String accountNumberType
```
      Type of the bank account number (International or Basic Bank Account Number). For more information refer to http://en.wikipedia.org/wiki/International_Bank_Account_Number.
    - routingNumber
```
String routingNumber
```
      Routing transit number (aka Bank Code) of the bank (typically for domestic use only - for international use, IBAN includes bank code). For more information refer to http://en.wikipedia.org/wiki/Bank_code.
    - accountType
```
String accountType
```
      Type of the bank account.
    - accountName
```
String accountName
```
      A customer designated name.
    - checkType
```
String checkType
```
      Type of the check when this information was obtained through a check by the facilitator or merchant.
    - authType
```
String authType
```
      How the check was obtained from the customer, if check was the source of the information provided.
    - authCaptureTimestamp
```
String authCaptureTimestamp
```
      Time at which the authorization (or check) was captured. Use this field if the user authorization needs to be captured due to any privacy requirements.
    - bankName
```
String bankName
```
      Name of the bank.
    - countryCode
```
String countryCode
```
      2 letter country code of the Bank.
    - firstName
```
String firstName
```
      Account holder's first name.
    - lastName
```
String lastName
```
      Account holder's last name.
    - birthDate
```
String birthDate
```
      Birth date of the bank account holder.
    - billingAddress
```
Address billingAddress
```
      Billing address.
    - state
```
String state
```
      State of this funding instrument.
    - confirmationStatus
```
String confirmationStatus
```
      Confirmation status of a bank account.
    - payerId
```
String payerId
```
      [DEPRECATED] Use external_customer_id instead.
    - externalCustomerId
```
String externalCustomerId
```
      A unique identifier of the customer to whom this bank account belongs to. Generated and provided by the facilitator. This is required when creating or using a stored funding instrument in vault.
    - merchantId
```
String merchantId
```
      A unique identifier of the merchant for which this bank account has been stored for. Generated and provided by the facilitator so it can be used to restrict the usage of the bank account to the specific merchnt.
    - createTime
```
String createTime
```
      Time the resource was created.
    - updateTime
```
String updateTime
```
      Time the resource was last updated.
    - validUntil
```
String validUntil
```
      Date/Time until this resource can be used to fund a payment.
    - links
```
List<E> links
```
- Class com.paypal.api.payments.BankToken extends PayPalModel implements Serializable
  - Serialized Fields
    - bankId
```
String bankId
```
      ID of a previously saved Bank resource using /vault/bank API.
    - externalCustomerId
```
String externalCustomerId
```
      The unique identifier of the payer used when saving this bank using /vault/bank API.
    - mandateReferenceNumber
```
String mandateReferenceNumber
```
      Identifier of the direct debit mandate to validate. Currently supported only for EU bank accounts(SEPA).
- Class com.paypal.api.payments.BaseAddress extends PayPalModel implements Serializable
  - Serialized Fields
    - line1
```
String line1
```
      Line 1 of the BaseAddress (e.g., Number, street, etc). 100 characters max.
    - line2
```
String line2
```
      Line 2 of the BaseAddress (e.g., Suite, apt #, etc). 100 characters max.
    - city
```
String city
```
      City name. 50 characters max.
    - countryCode
```
String countryCode
```
      [2-letter country code](https://developer.paypal.com/docs/classic/api/country_codes/). 2 characters max.
    - postalCode
```
String postalCode
```
      Zip code or equivalent is usually required for countries that have them. 20 characters max. **Required in certain countries.**
    - state
```
String state
```
      2-letter code for US states, and the equivalent for other countries. 100 characters max.
    - normalizationStatus
```
String normalizationStatus
```
      BaseAddress normalization status, returned only for payers from Brazil.
    - status
```
String status
```
      BaseAddress status
- Class com.paypal.api.payments.Billing extends PayPalModel implements Serializable
  - Serialized Fields
    - billingAgreementId
```
String billingAgreementId
```
      Identifier of the instrument in PayPal Wallet
- Class com.paypal.api.payments.BillingAgreementToken extends PayPalModel implements Serializable
- Class com.paypal.api.payments.BillingInfo extends PayPalModel implements Serializable
  - Serialized Fields
    - email
```
String email
```
      Email address of the invoice recipient. 260 characters max.
    - firstName
```
String firstName
```
      First name of the invoice recipient. 30 characters max.
    - lastName
```
String lastName
```
      Last name of the invoice recipient. 30 characters max.
    - businessName
```
String businessName
```
      Company business name of the invoice recipient. 100 characters max.
    - address
```
InvoiceAddress address
```
      Address of the invoice recipient.
    - language
```
String language
```
      Language of the email sent to the payer. Will only be used if payer doesn't have a PayPal account.
    - additionalInfo
```
String additionalInfo
```
      Option to display additional information such as business hours. 40 characters max.
- Class com.paypal.api.payments.CancelNotification extends PayPalModel implements Serializable
  - Serialized Fields
    - subject
```
String subject
```
      Subject of the notification.
    - note
```
String note
```
      Note to the payer.
    - sendToMerchant
```
Boolean sendToMerchant
```
      A flag indicating whether a copy of the email has to be sent to the merchant.
    - sendToPayer
```
Boolean sendToPayer
```
      A flag indicating whether a copy of the email has to be sent to the payer.
- Class com.paypal.api.payments.Capture extends PayPalResource implements Serializable
  - Serialized Fields
    - id
```
String id
```
      ID of the capture transaction.
    - amount
```
Amount amount
```
      Amount being captured. If the amount matches the orginally authorized amount, the state of the authorization changes to `captured`. If not, the state of the authorization changes to `partially_captured`.
    - isFinalCapture
```
Boolean isFinalCapture
```
      If set to `true`, all remaining funds held by the authorization will be released in the funding instrument.
    - state
```
String state
```
      State of the capture.
    - parentPayment
```
String parentPayment
```
      ID of the payment resource on which this transaction is based.
    - transactionFee
```
Currency transactionFee
```
      Transaction fee applicable for this payment.
    - createTime
```
String createTime
```
      Time of capture as defined in [RFC 3339 Section 5.6](http://tools.ietf.org/html/rfc3339#section-5.6).
    - updateTime
```
String updateTime
```
      Time that the resource was last updated.
    - links
```
List<E> links
```
- Class com.paypal.api.payments.Card3dSecureInfo extends PayPalModel implements Serializable
  - Serialized Fields
    - authStatus
```
String authStatus
```
      Authorization status from 3ds provider. Should be echoed back in the response
    - eci
```
String eci
```
      Numeric flag to indicate how the payment should be processed in relationship to 3d-secure. If 0 then ignore all 3d values and process as non-3ds
    - cavv
```
String cavv
```
      Cardholder Authentication Verification Value (used by VISA).
    - xid
```
String xid
```
      Transaction identifier from authenticator.
    - mpiVendor
```
String mpiVendor
```
      Name of the actual 3ds vendor who processed the 3ds request, e.g. Cardinal
- Class com.paypal.api.payments.CarrierAccount extends PayPalModel implements Serializable
  - Serialized Fields
    - id
```
String id
```
      ID that identifies the payer�s carrier account. Can be used in subsequent REST API calls, e.g. for making payments.
    - phoneNumber
```
String phoneNumber
```
      The payer�s phone number in E.164 format.
    - externalCustomerId
```
String externalCustomerId
```
      User identifier as created by the merchant.
    - phoneSource
```
String phoneSource
```
      The method of obtaining the phone number (USER_PROVIDED or READ_FROM_DEVICE).
    - countryCode
```
CountryCode countryCode
```
      The country where the phone number is registered. Specified in 2-character IS0-3166-1 format.
- Class com.paypal.api.payments.CarrierAccountToken extends PayPalModel implements Serializable
  - Serialized Fields
    - carrierAccountId
```
String carrierAccountId
```
      ID of a previously saved carrier account resource.
    - externalCustomerId
```
String externalCustomerId
```
      The unique identifier of the payer used when saving this carrier account instrument.
- Class com.paypal.api.payments.CartBase extends PayPalModel implements Serializable
  - Serialized Fields
    - referenceId
```
String referenceId
```
      Merchant identifier to the purchase unit. Optional parameter
    - amount
```
Amount amount
```
      Amount being collected.
    - payee
```
Payee payee
```
      Recipient of the funds in this transaction.
    - description
```
String description
```
      Description of transaction.
    - noteToPayee
```
String noteToPayee
```
      Note to the recipient of the funds in this transaction.
    - custom
```
String custom
```
      Free-form field for the use of clients. Only supported when the `payment_method` is set to `paypal`.
    - invoiceNumber
```
String invoiceNumber
```
      Invoice number used to track the payment. Only supported when the `payment_method` is set to `paypal`.
    - softDescriptor
```
String softDescriptor
```
      Soft descriptor used when charging this funding source. If length exceeds max length, the value will be truncated
    - softDescriptorCity
```
String softDescriptorCity
```
      Soft descriptor city used when charging this funding source. If length exceeds max length, the value will be truncated. Only supported when the `payment_method` is set to `credit_card`
    - paymentOptions
```
PaymentOptions paymentOptions
```
      Payment options requested for this purchase unit
    - itemList
```
ItemList itemList
```
      Items and related shipping address within a transaction.
    - notifyUrl
```
String notifyUrl
```
      URL to send payment notifications
    - orderUrl
```
String orderUrl
```
      Url on merchant site pertaining to this payment.
    - externalFunding
```
List<E> externalFunding
```
      List of external funding being applied to the purchase unit. Each external_funding unit should have a unique reference_id
- Class com.paypal.api.payments.ChargeModels extends PayPalModel implements Serializable
  - Serialized Fields
    - id
```
String id
```
      Identifier of the charge model. 128 characters max.
    - type
```
String type
```
      Type of charge model. Allowed values: `SHIPPING`, `TAX`.
    - amount
```
Currency amount
```
      Specific amount for this charge model.
- Class com.paypal.api.payments.Cost extends PayPalModel implements Serializable
  - Serialized Fields
    - percent
```
float percent
```
      Cost in percent. Range of 0 to 100.
    - amount
```
Currency amount
```
      Cost in amount. Range of 0 to 999999.99.
- Class com.paypal.api.payments.CreateProfileResponse extends PayPalModel implements Serializable
  - Serialized Fields
    - id
```
String id
```
      ID of the payment web experience profile.
- Class com.paypal.api.payments.Credit extends PayPalModel implements Serializable
  - Serialized Fields
    - id
```
String id
```
      Unique identifier of credit resource.
    - type
```
String type
```
      specifies type of credit
    - terms
```
String terms
```
      URI to the associated terms
- Class com.paypal.api.payments.CreditCard extends PayPalResource implements Serializable
  - Serialized Fields
    - id
```
String id
```
      ID of the credit card being saved for later use.
    - number
```
String number
```
      Card number.
    - type
```
String type
```
      Type of the Card (eg. Visa, Mastercard, etc.).
    - expireMonth
```
int expireMonth
```
      2 digit card expiry month.
    - expireYear
```
int expireYear
```
      4 digit card expiry year
    - cvv2
```
Integer cvv2
```
      Card validation code. Only supported when making a Payment but not when saving a credit card for future use.
    - firstName
```
String firstName
```
      Card holder's first name.
    - lastName
```
String lastName
```
      Card holder's last name.
    - billingAddress
```
Address billingAddress
```
      Billing Address associated with this card.
    - externalCustomerId
```
String externalCustomerId
```
      A unique identifier of the customer to whom this bank account belongs to. Generated and provided by the facilitator. This is required when creating or using a stored funding instrument in vault.
    - state
```
String state
```
      State of the funding instrument.
    - validUntil
```
String validUntil
```
      Date/Time until this resource can be used to fund a payment.
    - links
```
List<E> links
```
    - payerId
```
String payerId
```
      Payer ID
- Class com.paypal.api.payments.CreditCardHistory extends PayPalModel implements Serializable
  - Serialized Fields
    - items
```
List<E> items
```
      A list of credit card resources
    - totalItems
```
int totalItems
```
      Total number of items.
    - totalPages
```
int totalPages
```
      Total number of pages.
    - links
```
List<E> links
```
      HATEOAS links related to this call. Value assigned by PayPal.
- Class com.paypal.api.payments.CreditCardToken extends PayPalModel implements Serializable
  - Serialized Fields
    - creditCardId
```
String creditCardId
```
      ID of a previously saved Credit Card resource using /vault/credit-card API.
    - payerId
```
String payerId
```
      The unique identifier of the payer used when saving this credit card using /vault/credit-card API.
    - last4
```
String last4
```
      Last 4 digits of the card number from the saved card.
    - type
```
String type
```
      Type of the Card (eg. visa, mastercard, etc.) from the saved card. Please note that the values are always in lowercase and not meant to be used directly for display.
    - expireMonth
```
int expireMonth
```
      card expiry month from the saved card with value 1 - 12
    - expireYear
```
int expireYear
```
      4 digit card expiry year from the saved card
- Class com.paypal.api.payments.Currency extends PayPalModel implements Serializable
  - Serialized Fields
    - currency
```
String currency
```
      3 letter currency code
    - value
```
String value
```
      amount upto 2 decimals represented as string
- Class com.paypal.api.payments.CustomAmount extends PayPalModel implements Serializable
  - Serialized Fields
    - label
```
String label
```
      Custom amount label. 25 characters max.
    - amount
```
Currency amount
```
      Custom amount value. Range of 0 to 999999.99.
- Class com.paypal.api.payments.Details extends PayPalModel implements Serializable
  - Serialized Fields
    - shipping
```
String shipping
```
      Amount being charged for shipping.
    - subtotal
```
String subtotal
```
      Sub-total (amount) of items being paid for.
    - tax
```
String tax
```
      Amount being charged as tax.
    - fee
```
String fee
```
      Fee charged by PayPal. In case of a refund, this is the fee amount refunded to the original receipient of the payment.
    - handlingFee
```
String handlingFee
```
      Amount being charged as handling fee.
    - giftWrap
```
String giftWrap
```
      Amount being charged as gift wrap fee.
    - insurance
```
String insurance
```
      Amount being charged for the insurance fee.
    - shippingDiscount
```
String shippingDiscount
```
      Amount being discounted for the shipping fee.
- Class com.paypal.api.payments.Error extends PayPalModel implements Serializable
  - Serialized Fields
    - name
```
String name
```
      Human readable, unique name of the error.
    - purchaseUnitReferenceId
```
String purchaseUnitReferenceId
```
      Reference ID of the purchase_unit associated with this error
    - message
```
String message
```
      Message describing the error.
    - code
```
String code
```
      PayPal internal error code.
    - details
```
List<E> details
```
      Additional details of the error
    - processorResponse
```
ProcessorResponse processorResponse
```
      response codes returned from a payment processor such as avs, cvv, etc. Only supported when the `payment_method` is set to `credit_card`.
    - fmfDetails
```
FmfDetails fmfDetails
```
      Fraud filter details. Only supported when the `payment_method` is set to `credit_card`
    - informationLink
```
String informationLink
```
      URI for detailed information related to this error for the developer.
    - debugId
```
String debugId
```
      PayPal internal identifier used for correlation purposes.
    - links
```
List<E> links
```
- Class com.paypal.api.payments.ErrorDetails extends PayPalModel implements Serializable
  - Serialized Fields
    - field
```
String field
```
      Name of the field that caused the error.
    - issue
```
String issue
```
      Reason for the error.
    - purchaseUnitReferenceId
```
String purchaseUnitReferenceId
```
      Reference ID of the purchase_unit associated with this error
    - code
```
String code
```
      PayPal internal error code.
- Class com.paypal.api.payments.Event extends PayPalResource implements Serializable
  - Serialized Fields
    - id
```
String id
```
      Identifier of the Webhooks event resource.
    - createTime
```
String createTime
```
      Time the resource was created.
    - resourceType
```
String resourceType
```
      Name of the resource contained in resource element.
    - eventType
```
String eventType
```
      Name of the event type that occurred on resource, identified by data_resource element, to trigger the Webhooks event.
    - summary
```
String summary
```
      A summary description of the event. E.g. A successful payment authorization was created for $$
    - resource
```
Object resource
```
      This contains the resource that is identified by resource_type element.
    - links
```
List<E> links
```
      Hateoas links.
- Class com.paypal.api.payments.EventList extends PayPalModel implements Serializable
  - Serialized Fields
    - events
```
List<E> events
```
      A list of Webhooks event resources
    - count
```
int count
```
      Number of items returned in each range of results. Note that the last results range could have fewer items than the requested number of items.
    - links
```
List<E> links
```
- Class com.paypal.api.payments.EventType extends PayPalResource implements Serializable
  - Serialized Fields
    - name
```
String name
```
      Unique event-type name.
    - description
```
String description
```
      Human readable description of the event-type
- Class com.paypal.api.payments.EventTypeList extends PayPalModel implements Serializable
  - Serialized Fields
    - eventTypes
```
List<E> eventTypes
```
      A list of Webhooks event-types
- Class com.paypal.api.payments.ExtendedBankAccount extends BankAccount implements Serializable
  - Serialized Fields
    - mandateReferenceNumber
```
String mandateReferenceNumber
```
      Identifier of the direct debit mandate to validate. Currently supported only for EU bank accounts(SEPA).
- Class com.paypal.api.payments.FlowConfig extends PayPalModel implements Serializable
  - Serialized Fields
    - landingPageType
```
String landingPageType
```
      Type of PayPal page to be displayed when a user lands on the PayPal site for checkout. Allowed values: `Billing` or `Login`. When set to `Billing`, the Non-PayPal account landing page is used. When set to `Login`, the PayPal account login landing page is used.
    - bankTxnPendingUrl
```
String bankTxnPendingUrl
```
      The URL on the merchant site for transferring to after a bank transfer payment. Use this field only if you are using giropay or bank transfer payment methods in Germany.
- Class com.paypal.api.payments.FundingInstrument extends PayPalModel implements Serializable
  - Serialized Fields
    - creditCard
```
CreditCard creditCard
```
      Credit Card instrument.
    - creditCardToken
```
CreditCardToken creditCardToken
```
      PayPal vaulted credit Card instrument.
    - paymentCard
```
PaymentCard paymentCard
```
      Payment Card information.
    - bankAccount
```
ExtendedBankAccount bankAccount
```
      Bank Account information.
    - bankAccountToken
```
BankToken bankAccountToken
```
      Vaulted bank account instrument.
    - credit
```
Credit credit
```
      PayPal credit funding instrument.
    - incentive
```
Incentive incentive
```
      Incentive funding instrument.
    - externalFunding
```
ExternalFunding externalFunding
```
      External funding instrument.
    - carrierAccountToken
```
CarrierAccountToken carrierAccountToken
```
      Carrier account token instrument.
    - carrierAccount
```
CarrierAccount carrierAccount
```
      Carrier account instrument
    - privateLabelCard
```
PrivateLabelCard privateLabelCard
```
      Private Label Card funding instrument. These are store cards provided by merchants to drive business with value to customer with convenience and rewards.
    - billing
```
Billing billing
```
      Billing instrument that references pre-approval information for the payment
    - alternatePayment
```
AlternatePayment alternatePayment
```
      Alternate Payment information - Mostly regional payment providers. For e.g iDEAL in Netherlands
- Class com.paypal.api.payments.FuturePayment extends Payment implements Serializable
- Class com.paypal.api.payments.HyperSchema extends PayPalModel implements Serializable
  - Serialized Fields
    - links
```
List<E> links
```
    - fragmentResolution
```
String fragmentResolution
```
    - readonly
```
Boolean readonly
```
    - contentEncoding
```
String contentEncoding
```
    - pathStart
```
String pathStart
```
    - mediaType
```
String mediaType
```
- Class com.paypal.api.payments.InputFields extends PayPalModel implements Serializable
  - Serialized Fields
    - allowNote
```
Boolean allowNote
```
      Enables the buyer to enter a note to the merchant on the PayPal page during checkout.
    - noShipping
```
int noShipping
```
      Determines whether or not PayPal displays shipping address fields on the experience pages. Allowed values: `0`, `1`, or `2`. When set to `0`, PayPal displays the shipping address on the PayPal pages. When set to `1`, PayPal does not display shipping address fields whatsoever. When set to `2`, if you do not pass the shipping address, PayPal obtains it from the buyer's account profile. For digital goods, this field is required, and you must set it to `1`.
    - addressOverride
```
int addressOverride
```
      Determines if the PayPal pages should display the shipping address supplied in this call, rather than the shipping address on file with PayPal for this buyer. Displaying the address on file does not allow the buyer to edit the address. Allowed values: `0` or `1`. When set to `0`, the PayPal pages should display the address on file. When set to `1`, the PayPal pages should display the addresses supplied in this call instead of the address from the buyer's PayPal account.
- Class com.paypal.api.payments.Invoice extends PayPalResource implements Serializable
  - Serialized Fields
    - id
```
String id
```
      Unique invoice resource identifier.
    - number
```
String number
```
      Unique number that appears on the invoice. If left blank will be auto-incremented from the last number. 25 characters max.
    - uri
```
String uri
```
      URI of the invoice resource.
    - status
```
String status
```
      Status of the invoice.
    - merchantInfo
```
MerchantInfo merchantInfo
```
      Information about the merchant who is sending the invoice.
    - billingInfo
```
List<E> billingInfo
```
      Email address of invoice recipient (required) and optional billing information. (Note: We currently only allow one recipient).
    - shippingInfo
```
ShippingInfo shippingInfo
```
      Shipping information for entities to whom items are being shipped.
    - items
```
List<E> items
```
      List of items included in the invoice. 100 items max per invoice.
    - invoiceDate
```
String invoiceDate
```
      Date on which the invoice was enabled. Date format: yyyy-MM-dd z. For example, 2014-02-27 PST
    - paymentTerm
```
PaymentTerm paymentTerm
```
      Optional field to pass payment deadline for the invoice. Either term_type or due_date can be passed, but not both.
    - discount
```
Cost discount
```
      Invoice level discount in percent or amount.
    - shippingCost
```
ShippingCost shippingCost
```
      Shipping cost in percent or amount.
    - custom
```
CustomAmount custom
```
      Custom amount applied on an invoice. If a label is included then the amount cannot be empty.
    - taxCalculatedAfterDiscount
```
Boolean taxCalculatedAfterDiscount
```
      Indicates whether tax is calculated before or after a discount. If false (the default), the tax is calculated before a discount. If true, the tax is calculated after a discount.
    - taxInclusive
```
Boolean taxInclusive
```
      A flag indicating whether the unit price includes tax. Default is false
    - terms
```
String terms
```
      General terms of the invoice. 4000 characters max.
    - note
```
String note
```
      Note to the payer. 4000 characters max.
    - merchantMemo
```
String merchantMemo
```
      Bookkeeping memo that is private to the merchant. 150 characters max.
    - logoUrl
```
String logoUrl
```
      Full URL of an external image to use as the logo. 4000 characters max.
    - totalAmount
```
Currency totalAmount
```
      The total amount of the invoice.
    - paymentDetails
```
List<E> paymentDetails
```
      List of payment details for the invoice.
    - refundDetails
```
List<E> refundDetails
```
      List of refund details for the invoice.
    - metadata
```
Metadata metadata
```
      Audit information for the invoice.
- Class com.paypal.api.payments.InvoiceAddress extends BaseAddress implements Serializable
  - Serialized Fields
    - phone
```
Phone phone
```
- Class com.paypal.api.payments.InvoiceItem extends PayPalModel implements Serializable
  - Serialized Fields
    - name
```
String name
```
      Name of the item. 60 characters max.
    - description
```
String description
```
      Description of the item. 1000 characters max.
    - quantity
```
float quantity
```
      Quantity of the item. Range of 0 to 9999.999.
    - unitPrice
```
Currency unitPrice
```
      Unit price of the item. Range of -999999.99 to 999999.99.
    - tax
```
Tax tax
```
      Tax associated with the item.
    - date
```
String date
```
      Date on which the item or service was provided. Date format: yyyy-MM-dd z. For example, 2014-02-27 PST.
    - discount
```
Cost discount
```
      Item discount in percent or amount.
- Class com.paypal.api.payments.Invoices extends PayPalModel implements Serializable
  - Serialized Fields
    - totalCount
```
int totalCount
```
    - invoices
```
List<E> invoices
```
      List of invoices belonging to a merchant.
- Class com.paypal.api.payments.InvoicingMetaData extends PayPalModel implements Serializable
  - Serialized Fields
    - createdDate
```
String createdDate
```
      Date when the resource was created.
    - createdBy
```
String createdBy
```
      Email address of the account that created the resource.
    - cancelledDate
```
String cancelledDate
```
      Date when the resource was cancelled.
    - cancelledBy
```
String cancelledBy
```
      Actor who cancelled the resource.
    - lastUpdatedDate
```
String lastUpdatedDate
```
      Date when the resource was last edited.
    - lastUpdatedBy
```
String lastUpdatedBy
```
      Email address of the account that last edited the resource.
    - firstSentDate
```
String firstSentDate
```
      Date when the resource was first sent.
    - lastSentDate
```
String lastSentDate
```
      Date when the resource was last sent.
    - lastSentBy
```
String lastSentBy
```
      Email address of the account that last sent the resource.
- Class com.paypal.api.payments.InvoicingNotification extends PayPalModel implements Serializable
  - Serialized Fields
    - subject
```
String subject
```
      Subject of the notification.
    - note
```
String note
```
      Note to the payer.
    - sendToMerchant
```
Boolean sendToMerchant
```
      A flag indicating whether a copy of the email has to be sent to the merchant.
- Class com.paypal.api.payments.InvoicingPaymentDetail extends PayPalModel implements Serializable
  - Serialized Fields
    - type
```
String type
```
      PayPal payment detail indicating whether payment was made in an invoicing flow via PayPal or externally. In the case of the mark-as-paid API, payment type is EXTERNAL and this is what is now supported. The PAYPAL value is provided for backward compatibility.
    - transactionId
```
String transactionId
```
      PayPal payment transaction id. Mandatory field in case the type value is PAYPAL.
    - transactionType
```
String transactionType
```
      Type of the transaction.
    - date
```
String date
```
      Date when the invoice was paid. Date format: yyyy-MM-dd z. For example, 2014-02-27 PST.
    - method
```
String method
```
      Payment mode or method. This field is mandatory if the value of the type field is OTHER.
    - note
```
String note
```
      Optional note associated with the payment.
- Class com.paypal.api.payments.InvoicingRefundDetail extends PayPalModel implements Serializable
  - Serialized Fields
    - type
```
String type
```
      PayPal refund type indicating whether refund was done in invoicing flow via PayPal or externally. In the case of the mark-as-refunded API, refund type is EXTERNAL and this is what is now supported. The PAYPAL value is provided for backward compatibility.
    - date
```
String date
```
      Date when the invoice was marked as refunded. If no date is specified, the current date and time is used as the default. In addition, the date must be after the invoice payment date.
    - note
```
String note
```
      Optional note associated with the refund.
- Class com.paypal.api.payments.InvoicingSearch extends PayPalModel implements Serializable
  - Serialized Fields
    - email
```
String email
```
      Initial letters of the email address.
    - recipientFirstName
```
String recipientFirstName
```
      Initial letters of the recipient's first name.
    - recipientLastName
```
String recipientLastName
```
      Initial letters of the recipient's last name.
    - recipientBusinessName
```
String recipientBusinessName
```
      Initial letters of the recipient's business name.
    - number
```
String number
```
      The invoice number that appears on the invoice.
    - status
```
String status
```
      Status of the invoice.
    - lowerTotalAmount
```
Currency lowerTotalAmount
```
      Lower limit of total amount.
    - upperTotalAmount
```
Currency upperTotalAmount
```
      Upper limit of total amount.
    - startInvoiceDate
```
String startInvoiceDate
```
      Start invoice date.
    - endInvoiceDate
```
String endInvoiceDate
```
      End invoice date.
    - startDueDate
```
String startDueDate
```
      Start invoice due date.
    - endDueDate
```
String endDueDate
```
      End invoice due date.
    - startPaymentDate
```
String startPaymentDate
```
      Start invoice payment date.
    - endPaymentDate
```
String endPaymentDate
```
      End invoice payment date.
    - startCreationDate
```
String startCreationDate
```
      Start invoice creation date.
    - endCreationDate
```
String endCreationDate
```
      End invoice creation date.
    - page
```
float page
```
      Offset of the search results.
    - pageSize
```
float pageSize
```
      Page size of the search results.
    - totalCountRequired
```
Boolean totalCountRequired
```
      A flag indicating whether total count is required in the response.
- Class com.paypal.api.payments.Item extends PayPalModel implements Serializable
  - Serialized Fields
    - sku
```
String sku
```
      Stock keeping unit corresponding (SKU) to item.
    - name
```
String name
```
      Item name. 127 characters max.
    - description
```
String description
```
      Description of the item. Only supported when the `payment_method` is set to `paypal`.
    - quantity
```
String quantity
```
      Number of a particular item. 10 characters max.
    - price
```
String price
```
      Item cost. 10 characters max.
    - currency
```
String currency
```
      3-letter [currency code](https://developer.paypal.com/docs/integration/direct/rest_api_payment_country_currency_support/).
    - tax
```
String tax
```
      Tax of the item. Only supported when the `payment_method` is set to `paypal`.
    - url
```
String url
```
      URL linking to item information. Available to payer in transaction history.
    - category
```
String category
```
      Category type of the item.
    - weight
```
Measurement weight
```
      Weight of the item.
    - length
```
Measurement length
```
      Length of the item.
    - height
```
Measurement height
```
      Height of the item.
    - width
```
Measurement width
```
      Width of the item.
    - supplementaryData
```
List<E> supplementaryData
```
      Set of optional data used for PayPal risk determination.
    - postbackData
```
List<E> postbackData
```
      Set of optional data used for PayPal post-transaction notifications.
- Class com.paypal.api.payments.ItemList extends PayPalModel implements Serializable
  - Serialized Fields
    - items
```
List<E> items
```
      List of items.
    - shippingAddress
```
ShippingAddress shippingAddress
```
      Shipping address.
    - shippingMethod
```
String shippingMethod
```
      Shipping method used for this payment like USPSParcel etc.
    - shippingPhoneNumber
```
String shippingPhoneNumber
```
      Allows merchant's to share payer’s contact number with PayPal for the current payment. Final contact number of payer associated with the transaction might be same as shipping_phone_number or different based on Payer’s action on PayPal. The phone number must be represented in its canonical international format, as defined by the E.164 numbering plan
- Class com.paypal.api.payments.Links extends PayPalModel implements Serializable
  - Serialized Fields
    - href
```
String href
```
    - rel
```
String rel
```
    - targetSchema
```
HyperSchema targetSchema
```
    - method
```
String method
```
    - enctype
```
String enctype
```
    - schema
```
HyperSchema schema
```
- Class com.paypal.api.payments.MerchantInfo extends PayPalModel implements Serializable
  - Serialized Fields
    - email
```
String email
```
      Email address of the merchant. 260 characters max.
    - firstName
```
String firstName
```
      First name of the merchant. 30 characters max.
    - lastName
```
String lastName
```
      Last name of the merchant. 30 characters max.
    - address
```
InvoiceAddress address
```
      Address of the merchant.
    - businessName
```
String businessName
```
      Company business name of the merchant. 100 characters max.
    - phone
```
Phone phone
```
      Phone number of the merchant.
    - fax
```
Phone fax
```
      Fax number of the merchant.
    - website
```
String website
```
      Website of the merchant. 2048 characters max.
    - taxId
```
String taxId
```
      Tax ID of the merchant. 100 characters max.
    - additionalInfo
```
String additionalInfo
```
      Option to display additional information such as business hours. 40 characters max.
- Class com.paypal.api.payments.MerchantPreferences extends PayPalModel implements Serializable
  - Serialized Fields
    - id
```
String id
```
      Identifier of the merchant_preferences. 128 characters max.
    - setupFee
```
Currency setupFee
```
      Setup fee amount. Default is 0.
    - cancelUrl
```
String cancelUrl
```
      Redirect URL on cancellation of agreement request. 1000 characters max.
    - returnUrl
```
String returnUrl
```
      Redirect URL on creation of agreement request. 1000 characters max.
    - notifyUrl
```
String notifyUrl
```
      Notify URL on agreement creation. 1000 characters max.
    - maxFailAttempts
```
String maxFailAttempts
```
      Total number of failed attempts allowed. Default is 0, representing an infinite number of failed attempts.
    - autoBillAmount
```
String autoBillAmount
```
      Allow auto billing for the outstanding amount of the agreement in the next cycle. Allowed values: `YES`, `NO`. Default is `NO`.
    - initialFailAmountAction
```
String initialFailAmountAction
```
      Action to take if a failure occurs during initial payment. Allowed values: `CONTINUE`, `CANCEL`. Default is continue.
    - acceptedPaymentType
```
String acceptedPaymentType
```
      Payment types that are accepted for this plan.
    - charSet
```
String charSet
```
      char_set for this plan.
- Class com.paypal.api.payments.Metadata extends PayPalModel implements Serializable
  - Serialized Fields
    - createdDate
```
String createdDate
```
      Date when the resource was created.
    - createdBy
```
String createdBy
```
      Email address of the account that created the resource.
    - cancelledDate
```
String cancelledDate
```
      Date when the resource was cancelled.
    - cancelledBy
```
String cancelledBy
```
      Actor who cancelled the resource.
    - lastUpdatedDate
```
String lastUpdatedDate
```
      Date when the resource was last edited.
    - lastUpdatedBy
```
String lastUpdatedBy
```
      Email address of the account that last edited the resource.
    - firstSentDate
```
String firstSentDate
```
      Date when the resource was first sent.
    - lastSentDate
```
String lastSentDate
```
      Date when the resource was last sent.
    - lastSentBy
```
String lastSentBy
```
      Email address of the account that last sent the resource.
- Class com.paypal.api.payments.NameValuePair extends PayPalModel implements Serializable
  - Serialized Fields
    - name
```
String name
```
      Key for the name value pair. The value name types should be correlated
    - value
```
String value
```
      Value for the name value pair.
- Class com.paypal.api.payments.Notification extends PayPalModel implements Serializable
  - Serialized Fields
    - subject
```
String subject
```
      Subject of the notification.
    - note
```
String note
```
      Note to the payer.
    - sendToMerchant
```
Boolean sendToMerchant
```
      A flag indicating whether a copy of the email has to be sent to the merchant.
- Class com.paypal.api.payments.Order extends PayPalResource implements Serializable
  - Serialized Fields
    - id
```
String id
```
      Identifier of the order transaction.
    - purchaseUnitReferenceId
```
String purchaseUnitReferenceId
```
      Identifier to the purchase unit associated with this object. Obsolete. Use one in cart_base.
    - amount
```
Amount amount
```
      Amount being collected.
    - paymentMode
```
String paymentMode
```
      specifies payment mode of the transaction
    - state
```
String state
```
      State of the order transaction.
    - reasonCode
```
String reasonCode
```
      Reason code for the transaction state being Pending or Reversed. Only supported when the `payment_method` is set to `paypal`.
    - pendingReason
```
String pendingReason
```
      [DEPRECATED] Reason the transaction is in pending state. Use reason_code field above instead.
    - protectionEligibility
```
String protectionEligibility
```
      The level of seller protection in force for the transaction.
    - protectionEligibilityType
```
String protectionEligibilityType
```
      The kind of seller protection in force for the transaction. This property is returned only when the `protection_eligibility` property is set to `ELIGIBLE`or `PARTIALLY_ELIGIBLE`. Only supported when the `payment_method` is set to `paypal`. Allowed values:
      `ITEM_NOT_RECEIVED_ELIGIBLE`- Sellers are protected against claims for items not received.
      `UNAUTHORIZED_PAYMENT_ELIGIBLE`- Sellers are protected against claims for unauthorized payments.
      One or both of the allowed values can be returned.
    - parentPayment
```
String parentPayment
```
      ID of the Payment resource that this transaction is based on.
    - fmfDetails
```
FmfDetails fmfDetails
```
      Fraud Management Filter (FMF) details applied for the payment that could result in accept/deny/pending action.
    - createTime
```
String createTime
```
      Time the resource was created in UTC ISO8601 format.
    - updateTime
```
String updateTime
```
      Time the resource was last updated in UTC ISO8601 format.
    - links
```
List<E> links
```
- Class com.paypal.api.payments.OverrideChargeModel extends PayPalModel implements Serializable
  - Serialized Fields
    - chargeId
```
String chargeId
```
      ID of charge model.
    - amount
```
Currency amount
```
      Updated Amount to be associated with this charge model.
- Class com.paypal.api.payments.Patch extends PayPalModel implements Serializable
  - Serialized Fields
    - op
```
String op
```
      Patch operation to perform.Value required for add & remove operation can be any JSON value.
    - path
```
String path
```
      string containing a JSON-Pointer value that references a location within the target document (the target location) where the operation is performed.
    - value
```
Object value
```
    - from
```
String from
```
- Class com.paypal.api.payments.PatchRequest extends PayPalModel implements Serializable
  - Serialized Fields
    - op
```
String op
```
      Patch operation to perform.Value required for add & remove operation can be any JSON value.
    - path
```
String path
```
      string containing a JSON-Pointer value that references a location within the target document (the target location) where the operation is performed.
- Class com.paypal.api.payments.Payee extends PayPalModel implements Serializable
  - Serialized Fields
    - email
```
String email
```
      Email Address associated with the Payee's PayPal Account. If the provided email address is not associated with any PayPal Account, the payee can only receiver PayPal Wallet Payments. Direct Credit Card Payments will be denied due to card compliance requirements.
    - merchantId
```
String merchantId
```
      Encrypted PayPal account identifier for the Payee.
    - firstName
```
String firstName
```
      First Name of the Payee.
    - lastName
```
String lastName
```
      Last Name of the Payee.
    - accountNumber
```
String accountNumber
```
      Unencrypted PayPal account Number of the Payee
    - phone
```
Phone phone
```
      Information related to the Payer. In case of PayPal Wallet payment, this information will be filled in by PayPal after the user approves the payment using their PayPal Wallet.
- Class com.paypal.api.payments.Payer extends PayPalModel implements Serializable
  - Serialized Fields
    - paymentMethod
```
String paymentMethod
```
      Payment method being used - PayPal Wallet payment, Bank Direct Debit or Direct Credit card.
    - status
```
String status
```
      Status of payer's PayPal Account.
    - accountType
```
String accountType
```
      Type of account relationship payer has with PayPal.
    - accountAge
```
String accountAge
```
      Duration since the payer established account relationship with PayPal in days.
    - fundingInstruments
```
List<E> fundingInstruments
```
      List of funding instruments to fund the payment. 'OneOf' funding_instruments,funding_option_id to be used to identify the specifics of payment method passed.
    - fundingOptionId
```
String fundingOptionId
```
      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.
    - fundingOption
```
FundingOption fundingOption
```
      Default funding option available for the payment
    - relatedFundingOption
```
FundingOption relatedFundingOption
```
      Funding option related to default funding option.
    - payerInfo
```
PayerInfo payerInfo
```
      Information related to the Payer.
- Class com.paypal.api.payments.PayerInfo extends PayPalModel implements Serializable
  - Serialized Fields
    - email
```
String email
```
      Email address representing the payer. 127 characters max.
    - externalRememberMeId
```
String externalRememberMeId
```
      External Remember Me id representing the payer
    - accountNumber
```
String accountNumber
```
      Account Number representing the Payer
    - salutation
```
String salutation
```
      Salutation of the payer.
    - firstName
```
String firstName
```
      First name of the payer.
    - middleName
```
String middleName
```
      Middle name of the payer.
    - lastName
```
String lastName
```
      Last name of the payer.
    - suffix
```
String suffix
```
      Suffix of the payer.
    - payerId
```
String payerId
```
      PayPal assigned encrypted Payer ID.
    - phone
```
String phone
```
      Phone number representing the payer. 20 characters max.
    - phoneType
```
String phoneType
```
      Phone type
    - birthDate
```
String birthDate
```
      Birth date of the Payer in ISO8601 format (yyyy-mm-dd).
    - taxId
```
String taxId
```
      Payer’s tax ID. Only supported when the `payment_method` is set to `paypal`.
    - taxIdType
```
String taxIdType
```
      Payer’s tax ID type. Allowed values: `BR_CPF` or `BR_CNPJ`. Only supported when the `payment_method` is set to `paypal`.
    - countryCode
```
String countryCode
```
      Two-letter registered country code of the payer to identify the buyer country.
    - billingAddress
```
Address billingAddress
```
      Billing address of the Payer.
    - shippingAddress
```
ShippingAddress shippingAddress
```
      Shipping address of payer PayPal account.
- Class com.paypal.api.payments.Payment extends PayPalResource implements Serializable
  - Serialized Fields
    - id
```
String id
```
      ID of the created payment, the 'transaction ID'
    - intent
```
String intent
```
      Payment intent.
    - payer
```
Payer payer
```
      Source of the funds for this payment represented by a PayPal account or a direct credit card.
    - potentialPayerInfo
```
PotentialPayerInfo potentialPayerInfo
```
      Information that the merchant knows about the payer. This information is not definitive and only serves as a hint to the UI or any pre-processing logic.
    - payee
```
Payee payee
```
      Receiver of funds for this payment. **Readonly for PayPal external REST payments.**
    - cart
```
String cart
```
      ID of the cart to execute the payment.
    - transactions
```
List<E> transactions
```
      Transactional details including the amount and item details.
    - failedTransactions
```
List<E> failedTransactions
```
      Applicable for advanced payments like multi seller payment (MSP) to support partial failures
    - billingAgreementTokens
```
List<E> billingAgreementTokens
```
      Collection of PayPal generated billing agreement tokens.
    - creditFinancingOffered
```
CreditFinancingOffered creditFinancingOffered
```
      Credit financing offered to payer on PayPal side. Returned in payment after payer opts-in
    - paymentInstruction
```
PaymentInstruction paymentInstruction
```
      Instructions for the payer to complete this payment.
    - state
```
String state
```
      Payment state.
    - experienceProfileId
```
String experienceProfileId
```
      PayPal generated identifier for the merchant's payment experience profile. Refer to [this](https://developer.paypal.com/webapps/developer/docs/api/#payment-experience) link to create experience profile ID.
    - noteToPayer
```
String noteToPayer
```
      free-form field for the use of clients to pass in a message to the payer
    - redirectUrls
```
RedirectUrls redirectUrls
```
      Set of redirect URLs you provide only for PayPal-based payments.
    - failureReason
```
String failureReason
```
      Failure reason code returned when the payment failed for some valid reasons.
    - createTime
```
String createTime
```
      Payment creation time as defined in [RFC 3339 Section 5.6](http://tools.ietf.org/html/rfc3339#section-5.6).
    - updateTime
```
String updateTime
```
      Payment update time as defined in [RFC 3339 Section 5.6](http://tools.ietf.org/html/rfc3339#section-5.6).
    - links
```
List<E> links
```
- Class com.paypal.api.payments.PaymentCard extends PayPalModel implements Serializable
  - Serialized Fields
    - id
```
String id
```
      ID of the credit card being saved for later use.
    - number
```
String number
```
      Card number.
    - type
```
String type
```
      Type of the Card.
    - expireMonth
```
String expireMonth
```
      2 digit card expiry month.
    - expireYear
```
String expireYear
```
      4 digit card expiry year
    - startMonth
```
String startMonth
```
      2 digit card start month. Needed for UK Maestro Card.
    - startYear
```
String startYear
```
      4 digit card start year. Needed for UK Maestro Card.
    - cvv2
```
String cvv2
```
      Card validation code. Only supported when making a Payment but not when saving a payment card for future use.
    - firstName
```
String firstName
```
      Card holder's first name.
    - lastName
```
String lastName
```
      Card holder's last name.
    - billingCountry
```
String billingCountry
```
      2 letter country code
    - billingAddress
```
Address billingAddress
```
      Billing Address associated with this card.
    - externalCustomerId
```
String externalCustomerId
```
      A unique identifier of the customer to whom this card account belongs to. Generated and provided by the facilitator. This is required when creating or using a stored funding instrument in vault.
    - status
```
String status
```
      State of the funding instrument.
    - validUntil
```
String validUntil
```
      Date/Time until this resource can be used fund a payment.
    - issueNumber
```
String issueNumber
```
      1-2 digit card issue number. Needed for UK Maestro Card.
    - card3dSecureInfo
```
Card3dSecureInfo card3dSecureInfo
```
      Fields required to support 3d secure information when processing credit card payments. Only supported when the `payment_method` is set to `credit_card`.
    - links
```
List<E> links
```
- Class com.paypal.api.payments.PaymentCardToken extends PayPalModel implements Serializable
  - Serialized Fields
    - paymentCardId
```
String paymentCardId
```
      ID of a previously saved Payment Card resource.
    - externalCustomerId
```
String externalCustomerId
```
      The unique identifier of the payer used when saving this payment card.
    - last4
```
String last4
```
      Last 4 digits of the card number from the saved card.
    - type
```
String type
```
      Type of the Card.
    - expireMonth
```
int expireMonth
```
      card expiry month from the saved card with value 1 - 12
    - expireYear
```
int expireYear
```
      4 digit card expiry year from the saved card
- Class com.paypal.api.payments.PaymentDefinition extends PayPalModel implements Serializable
  - Serialized Fields
    - id
```
String id
```
      Identifier of the payment_definition. 128 characters max.
    - name
```
String name
```
      Name of the payment definition. 128 characters max.
    - type
```
String type
```
      Type of the payment definition. Allowed values: `TRIAL`, `REGULAR`.
    - frequencyInterval
```
String frequencyInterval
```
      How frequently the customer should be charged.
    - frequency
```
String frequency
```
      Frequency of the payment definition offered. Allowed values: `WEEK`, `DAY`, `YEAR`, `MONTH`.
    - cycles
```
String cycles
```
      Number of cycles in this payment definition.
    - amount
```
Currency amount
```
      Amount that will be charged at the end of each cycle for this payment definition.
    - chargeModels
```
List<E> chargeModels
```
      Array of charge_models for this payment definition.
- Class com.paypal.api.payments.PaymentDetail extends PayPalModel implements Serializable
  - Serialized Fields
    - type
```
String type
```
      PayPal payment detail indicating whether payment was made in an invoicing flow via PayPal or externally. In the case of the mark-as-paid API, payment type is EXTERNAL and this is what is now supported. The PAYPAL value is provided for backward compatibility.
    - transactionId
```
String transactionId
```
      PayPal payment transaction id. Mandatory field in case the type value is PAYPAL.
    - transactionType
```
String transactionType
```
      Type of the transaction.
    - date
```
String date
```
      Date when the invoice was paid. Date format: yyyy-MM-dd z. For example, 2014-02-27 PST.
    - method
```
String method
```
      Payment mode or method. This field is mandatory if the value of the type field is OTHER.
    - note
```
String note
```
      Optional note associated with the payment.
- Class com.paypal.api.payments.PaymentExecution extends PayPalModel implements Serializable
  - Serialized Fields
    - payerId
```
String payerId
```
      The ID of the Payer, passed in the `return_url` by PayPal.
    - carrierAccountId
```
String carrierAccountId
```
      Carrier account id for a carrier billing payment. For a carrier billing payment, payer_id is not applicable.
    - transactions
```
List<E> transactions
```
      Transactional details including the amount and item details.
- Class com.paypal.api.payments.PaymentHistory extends PayPalModel implements Serializable
  - Serialized Fields
    - payments
```
List<E> payments
```
      A list of Payment resources
    - count
```
int count
```
      Number of items returned in each range of results. Note that the last results range could have fewer items than the requested number of items.
    - nextId
```
String nextId
```
      Identifier of the next element to get the next range of results.
- Class com.paypal.api.payments.PaymentInstruction extends PayPalModel implements Serializable
  - Serialized Fields
    - referenceNumber
```
String referenceNumber
```
      ID of payment instruction
    - instructionType
```
String instructionType
```
      Type of payment instruction
    - recipientBankingInstruction
```
RecipientBankingInstruction recipientBankingInstruction
```
      Recipient bank Details.
    - amount
```
Currency amount
```
      Amount to be transferred
    - paymentDueDate
```
String paymentDueDate
```
      Date by which payment should be received
    - note
```
String note
```
      Additional text regarding payment handling
    - links
```
List<E> links
```
- Class com.paypal.api.payments.PaymentOptions extends PayPalModel implements Serializable
  - Serialized Fields
    - allowedPaymentMethod
```
String allowedPaymentMethod
```
      Optional payment method type. If specified, the transaction will go through for only instant payment. Only for use with the paypal payment_method, not relevant for the credit_card payment_method.
    - recurringFlag
```
Boolean recurringFlag
```
      Indicator if this payment request is a recurring payment. Only supported when the `payment_method` is set to `credit_card`
    - skipFmf
```
Boolean skipFmf
```
      Indicator if fraud management filters (fmf) should be skipped for this transaction. Only supported when the `payment_method` is set to `credit_card`
- Class com.paypal.api.payments.PaymentTerm extends PayPalModel implements Serializable
  - Serialized Fields
    - termType
```
String termType
```
      Terms by which the invoice payment is due.
    - dueDate
```
String dueDate
```
      Date on which invoice payment is due. It must be always a future date. Date format: yyyy-MM-dd z. For example, 2014-02-27 PST
- Class com.paypal.api.payments.Payout extends PayPalResource implements Serializable
  - Serialized Fields
    - senderBatchHeader
```
PayoutSenderBatchHeader senderBatchHeader
```
      The original batch header as provided by the payment sender.
    - items
```
List<E> items
```
      An array of payout items (that is, a set of individual payouts).
    - links
```
List<E> links
```
- Class com.paypal.api.payments.PayoutBatch extends PayPalModel implements Serializable
  - Serialized Fields
    - batchHeader
```
PayoutBatchHeader batchHeader
```
      A batch header that includes the generated batch status.
    - items
```
List<E> items
```
      Array of the items in a batch payout.
    - links
```
List<E> links
```
- Class com.paypal.api.payments.PayoutBatchHeader extends PayPalModel implements Serializable
  - Serialized Fields
    - payoutBatchId
```
String payoutBatchId
```
      An ID for the batch payout. Generated by PayPal. 30 characters max.
    - batchStatus
```
String batchStatus
```
      Generated batch status.
    - timeCreated
```
String timeCreated
```
      The time the batch entered processing.
    - timeCompleted
```
String timeCompleted
```
      The time that processing for the batch was completed.
    - senderBatchHeader
```
PayoutSenderBatchHeader senderBatchHeader
```
      The original batch header as provided by the payment sender.
    - amount
```
Currency amount
```
      Total amount, in U.S. dollars, requested for the applicable payouts.
    - fees
```
Currency fees
```
      Total estimate in U.S. dollars for the applicable payouts fees.
    - errors
```
Error errors
```
    - links
```
List<E> links
```
- Class com.paypal.api.payments.PayoutItem extends PayPalResource implements Serializable
  - Serialized Fields
    - recipientType
```
String recipientType
```
      The type of identification for the payment receiver. If this field is provided, the payout items without a `recipient_type` will use the provided value. If this field is not provided, each payout item must include a value for the `recipient_type`.
    - amount
```
Currency amount
```
      The amount of money to pay a receiver.
    - note
```
String note
```
      Note for notifications. The note is provided by the payment sender. This note can be any string. 4000 characters max.
    - receiver
```
String receiver
```
      The receiver of the payment. In a call response, the format of this value corresponds to the `recipient_type` specified in the request. 127 characters max.
    - senderItemId
```
String senderItemId
```
      A sender-specific ID number, used in an accounting system for tracking purposes. 30 characters max.
- Class com.paypal.api.payments.PayoutItemDetails extends PayPalModel implements Serializable
  - Serialized Fields
    - payoutItemId
```
String payoutItemId
```
      An ID for an individual payout. Provided by PayPal, such as in the case of getting the status of a batch request. 30 characters max.
    - transactionId
```
String transactionId
```
      Generated ID for the transaction. 30 characters max.
    - transactionStatus
```
String transactionStatus
```
      Status of a transaction.
    - payoutItemFee
```
Currency payoutItemFee
```
      Amount of money in U.S. dollars for fees.
    - payoutBatchId
```
String payoutBatchId
```
      An ID for the batch payout. Generated by PayPal. 30 characters max.
    - senderBatchId
```
String senderBatchId
```
      Sender-created ID for tracking the batch in an accounting system. 30 characters max.
    - payoutItem
```
PayoutItem payoutItem
```
      The data for a payout item that the sender initially provided.
    - timeProcessed
```
String timeProcessed
```
      Time of the last processing for this item.
    - error
```
Error error
```
      Deprecated. use errors instead
    - errors
```
Error errors
```
      *
    - links
```
List<E> links
```
      HATEOAS links
- Class com.paypal.api.payments.PayoutSenderBatchHeader extends PayPalModel implements Serializable
  - Serialized Fields
    - senderBatchId
```
String senderBatchId
```
      Sender-created ID for tracking the batch payout in an accounting system. 30 characters max.
    - emailSubject
```
String emailSubject
```
      The subject line text for the email that PayPal sends when a payout item is completed. (The subject line is the same for all recipients.) Maximum of 255 single-byte alphanumeric characters.
    - recipientType
```
String recipientType
```
      The type of ID for a payment receiver. If this field is provided, the payout items without a `recipient_type` will use the provided value. If this field is not provided, each payout item must include a value for the `recipient_type`.
- Class com.paypal.api.payments.Phone extends PayPalModel implements Serializable
  - Serialized Fields
    - countryCode
```
String countryCode
```
      Country code (from in E.164 format)
    - nationalNumber
```
String nationalNumber
```
      In-country phone number (from in E.164 format)
    - extension
```
String extension
```
      Phone extension
- Class com.paypal.api.payments.Plan extends PayPalResource implements Serializable
  - Serialized Fields
    - id
```
String id
```
      Identifier of the billing plan. 128 characters max.
    - name
```
String name
```
      Name of the billing plan. 128 characters max.
    - description
```
String description
```
      Description of the billing plan. 128 characters max.
    - type
```
String type
```
      Type of the billing plan. Allowed values: `FIXED`, `INFINITE`.
    - state
```
String state
```
      Status of the billing plan. Allowed values: `CREATED`, `ACTIVE`, `INACTIVE`, and `DELETED`.
    - createTime
```
String createTime
```
      Time when the billing plan was created. Format YYYY-MM-DDTimeTimezone, as defined in [ISO8601](http://tools.ietf.org/html/rfc3339#section-5.6).
    - updateTime
```
String updateTime
```
      Time when this billing plan was updated. Format YYYY-MM-DDTimeTimezone, as defined in [ISO8601](http://tools.ietf.org/html/rfc3339#section-5.6).
    - paymentDefinitions
```
List<E> paymentDefinitions
```
      Array of payment definitions for this billing plan.
    - terms
```
List<E> terms
```
      Array of terms for this billing plan.
    - merchantPreferences
```
MerchantPreferences merchantPreferences
```
      Specific preferences such as: set up fee, max fail attempts, autobill amount, and others that are configured for this billing plan.
    - links
```
List<E> links
```
- Class com.paypal.api.payments.PlanList extends PayPalModel implements Serializable
  - Serialized Fields
    - plans
```
List<E> plans
```
      Array of billing plans.
    - totalItems
```
String totalItems
```
      Total number of items.
    - totalPages
```
String totalPages
```
      Total number of pages.
    - links
```
List<E> links
```
- Class com.paypal.api.payments.Presentation extends PayPalModel implements Serializable
  - Serialized Fields
    - brandName
```
String brandName
```
      A label that overrides the business name in the PayPal account on the PayPal pages. Character length and limitations: 127 single-byte alphanumeric characters.
    - logoImage
```
String logoImage
```
      A URL to logo image. Allowed vaues: `.gif`, `.jpg`, or `.png`. Limit the image to 190 pixels wide by 60 pixels high. PayPal crops images that are larger. PayPal places your logo image at the top of the cart review area. PayPal recommends that you store the image on a secure (https) server. Otherwise, web browsers display a message that checkout pages contain non-secure items. Character length and limit: 127 single-byte alphanumeric characters.
    - localeCode
```
String localeCode
```
      Locale of pages displayed by PayPal payment experience. Allowed values: `AU`, `AT`, `BE`, `BR`, `CA`, `CH`, `CN`, `DE`, `ES`, `GB`, `FR`, `IT`, `NL`, `PL`, `PT`, `RU`, `US`. The following 5-character codes are also allowed for languages in specific countries: `da_DK`, `he_IL`, `id_ID`, `ja_JP`, `no_NO`, `pt_BR`, `ru_RU`, `sv_SE`, `th_TH`, `tr_TR`, `zh_CN`, `zh_HK`, `zh_TW`.
- Class com.paypal.api.payments.RedirectUrls extends PayPalModel implements Serializable
  - Serialized Fields
    - returnUrl
```
String returnUrl
```
      Url where the payer would be redirected to after approving the payment.
    - cancelUrl
```
String cancelUrl
```
      Url where the payer would be redirected to after canceling the payment.
- Class com.paypal.api.payments.Refund extends PayPalResource implements Serializable
  - Serialized Fields
    - id
```
String id
```
      ID of the refund transaction. 17 characters max.
    - amount
```
Amount amount
```
      Details including both refunded amount (to payer) and refunded fee (to payee). 10 characters max.
    - state
```
String state
```
      State of the refund.
    - reason
```
String reason
```
      Reason description for the Sale transaction being refunded.
    - saleId
```
String saleId
```
      ID of the Sale transaction being refunded.
    - captureId
```
String captureId
```
      ID of the sale transaction being refunded.
    - parentPayment
```
String parentPayment
```
      ID of the payment resource on which this transaction is based.
    - description
```
String description
```
      Description of what is being refunded for.
    - createTime
```
String createTime
```
      Time of refund as defined in [RFC 3339 Section 5.6](http://tools.ietf.org/html/rfc3339#section-5.6).
    - updateTime
```
String updateTime
```
      Time that the resource was last updated.
    - links
```
List<E> links
```
- Class com.paypal.api.payments.RefundDetail extends PayPalModel implements Serializable
  - Serialized Fields
    - type
```
String type
```
      PayPal refund type indicating whether refund was done in invoicing flow via PayPal or externally. In the case of the mark-as-refunded API, refund type is EXTERNAL and this is what is now supported. The PAYPAL value is provided for backward compatibility.
    - date
```
String date
```
      Date when the invoice was marked as refunded. If no date is specified, the current date and time is used as the default. In addition, the date must be after the invoice payment date.
    - note
```
String note
```
      Optional note associated with the refund.
- Class com.paypal.api.payments.RelatedResources extends PayPalModel implements Serializable
  - Serialized Fields
    - sale
```
Sale sale
```
      A sale transaction
    - authorization
```
Authorization authorization
```
      An order transaction
    - capture
```
Capture capture
```
      A capture transaction
    - refund
```
Refund refund
```
      A refund transaction
    - order
```
Order order
```
      An order transaction
- Class com.paypal.api.payments.Sale extends PayPalResource implements Serializable
  - Serialized Fields
    - id
```
String id
```
      ID of the sale transaction.
    - purchaseUnitReferenceId
```
String purchaseUnitReferenceId
```
      Identifier of the purchased unit associated with this object.
    - amount
```
Amount amount
```
      Amount being collected.
    - paymentMode
```
String paymentMode
```
      Specifies payment mode of the transaction. Only supported when the `payment_method` is set to `paypal`.
    - state
```
String state
```
      State of the sale.
    - reasonCode
```
String reasonCode
```
      Reason code for the transaction state being Pending or Reversed. Only supported when the `payment_method` is set to `paypal`.
    - protectionEligibility
```
String protectionEligibility
```
      The level of seller protection in force for the transaction. Only supported when the `payment_method` is set to `paypal`.
    - protectionEligibilityType
```
String protectionEligibilityType
```
      The kind of seller protection in force for the transaction. It is returned only when protection_eligibility is ELIGIBLE or PARTIALLY_ELIGIBLE. Only supported when the `payment_method` is set to `paypal`.
    - clearingTime
```
String clearingTime
```
      Expected clearing time for eCheck transactions. Only supported when the `payment_method` is set to `paypal`.
    - paymentHoldStatus
```
String paymentHoldStatus
```
      Status of the Recipient Fund. For now, it will be returned only when fund status is held
    - paymentHoldReasons
```
List<E> paymentHoldReasons
```
      Reasons for PayPal holding recipient fund. It is set only if payment hold status is held
    - transactionFee
```
Currency transactionFee
```
      Transaction fee charged by PayPal for this transaction.
    - receivableAmount
```
Currency receivableAmount
```
      Net amount the merchant receives for this transaction in their receivable currency. Returned only in cross-currency use cases where a merchant bills a buyer in a non-primary currency for that buyer.
    - exchangeRate
```
String exchangeRate
```
      Exchange rate applied for this transaction. Returned only in cross-currency use cases where a merchant bills a buyer in a non-primary currency for that buyer.
    - fmfDetails
```
FmfDetails fmfDetails
```
      Fraud Management Filter (FMF) details applied for the payment that could result in accept, deny, or pending action. Returned in a payment response only if the merchant has enabled FMF in the profile settings and one of the fraud filters was triggered based on those settings. See [Fraud Management Filters Summary](/docs/classic/fmf/integration-guide/FMFSummary/) for more information.
    - receiptId
```
String receiptId
```
      Receipt id is a payment identification number returned for guest users to identify the payment.
    - parentPayment
```
String parentPayment
```
      ID of the payment resource on which this transaction is based.
    - processorResponse
```
ProcessorResponse processorResponse
```
      Response codes returned by the processor concerning the submitted payment. Only supported when the `payment_method` is set to `credit_card`.
    - billingAgreementId
```
String billingAgreementId
```
      ID of the billing agreement used as reference to execute this transaction.
    - createTime
```
String createTime
```
      Time of sale as defined in [RFC 3339 Section 5.6](http://tools.ietf.org/html/rfc3339#section-5.6)
    - updateTime
```
String updateTime
```
      Time the resource was last updated in UTC ISO8601 format.
    - links
```
List<E> links
```
- Class com.paypal.api.payments.Search extends PayPalModel implements Serializable
  - Serialized Fields
    - email
```
String email
```
      Initial letters of the email address.
    - recipientFirstName
```
String recipientFirstName
```
      Initial letters of the recipient's first name.
    - recipientLastName
```
String recipientLastName
```
      Initial letters of the recipient's last name.
    - recipientBusinessName
```
String recipientBusinessName
```
      Initial letters of the recipient's business name.
    - number
```
String number
```
      The invoice number that appears on the invoice.
    - status
```
String status
```
      Status of the invoice.
    - lowerTotalAmount
```
Currency lowerTotalAmount
```
      Lower limit of total amount.
    - upperTotalAmount
```
Currency upperTotalAmount
```
      Upper limit of total amount.
    - startInvoiceDate
```
String startInvoiceDate
```
      Start invoice date.
    - endInvoiceDate
```
String endInvoiceDate
```
      End invoice date.
    - startDueDate
```
String startDueDate
```
      Start invoice due date.
    - endDueDate
```
String endDueDate
```
      End invoice due date.
    - startPaymentDate
```
String startPaymentDate
```
      Start invoice payment date.
    - endPaymentDate
```
String endPaymentDate
```
      End invoice payment date.
    - startCreationDate
```
String startCreationDate
```
      Start invoice creation date.
    - endCreationDate
```
String endCreationDate
```
      End invoice creation date.
    - page
```
float page
```
      Offset of the search results.
    - pageSize
```
float pageSize
```
      Page size of the search results.
    - totalCountRequired
```
Boolean totalCountRequired
```
      A flag indicating whether total count is required in the response.
- Class com.paypal.api.payments.ShippingAddress extends Address implements Serializable
  - Serialized Fields
    - id
```
String id
```
      Address ID assigned in PayPal system.
    - recipientName
```
String recipientName
```
      Name of the recipient at this address.
    - defaultAddress
```
Boolean defaultAddress
```
      Default shipping address of the Payer.
- Class com.paypal.api.payments.ShippingCost extends PayPalModel implements Serializable
  - Serialized Fields
    - amount
```
Currency amount
```
      Shipping cost in amount. Range of 0 to 999999.99.
    - tax
```
Tax tax
```
      Tax percentage on shipping amount.
- Class com.paypal.api.payments.ShippingInfo extends PayPalModel implements Serializable
  - Serialized Fields
    - firstName
```
String firstName
```
      First name of the invoice recipient. 30 characters max.
    - lastName
```
String lastName
```
      Last name of the invoice recipient. 30 characters max.
    - businessName
```
String businessName
```
      Company business name of the invoice recipient. 100 characters max.
    - address
```
InvoiceAddress address
```
      Address of the invoice recipient.
    - email
```
String email
```
- Class com.paypal.api.payments.Tax extends PayPalModel implements Serializable
  - Serialized Fields
    - id
```
String id
```
      Identifier of the resource.
    - name
```
String name
```
      Name of the tax. 10 characters max.
    - percent
```
float percent
```
      Rate of the specified tax. Range of 0.001 to 99.999.
    - amount
```
Currency amount
```
      Tax in the form of money. Cannot be specified in a request.
- Class com.paypal.api.payments.Terms extends PayPalModel implements Serializable
  - Serialized Fields
    - id
```
String id
```
      Identifier of the terms. 128 characters max.
    - type
```
String type
```
      Term type. Allowed values: `MONTHLY`, `WEEKLY`, `YEARLY`.
    - maxBillingAmount
```
Currency maxBillingAmount
```
      Max Amount associated with this term.
    - occurrences
```
String occurrences
```
      How many times money can be pulled during this term.
    - amountRange
```
Currency amountRange
```
      Amount_range associated with this term.
    - buyerEditable
```
String buyerEditable
```
      Buyer's ability to edit the amount in this term.
- Class com.paypal.api.payments.Transaction extends TransactionBase implements Serializable
  - Serialized Fields
    - transactions
```
List<E> transactions
```
      Additional transactions for complex payment scenarios.
- Class com.paypal.api.payments.TransactionBase extends CartBase implements Serializable
  - Serialized Fields
    - relatedResources
```
List<E> relatedResources
```
      List of financial transactions (Sale, Authorization, Capture, Refund) related to the payment.
    - purchaseUnitReferenceId
```
String purchaseUnitReferenceId
```
      Identifier to the purchase unit corresponding to this sale transaction.
- Class com.paypal.api.payments.Transactions extends PayPalModel implements Serializable
  - Serialized Fields
    - amount
```
Amount amount
```
      Amount being collected.
- Class com.paypal.api.payments.Webhook extends PayPalResource implements Serializable
  - Serialized Fields
    - id
```
String id
```
      Identifier of the webhook resource.
    - url
```
String url
```
      Webhook notification endpoint url.
    - eventTypes
```
List<E> eventTypes
```
      List of Webhooks event-types.
    - links
```
List<E> links
```
      Hateoas Links.
- Class com.paypal.api.payments.WebhookList extends PayPalResource implements Serializable
  - Serialized Fields
    - webhooks
```
List<E> webhooks
```
      A list of Webhooks
- Class com.paypal.api.payments.WebProfileList extends ArrayList<WebProfile> implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - webProfiles
```
List<E> webProfiles
```
Package com.paypal.base.codec
- Class com.paypal.base.codec.DecoderException extends Exception implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.paypal.base.codec.EncoderException extends Exception implements Serializable
  
  serialVersionUID:
  
  1L
Package com.paypal.base.exception
- Class com.paypal.base.exception.BaseException extends Exception implements Serializable
  
  serialVersionUID:
  
  -5345825923487658213L
- Class com.paypal.base.exception.ClientActionRequiredException extends HttpErrorException implements Serializable
  
  serialVersionUID:
  
  -15345584654755445L
- Class com.paypal.base.exception.HttpErrorException extends BaseException implements Serializable
  
  serialVersionUID:
  
  -4312358746964758546L
  - Serialized Fields
    - responsecode
```
int responsecode
```
    - errorResponse
```
String errorResponse
```
- Class com.paypal.base.exception.InvalidCredentialException extends BaseException implements Serializable
  
  serialVersionUID:
  
  -4321565982347658546L
- Class com.paypal.base.exception.InvalidResponseDataException extends BaseException implements Serializable
  
  serialVersionUID:
  
  -7489562847530985773L
- Class com.paypal.base.exception.MissingCredentialException extends BaseException implements Serializable
  
  serialVersionUID:
  
  -2345825926387658303L
- Class com.paypal.base.exception.OAuthException extends PayPalException implements Serializable
  - Serialized Fields
    - message
```
String message
```
- Class com.paypal.base.exception.PayPalException extends Exception implements Serializable
- Class com.paypal.base.exception.SSLConfigurationException extends BaseException implements Serializable
  
  serialVersionUID:
  
  -2345834567387658303L
Package com.paypal.base.rest
- Class com.paypal.base.rest.PayPalModel extends Object implements Serializable
- Class com.paypal.base.rest.PayPalResource extends PayPalModel implements Serializable
- Class com.paypal.base.rest.PayPalRESTException extends Exception implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - responsecode
```
int responsecode
```
      If source is HttpErrorException, exception's response code value is copied
    - details
```
Error details
```
      If source is HttpErrorException and response code is 400, error response content is converted to Error object

Serialized Form

Package com.paypal.api.openidconnect

Class com.paypal.api.openidconnect.Address extends PayPalModel implements Serializable

Serialized Fields

streetAddress

locality

region

postalCode

country

Class com.paypal.api.openidconnect.Error extends PayPalModel implements Serializable

Serialized Fields

error

errorDescription

errorUri

Class com.paypal.api.openidconnect.Tokeninfo extends PayPalResource implements Serializable

Serialized Fields

scope

accessToken

refreshToken

tokenType

expiresIn

appId

Class com.paypal.api.openidconnect.Userinfo extends PayPalResource implements Serializable

Serialized Fields

userId

sub

name

givenName

familyName

middleName

picture

email

emailVerified

gender

birthdate

zoneinfo

locale

phoneNumber

address

verifiedAccount

accountType

ageRange

payerId

Package com.paypal.api.payments

Class com.paypal.api.payments.Address extends BaseAddress implements Serializable

Serialized Fields

phone

Class com.paypal.api.payments.Agreement extends PayPalResource implements Serializable

Serialized Fields

id

state

name

description

startDate

agreementDetails

payer

shippingAddress

overrideMerchantPreferences

overrideChargeModels

plan

createTime

updateTime

token

links

Class com.paypal.api.payments.AgreementDetails extends PayPalModel implements Serializable

Serialized Fields

outstandingBalance

cyclesRemaining

cyclesCompleted

nextBillingDate

lastPaymentDate

lastPaymentAmount

finalPaymentDate

failedPaymentCount

Class com.paypal.api.payments.AgreementStateDescriptor extends PayPalModel implements Serializable

Serialized Fields

note

amount

Class com.paypal.api.payments.AgreementTransaction extends PayPalModel implements Serializable

Serialized Fields