com.mangopay.core.APIs

Interface DisputeApi

All Known Implementing Classes:

DisputeApiImpl

public interface DisputeApi

Created by thepa on 18-Jan-17.

Method Summary

Modifier and Type	Method and Description
Dispute	closeDispute(java.lang.String disputeId) Closes dispute.
Dispute	contestDispute(Money contestedFunds, java.lang.String disputeId) Contests dispute.
DisputeDocument	createDisputeDocument(DisputeDocument disputeDocument, java.lang.String disputeId) Creates document for dispute.
DisputeDocument	createDisputeDocument(java.lang.String idempotencyKey, DisputeDocument disputeDocument, java.lang.String disputeId) Creates document for dispute.
java.util.List<DocumentPageConsult>	createDisputeDocumentConsult(java.lang.String documentId) Creates temporary URLs where each page of a dispute document can be viewed.
void	createDisputePage(java.lang.String disputeId, java.lang.String documentId, byte[] binaryData) Creates document's page for dispute.
void	createDisputePage(java.lang.String disputeId, java.lang.String documentId, java.lang.String filePath) Creates document's page for dispute.
void	createDisputePage(java.lang.String idempotencyKey, java.lang.String disputeId, java.lang.String documentId, byte[] binaryData) Creates document's page for dispute.
void	createDisputePage(java.lang.String idempotencyKey, java.lang.String disputeId, java.lang.String documentId, java.lang.String filePath) Creates document's page for dispute.
Transfer	createSettlementTransfer(SettlementTransfer settlementTransfer, java.lang.String repudiationId) Creates settlement transfer.
Transfer	createSettlementTransfer(java.lang.String idempotencyKey, SettlementTransfer settlementTransfer, java.lang.String repudiationId) Creates settlement transfer.
Dispute	get(java.lang.String disputeId) Gets dispute.
java.util.List<Dispute>	getAll() Gets all disputes.
java.util.List<Dispute>	getAll(Pagination pagination, FilterDisputes filters, Sorting sorting) Gets all disputes.
java.util.List<Dispute>	getDisputesForUser(java.lang.String userId, Pagination pagination, FilterDisputes filters, Sorting sorting) Gets user's disputes.
java.util.List<Dispute>	getDisputesForWallet(java.lang.String walletId, Pagination pagination, FilterDisputes filters, Sorting sorting) Gets dispute's documents for wallet.
java.util.List<Dispute>	getDisputesWithPendingSettlement() Get disputes that need settling
java.util.List<Dispute>	getDisputesWithPendingSettlement(Pagination pagination, Sorting sorting) Get disputes that need settling
DisputeDocument	getDocument(java.lang.String documentId) Gets dispute's document.
java.util.List<DisputeDocument>	getDocumentsForClient(Pagination pagination, FilterDisputeDocuments filters, Sorting sorting) Gets dispute's documents for client.
java.util.List<DisputeDocument>	getDocumentsForDispute(java.lang.String disputeId, Pagination pagination, FilterDisputeDocuments filters, Sorting sorting) Gets documents for dispute.
Repudiation	getRepudiation(java.lang.String repudiationId) Deprecated. use RepudiationApi.getRepudiation(String) instead
java.util.List<Transaction>	getTransactions(java.lang.String disputeId, Pagination pagination, FilterTransactions filters, Sorting sorting) Gets dispute's transactions.
Dispute	resubmitDispute(java.lang.String disputeId) Resubmits dispute.
DisputeDocument	submitDisputeDocument(DisputeDocument disputeDocument, java.lang.String disputeId) Submits dispute document.
Dispute	updateTag(java.lang.String tag, java.lang.String disputeId) Updates dispute's tag.

Method Detail

get

Dispute get(java.lang.String disputeId)
     throws java.lang.Exception

Gets dispute.

Parameters:

disputeId - Dispute identifier.

Returns:

Dispute instance returned from API.

Throws:

java.lang.Exception

getAll

java.util.List<Dispute> getAll(Pagination pagination,
                               FilterDisputes filters,
                               Sorting sorting)
                        throws java.lang.Exception

Gets all disputes.

Parameters:

pagination - Pagination.

filters - Filters.

sorting - Sorting.

Returns:

List of Dispute instances returned from API.

Throws:

java.lang.Exception

getAll

java.util.List<Dispute> getAll()
                        throws java.lang.Exception

Gets all disputes.

Returns:

List of Dispute instances returned from API.

