ChecksApi (checks 1.1.0 API)

java.lang.Object
- com.acheck21.checks.api.ChecksApi

```
public class ChecksApi
extends Object
```

Constructor Summary

Constructors
Constructor and Description

ChecksApi()

ChecksApi(ApiClient apiClient)

Constructors
Constructor and Description
`ChecksApi()`
`ChecksApi(ApiClient apiClient)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Check`	`createCheck(String clientId, CreateCheckParams values)` Create a new Check transaction.
`com.squareup.okhttp.Call`	`createCheckAsync(String clientId, CreateCheckParams values, ApiCallback<Check> callback)` Create a new Check transaction.
`ApiResponse<Check>`	`createCheckWithHttpInfo(String clientId, CreateCheckParams values)` Create a new Check transaction.
`ReturnsQueryResult`	`findReturns(String clientId, Date startDate, Date endDate, Integer offset, Integer limit)` Retrieve returns for given date(s) or yesterday if no dates are given
`com.squareup.okhttp.Call`	`findReturnsAsync(String clientId, Date startDate, Date endDate, Integer offset, Integer limit, ApiCallback<ReturnsQueryResult> callback)` Retrieve returns for given date(s) or yesterday if no dates are given (asynchronously)
`ApiResponse<ReturnsQueryResult>`	`findReturnsWithHttpInfo(String clientId, Date startDate, Date endDate, Integer offset, Integer limit)` Retrieve returns for given date(s) or yesterday if no dates are given
`ApiClient`	`getApiClient()`
`List<Attachment>`	`getAttachments(String clientId, Long documentId)` Retrieve Attachments for a specific Check.
`com.squareup.okhttp.Call`	`getAttachmentsAsync(String clientId, Long documentId, ApiCallback<List<Attachment>> callback)` Retrieve Attachments for a specific Check.
`ApiResponse<List<Attachment>>`	`getAttachmentsWithHttpInfo(String clientId, Long documentId)` Retrieve Attachments for a specific Check.
`Check`	`getCheck(String clientId, Long documentId)` Retrieve a specific Check
`com.squareup.okhttp.Call`	`getCheckAsync(String clientId, Long documentId, ApiCallback<Check> callback)` Retrieve a specific Check (asynchronously)
`CheckQueryResult`	`getChecks(String clientId, Date startDate, Date endDate, List<String> currentStates, Integer offset, Integer limit)` Search for all Checks that belong to a merchant account.
`com.squareup.okhttp.Call`	`getChecksAsync(String clientId, Date startDate, Date endDate, List<String> currentStates, Integer offset, Integer limit, ApiCallback<CheckQueryResult> callback)` Search for all Checks that belong to a merchant account.
`ApiResponse<CheckQueryResult>`	`getChecksWithHttpInfo(String clientId, Date startDate, Date endDate, List<String> currentStates, Integer offset, Integer limit)` Search for all Checks that belong to a merchant account.
`ApiResponse<Check>`	`getCheckWithHttpInfo(String clientId, Long documentId)` Retrieve a specific Check
`List<ModelReturn>`	`getReturns(String clientId, Long documentId)` Retrieve returns for a specific Check.
`com.squareup.okhttp.Call`	`getReturnsAsync(String clientId, Long documentId, ApiCallback<List<ModelReturn>> callback)` Retrieve returns for a specific Check.
`ApiResponse<List<ModelReturn>>`	`getReturnsWithHttpInfo(String clientId, Long documentId)` Retrieve returns for a specific Check.
`List<Settlement>`	`getSettlements(String clientId, Long documentId)` Retrieve Settlements for a specific Check.
`com.squareup.okhttp.Call`	`getSettlementsAsync(String clientId, Long documentId, ApiCallback<List<Settlement>> callback)` Retrieve Settlements for a specific Check.
`ApiResponse<List<Settlement>>`	`getSettlementsWithHttpInfo(String clientId, Long documentId)` Retrieve Settlements for a specific Check.
`void`	`setApiClient(ApiClient apiClient)`
`ValidationResult`	`validateCheck(String clientId, ValidateCheckParams values)` Validates a check.
`com.squareup.okhttp.Call`	`validateCheckAsync(String clientId, ValidateCheckParams values, ApiCallback<ValidationResult> callback)` Validates a check.
`ApiResponse<ValidationResult>`	`validateCheckWithHttpInfo(String clientId, ValidateCheckParams values)` Validates a check.
`void`	`voidCheck(String clientId, Long documentId)` Delete a specific Check transaction.
`com.squareup.okhttp.Call`	`voidCheckAsync(String clientId, Long documentId, ApiCallback<Void> callback)` Delete a specific Check transaction.
`ApiResponse<Void>`	`voidCheckWithHttpInfo(String clientId, Long documentId)` Delete a specific Check transaction.

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

