PaymentRequest (Apruve Client for Java 0.4.2 API)

java.lang.Object
- com.apruve.models.PaymentRequest

```
public class PaymentRequest
extends Object
```
A request to a payer for payment on behalf of a shopper. In order to provide the prospective payer with as much information as possible, and enhance the likelihood for approval, as much detail should be provided as possible.

Author:

neal

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class PaymentRequest.PaymentRequestStatus

Nested Classes
Modifier and Type	Class and Description
`static class`	`PaymentRequest.PaymentRequestStatus`

Field Summary

Fields
Modifier and Type Field and Description

protected static String PAYMENT_REQUESTS_PATH

Fields
Modifier and Type	Field and Description
`protected static String`	`PAYMENT_REQUESTS_PATH`

Constructor Summary

Constructors
Modifier Constructor and Description

protected PaymentRequest()

PaymentRequest(String merchantId)

Constructors
Modifier	Constructor and Description
`protected`	`PaymentRequest()`
	`PaymentRequest(String merchantId)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addLineItem(LineItem item)`
`ApruveResponse<PaymentRequestUpdateResponse>`	`finalizeRequest()` Invokes the "finalize" action on the payment request.
`static ApruveResponse<PaymentRequest>`	`get(String paymentRequestId)` Fetches the PaymentRequest with the given ID from Apruve.
`Integer`	`getAmountCents()`
`URL`	`getApiUrl()`
`Date`	`getCreatedAt()`
`Currency`	`getCurrency()`
`Date`	`getExpiresAt()`
`static String`	`getFinalizePath(String paymentRequestId)`
`String`	`getId()`
`List<LineItem>`	`getLineItems()`
`String`	`getMerchantId()`
`String`	`getMerchantOrderId()`
`static String`	`getPaymentRequestsPath()`
`Integer`	`getShippingCents()`
`PaymentRequest.PaymentRequestStatus`	`getStatus()`
`Integer`	`getTaxCents()`
`Date`	`getUpdatedAt()`
`String`	`getUsername()`
`URL`	`getViewUrl()`
`void`	`setAmountCents(Integer amountCents)`
`void`	`setAmountCents(String amountCents)`
`protected void`	`setApiUrl(String apiUrl)`
`protected void`	`setApiUrl(URL apiUrl)`
`protected void`	`setCreatedAt(Date createdAt)`
`protected void`	`setCreatedAt(String createdAt)`
`void`	`setCurrency(Currency currency)`
`void`	`setCurrency(String currency)`
`void`	`setExpiresAt(Date expiresAt)`
`void`	`setExpiresAt(String expiresAt)`
`void`	`setId(String id)`
`void`	`setLineItems(List<LineItem> lineItems)`
`void`	`setMerchantId(String merchantId)`
`void`	`setMerchantOrderId(String merchantOrderId)`
`void`	`setShippingCents(Integer shippingCents)`
`void`	`setShippingCents(String shippingCents)`
`protected void`	`setStatus(PaymentRequest.PaymentRequestStatus status)`
`void`	`setStatus(String status)`
`void`	`setTaxCents(Integer taxCents)`
`void`	`setTaxCents(String taxCents)`
`protected void`	`setUpdatedAt(Date updatedAt)`
`protected void`	`setUpdatedAt(String updatedAt)`
`protected void`	`setViewUrl(String viewUrl)`
`protected void`	`setViewUrl(URL viewUrl)`
`String`	`toJson()` Returns the JSON string for a PaymentRequest.
`String`	`toSecureHash()` For use by merchants, and depends on proper initialization of ApruveClient.
`String`	`toString()`
`protected String`	`toValueString()`
`ApruveResponse<PaymentRequestUpdateResponse>`	`update()` Updates the PaymentRequest state at Apruve to match the current object state.

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

- Field Detail
  - PAYMENT_REQUESTS_PATH
