Package api

Class DisputesApi

java.lang.Object

api.DisputesApi

public class DisputesApi
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
class	DisputesApi.APIlistDisputeEvidenceRequest
class	DisputesApi.APIlistDisputesAdjustmentsRequest
class	DisputesApi.APIlistDisputesRequest

Constructor Summary

Constructors

Constructor	Description
DisputesApi()
DisputesApi(FinixClient finixClient)

Method Summary

Modifier and Type	Method	Description
DisputeEvidence	createDisputeEvidence(String disputeId, CreateDisputeEvidenceRequest createDisputeEvidenceRequest)	Upload Dispute Evidence Upload dispute evidence for a `Dispute`.
okhttp3.Call	createDisputeEvidenceAsync(String disputeId, CreateDisputeEvidenceRequest createDisputeEvidenceRequest, ApiCallback<DisputeEvidence> _callback)	Upload Dispute Evidence (asynchronously) Upload dispute evidence for a `Dispute`.
okhttp3.Call	createDisputeEvidenceCall(String disputeId, CreateDisputeEvidenceRequest createDisputeEvidenceRequest, ApiCallback _callback)	Build call for createDisputeEvidence
ApiResponse<DisputeEvidence>	createDisputeEvidenceWithHttpInfo(String disputeId, CreateDisputeEvidenceRequest createDisputeEvidenceRequest)	Upload Dispute Evidence Upload dispute evidence for a `Dispute`.
Dispute	get(String disputeId)	Fetch a Dispute Retrieve the details of a previously created `Dispute`.
String	getCustomBaseUrl()
okhttp3.Call	getDisputeAsync(String disputeId, ApiCallback<Dispute> _callback)	Fetch a Dispute (asynchronously) Retrieve the details of a previously created `Dispute`.
okhttp3.Call	getDisputeCall(String disputeId, ApiCallback _callback)	Build call for getDispute
DisputeEvidence	getDisputeEvidence(String disputeId, String evidenceId)	Fetch Dispute Evidence Fetch evidence uploaded for a `Dispute`.
okhttp3.Call	getDisputeEvidenceAsync(String disputeId, String evidenceId, ApiCallback<DisputeEvidence> _callback)	Fetch Dispute Evidence (asynchronously) Fetch evidence uploaded for a `Dispute`.
okhttp3.Call	getDisputeEvidenceCall(String disputeId, String evidenceId, ApiCallback _callback)	Build call for getDisputeEvidence
ApiResponse<DisputeEvidence>	getDisputeEvidenceWithHttpInfo(String disputeId, String evidenceId)	Fetch Dispute Evidence Fetch evidence uploaded for a `Dispute`.
ApiResponse<Dispute>	getDisputeWithHttpInfo(String disputeId)	Fetch a Dispute Retrieve the details of a previously created `Dispute`.
FinixClient	getFinixClient()
int	getHostIndex()
FinixList	list(ListDisputesQueryParams listDisputesQueryParams)	List Disputes Retrieve a list of `Disputes`.
FinixList	listDisputeEvidenceByDisputeId(String disputeId, ListDisputeEvidenceQueryParams listDisputeEvidenceQueryParams)	List Dispute Evidence Retrieve a list of dispute evidence for a `Dispute`.
FinixList	listDisputesAdjustments(String disputeId, ListDisputesAdjustmentsQueryParams listDisputesAdjustmentsQueryParams)	Fetch Dispute Adjustment Transfers List the adjustment `Transfers` for a `Dispute`.
void	setCustomBaseUrl(String customBaseUrl)
void	setFinixClient(FinixClient finixClient)
void	setHostIndex(int hostIndex)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DisputesApi

public DisputesApi()

DisputesApi

public DisputesApi(FinixClient finixClient)

Method Detail

getFinixClient

public FinixClient getFinixClient()

setFinixClient

public void setFinixClient(FinixClient finixClient)

getHostIndex

public int getHostIndex()

setHostIndex

public void setHostIndex(int hostIndex)

getCustomBaseUrl

public String getCustomBaseUrl()

setCustomBaseUrl

public void setCustomBaseUrl(String customBaseUrl)

createDisputeEvidenceCall

public okhttp3.Call createDisputeEvidenceCall(String disputeId,
                                              CreateDisputeEvidenceRequest createDisputeEvidenceRequest,
                                              ApiCallback _callback)
                                       throws ApiException

Build call for createDisputeEvidence

Parameters:

disputeId - ID of `Dispute` to mange evidence for. (required)

createDisputeEvidenceRequest - (optional)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details:

