Serialized Form (WePay-Java-SDK 2.0.2 API)

Package com.lookfirst.wepay
- Class com.lookfirst.wepay.WePayException extends RuntimeException implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - error
```
String error
```
      The raw error type string
    - errorType
```
WePayError errorType
```
      The error string converted to a known enum, or null if unknown
    - errorText
```
String errorText
```
      The error text by itself
    - errorCode
```
Integer errorCode
```
- Class com.lookfirst.wepay.WePayKey extends Object implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - production
```
boolean production
```
    - clientId
```
Long clientId
```
    - clientSecret
```
String clientSecret
```
Package com.lookfirst.wepay.api
- Class com.lookfirst.wepay.api.AccountBalance extends Object implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - currency
```
String currency
```
      The currency of the above amounts. For now this will always be USD.
    - balance
```
BigDecimal balance
```
    - incomingPendingAmount
```
BigDecimal incomingPendingAmount
```
    - outgoingPendingAmount
```
BigDecimal outgoingPendingAmount
```
    - reservedAmount
```
BigDecimal reservedAmount
```
      The actual amount of money in dollars that is reserved and is not available for withdrawal (ie the minimum balance).
    - disputedAmount
```
BigDecimal disputedAmount
```
      The actual amount of money in dollars that is currently in dispute between the payee and the payer and is not available for withdrawal.
    - withdrawalPeriod
```
String withdrawalPeriod
```
      "daily"
    - withdrawalNextTime
```
Long withdrawalNextTime
```
      Unix time
    - withdrawalBankName
```
String withdrawalBankName
```
      Name of the bank
    - pendingBalance
```
BigDecimal pendingBalance
```
      Deprecated.
      
      The pending balance of the account.
    - availableBalance
```
BigDecimal availableBalance
```
      Deprecated.
      
      The actual amount of money that has cleared and is available to the account.
    - pendingAmount
```
BigDecimal pendingAmount
```
      Deprecated.
      
      The actual amount of money in dollars that is pending.
- Class com.lookfirst.wepay.api.AccountId extends Object implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - accountId
```
Long accountId
```
      The unique ID of the account.
    - state
```
String state
```
      The state of the account.
- Class com.lookfirst.wepay.api.AccountReserve extends AccountId implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - currency
```
String currency
```
      The currency of the above amounts. For now this will always be USD.
    - reservedAmount
```
BigDecimal reservedAmount
```
      The actual amount of money in dollars that is reserved and is not available for withdrawal (ie the minimum balance).
    - withdrawalsSchedule
```
List<E> withdrawalsSchedule
```
      An array of time/amount pairs up to the next 10 withdrawals based on current balance, the reserves and withdrawals schedules. It will be empty if withdrawals are not yet configured or if there is no balance.
- Class com.lookfirst.wepay.api.AccountStatus extends Object implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - currency
```
String currency
```
      The currency of the above amounts. For now this will always be USD.
    - incomingPaymentsStatus
```
String incomingPaymentsStatus
```
    - outgoingPaymentsStatus
```
String outgoingPaymentsStatus
```
- Class com.lookfirst.wepay.api.AccountTax extends Object implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - taxes
```
String taxes
```
      The tax tables for the account.
- Class com.lookfirst.wepay.api.AccountUri extends AccountId implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - accountUri
```
String accountUri
```
      A uri that corresponds to the account's page on WePay.
- Class com.lookfirst.wepay.api.AddBank extends Object implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - accountId
```
Long accountId
```
      The unique ID of the account.
    - addBankUri
```
String addBankUri
```
      The URI to add the bank account to the specified acocunt id.
- Class com.lookfirst.wepay.api.AppModify extends Object implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - userId
```
String userId
```
      The unique integer user ID of the user
    - accessToken
```
String accessToken
```
      The string access token that you can use to make calls on behalf of the user
    - themeObject
```
ThemeObject themeObject
```
      The theme object associated with the App (if applicable).
    - gaqDomains
```
List<E> gaqDomains
```
      An array of Google Analytics domains associated with the app.
- Class com.lookfirst.wepay.api.AppUri extends Object implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - clientId
```
String clientId
```
      The unique ID of the app.
    - status