Throws:

java.lang.Exception

getTransactions

java.util.List<Transaction> getTransactions(java.lang.String disputeId,
                                            Pagination pagination,
                                            FilterTransactions filters,
                                            Sorting sorting)
                                     throws java.lang.Exception

Gets dispute's transactions.

Parameters:

disputeId - Dispute identifier.

pagination - Pagination.

filters - Filters.

sorting - Sorting.

Returns:

List of Transaction instances returned from API.

Throws:

java.lang.Exception

getDisputesForWallet

java.util.List<Dispute> getDisputesForWallet(java.lang.String walletId,
                                             Pagination pagination,
                                             FilterDisputes filters,
                                             Sorting sorting)
                                      throws java.lang.Exception

Gets dispute's documents for wallet.

Parameters:

walletId - Wallet identifier.

pagination - Pagination.

filters - Filters.

sorting - Sorting.

Returns:

List of dispute instances returned from API.

Throws:

java.lang.Exception

getDisputesForUser

java.util.List<Dispute> getDisputesForUser(java.lang.String userId,
                                           Pagination pagination,
                                           FilterDisputes filters,
                                           Sorting sorting)
                                    throws java.lang.Exception

Gets user's disputes.

Parameters:

userId - User identifier.

pagination - Pagination.

filters - Filters.

sorting - Sorting.

Returns:

List of Dispute instances returned from API.

Throws:

java.lang.Exception

getDocument

DisputeDocument getDocument(java.lang.String documentId)
                     throws java.lang.Exception

Gets dispute's document.

Parameters:

documentId - Dispute document identifier.

Returns:

Dispute's document instance returned from API.

Throws:

java.lang.Exception

getDocumentsForDispute

java.util.List<DisputeDocument> getDocumentsForDispute(java.lang.String disputeId,
                                                       Pagination pagination,
                                                       FilterDisputeDocuments filters,
                                                       Sorting sorting)
                                                throws java.lang.Exception

Gets documents for dispute.

Parameters:

disputeId - Dispute identifier.

pagination - Pagination.

filters - Filters.

sorting - Sorting.

Returns:

List of DisputeDocument instances returned from API.

Throws:

java.lang.Exception

getDocumentsForClient

java.util.List<DisputeDocument> getDocumentsForClient(Pagination pagination,
                                                      FilterDisputeDocuments filters,
                                                      Sorting sorting)
                                               throws java.lang.Exception

Gets dispute's documents for client.

Parameters:

pagination - Pagination.

filters - Filters.

sorting - Sorting.

Returns:

List of dispute documents returned from API.

Throws:

java.lang.Exception

getRepudiation

@Deprecated
Repudiation getRepudiation(java.lang.String repudiationId)
                                throws java.lang.Exception

Deprecated. use RepudiationApi.getRepudiation(String) instead

Gets repudiation.

Parameters:

repudiationId - Repudiation identifier.

Returns:

Repudiation instance returned from API.

Throws:

java.lang.Exception

createSettlementTransfer

Transfer createSettlementTransfer(SettlementTransfer settlementTransfer,
                                  java.lang.String repudiationId)
                           throws java.lang.Exception

Creates settlement transfer.

Parameters:

settlementTransfer - Settlement transfer.

repudiationId - Repudiation identifier.

Returns:

Transfer instance returned from API.

Throws:

java.lang.Exception

createSettlementTransfer

Transfer createSettlementTransfer(java.lang.String idempotencyKey,
                                  SettlementTransfer settlementTransfer,
                                  java.lang.String repudiationId)
                           throws java.lang.Exception

Creates settlement transfer.

Parameters:

idempotencyKey - idempotency key for this request.

settlementTransfer - Settlement transfer.

repudiationId - Repudiation identifier.

Returns:

Transfer instance returned from API.

Throws:

java.lang.Exception

getDisputesWithPendingSettlement

java.util.List<Dispute> getDisputesWithPendingSettlement()
                                                  throws java.lang.Exception

Get disputes that need settling

Returns:

a list of Disputes

Throws:

java.lang.Exception

getDisputesWithPendingSettlement

java.util.List<Dispute> getDisputesWithPendingSettlement(Pagination pagination,
                                                         Sorting sorting)
                                                  throws java.lang.Exception

Get disputes that need settling

Parameters:

pagination - Pagination object

sorting - Sorting object

Returns:

a list of Disputes

Throws:

java.lang.Exception