Status Code	Description	Response Headers
201	Single Evidence object	* finix-apiuser-role - * date - * x-request-id -
401	Authentication information is missing or invalid	* finix-apiuser-role - * date - * x-request-id -
403	Forbidden	* finix-apiuser-role - * date - * x-request-id -
404	Object does not exist	* finix-apiuser-role - * date - * x-request-id -
406	Not Acceptable	* finix-apiuser-role - * date - * x-request-id -

createDisputeEvidence

public DisputeEvidence createDisputeEvidence(String disputeId,
                                             CreateDisputeEvidenceRequest createDisputeEvidenceRequest)
                                      throws ApiException

Upload Dispute Evidence Upload dispute evidence for a `Dispute`. - You can upload up to 8 files; the total size of the uploaded files combined cannot exceed 10 MB. - The allowed file formats include JPG, PNG, PDF, or TIFF. - Individual PNG and JPEG files can't exceed 50 KB; PDF and TIFF files can't exceed 1 MB.

Parameters:

disputeId - ID of `Dispute` to mange evidence for. (required)

createDisputeEvidenceRequest - (optional)

Returns:

DisputeEvidence

Throws:

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

Http Response Details:

Status Code	Description	Response Headers
201	Single Evidence object	* finix-apiuser-role - * date - * x-request-id -
401	Authentication information is missing or invalid	* finix-apiuser-role - * date - * x-request-id -
403	Forbidden	* finix-apiuser-role - * date - * x-request-id -
404	Object does not exist	* finix-apiuser-role - * date - * x-request-id -
406	Not Acceptable	* finix-apiuser-role - * date - * x-request-id -

createDisputeEvidenceWithHttpInfo

public ApiResponse<DisputeEvidence> createDisputeEvidenceWithHttpInfo(String disputeId,
                                                                      CreateDisputeEvidenceRequest createDisputeEvidenceRequest)
                                                               throws ApiException

Upload Dispute Evidence Upload dispute evidence for a `Dispute`. - You can upload up to 8 files; the total size of the uploaded files combined cannot exceed 10 MB. - The allowed file formats include JPG, PNG, PDF, or TIFF. - Individual PNG and JPEG files can't exceed 50 KB; PDF and TIFF files can't exceed 1 MB.

Parameters:

disputeId - ID of `Dispute` to mange evidence for. (required)

createDisputeEvidenceRequest - (optional)

Returns:

ApiResponse<DisputeEvidence>

Throws:

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

Http Response Details:

Status Code	Description	Response Headers
201	Single Evidence object	* finix-apiuser-role - * date - * x-request-id -
401	Authentication information is missing or invalid	* finix-apiuser-role - * date - * x-request-id -
403	Forbidden	* finix-apiuser-role - * date - * x-request-id -
404	Object does not exist	* finix-apiuser-role - * date - * x-request-id -
406	Not Acceptable	* finix-apiuser-role - * date - * x-request-id -

createDisputeEvidenceAsync

public okhttp3.Call createDisputeEvidenceAsync(String disputeId,
                                               CreateDisputeEvidenceRequest createDisputeEvidenceRequest,
                                               ApiCallback<DisputeEvidence> _callback)
                                        throws ApiException

Upload Dispute Evidence (asynchronously) Upload dispute evidence for a `Dispute`. - You can upload up to 8 files; the total size of the uploaded files combined cannot exceed 10 MB. - The allowed file formats include JPG, PNG, PDF, or TIFF. - Individual PNG and JPEG files can't exceed 50 KB; PDF and TIFF files can't exceed 1 MB.

Parameters:

disputeId - ID of `Dispute` to mange evidence for. (required)