```
String status
```
      The approval status of the API application.
    - themeObject
```
ThemeObject themeObject
```
      The theme object associated with the App (if applicable).
    - gaqDomains
```
List<E> gaqDomains
```
      An array of Google Analytics domains associated with the app.
- Class com.lookfirst.wepay.api.Call extends Object implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - call
```
String call
```
      The name of the API call you want to make (ie. /checkout/find).
    - authorization
```
String authorization
```
      The access token of the user that is making the API call.
    - referenceId
```
String referenceId
```
      A unique id that you can attach to an API call so that you can specifically identify that call.
    - parameters
```
Map<K,V> parameters
```
      The parameters required by the API call that you specified in the "call" parameter.
- Class com.lookfirst.wepay.api.Calls extends Object implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - calls
```
List<E> calls
```
- Class com.lookfirst.wepay.api.Checkout extends CheckoutUri implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - accountId
```
Long accountId
```
      The unique ID of the payment account that the money will go into.
    - preapprovalId
```
Long preapprovalId
```
      The unique ID of the preapproval associated with the checkout (if applicable).
    - state
```
Constants.State state
```
      The state the checkout is in. See the section on IPN for a listing of all states.
    - softDescriptor
```
String softDescriptor
```
      The payment description that will show up on payer's credit card statement. (255)
    - shortDescription
```
String shortDescription
```
      The short description of the checkout.
    - longDescription
```
String longDescription
```
      The long description of the checkout (if available).
    - currency
```
String currency
```
      The currency used (always USD for now).
    - amount
```
BigDecimal amount
```
      The dollar amount of the checkout object. This will always be the amount you passed in /checkout/create
    - fee
```
BigDecimal fee
```
      The dollar amount of the WePay fee.
    - gross
```
BigDecimal gross
```
      The total dollar amount paid by the payer.
    - appFee
```
BigDecimal appFee
```
      The amount that the application received in fees. App fees go into the API application's WePay account.
    - feePayer
```
Constants.FeePayer feePayer
```
      Who is paying the fee (either "payer" for the person paying or "payee" for the person receiving the money).
    - referenceId
```
String referenceId
```
      The unique reference_id passed by the application (if available).
    - redirectUri
```
String redirectUri
```
      The uri the payer will be redirected to after payment (if available).
    - callbackUri
```
String callbackUri
```
      The uri which Instant Payment Notifications will be sent to.
    - disputeUri
```
String disputeUri
```
      The uri that payers can visit to open a dispute for this checkout.
    - payerEmail
```
String payerEmail
```
      The email address of the person paying (only returned if a payment has been made).
    - payerName
```
String payerName
```
      The name of the person paying (only returned if a payment has been made).
    - cancelReason
```
String cancelReason
```
      If the payment was canceled, the reason why.
    - refundReason
```
String refundReason
```
      If the payment was refunded the reason why.
    - autoCapture
```
boolean autoCapture
```
      A boolean value. Default is true. If set to true then the payment will not automatically be released to the account and will be held by WePay in payment state 'reserved'. To release funds to the account you must call /checkout/capture
    - requireShipping
```
boolean requireShipping
```
      A boolean value. Default is false. If set to true then the payer will be required to enter their shipping address when paying.
    - shippingAddress
```
Checkout.ShippingAddress shippingAddress
```
      If 'require_shipping' was set to true and the payment was made, this will be the shipping address that the payer entered. It will be in the following format: {"address1":"455 Portage Ave","address2":"Suite B","city":"Palo Alto","state":"CA","zip":"94306","country":"US"}
    - tax
```
String tax
```
      The dollar amount of taxes paid.
    - amountRefunded
```
BigDecimal amountRefunded
```
      If this checkout has been fully or partially refunded, this has the amount that has been refunded so far.
    - amountChargedBack
```
BigDecimal amountChargedBack
```
      If this checkout has been fully or partially charged back, this has the amount that has been charged back so far.
    - createTime
```
Long createTime
```
      The unixtime when the checkout was created.
- Class com.lookfirst.wepay.api.CheckoutId extends Object implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - checkoutId
```
Long checkoutId
```
      The unique ID of the checkout