Constructor Detail

ChecksApi
```
public ChecksApi()
```

ChecksApi
```
public ChecksApi(ApiClient apiClient)
```

Method Detail

getApiClient
```
public ApiClient getApiClient()
```

setApiClient

public void setApiClient(ApiClient apiClient)

createCheck
```
public Check createCheck(String clientId,
                         CreateCheckParams values)
                  throws ApiException
```
Create a new Check transaction.

Parameters:

clientId - (required)

values - (optional)

Returns:

Check

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

createCheckWithHttpInfo

public ApiResponse<Check> createCheckWithHttpInfo(String clientId,
                                                  CreateCheckParams values)
                                           throws ApiException

Create a new Check transaction.

Parameters:: clientId - (required); values - (optional)
Returns:: ApiResponse<Check>
Throws:: ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

createCheckAsync

public com.squareup.okhttp.Call createCheckAsync(String clientId,
                                                 CreateCheckParams values,
                                                 ApiCallback<Check> callback)
                                          throws ApiException

Create a new Check transaction. (asynchronously)

Parameters:: clientId - (required); values - (optional); callback - The callback to be executed when the API call finishes
Returns:: The request call
Throws:: ApiException - If fail to process the API call, e.g. serializing the request body object

findReturns

public ReturnsQueryResult findReturns(String clientId,
                                      Date startDate,
                                      Date endDate,
                                      Integer offset,
                                      Integer limit)
                               throws ApiException

Retrieve returns for given date(s) or yesterday if no dates are given

Parameters:: clientId - (required); startDate - (optional); endDate - (optional); offset - (optional); limit - (optional)
Returns:: ReturnsQueryResult
Throws:: ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

findReturnsWithHttpInfo

public ApiResponse<ReturnsQueryResult> findReturnsWithHttpInfo(String clientId,
                                                               Date startDate,
                                                               Date endDate,
                                                               Integer offset,
                                                               Integer limit)
                                                        throws ApiException

Retrieve returns for given date(s) or yesterday if no dates are given

Parameters:: clientId - (required); startDate - (optional); endDate - (optional); offset - (optional); limit - (optional)
Returns:: ApiResponse<ReturnsQueryResult>
Throws:: ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

findReturnsAsync

public com.squareup.okhttp.Call findReturnsAsync(String clientId,
                                                 Date startDate,
                                                 Date endDate,
                                                 Integer offset,
                                                 Integer limit,
                                                 ApiCallback<ReturnsQueryResult> callback)
                                          throws ApiException

Retrieve returns for given date(s) or yesterday if no dates are given (asynchronously)

Parameters:: clientId - (required); startDate - (optional); endDate - (optional); offset - (optional); limit - (optional); callback - The callback to be executed when the API call finishes
Returns:: The request call
Throws:: ApiException - If fail to process the API call, e.g. serializing the request body object

getAttachments
```
public List<Attachment> getAttachments(String clientId,
                                       Long documentId)
                                throws ApiException
```
Retrieve Attachments for a specific Check. Usually there is at most one settlement per check.

Parameters:

clientId - (required)

documentId - (required)

Returns:

List<Attachment>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

getAttachmentsWithHttpInfo

public ApiResponse<List<Attachment>> getAttachmentsWithHttpInfo(String clientId,
                                                                Long documentId)
                                                         throws ApiException

Retrieve Attachments for a specific Check. Usually there is at most one settlement per check.

Parameters:: clientId - (required); documentId - (required)
Returns:: ApiResponse<List<Attachment>>
Throws:: ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

getAttachmentsAsync

