Package com.chargehound.resources

Class Disputes

java.lang.Object

com.chargehound.resources.Disputes

public class Disputes
extends java.lang.Object

Constructor Summary

Constructors

Constructor	Description
Disputes(Chargehound chargehound)

Method Summary

Modifier and Type	Method	Description
Dispute	accept(java.lang.String id)	Accepting a dispute.
Dispute	create(Dispute.CreateParams create)	Create a dispute This endpoint will return a single dispute.
DisputesList	list()	Retrieve a list of disputes.
DisputesList	list(DisputesList.Params params)	Retrieve a list of disputes.
Dispute.Response	response(java.lang.String id)	Retrieve the response for a dispute once it is available.
Dispute	retrieve(java.lang.String id)	Retrieve a dispute.
Dispute	submit(java.lang.String id)	Submitting a dispute You will want to submit the dispute through Chargehound after you recieve a webhook notification of a new dispute.
Dispute	submit(java.lang.String id, Dispute.UpdateParams update)	Submitting a dispute You will want to submit the dispute through Chargehound after you recieve a webhook notification of a new dispute.
Dispute	update(java.lang.String id, Dispute.UpdateParams update)	Updating a dispute You can update the template and the fields on a dispute.

Methods inherited from class java.lang.Object

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

Constructor Detail

Disputes

public Disputes(Chargehound chargehound)

Method Detail

retrieve

public Dispute retrieve(java.lang.String id)
                 throws ChargehoundException

Retrieve a dispute. This endpoint will return a single dispute.

Parameters:

id - A dispute id

Returns:

Dispute

Throws:

ChargehoundException - Exception on failed API request

response

public Dispute.Response response(java.lang.String id)
                          throws ChargehoundException

Retrieve the response for a dispute once it is available.

Parameters:

id - A dispute id

Returns:

Dispute

Throws:

ChargehoundException - Exception on failed API request

list

public DisputesList list()
                  throws ChargehoundException

Retrieve a list of disputes.

Returns:

DisputesList

Throws:

ChargehoundException - Exception on failed API request

list

public DisputesList list(DisputesList.Params params)
                  throws ChargehoundException

Retrieve a list of disputes. This endpoint will list all the disputes that we have synced. By default the disputes will be ordered by `created` with the most recent dispute first. `has_more` will be `true` if more results are available.

Parameters:

params - Query parameters for the list of disputes.

Returns:

DisputesList

Throws:

ChargehoundException - Exception on failed API request

accept

public Dispute accept(java.lang.String id)
               throws ChargehoundException

Accepting a dispute. Accept a dispute if you do not want to submit a response.

Parameters:

id - A dispute id

Returns:

Dispute

Throws:

ChargehoundException - Exception on failed API request

update

public Dispute update(java.lang.String id,
                      Dispute.UpdateParams update)
               throws ChargehoundException

Updating a dispute You can update the template and the fields on a dispute.

Parameters:

id - A dispute id

update - dispute update object

Returns:

Dispute

Throws:

ChargehoundException - Exception on failed API request

submit

public Dispute submit(java.lang.String id,
                      Dispute.UpdateParams update)
               throws ChargehoundException

Submitting a dispute You will want to submit the dispute through Chargehound after you recieve a webhook notification of a new dispute. With one `POST` request you can update a dispute with the evidence fields and submit the response. The response will have a `201` status if the submit was successful. The dispute will also be in the submitted state.

Parameters:

id - A dispute id

update - A dispute update object

Returns:

Dispute

Throws:

ChargehoundException - Exception on failed API request

submit

public Dispute submit(java.lang.String id)
               throws ChargehoundException

Submitting a dispute You will want to submit the dispute through Chargehound after you recieve a webhook notification of a new dispute. With one `POST` request you can update a dispute with the evidence fields and submit the response. The response will have a `201` status if the submit was successful. The dispute will also be in the submitted state.

Parameters:

id - A dispute id

Returns:

Dispute

Throws:

ChargehoundException - Exception on failed API request

create

public Dispute create(Dispute.CreateParams create)
               throws ChargehoundException

Create a dispute This endpoint will return a single dispute.

Parameters:

create - A dispute create object

Returns:

Dispute

Throws:

ChargehoundException - Exception on failed API request