```
protected static final String PAYMENT_REQUESTS_PATH
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - PaymentRequest
```
protected PaymentRequest()
```
  - PaymentRequest
```
public PaymentRequest(String merchantId)
```
- Method Detail
  - get
```
public static ApruveResponse<PaymentRequest> get(String paymentRequestId)
```
    Fetches the PaymentRequest with the given ID from Apruve.
    
    Parameters:
    
    paymentRequestId -
    
    Returns:
    
    PaymentRequest, or null if not found
    
    See Also:
    
    https://www.apruve.com/doc/developers/rest-api/
  - update
```
public ApruveResponse<PaymentRequestUpdateResponse> update()
```
    Updates the PaymentRequest state at Apruve to match the current object state.
    Only the following fields are updated by this API call, and then only if the payment request status is NEW:
    - merchantOrderId
    - amountCents
    - taxCents
    - shippingCents
    Changes to any other fields are ignored.
    Returns:
    
    PaymentRequestUpdateResponse, or null if the request does not exist
    
    See Also:
    
    https://www.apruve.com/doc/developers/rest-api/
  - finalizeRequest
```
public ApruveResponse<PaymentRequestUpdateResponse> finalizeRequest()
```
    Invokes the "finalize" action on the payment request. This allows you to escalate the request to the payer without creating a Payment first.
    
    Returns:
    
    PaymentRequestUpdateResponse, or null if the request does not exist
    
    See Also:
    
    https://www.apruve.com/doc/developers/rest-api/
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - toJson
```
public String toJson()
```
    Returns the JSON string for a PaymentRequest. Notably, this is suitable for merchants using the apruve.js JavaScript library. Use this to populate the value of apruve.paymentRequest.
    
    Parameters:
    
    paymentRequest -
    
    Returns:
  - toSecureHash
```
public String toSecureHash()
```
    For use by merchants, and depends on proper initialization of ApruveClient. Returns the secure hash for a PaymentRequest, suitable for use with the property of apruve.js JavaScript library on a merchant checkout page. Use this to populate the value of apruve.secureHash.
    
    Returns:
  - toValueString
```
protected String toValueString()
```
  - addLineItem
```
public void addLineItem(LineItem item)
```
  - getId
```
public String getId()
```
    Returns:
    
    the id
  - setId
```
public void setId(String id)
```
    Parameters:
    
    id - the id to set
  - getMerchantId
```
public String getMerchantId()
```
    Returns:
    
    the merchantId
  - setMerchantId
```
public void setMerchantId(String merchantId)
```
    Parameters:
    
    merchantId - the merchantId to set
  - getStatus
```
public PaymentRequest.PaymentRequestStatus getStatus()
```
    Returns:
    
    the status
  - setStatus
```
protected void setStatus(PaymentRequest.PaymentRequestStatus status)
```
    Parameters:
    
    status - the status to set
  - setStatus
```
public void setStatus(String status)
```
    Parameters:
    
    status - the status to set
  - getMerchantOrderId
```
public String getMerchantOrderId()
```
    Returns:
    
    the merchantOrderId
  - setMerchantOrderId
```
public void setMerchantOrderId(String merchantOrderId)
```
    Parameters:
    
    merchantOrderId - the merchantOrderId to set
  - getAmountCents
```
public Integer getAmountCents()
```
    Returns:
    
    the amountCents
  - setAmountCents
```
public void setAmountCents(Integer amountCents)
```
    Parameters:
    
    amountCents - the amountCents to set
  - setAmountCents
```
public void setAmountCents(String amountCents)
```
    Parameters:
    
    amountCents - the amountCents to set
  - getTaxCents
```
public Integer getTaxCents()
```
    Returns:
    
    the taxCents
  - setTaxCents
```
public void setTaxCents(Integer taxCents)
```
    Parameters:
    
    taxCents - the taxCents to set
  - setTaxCents
```
public void setTaxCents(String taxCents)
```
    Parameters:
    
    taxCents - the taxCents to set
  - getShippingCents
```
public Integer getShippingCents()
```
    Returns:
    
    the shippingCents
  - setShippingCents
```
public void setShippingCents(Integer shippingCents)
```
    Parameters:
    
    shippingCents - the shippingCents to set
  - setShippingCents
```
public void setShippingCents(String shippingCents)
```
    Parameters:
    
    shippingCents -
  - getCurrency
```
public Currency getCurrency()
```
    Returns:
    
    the currency
  - setCurrency
```
public void setCurrency(Currency currency)
```
    Parameters:
    
    currency - the currency to set
  - setCurrency
```
public void setCurrency(String currency)
```
    Parameters:
    
    currency - the currency to set
  - getLineItems
```
public List<LineItem> getLineItems()
```
    Returns:
    
    the lineItems
  - setLineItems
```
public void setLineItems(List<LineItem> lineItems)
```
    Parameters:
    
    lineItems - the lineItems to set
  - getApiUrl
```
public URL getApiUrl()
```
    Returns:
    
    the apiUrl
  - setApiUrl
```
protected void setApiUrl(URL apiUrl)
```
    Parameters:
    
    apiUrl - the apiUrl to set
  - setApiUrl
```
protected void setApiUrl(String apiUrl)
                  throws MalformedURLException