- Class com.lookfirst.wepay.api.CheckoutState extends CheckoutId implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - state
```
Constants.State state
```
      The state the payment is in. See the IPN section for a list of payment states.
- Class com.lookfirst.wepay.api.CheckoutUri extends CheckoutId implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - checkoutUri
```
String checkoutUri
```
      The uri you can send a user to so they can pay.
- Class com.lookfirst.wepay.api.CreditCard extends Object implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - creditCardId
```
String creditCardId
```
      The unique ID of the credit_card.
    - creditCardName
```
String creditCardName
```
      The string that identifies the credit_card such as MasterCard xxxxxx4769.
    - state
```
String state
```
      The state that the credit card is in.
    - userName
```
String userName
```
      The name on the card (ie "Bob Smith").
    - email
```
String email
```
      The email address of the user who owns the card.
    - referenceId
```
String referenceId
```
      The unique reference ID of the account (this is set by the application in the /account/create or /account/modify call).
- Class com.lookfirst.wepay.api.Preapproval extends Object implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - preapprovalId
```
Long preapprovalId
```
      The unique ID of the preapproval.
    - preapprovalUri
```
String preapprovalUri
```
      The uri that you send the user to so they can enter their payment info and approve the preapproval.
    - manageUri
```
String manageUri
```
      A uri that you can send the user to if they need to update their payment method.
    - accountId
```
Long accountId
```
      The unique ID of the WePay account where the money will go.
    - shortDescription
```
String shortDescription
```
      A short description of what the payer is being charged for.
    - longDescription
```
String longDescription
```
      A longer description of what the payer is being charged for (if set).
    - currency
```
String currency
```
      The currency that any charges will take place in (for now always USD).
    - amount
```
BigDecimal amount
```
      The amount in dollars that the application can charge the payer automatically every period.
    - feePayer
```
Constants.FeePayer feePayer
```
      Who is paying the fee (either "payer" for the person paying, "payee" for the person receiving the money, "payer_from_app" if payer is paying for app fee and the app is paying WePay fees, or "payee_from_app" if payee is paying for app fee and app is paying for WePay fees).
    - state
```
Constants.State state
```
      The state that the preapproval is in. See the object states page for the full list.
    - redirectUri
```
String redirectUri
```
      The uri that the payer will be redirected to after approving the preapproval.
    - appFee
```
BigDecimal appFee
```
      The fee that will go to the API application's account (if set). Limited to 20% of the preapproval amount.
    - period
```
String period
```
      How often the API application can execute payments for a payer with this preapproval. Can be: hourly, daily, weekly, biweekly, monthly, bimonthly, quarterly, yearly, and once. Once period is if you only want to get authorization for a future charge and don't need it to be recurring.
    - frequency
```
Integer frequency
```
      The number of times the API application can execute payments per period.
    - startTime
```
Long startTime
```
      When the API application can begin executing payments with this preapproval. Will be a unix timestamp.
    - endTime
```
Long endTime
```
      The last time that the API application can execute a payment with this preapproval. Will be a unix timestamp.
    - referenceId
```
String referenceId
```
      The reference_id passed by the application (if set).
    - callbackUri
```
String callbackUri
```
      The uri which instant payment notifications will be sent to.
    - address
```
Checkout.ShippingAddress address
```
      The shipping address that the payer entered (if applicable). It will be in the following format: US Addresses: {"address1":"380 Portage Ave","address2":"","city":"Palo Alto","state":"CA","zip":"94306","country":"US"}. Non-US Addresses: {"address1":"100 Main St","address2":"","city":"Toronto","region":"ON","postcode":"M4E 1Z5","country":"CA"} Use ISO 3166-1 codes when specifying the country.
    - shippingFee
```
BigDecimal shippingFee
```
      The amount that was paid in shipping fees (if any).
    - tax
```
BigDecimal tax
```
      The dollar amount of taxes paid (if any).
    - autoRecur
```
boolean autoRecur
```
      Whether or not the preapproval automatically executes the payments every period.
    - payerName
```
String payerName
```
      The name of the payer.
    - payeeEmail
```
String payeeEmail
```
      The email of the payer.
    - createTime
```
Long createTime
```
      The unixtime when the preapproval was created.
    - nextDueTime
