SearchTransactionsInput (PayPal Server SDK 2.2.0 API)

java.lang.Object
- com.paypal.sdk.models.SearchTransactionsInput

```
public class SearchTransactionsInput
extends Object
```
This is a model class for SearchTransactionsInput type.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class SearchTransactionsInput.Builder
Class to build instances of SearchTransactionsInput.

Nested Classes
Modifier and Type	Class and Description
`static class`	`SearchTransactionsInput.Builder` Class to build instances of `SearchTransactionsInput`.

Constructor Summary

Constructors
Constructor and Description
`SearchTransactionsInput()` Default constructor.
`SearchTransactionsInput(String startDate, String endDate, String transactionId, String transactionType, String transactionStatus, String transactionAmount, String transactionCurrency, String paymentInstrumentType, String storeId, String terminalId, String fields, String balanceAffectingRecordsOnly, Integer pageSize, Integer page)` Initialization constructor.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`getBalanceAffectingRecordsOnly()` Getter for BalanceAffectingRecordsOnly.
`String`	`getEndDate()` Getter for EndDate.
`String`	`getFields()` Getter for Fields.
`Integer`	`getPage()` Getter for Page.
`Integer`	`getPageSize()` Getter for PageSize.
`String`	`getPaymentInstrumentType()` Getter for PaymentInstrumentType.
`String`	`getStartDate()` Getter for StartDate.
`String`	`getStoreId()` Getter for StoreId.
`String`	`getTerminalId()` Getter for TerminalId.
`String`	`getTransactionAmount()` Getter for TransactionAmount.
`String`	`getTransactionCurrency()` Getter for TransactionCurrency.
`String`	`getTransactionId()` Getter for TransactionId.
`String`	`getTransactionStatus()` Getter for TransactionStatus.
`String`	`getTransactionType()` Getter for TransactionType.
`void`	`setBalanceAffectingRecordsOnly(String balanceAffectingRecordsOnly)` Setter for BalanceAffectingRecordsOnly.
`void`	`setEndDate(String endDate)` Setter for EndDate.
`void`	`setFields(String fields)` Setter for Fields.
`void`	`setPage(Integer page)` Setter for Page.
`void`	`setPageSize(Integer pageSize)` Setter for PageSize.
`void`	`setPaymentInstrumentType(String paymentInstrumentType)` Setter for PaymentInstrumentType.
`void`	`setStartDate(String startDate)` Setter for StartDate.
`void`	`setStoreId(String storeId)` Setter for StoreId.
`void`	`setTerminalId(String terminalId)` Setter for TerminalId.
`void`	`setTransactionAmount(String transactionAmount)` Setter for TransactionAmount.
`void`	`setTransactionCurrency(String transactionCurrency)` Setter for TransactionCurrency.
`void`	`setTransactionId(String transactionId)` Setter for TransactionId.
`void`	`setTransactionStatus(String transactionStatus)` Setter for TransactionStatus.
`void`	`setTransactionType(String transactionType)` Setter for TransactionType.
`SearchTransactionsInput.Builder`	`toBuilder()` Builds a new `SearchTransactionsInput.Builder` object.
`String`	`toString()` Converts this SearchTransactionsInput into string format.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - SearchTransactionsInput
```
public SearchTransactionsInput()
```
    Default constructor.
  - SearchTransactionsInput
```
public SearchTransactionsInput(String startDate,
                               String endDate,
                               String transactionId,
                               String transactionType,
                               String transactionStatus,
                               String transactionAmount,
                               String transactionCurrency,
                               String paymentInstrumentType,
                               String storeId,
                               String terminalId,
                               String fields,
                               String balanceAffectingRecordsOnly,
                               Integer pageSize,
                               Integer page)
```
    Initialization constructor.
    
    Parameters:
    
    startDate - String value for startDate.
    
    endDate - String value for endDate.
    
    transactionId - String value for transactionId.
    
    transactionType - String value for transactionType.
    
    transactionStatus - String value for transactionStatus.
    
    transactionAmount - String value for transactionAmount.
    
    transactionCurrency - String value for transactionCurrency.
    
    paymentInstrumentType - String value for paymentInstrumentType.
    
    storeId - String value for storeId.
    
    terminalId - String value for terminalId.
    
    fields - String value for fields.
    
    balanceAffectingRecordsOnly - String value for balanceAffectingRecordsOnly.
    
    pageSize - Integer value for pageSize.
    
    page - Integer value for page.