public com.squareup.okhttp.Call getAttachmentsAsync(String clientId,
                                                    Long documentId,
                                                    ApiCallback<List<Attachment>> callback)
                                             throws ApiException

Retrieve Attachments for a specific Check. Usually there is at most one settlement per check. (asynchronously)

Parameters:: clientId - (required); documentId - (required); callback - The callback to be executed when the API call finishes
Returns:: The request call
Throws:: ApiException - If fail to process the API call, e.g. serializing the request body object

getCheck
```
public Check getCheck(String clientId,
                      Long documentId)
               throws ApiException
```
Retrieve a specific Check

Parameters:

clientId - (required)

documentId - (required)

Returns:

Check

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

getCheckWithHttpInfo

public ApiResponse<Check> getCheckWithHttpInfo(String clientId,
                                               Long documentId)
                                        throws ApiException

Retrieve a specific Check

Parameters:: clientId - (required); documentId - (required)
Returns:: ApiResponse<Check>
Throws:: ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

getCheckAsync

public com.squareup.okhttp.Call getCheckAsync(String clientId,
                                              Long documentId,
                                              ApiCallback<Check> callback)
                                       throws ApiException

Retrieve a specific Check (asynchronously)

Parameters:: clientId - (required); documentId - (required); callback - The callback to be executed when the API call finishes
Returns:: The request call
Throws:: ApiException - If fail to process the API call, e.g. serializing the request body object

getChecks

public CheckQueryResult getChecks(String clientId,
                                  Date startDate,
                                  Date endDate,
                                  List<String> currentStates,
                                  Integer offset,
                                  Integer limit)
                           throws ApiException

Search for all Checks that belong to a merchant account.

Parameters:: clientId - (required); startDate - (optional); endDate - (optional); currentStates - (optional); offset - (optional); limit - (optional)
Returns:: CheckQueryResult
Throws:: ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

getChecksWithHttpInfo

public ApiResponse<CheckQueryResult> getChecksWithHttpInfo(String clientId,
                                                           Date startDate,
                                                           Date endDate,
                                                           List<String> currentStates,
                                                           Integer offset,
                                                           Integer limit)
                                                    throws ApiException

Search for all Checks that belong to a merchant account.

Parameters:: clientId - (required); startDate - (optional); endDate - (optional); currentStates - (optional); offset - (optional); limit - (optional)
Returns:: ApiResponse<CheckQueryResult>
Throws:: ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

getChecksAsync

public com.squareup.okhttp.Call getChecksAsync(String clientId,
                                               Date startDate,
                                               Date endDate,
                                               List<String> currentStates,
                                               Integer offset,
                                               Integer limit,
                                               ApiCallback<CheckQueryResult> callback)
                                        throws ApiException

Search for all Checks that belong to a merchant account. (asynchronously)

Parameters:: clientId - (required); startDate - (optional); endDate - (optional); currentStates - (optional); offset - (optional); limit - (optional); callback - The callback to be executed when the API call finishes
Returns:: The request call
Throws:: ApiException - If fail to process the API call, e.g. serializing the request body object

getReturns
```
public List<ModelReturn> getReturns(String clientId,
                                    Long documentId)
                             throws ApiException
```
Retrieve returns for a specific Check.

Parameters:

clientId - (required)

documentId - (required)

Returns:

List<ModelReturn>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

getReturnsWithHttpInfo

public ApiResponse<List<ModelReturn>> getReturnsWithHttpInfo(String clientId,
                                                             Long documentId)
                                                      throws ApiException

Retrieve returns for a specific Check.

Parameters:: clientId - (required); documentId - (required)
Returns:: ApiResponse<List<ModelReturn>>
Throws:: ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

getReturnsAsync

public com.squareup.okhttp.Call getReturnsAsync(String clientId,
                                                Long documentId,
                                                ApiCallback<List<ModelReturn>> callback)
                                         throws ApiException

Retrieve returns for a specific Check. (asynchronously)

Parameters:: clientId - (required); documentId - (required); callback - The callback to be executed when the API call finishes
Returns:: The request call
Throws:: ApiException - If fail to process the API call, e.g. serializing the request body object