```
Long nextDueTime
```
      The unixtime of the next scheduled charge +/- 5 minutes (will only show up for approved auto_recur preapprovals).
    - lastCheckoutId
```
Long lastCheckoutId
```
      The checkout ID of the last successful checkout (state captured) for the preapproval.
    - lastCheckoutTime
```
Long lastCheckoutTime
```
      The unixtime when the last successful checkout occurred.
- Class com.lookfirst.wepay.api.ThemeObject extends Object implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - name
```
String name
```
      Sets a name for the theme
    - primaryColor
```
String primaryColor
```
      Sets colors on important elements such as headers
    - secondaryColor
```
String secondaryColor
```
      Sets colors on secondary elements such as info boxes, and the focus styles on text inputs
    - backgroundColor
```
String backgroundColor
```
      Sets the background color for the page frame on onsite pages, and the iframe background on iframe checkouts
    - buttonColor
```
String buttonColor
```
      Sets the color on primary action buttons
- Class com.lookfirst.wepay.api.Token extends Object implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - userId
```
String userId
```
      The unique user ID of the user
    - accessToken
```
String accessToken
```
      The access token that you can use to make calls on behalf of the user
    - tokenType
```
String tokenType
```
      The token type - for now only "BEARER" is supported
    - expiresIn
```
String expiresIn
```
      How much time till the access_token expires. If NULL or not present, the access token will be valid until the user revokes the access_token
- Class com.lookfirst.wepay.api.Transfer extends TransferInstruction implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - transferId
```
String transferId
```
      Deprecated.
      
      The unique ID of the transfer.
    - accountId
```
String accountId
```
      Deprecated.
      
      The unique ID of the account the money is coming from.
    - disbursementId
```
String disbursementId
```
      Deprecated.
      
      No The unique ID of the disbursement you want to look up transfers for.
    - state
```
String state
```
      Deprecated.
      
      The state that the disbursement is in (new, sent, or failed).
- Class com.lookfirst.wepay.api.TransferInstruction extends Object implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - to
```
String to
```
      Deprecated.
      
      The email address that the money is being sent to.
    - amount
```
String amount
```
      Deprecated.
      
      The dollar amount on money that is being sent.
    - referenceId
```
String referenceId
```
      Deprecated.
      
      The reference_id passed by the application (if set).
- Class com.lookfirst.wepay.api.TransferState extends Object implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - transferId
```
String transferId
```
      Deprecated.
      
      Yes The unique ID of the transfer you refunded.
    - state
```
String state
```
      Deprecated.
      
      The state that the refund is in (new, sent, or failed).
- Class com.lookfirst.wepay.api.WePayAccount extends AccountUri implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - name
```
String name
```
      The name of the account.
    - state
```
String state
```
      The state of the account: active, disabled or deleted.
    - description
```
String description
```
      The account description.
    - referenceId
```
String referenceId
```
      The unique reference ID of the account (this is set by the application in the /account/create or /account/modify call).
    - paymentLimit
```
String paymentLimit
```
      The maximum amount in dollars (including fees) that you can charge for payments to this account.
    - gaqDomains
```
List<E> gaqDomains
```
      An array of Google Analytics domains associated with the app.
    - themeObject
```
ThemeObject themeObject
```
      The theme object associated with the App (if applicable).
    - verificationState
```
String verificationState
```
      Returns "verified" if the account has been verified and "unverified" if it has not. If the account has pending verification, then it is "pending".
    - verificationUrl
```
String verificationUrl
```
      If the account is "unverified" then you can send the user to this url to verify their account.
    - type
```
String type
```
      The account type. Can be "personal", "nonprofit", or "business".
    - createTime
```
Long createTime
```
      The unixtime when the account was created.
    - balances
```
List<E> balances
```
      Array of account balances for each currency.
    - statuses
```
List<E> statuses
```
      Array of account incoming and outgoing payments status for each currency.
    - actionReasons
```
List<E> actionReasons
```
      Array of action strings explaining all the actions that are required to make this account active. It will be empty if no action is required.
    - country
```
String country
```
      The account's country of origin 2-letter ISO code (e.g. 'US')
    - currencies
```
List<E> currencies
```
      Array of supported currency strings for this account (e.g. ["USD"]). Only "USD" is supported for now.