- Method Detail
  - getStartDate
```
public String getStartDate()
```
    Getter for StartDate. Filters the transactions in the response by a start date and time, in [Internet date and time format](https://tools.ietf.org/html/rfc3339#section-5.6). Seconds are required. Fractional seconds are optional.
    
    Returns:
    
    Returns the String
  - setStartDate
```
public void setStartDate(String startDate)
```
    Setter for StartDate. Filters the transactions in the response by a start date and time, in [Internet date and time format](https://tools.ietf.org/html/rfc3339#section-5.6). Seconds are required. Fractional seconds are optional.
    
    Parameters:
    
    startDate - Value for String
  - getEndDate
```
public String getEndDate()
```
    Getter for EndDate. Filters the transactions in the response by an end date and time, in [Internet date and time format](https://tools.ietf.org/html/rfc3339#section-5.6). Seconds are required. Fractional seconds are optional. The maximum supported range is 31 days.
    
    Returns:
    
    Returns the String
  - setEndDate
```
public void setEndDate(String endDate)
```
    Setter for EndDate. Filters the transactions in the response by an end date and time, in [Internet date and time format](https://tools.ietf.org/html/rfc3339#section-5.6). Seconds are required. Fractional seconds are optional. The maximum supported range is 31 days.
    
    Parameters:
    
    endDate - Value for String
  - getTransactionId
```
public String getTransactionId()
```
    Getter for TransactionId. Filters the transactions in the response by a PayPal transaction ID. A valid transaction ID is 17 characters long, except for an order ID, which is 19 characters long. Note: A transaction ID is not unique in the reporting system. The response can list two transactions with the same ID. One transaction can be balance affecting while the other is non-balance affecting.
    
    Returns:
    
    Returns the String
  - setTransactionId
```
public void setTransactionId(String transactionId)
```
    Setter for TransactionId. Filters the transactions in the response by a PayPal transaction ID. A valid transaction ID is 17 characters long, except for an order ID, which is 19 characters long. Note: A transaction ID is not unique in the reporting system. The response can list two transactions with the same ID. One transaction can be balance affecting while the other is non-balance affecting.
    
    Parameters:
    
    transactionId - Value for String
  - getTransactionType
```
public String getTransactionType()
```
    Getter for TransactionType. Filters the transactions in the response by a PayPal transaction event code. See [Transaction event codes](/docs/integration/direct/transaction-search/transaction-event-codes/).
    
    Returns:
    
    Returns the String
  - setTransactionType
```
public void setTransactionType(String transactionType)
```
    Setter for TransactionType. Filters the transactions in the response by a PayPal transaction event code. See [Transaction event codes](/docs/integration/direct/transaction-search/transaction-event-codes/).
    
    Parameters:
    
    transactionType - Value for String
  - getTransactionStatus
```
public String getTransactionStatus()
```
    Getter for TransactionStatus. Filters the transactions in the response by a PayPal transaction status code. Value is: Status code Description D PayPal or merchant rules denied the transaction. P The transaction is pending. The transaction was created but waits for another payment process to complete, such as an ACH transaction, before the status changes to S. S The transaction successfully completed without a denial and after any pending statuses. V A successful transaction was reversed and funds were refunded to the original sender.
    
    Returns:
    
    Returns the String
  - setTransactionStatus
```
public void setTransactionStatus(String transactionStatus)
```
    Setter for TransactionStatus. Filters the transactions in the response by a PayPal transaction status code. Value is: Status code Description D PayPal or merchant rules denied the transaction. P The transaction is pending. The transaction was created but waits for another payment process to complete, such as an ACH transaction, before the status changes to S. S The transaction successfully completed without a denial and after any pending statuses. V A successful transaction was reversed and funds were refunded to the original sender.
    
    Parameters:
    
    transactionStatus - Value for String
  - getTransactionAmount
```
public String getTransactionAmount()
```
    Getter for TransactionAmount. Filters the transactions in the response by a gross transaction amount range. Specify the range as ` TO `, where ` ` is the lower limit of the gross PayPal transaction amount and ` ` is the upper limit of the gross transaction amount. Specify the amounts in lower denominations. For example, to search for transactions from $5.00 to $10.05, specify `[500 TO 1005]`. Note:The values must be URL encoded.
    
    Returns:
    
    Returns the String
  - setTransactionAmount
```
public void setTransactionAmount(String transactionAmount)
```
    Setter for TransactionAmount. Filters the transactions in the response by a gross transaction amount range. Specify the range as ` TO `, where ` ` is the lower limit of the gross PayPal transaction amount and ` ` is the upper limit of the gross transaction amount. Specify the amounts in lower denominations. For example, to search for transactions from $5.00 to $10.05, specify `[500 TO 1005]`. Note:The values must be URL encoded.
    
    Parameters:
    
    transactionAmount - Value for String
  - getTransactionCurrency
```
public String getTransactionCurrency()
```
    Getter for TransactionCurrency. Filters the transactions in the response by a [three-character ISO-4217 currency code](/api/rest/reference/currency-codes/) for the PayPal transaction currency.
    
    Returns:
    
    Returns the String
  - setTransactionCurrency
```
public void setTransactionCurrency(String transactionCurrency)
```
    Setter for TransactionCurrency. Filters the transactions in the response by a [three-character ISO-4217 currency code](/api/rest/reference/currency-codes/) for the PayPal transaction currency.
    
    Parameters:
    
    transactionCurrency - Value for String
  - getPaymentInstrumentType
```
public String getPaymentInstrumentType()
```
    Getter for PaymentInstrumentType. Filters the transactions in the response by a payment instrument type. Value is either: CREDITCARD. Returns a direct credit card transaction with a corresponding value. DEBITCARD. Returns a debit card transaction with a corresponding value. If you omit this parameter, the API does not apply this filter.
    
    Returns:
    
    Returns the String
  - setPaymentInstrumentType
```
public void setPaymentInstrumentType(String paymentInstrumentType)
```
    Setter for PaymentInstrumentType. Filters the transactions in the response by a payment instrument type. Value is either: CREDITCARD. Returns a direct credit card transaction with a corresponding value. DEBITCARD. Returns a debit card transaction with a corresponding value. If you omit this parameter, the API does not apply this filter.
    
    Parameters:
    
    paymentInstrumentType - Value for String
  - getStoreId
```
public String getStoreId()
```
    Getter for StoreId. Filters the transactions in the response by a store ID.
    
    Returns:
    
    Returns the String
  - setStoreId
```
public void setStoreId(String storeId)
```
    Setter for StoreId. Filters the transactions in the response by a store ID.
    
    Parameters:
    
    storeId - Value for String
  - getTerminalId
```
public String getTerminalId()
```
    Getter for TerminalId. Filters the transactions in the response by a terminal ID.
    
    Returns:
    
    Returns the String
  - setTerminalId
```
public void setTerminalId(String terminalId)
```
    Setter for TerminalId. Filters the transactions in the response by a terminal ID.
    
    Parameters:
    
    terminalId - Value for String
  - getFields
```
public String getFields()
```
    Getter for Fields. Indicates which fields appear in the response. Value is a single field or a comma-separated list of fields. The transaction_info value returns only the transaction details in the response. To include all fields in the response, specify fields=all. Valid fields are: transaction_info. The transaction information. Includes the ID of the PayPal account of the payee, the PayPal-generated transaction ID, the PayPal-generated base ID, the PayPal reference ID type, the transaction event code, the date and time when the transaction was initiated and was last updated, the transaction amounts including the PayPal fee, any discounts, insurance, the transaction status, and other information about the transaction. payer_info. The payer information. Includes the PayPal customer account ID and the payer's email address, primary phone number, name, country code, address, and whether the payer is verified or unverified. shipping_info. The shipping information. Includes the recipient's name, the shipping method for this order, the shipping address for this order, and the secondary address associated with this order. auction_info. The auction information. Includes the name of the auction site, the auction site URL, the ID of the customer who makes the purchase in the auction, and the date and time when the auction closes. cart_info. The cart information. Includes an array of item details, whether the item amount or the shipping amount already includes tax, and the ID of the invoice for PayPal-generated invoices. incentive_info. An array of incentive detail objects. Each object includes the incentive, such as a special offer or coupon, the incentive amount, and the incentive program code that identifies a merchant loyalty or incentive program. store_info. The store information. Includes the ID of the merchant store and the terminal ID for the checkout stand in the merchant store.
    
    Returns:
    
    Returns the String
  - setFields
```
public void setFields(String fields)
```
    Setter for Fields. Indicates which fields appear in the response. Value is a single field or a comma-separated list of fields. The transaction_info value returns only the transaction details in the response. To include all fields in the response, specify fields=all. Valid fields are: transaction_info. The transaction information. Includes the ID of the PayPal account of the payee, the PayPal-generated transaction ID, the PayPal-generated base ID, the PayPal reference ID type, the transaction event code, the date and time when the transaction was initiated and was last updated, the transaction amounts including the PayPal fee, any discounts, insurance, the transaction status, and other information about the transaction. payer_info. The payer information. Includes the PayPal customer account ID and the payer's email address, primary phone number, name, country code, address, and whether the payer is verified or unverified. shipping_info. The shipping information. Includes the recipient's name, the shipping method for this order, the shipping address for this order, and the secondary address associated with this order. auction_info. The auction information. Includes the name of the auction site, the auction site URL, the ID of the customer who makes the purchase in the auction, and the date and time when the auction closes. cart_info. The cart information. Includes an array of item details, whether the item amount or the shipping amount already includes tax, and the ID of the invoice for PayPal-generated invoices. incentive_info. An array of incentive detail objects. Each object includes the incentive, such as a special offer or coupon, the incentive amount, and the incentive program code that identifies a merchant loyalty or incentive program. store_info. The store information. Includes the ID of the merchant store and the terminal ID for the checkout stand in the merchant store.
    
    Parameters:
    
    fields - Value for String
  - getBalanceAffectingRecordsOnly
```
public String getBalanceAffectingRecordsOnly()
```
    Getter for BalanceAffectingRecordsOnly. Indicates whether the response includes only balance-impacting transactions or all transactions. Value is either: Y. The default. The response includes only balance transactions. N. The response includes all transactions.
    
    Returns:
    
    Returns the String
  - setBalanceAffectingRecordsOnly
```
public void setBalanceAffectingRecordsOnly(String balanceAffectingRecordsOnly)
```
    Setter for BalanceAffectingRecordsOnly. Indicates whether the response includes only balance-impacting transactions or all transactions. Value is either: Y. The default. The response includes only balance transactions. N. The response includes all transactions.
    
    Parameters:
    
    balanceAffectingRecordsOnly - Value for String
  - getPageSize
```
public Integer getPageSize()
```
    Getter for PageSize. The number of items to return in the response. So, the combination of `page=1` and `page_size=20` returns the first 20 items. The combination of `page=2` and `page_size=20` returns the next 20 items.
    
    Returns:
    
    Returns the Integer
  - setPageSize
```
public void setPageSize(Integer pageSize)
```
    Setter for PageSize. The number of items to return in the response. So, the combination of `page=1` and `page_size=20` returns the first 20 items. The combination of `page=2` and `page_size=20` returns the next 20 items.
    
    Parameters:
    
    pageSize - Value for Integer
  - getPage
```
public Integer getPage()
```
    Getter for Page. The zero-relative start index of the entire list of items that are returned in the response. So, the combination of `page=1` and `page_size=20` returns the first 20 items.
    
    Returns:
    
    Returns the Integer
  - setPage
```
public void setPage(Integer page)
```
    Setter for Page. The zero-relative start index of the entire list of items that are returned in the response. So, the combination of `page=1` and `page_size=20` returns the first 20 items.
    
    Parameters:
    
    page - Value for Integer
  - toString
```
public String toString()
```
    Converts this SearchTransactionsInput into string format.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    String representation of this class
  - toBuilder
```
public SearchTransactionsInput.Builder toBuilder()
```
    Builds a new SearchTransactionsInput.Builder object. Creates the instance with the state of the current model.
    
    Returns:
    
    a new SearchTransactionsInput.Builder object

Class SearchTransactionsInput

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

SearchTransactionsInput

SearchTransactionsInput

Method Detail

getStartDate

setStartDate

getEndDate

setEndDate

getTransactionId

setTransactionId

getTransactionType

setTransactionType

getTransactionStatus

setTransactionStatus

getTransactionAmount

setTransactionAmount

getTransactionCurrency

setTransactionCurrency

getPaymentInstrumentType

setPaymentInstrumentType

getStoreId

setStoreId

getTerminalId

setTerminalId

getFields

setFields

getBalanceAffectingRecordsOnly

setBalanceAffectingRecordsOnly

getPageSize

setPageSize

getPage

setPage

toString

toBuilder