Payment (Apruve Client for Java 0.4.2 API)

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

```
public class Payment
extends Object
```
A Payment represents a request to collect funds in accordance with a PaymentRequest.

Author:

Todd Cochran

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class Payment.PaymentStatus

Nested Classes
Modifier and Type	Class and Description
`static class`	`Payment.PaymentStatus`

Constructor Summary

Constructors
Modifier Constructor and Description

protected Payment()

Payment(String paymentRequestId, Integer amountCents)

Constructors
Modifier	Constructor and Description
`protected`	`Payment()`
	`Payment(String paymentRequestId, Integer amountCents)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ApruveResponse<PaymentCreateResponse>`	`create()` Create a new Payment on the Apruve servers.
`static ApruveResponse<Payment>`	`get(String paymentRequestId, String paymentId)` Fetches the Payment with the given ID from Apruve.
`static ApruveResponse<List<Payment>>`	`getAll(String paymentRequestId)` Fetches all Payments belonging to the PaymentRequest with the specified ID.
`Integer`	`getAmountCents()`
`URL`	`getApiUrl()`
`Date`	`getCreatedAt()`
`Currency`	`getCurrency()`
`String`	`getId()`
`String`	`getMerchantNotes()`
`List<PaymentItem>`	`getPaymentItems()`
`String`	`getPaymentRequestId()`
`static String`	`getPaymentsPath(String paymentRequestId)`
`Payment.PaymentStatus`	`getStatus()`
`Date`	`getUpdatedAt()`
`String`	`getUrl(ApruveClient client)`
`URL`	`getViewUrl()`
`void`	`setAmountCents(Integer amountCents)`
`void`	`setApiUrl(String apiUrl)`
`void`	`setApiUrl(URL apiUrl)`
`void`	`setCreatedAt(Date createdAt)`
`void`	`setCurrency(Currency currency)`
`void`	`setCurrency(String currency)`
`void`	`setId(String id)`
`void`	`setMerchantNotes(String merchantNotes)`
`void`	`setPaymentItems(List<PaymentItem> paymentItems)`
`void`	`setPaymentRequestId(String paymentRequestId)`
`void`	`setStatus(Payment.PaymentStatus status)`
`void`	`setUpdatedAt(Date updatedAt)`
`void`	`setViewUrl(String viewUrl)`
`void`	`setViewUrl(URL viewUrl)`
`String`	`toJson()`

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

- Constructor Detail
  - Payment
```
protected Payment()
```
  - Payment
```
public Payment(String paymentRequestId,
               Integer amountCents)
```
    Parameters:
    
    paymentRequestId -
    
    amountCents -
- Method Detail
  - get
```
public static ApruveResponse<Payment> get(String paymentRequestId,
                                          String paymentId)
```
    Fetches the Payment with the given ID from Apruve.
    
    Parameters:
    
    paymentRequestId - The ID of the PaymentRequest that owns the Payment
    
    paymentId - The ID of the Payment
    
    Returns:
    
    Payment, or null if not found
    
    See Also:
    
    https://www.apruve.com/doc/developers/rest-api/
  - getAll
```
public static ApruveResponse<List<Payment>> getAll(String paymentRequestId)
```
    Fetches all Payments belonging to the PaymentRequest with the specified ID.
    
    Parameters:
    
    paymentRequestId - The ID of the PaymentRequest that owns the Payment
    
    Returns:
    
    List of Payments, or null if the PaymentRequest is not found
    
    See Also:
    
    https://www.apruve.com/doc/developers/rest-api/
  - create
```
public ApruveResponse<PaymentCreateResponse> create()
```
    Create a new Payment on the Apruve servers.
    
    Returns:
    
    PaymentCreateResponse
    
    See Also:
    
    https://www.apruve.com/doc/developers/rest-api/
  - toJson
```
public String toJson()
```
  - getUrl
```
public String getUrl(ApruveClient client)
```
  - getId
```
public String getId()
```
    Returns:
    
    the id
  - setId
```
public void setId(String id)
```
    Parameters:
    
    id - the id to set
  - getPaymentRequestId
```
public String getPaymentRequestId()
```
    Returns:
    
    the paymentRequestId
  - setPaymentRequestId
```
public void setPaymentRequestId(String paymentRequestId)
```
    Parameters:
    
    paymentRequestId - the paymentRequestId to set
  - getAmountCents
```
public Integer getAmountCents()
```
    Returns:
    
    the amountCents
  - setAmountCents
```
public void setAmountCents(Integer amountCents)
```
    Parameters:
    
    amountCents - the amountCents to set
  - 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
  - getMerchantNotes
```
public String getMerchantNotes()
```
    Returns:
    
    the merchantNotes
  - setMerchantNotes
```
public void setMerchantNotes(String merchantNotes)
```
    Parameters:
    
    merchantNotes - the merchantNotes to set
  - getApiUrl
```
public URL getApiUrl()
```
    Returns:
    
    the apiUrl
  - setApiUrl
```
public void setApiUrl(URL apiUrl)
```
    Parameters:
    
    apiUrl - the apiUrl to set
  - setApiUrl
```
public void setApiUrl(String apiUrl)
               throws MalformedURLException
```
    Parameters:
    
    apiUrl -
    
    Throws:
    
    MalformedURLException
  - getViewUrl
```
public URL getViewUrl()
```
    Returns:
    
    the viewUrl
  - setViewUrl
```
public void setViewUrl(URL viewUrl)
```
    Parameters:
    
    viewUrl - the viewUrl to set
  - setViewUrl
```
public void setViewUrl(String viewUrl)
                throws MalformedURLException
```
    Parameters:
    
    viewUrl -
    
    Throws:
    
    MalformedURLException
  - getCreatedAt
```
public Date getCreatedAt()
```
    Returns:
    
    the createdAt
  - setCreatedAt
```
public void setCreatedAt(Date createdAt)
```
    Parameters:
    
    createdAt - the createdAt to set
  - getUpdatedAt
```
public Date getUpdatedAt()
```
    Returns:
    
    the updatedAt
  - setUpdatedAt
```
public void setUpdatedAt(Date updatedAt)
```
    Parameters:
    
    updatedAt - the updatedAt to set
  - getStatus
```
public Payment.PaymentStatus getStatus()
```
  - setStatus
```
public void setStatus(Payment.PaymentStatus status)
```
  - getPaymentItems
```
public List<PaymentItem> getPaymentItems()
```
  - setPaymentItems
```
public void setPaymentItems(List<PaymentItem> paymentItems)
```
  - getPaymentsPath
```
public static String getPaymentsPath(String paymentRequestId)
```

Class Payment

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Payment

Payment

Method Detail

get

getAll

create

toJson

getUrl

getId

setId

getPaymentRequestId

setPaymentRequestId

getAmountCents

setAmountCents

getCurrency

setCurrency

setCurrency

getMerchantNotes

setMerchantNotes

getApiUrl

setApiUrl

setApiUrl

getViewUrl

setViewUrl

setViewUrl

getCreatedAt

setCreatedAt

getUpdatedAt

setUpdatedAt

getStatus

setStatus

getPaymentItems

setPaymentItems

getPaymentsPath