- Class com.lookfirst.wepay.api.WePayUser extends Object implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - userId
```
String userId
```
      The unique ID of the user.
    - firstName
```
String firstName
```
      The first name of the user
    - lastName
```
String lastName
```
      The last name of the user
    - email
```
String email
```
      The email of the user
    - state
```
String state
```
      Either "registered" if the user has registered, or "pending" if the user still needs to confirm their registration
- Class com.lookfirst.wepay.api.Withdrawal extends Object implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - withdrawalId
```
Long withdrawalId
```
      The unique ID of the withdrawal.
    - accountId
```
Long accountId
```
      The unique ID of the account that the money is coming from.
    - state
```
Constants.State state
```
      The state that the withdrawal is in See the section on payment states for a list of possible states.
    - redirectUri
```
String redirectUri
```
      The uri that the account owner will return to after completing the withdrawal. Set to app homepage if not passed in /withdrawal/create.
    - withdrawalUri
```
String withdrawalUri
```
      The uri that you will send the account owner to to complete the withdrawal.
    - callbackUri
```
String callbackUri
```
      The uri that we will post notifications to each time the state on this withdrawal changes.
    - amount
```
BigDecimal amount
```
      The amount on money withdrawn from the WePay account to the bank account.
    - currency
```
String currency
```
      The currency used, default "USD" ("USD" for now).
    - note
```
String note
```
      A short description for the reason of the withdrawal (255 characters).
    - recipientConfirmed
```
boolean recipientConfirmed
```
      Whether the recipient of the money has been confirmed (for bank withdrawals this is the receiving bank account).
    - type
```
Constants.WithdrawalType type
```
      The type of withdrawal. Will be "check" for a sent paper check, or "ach" for a withdrawal to a bank account.
    - createTime
```
Long createTime
```
      The unixtime when the withdrawal was created.
    - captureTime
```
Long captureTime
```
      The unixtime when the withdrawal was captured and credited to the payee's bank account. Returns 0 if withdrawal is not yet captured.

Serialized Form

Package com.lookfirst.wepay

Class com.lookfirst.wepay.WePayException extends RuntimeException implements Serializable

Serialized Fields

error

errorType

errorText

errorCode

Class com.lookfirst.wepay.WePayKey extends Object implements Serializable

Serialized Fields

production

clientId

clientSecret

Package com.lookfirst.wepay.api

Class com.lookfirst.wepay.api.AccountBalance extends Object implements Serializable

Serialized Fields

currency

balance

incomingPendingAmount

outgoingPendingAmount

reservedAmount

disputedAmount

withdrawalPeriod

withdrawalNextTime

withdrawalBankName

pendingBalance

availableBalance

pendingAmount

Class com.lookfirst.wepay.api.AccountId extends Object implements Serializable

Serialized Fields

accountId

state

Class com.lookfirst.wepay.api.AccountReserve extends AccountId implements Serializable

Serialized Fields

currency

reservedAmount

withdrawalsSchedule

Class com.lookfirst.wepay.api.AccountStatus extends Object implements Serializable

Serialized Fields

currency

incomingPaymentsStatus

outgoingPaymentsStatus

Class com.lookfirst.wepay.api.AccountTax extends Object implements Serializable

Serialized Fields

taxes

Class com.lookfirst.wepay.api.AccountUri extends AccountId implements Serializable

Serialized Fields

accountUri

Class com.lookfirst.wepay.api.AddBank extends Object implements Serializable

Serialized Fields

accountId

addBankUri

Class com.lookfirst.wepay.api.AppModify extends Object implements Serializable

Serialized Fields

userId

accessToken

themeObject

gaqDomains

Class com.lookfirst.wepay.api.AppUri extends Object implements Serializable

Serialized Fields

clientId

status

themeObject

gaqDomains

Class com.lookfirst.wepay.api.Call extends Object implements Serializable

Serialized Fields

call

authorization

referenceId

parameters

Class com.lookfirst.wepay.api.Calls extends Object implements Serializable

Serialized Fields

calls

Class com.lookfirst.wepay.api.Checkout extends CheckoutUri implements Serializable

Serialized Fields

accountId

preapprovalId

state

softDescriptor

shortDescription