updateTag

Dispute updateTag(java.lang.String tag,
                  java.lang.String disputeId)
           throws java.lang.Exception

Updates dispute's tag.

Parameters:

tag - New tag text.

disputeId - Dispute identifier.

Returns:

Dispute instance returned from API.

Throws:

java.lang.Exception

submitDisputeDocument

DisputeDocument submitDisputeDocument(DisputeDocument disputeDocument,
                                      java.lang.String disputeId)
                               throws java.lang.Exception

Submits dispute document.

Parameters:

disputeDocument - Dispute document to be submitted.

disputeId - Dispute identifier.

Returns:

Dispute document instance returned from API.

Throws:

java.lang.Exception

contestDispute

Dispute contestDispute(Money contestedFunds,
                       java.lang.String disputeId)
                throws java.lang.Exception

Contests dispute.

Parameters:

contestedFunds - Contested funds.

disputeId - Dispute identifier.

Returns:

Dispute instance returned from API.

Throws:

java.lang.Exception

resubmitDispute

Dispute resubmitDispute(java.lang.String disputeId)
                 throws java.lang.Exception

Resubmits dispute.

Parameters:

disputeId - Dispute identifier.

Returns:

Dispute instance returned from API.

Throws:

java.lang.Exception

closeDispute

Dispute closeDispute(java.lang.String disputeId)
              throws java.lang.Exception

Closes dispute.

Parameters:

disputeId - Dispute identifier.

Returns:

Dispute instance returned from API.

Throws:

java.lang.Exception

createDisputeDocument

DisputeDocument createDisputeDocument(DisputeDocument disputeDocument,
                                      java.lang.String disputeId)
                               throws java.lang.Exception

Creates document for dispute.

Parameters:

disputeDocument - Dispute document to be created.

disputeId - Dispute identifier.

Returns:

Dispute document returned from API.

Throws:

java.lang.Exception

createDisputeDocument

DisputeDocument createDisputeDocument(java.lang.String idempotencyKey,
                                      DisputeDocument disputeDocument,
                                      java.lang.String disputeId)
                               throws java.lang.Exception

Creates document for dispute.

Parameters:

idempotencyKey - idempotency key for this request.

disputeDocument - Dispute document to be created.

disputeId - Dispute identifier.

Returns:

Dispute document returned from API.

Throws:

java.lang.Exception

createDisputePage

void createDisputePage(java.lang.String disputeId,
                       java.lang.String documentId,
                       byte[] binaryData)
                throws java.lang.Exception

Creates document's page for dispute.

Parameters:

disputeId - Dispute identifier.

documentId - Dispute document identifier.

binaryData - The byte array the DisputePage will be created from.

Throws:

java.lang.Exception

createDisputePage

void createDisputePage(java.lang.String idempotencyKey,
                       java.lang.String disputeId,
                       java.lang.String documentId,
                       byte[] binaryData)
                throws java.lang.Exception

Creates document's page for dispute.

Parameters:

idempotencyKey - idempotency key for this request.

disputeId - Dispute identifier.

documentId - Dispute document identifier.

binaryData - The byte array the DisputePage will be created from.

Throws:

java.lang.Exception

createDisputePage

void createDisputePage(java.lang.String disputeId,
                       java.lang.String documentId,
                       java.lang.String filePath)
                throws java.lang.Exception

Creates document's page for dispute.

Parameters:

disputeId - Dispute identifier.

documentId - Dispute document identifier.

filePath - Path to the file the DisputePage will be created from.

Throws:

java.io.IOException

java.lang.Exception

createDisputePage

void createDisputePage(java.lang.String idempotencyKey,
                       java.lang.String disputeId,
                       java.lang.String documentId,
                       java.lang.String filePath)
                throws java.lang.Exception

Creates document's page for dispute.

Parameters:

idempotencyKey - idempotency key for this request.

disputeId - Dispute identifier.

documentId - Dispute document identifier.

filePath - Path to the file the DisputePage will be created from.

Throws:

java.io.IOException

java.lang.Exception

createDisputeDocumentConsult

java.util.List<DocumentPageConsult> createDisputeDocumentConsult(java.lang.String documentId)
                                                          throws java.lang.Exception

Creates temporary URLs where each page of a dispute document can be viewed.

Parameters:

documentId - Identification of the document whose pages to view

Returns:

List of consults for viewing the dispute document's pages

Throws:

java.lang.Exception