```
    Parameters:
    
    apiUrl - the apiUrl to set
    
    Throws:
    
    MalformedURLException
  - getViewUrl
```
public URL getViewUrl()
```
    Returns:
    
    the viewUrl
  - setViewUrl
```
protected void setViewUrl(URL viewUrl)
```
    Parameters:
    
    viewUrl - the viewUrl to set
  - setViewUrl
```
protected void setViewUrl(String viewUrl)
                   throws MalformedURLException
```
    Parameters:
    
    viewUrl - the viewUrl to set
    
    Throws:
    
    MalformedURLException
  - getCreatedAt
```
public Date getCreatedAt()
```
    Returns:
    
    the createdAt
  - setCreatedAt
```
protected void setCreatedAt(Date createdAt)
```
    Parameters:
    
    createdAt - the createdAt to set
  - setCreatedAt
```
protected void setCreatedAt(String createdAt)
```
    Parameters:
    
    createdAt - the createdAt to set
  - getUpdatedAt
```
public Date getUpdatedAt()
```
    Returns:
    
    the updatedAt
  - setUpdatedAt
```
protected void setUpdatedAt(Date updatedAt)
```
    Parameters:
    
    updatedAt - the updatedAt to set
  - setUpdatedAt
```
protected void setUpdatedAt(String updatedAt)
```
    Parameters:
    
    updatedAt -
  - getExpiresAt
```
public Date getExpiresAt()
```
    Returns:
    
    the expiresAt
  - setExpiresAt
```
public void setExpiresAt(Date expiresAt)
```
    Parameters:
    
    expiresAt -
  - setExpiresAt
```
public void setExpiresAt(String expiresAt)
```
    Parameters:
    
    expiresAt -
  - getUsername
```
public String getUsername()
```
    Returns:
    
    the username
  - getPaymentRequestsPath
```
public static String getPaymentRequestsPath()
```
  - getFinalizePath
```
public static String getFinalizePath(String paymentRequestId)
```

Class PaymentRequest

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

PAYMENT_REQUESTS_PATH

Constructor Detail

PaymentRequest

PaymentRequest

Method Detail

get

update

finalizeRequest

toString

toJson

toSecureHash

toValueString

addLineItem

getId

setId

getMerchantId

setMerchantId

getStatus

setStatus

setStatus

getMerchantOrderId

setMerchantOrderId

getAmountCents

setAmountCents

setAmountCents

getTaxCents

setTaxCents

setTaxCents

getShippingCents

setShippingCents

setShippingCents

getCurrency

setCurrency

setCurrency

getLineItems

setLineItems

getApiUrl

setApiUrl

setApiUrl

getViewUrl

setViewUrl

setViewUrl

getCreatedAt

setCreatedAt

setCreatedAt

getUpdatedAt

setUpdatedAt

setUpdatedAt

getExpiresAt

setExpiresAt

setExpiresAt

getUsername

getPaymentRequestsPath

getFinalizePath