getSettlements
```
public List<Settlement> getSettlements(String clientId,
                                       Long documentId)
                                throws ApiException
```
Retrieve Settlements for a specific Check. Usually there is at most one settlement per check.

Parameters:

clientId - (required)

documentId - (required)

Returns:

List<Settlement>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

getSettlementsWithHttpInfo

public ApiResponse<List<Settlement>> getSettlementsWithHttpInfo(String clientId,
                                                                Long documentId)
                                                         throws ApiException

Retrieve Settlements for a specific Check. Usually there is at most one settlement per check.

Parameters:: clientId - (required); documentId - (required)
Returns:: ApiResponse<List<Settlement>>
Throws:: ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

getSettlementsAsync

public com.squareup.okhttp.Call getSettlementsAsync(String clientId,
                                                    Long documentId,
                                                    ApiCallback<List<Settlement>> callback)
                                             throws ApiException

Retrieve Settlements for a specific Check. Usually there is at most one settlement per check. (asynchronously)

Parameters:: clientId - (required); documentId - (required); callback - The callback to be executed when the API call finishes
Returns:: The request call
Throws:: ApiException - If fail to process the API call, e.g. serializing the request body object

validateCheck
```
public ValidationResult validateCheck(String clientId,
                                      ValidateCheckParams values)
                               throws ApiException
```
Validates a check. This usually involves verifying the account exists and that there are no unpaid items (a.k.a. bounced checks) associated with the account. This is configured in the Global Gateway's client manager.

Parameters:

clientId - (required)

values - (optional)

Returns:

ValidationResult

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

validateCheckWithHttpInfo
```
public ApiResponse<ValidationResult> validateCheckWithHttpInfo(String clientId,
                                                               ValidateCheckParams values)
                                                        throws ApiException
```
Validates a check. This usually involves verifying the account exists and that there are no unpaid items (a.k.a. bounced checks) associated with the account. This is configured in the Global Gateway's client manager.

Parameters:

clientId - (required)

values - (optional)

Returns:

ApiResponse<ValidationResult>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

validateCheckAsync
```
public com.squareup.okhttp.Call validateCheckAsync(String clientId,
                                                   ValidateCheckParams values,
                                                   ApiCallback<ValidationResult> callback)
                                            throws ApiException
```
Validates a check. This usually involves verifying the account exists and that there are no unpaid items (a.k.a. bounced checks) associated with the account. This is configured in the Global Gateway's client manager. (asynchronously)

Parameters:

clientId - (required)

values - (optional)

callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

voidCheck
```
public void voidCheck(String clientId,
                      Long documentId)
               throws ApiException
```
Delete a specific Check transaction.

Parameters:

clientId - (required)

documentId - (required)

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

voidCheckWithHttpInfo

public ApiResponse<Void> voidCheckWithHttpInfo(String clientId,
                                               Long documentId)
                                        throws ApiException

Delete a specific Check transaction.

Parameters:: clientId - (required); documentId - (required)
Returns:: ApiResponse<Void>
Throws:: ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

voidCheckAsync

public com.squareup.okhttp.Call voidCheckAsync(String clientId,
                                               Long documentId,
                                               ApiCallback<Void> callback)
                                        throws ApiException

Delete a specific Check transaction. (asynchronously)

Parameters:: clientId - (required); documentId - (required); callback - The callback to be executed when the API call finishes
Returns:: The request call
Throws:: ApiException - If fail to process the API call, e.g. serializing the request body object

Class ChecksApi

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ChecksApi

ChecksApi

Method Detail

getApiClient

setApiClient

createCheck

createCheckWithHttpInfo

createCheckAsync

findReturns

findReturnsWithHttpInfo

findReturnsAsync

getAttachments

getAttachmentsWithHttpInfo

getAttachmentsAsync

getCheck

getCheckWithHttpInfo

getCheckAsync

getChecks

getChecksWithHttpInfo

getChecksAsync

getReturns

getReturnsWithHttpInfo

getReturnsAsync

getSettlements

getSettlementsWithHttpInfo

getSettlementsAsync

validateCheck

validateCheckWithHttpInfo

validateCheckAsync

voidCheck

voidCheckWithHttpInfo

voidCheckAsync