createDisputeEvidenceRequest - (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

Http Response Details:

Status Code	Description	Response Headers
201	Single Evidence object	* finix-apiuser-role - * date - * x-request-id -
401	Authentication information is missing or invalid	* finix-apiuser-role - * date - * x-request-id -
403	Forbidden	* finix-apiuser-role - * date - * x-request-id -
404	Object does not exist	* finix-apiuser-role - * date - * x-request-id -
406	Not Acceptable	* finix-apiuser-role - * date - * x-request-id -

getDisputeCall

public okhttp3.Call getDisputeCall(String disputeId,
                                   ApiCallback _callback)
                            throws ApiException

Build call for getDispute

Parameters:

disputeId - ID of `Dispute` to fetch. (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details:

Status Code	Description	Response Headers
200	Single Dispute object	* finix-apiuser-role - * date - * x-request-id -
401	Authentication information is missing or invalid	* finix-apiuser-role - * date - * x-request-id -
403	Forbidden	* finix-apiuser-role - * date - * x-request-id -
404	Object does not exist	* finix-apiuser-role - * date - * x-request-id -
406	Not Acceptable	* finix-apiuser-role - * date - * x-request-id -

get

public Dispute get(String disputeId)
            throws ApiException

Fetch a Dispute Retrieve the details of a previously created `Dispute`.

Parameters:

disputeId - ID of `Dispute` to fetch. (required)

Returns:

Dispute

Throws:

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

Http Response Details:

Status Code	Description	Response Headers
200	Single Dispute object	* finix-apiuser-role - * date - * x-request-id -
401	Authentication information is missing or invalid	* finix-apiuser-role - * date - * x-request-id -
403	Forbidden	* finix-apiuser-role - * date - * x-request-id -
404	Object does not exist	* finix-apiuser-role - * date - * x-request-id -
406	Not Acceptable	* finix-apiuser-role - * date - * x-request-id -

getDisputeWithHttpInfo

public ApiResponse<Dispute> getDisputeWithHttpInfo(String disputeId)
                                            throws ApiException

Fetch a Dispute Retrieve the details of a previously created `Dispute`.

Parameters:

disputeId - ID of `Dispute` to fetch. (required)

Returns:

ApiResponse<Dispute>

Throws:

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

Http Response Details:

Status Code	Description	Response Headers
200	Single Dispute object	* finix-apiuser-role - * date - * x-request-id -
401	Authentication information is missing or invalid	* finix-apiuser-role - * date - * x-request-id -
403	Forbidden	* finix-apiuser-role - * date - * x-request-id -
404	Object does not exist	* finix-apiuser-role - * date - * x-request-id -
406	Not Acceptable	* finix-apiuser-role - * date - * x-request-id -

getDisputeAsync

public okhttp3.Call getDisputeAsync(String disputeId,
                                    ApiCallback<Dispute> _callback)
                             throws ApiException

Fetch a Dispute (asynchronously) Retrieve the details of a previously created `Dispute`.

Parameters:

disputeId - ID of `Dispute` to fetch. (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

Http Response Details:

Status Code	Description	Response Headers
200	Single Dispute object	* finix-apiuser-role - * date - * x-request-id -
401	Authentication information is missing or invalid	* finix-apiuser-role - * date - * x-request-id -
403	Forbidden	* finix-apiuser-role - * date - * x-request-id -
404	Object does not exist	* finix-apiuser-role - * date - * x-request-id -
406	Not Acceptable	* finix-apiuser-role - * date - * x-request-id -

getDisputeEvidenceCall

public okhttp3.Call getDisputeEvidenceCall(String disputeId,
                                           String evidenceId,
                                           ApiCallback _callback)
                                    throws ApiException

Build call for getDisputeEvidence

Parameters:

disputeId - ID of `Dispute` to fetch evidence for. (required)

evidenceId - ID of `evidence` to fetch. (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details:

Status Code	Description	Response Headers
200	Single Evidence object	* finix-apiuser-role - * date - * x-request-id -
401	Authentication information is missing or invalid	* finix-apiuser-role - * date - * x-request-id -
403	Forbidden	* finix-apiuser-role - * date - * x-request-id -
404	Object does not exist	* finix-apiuser-role - * date - * x-request-id -
406	Not Acceptable	* finix-apiuser-role - * date - * x-request-id -

getDisputeEvidence

public DisputeEvidence getDisputeEvidence(String disputeId,
                                          String evidenceId)
                                   throws ApiException

Fetch Dispute Evidence Fetch evidence uploaded for a `Dispute`. If you don't have the Finix Dashboard available, you can fetch the evidence to review the `status` of the upload to confirm the evidence got sent to the processor.

Parameters:

disputeId - ID of `Dispute` to fetch evidence for. (required)

evidenceId - ID of `evidence` to fetch. (required)

Returns:

DisputeEvidence

Throws:

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

Http Response Details:

Status Code	Description	Response Headers
200	Single Evidence object	* finix-apiuser-role - * date - * x-request-id -
401	Authentication information is missing or invalid	* finix-apiuser-role - * date - * x-request-id -
403	Forbidden	* finix-apiuser-role - * date - * x-request-id -
404	Object does not exist	* finix-apiuser-role - * date - * x-request-id -
406	Not Acceptable	* finix-apiuser-role - * date - * x-request-id -

getDisputeEvidenceWithHttpInfo

public ApiResponse<DisputeEvidence> getDisputeEvidenceWithHttpInfo(String disputeId,
                                                                   String evidenceId)
                                                            throws ApiException

Fetch Dispute Evidence Fetch evidence uploaded for a `Dispute`. If you don't have the Finix Dashboard available, you can fetch the evidence to review the `status` of the upload to confirm the evidence got sent to the processor.

Parameters:

disputeId - ID of `Dispute` to fetch evidence for. (required)

evidenceId - ID of `evidence` to fetch. (required)

Returns:

ApiResponse<DisputeEvidence>

Throws:

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

Http Response Details:

Status Code	Description	Response Headers
200	Single Evidence object	* finix-apiuser-role - * date - * x-request-id -
401	Authentication information is missing or invalid	* finix-apiuser-role - * date - * x-request-id -
403	Forbidden	* finix-apiuser-role - * date - * x-request-id -
404	Object does not exist	* finix-apiuser-role - * date - * x-request-id -
406	Not Acceptable	* finix-apiuser-role - * date - * x-request-id -

getDisputeEvidenceAsync

public okhttp3.Call getDisputeEvidenceAsync(String disputeId,
                                            String evidenceId,
                                            ApiCallback<DisputeEvidence> _callback)
                                     throws ApiException

Fetch Dispute Evidence (asynchronously) Fetch evidence uploaded for a `Dispute`. If you don't have the Finix Dashboard available, you can fetch the evidence to review the `status` of the upload to confirm the evidence got sent to the processor.

Parameters:

disputeId - ID of `Dispute` to fetch evidence for. (required)

evidenceId - ID of `evidence` to fetch. (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

Http Response Details:

Status Code	Description	Response Headers
200	Single Evidence object	* finix-apiuser-role - * date - * x-request-id -
401	Authentication information is missing or invalid	* finix-apiuser-role - * date - * x-request-id -
403	Forbidden	* finix-apiuser-role - * date - * x-request-id -
404	Object does not exist	* finix-apiuser-role - * date - * x-request-id -
406	Not Acceptable	* finix-apiuser-role - * date - * x-request-id -

listDisputeEvidenceByDisputeId

public FinixList listDisputeEvidenceByDisputeId(String disputeId,
                                                ListDisputeEvidenceQueryParams listDisputeEvidenceQueryParams)
                                         throws ApiException

List Dispute Evidence Retrieve a list of dispute evidence for a `Dispute`.

Parameters:

disputeId - ID of `Dispute` to mange evidence for. (required)

Returns:

APIlistDisputeEvidenceRequest

Throws:

ApiException

Http Response Details:

Status Code	Description	Response Headers
200	List of Evidence objects	* finix-apiuser-role - * date - * x-request-id -
401	Authentication information is missing or invalid	* finix-apiuser-role - * date - * x-request-id -
403	Forbidden	* finix-apiuser-role - * date - * x-request-id -
404	Object does not exist	* finix-apiuser-role - * date - * x-request-id -
406	Not Acceptable	* finix-apiuser-role - * date - * x-request-id -

list

public FinixList list(ListDisputesQueryParams listDisputesQueryParams)
               throws ApiException

List Disputes Retrieve a list of `Disputes`.

Returns:

APIlistDisputesRequest

Throws:

ApiException

Http Response Details:

Status Code	Description	Response Headers
200	List of Disputes	* finix-apiuser-role - * date - * x-request-id -
401	Authentication information is missing or invalid	* finix-apiuser-role - * date - * x-request-id -
403	Forbidden	* finix-apiuser-role - * date - * x-request-id -
406	Not Acceptable	* finix-apiuser-role - * date - * x-request-id -

listDisputesAdjustments

public FinixList listDisputesAdjustments(String disputeId,
                                         ListDisputesAdjustmentsQueryParams listDisputesAdjustmentsQueryParams)
                                  throws ApiException

Fetch Dispute Adjustment Transfers List the adjustment `Transfers` for a `Dispute`. Depending on the stage of the `Dispute`, different adjustment `Transfer` subtypes can be applied. There are four available subtypes for adjustment `Transfers` in `Disputes`: <ul><li><strong>PLATFORM\\_CREDIT</strong><li><strong>MERCHANT\\_DEBIT</strong><li><strong>MERCHANT\\_CREDIT</strong><li><strong>PLATFORM\\_DEBIT</strong></ul>

Parameters:

disputeId - ID of the `Dispute` resource. (required)

Returns:

APIlistDisputesAdjustmentsRequest

Throws:

ApiException

Http Response Details:

Status Code	Description	Response Headers
200	List of adjustment_transfer objects	-
401	Unauthorized	-
403	Forbidden	* finix-apiuser-role - * date - * x-request-id -
404	Object does not exist	* finix-apiuser-role - * date - * x-request-id -
406	Not Acceptable	* finix-apiuser-role - * date - * x-request-id -