1. class
  2. MangoPay
  3. \
  4. ApiDisputes

ApiDisputes

class ApiDisputes extends ApiBase (View source)

Class ApiDisputes

Properties

protected MangoPayApi $_root

Root/parent instance that holds the OAuthToken and Configuration instance

 from  ApiBase

Methods

mixed
getLogger()

No description

from  ApiBase
__construct(MangoPayApi $root)

Constructor Root/parent instance that holds the OAuthToken and Configuration instance

from  ApiBase
string
GetRequestUrl(string $key)

Get URL for REST Mango Pay API

from  ApiBase
RequestType
GetRequestType(string $key)

Get request type for REST Mango Pay API

from  ApiBase
object
CreateObject(string $methodKey, object $entity, object $responseClassName = null, string $entityId = null, $subEntityId = null, $idempotencyKey = null)

Create object in API

from  ApiBase
object
GetObject(string $methodKey, object $responseClassName, $firstEntityId = null, $secondEntityId = null, $thirdEntityId = null, $clientIdRequired = true)

Get entity object from API

from  ApiBase
object[]
GetList(string $methodKey, Pagination $pagination, object $responseClassName = null, string $entityId = null, object $filter = null, Sorting $sorting = null, $secondEntityId = null, $clientIdRequired = true)

Get lst with entities object from API

from  ApiBase
object
SaveObject(string $methodKey, object $entity, object $responseClassName = null, $secondEntityId = null, $thirdEntityId = null)

Save object in API

from  ApiBase
object
ExecutePostRequest($methodKey, $entity, $responseClassName, $entityId = null)

Executes a POST request

from  ApiBase
Error
CastResponseToError(object $response)

Cast response object to an error object

from  ApiBase
CastResponseToEntity(object $response, string $entityClassName, $asDependentObject = false)

Cast response object to entity object

from  ApiBase
array
BuildRequestData(object $entity)

Get array with request data

from  ApiBase
GetObjectForIdempotencyUrl($url)

No description

from  ApiBase
Dispute
Get(string $disputeId)

Gets dispute

Dispute[]
GetAll(Pagination $pagination = null, Sorting $sorting = null, FilterDisputes $filter = null)

Get all disputes

Dispute[]
GetPendingSettlements(Pagination $pagination = null, Sorting $sorting = null)

List Disputes that need settling

Dispute
Update(Dispute $dispute)

Updates dispute's tag

Dispute
ContestDispute(string $disputeId, Money $contestedFunds)

Contests dispute

Dispute
ResubmitDispute(string $disputeId)

This method is used to resubmit a Dispute if it is reopened requiring more docs

Dispute
CloseDispute(string $disputeId)

Close dispute

Transaction[]
GetTransactions(string $disputeId, Pagination $pagination = null, Sorting $sorting = null, FilterTransactions $filter = null)

Gets dispute's transactions

Dispute[]
GetDisputesForWallet(string $walletId, Pagination $pagination = null, Sorting $sorting = null, FilterDisputes $filter = null)

Gets dispute's documents for wallet

Dispute[]
GetDisputesForUser(string $userId, Pagination $pagination = null, Sorting $sorting = null, FilterDisputes $filter = null)

Gets user's disputes

Repudiation
GetRepudiation(string $repudiationId)

Gets repudiation

Transfer
CreateSettlementTransfer(SettlementTransfer $settlementTransfer, string $repudiationId, $idempotencyKey = null)

Creates settlement transfer

SettlementTransfer
GetSettlementTransfer(string $settlementTransferId)

Gets settlement transfer

DisputeDocument[]
GetDocumentsForDispute(string $disputeId, Pagination $pagination = null, Sorting $sorting = null, FilterDisputeDocuments $filter = null)

Gets documents for dispute

DisputeDocument
UpdateDisputeDocument(string $disputeId, DisputeDocument $disputeDocument)

Update dispute document

DisputeDocument
CreateDisputeDocument(string $disputeId, DisputeDocument $disputeDocument, $idempotencyKey = null)

Creates document for dispute

CreateDisputeDocumentPage(string $disputeId, string $disputeDocumentId, DisputeDocumentPage $disputeDocumentPage, $idempotencyKey = null)

Creates document's page for dispute

CreateDisputeDocumentPageFromFile(string $disputeId, string $disputeDocumentId, string $file, $idempotencyKey = null)

Creates document's page for dispute from file

Details

in ApiBase at line 19
protected mixed getLogger()

No description

Return Value

mixed

in ApiBase at line 256
__construct(MangoPayApi $root)

Constructor Root/parent instance that holds the OAuthToken and Configuration instance

Parameters

MangoPayApi $root

in ApiBase at line 266
protected string GetRequestUrl(string $key)

Get URL for REST Mango Pay API

Parameters

string $key

Key with data

Return Value

string

in ApiBase at line 276
protected RequestType GetRequestType(string $key)

Get request type for REST Mango Pay API

Parameters

string $key

Key with data

Return Value

RequestType

in ApiBase at line 289
protected object CreateObject(string $methodKey, object $entity, object $responseClassName = null, string $entityId = null, $subEntityId = null, $idempotencyKey = null)

Create object in API

Parameters

string $methodKey

Key with request data
object $entity

Entity object
object $responseClassName

Name of entity class from response
string $entityId

Entity identifier
$subEntityId
$idempotencyKey

Return Value

object

Response data

in ApiBase at line 324
protected object GetObject(string $methodKey, object $responseClassName, $firstEntityId = null, $secondEntityId = null, $thirdEntityId = null, $clientIdRequired = true)

Get entity object from API

Parameters

string $methodKey

Key with request data
object $responseClassName

Name of entity class from response
$firstEntityId
$secondEntityId
$thirdEntityId
$clientIdRequired

Return Value

object

Response data

Exceptions

Exception

in ApiBase at line 354
protected object[] GetList(string $methodKey, Pagination $pagination, object $responseClassName = null, string $entityId = null, object $filter = null, Sorting $sorting = null, $secondEntityId = null, $clientIdRequired = true)

Get lst with entities object from API

Parameters

string $methodKey

Key with request data
Pagination $pagination

Pagination object
object $responseClassName

Name of entity class from response
string $entityId

Entity identifier
object $filter

Object to filter data
Sorting $sorting

Object to sorting data
$secondEntityId
$clientIdRequired

Return Value

object[]

Response data

in ApiBase at line 391
protected object SaveObject(string $methodKey, object $entity, object $responseClassName = null, $secondEntityId = null, $thirdEntityId = null)

Save object in API

Parameters

string $methodKey

Key with request data
object $entity

Entity object to save
object $responseClassName

Name of entity class from response
$secondEntityId
$thirdEntityId

Return Value

object

Response data

in ApiBase at line 426
protected object ExecutePostRequest($methodKey, $entity, $responseClassName, $entityId = null)

Executes a POST request

Parameters

$methodKey

Key with request data
$entity

Entity object
$responseClassName

Name of entity class from response
$entityId

Entity identifier

Return Value

object

Response data

in ApiBase at line 451
protected Error CastResponseToError(object $response)

Cast response object to an error object

Parameters

object $response

Object from API response

Return Value

Error

The error

in ApiBase at line 487
protected CastResponseToEntity(object $response, string $entityClassName, $asDependentObject = false)

Cast response object to entity object

Parameters

object $response

Object from API response
string $entityClassName

Name of entity class to cast
$asDependentObject

in ApiBase at line 574
protected array BuildRequestData(object $entity)

Get array with request data

Parameters

object $entity

Entity object to send as request data

Return Value

array

in ApiBase at line 631
protected GetObjectForIdempotencyUrl($url)

No description

Parameters

$url

at line 20
Dispute Get(string $disputeId)

Gets dispute

Parameters

string $disputeId

Dispute identifier

Return Value

Dispute

Dispute instance returned from API

at line 32
Dispute[] GetAll(Pagination $pagination = null, Sorting $sorting = null, FilterDisputes $filter = null)

Get all disputes

Parameters

Pagination $pagination

Pagination object
Sorting $sorting

Object to sorting data
FilterDisputes $filter

Filtering object

Return Value

Dispute[]

Array with disputes

at line 43
Dispute[] GetPendingSettlements(Pagination $pagination = null, Sorting $sorting = null)

List Disputes that need settling

Parameters

Pagination $pagination

Pagination object
Sorting $sorting

Object to sorting data

Return Value

Dispute[]

Array with disputes

at line 53
Dispute Update(Dispute $dispute)

Updates dispute's tag

Parameters

Dispute $dispute

Dispute object to update

Return Value

Dispute

Transfer instance returned from API

at line 64
Dispute ContestDispute(string $disputeId, Money $contestedFunds)

Contests dispute

Parameters

string $disputeId

Dispute identifier
Money $contestedFunds

Contested funds

Return Value

Dispute

Dispute instance returned from API

at line 77
Dispute ResubmitDispute(string $disputeId)

This method is used to resubmit a Dispute if it is reopened requiring more docs

Parameters

string $disputeId

Dispute identifier

Return Value

Dispute

Dispute instance returned from API

at line 89
Dispute CloseDispute(string $disputeId)

Close dispute

Parameters

string $disputeId

Dispute identifier

Return Value

Dispute

Dispute instance returned from API

at line 105
Transaction[] GetTransactions(string $disputeId, Pagination $pagination = null, Sorting $sorting = null, FilterTransactions $filter = null)

Gets dispute's transactions

Parameters

string $disputeId

Dispute identifier
Pagination $pagination

Pagination object
Sorting $sorting

Object to sorting data
FilterTransactions $filter

Filtering object

Return Value

Transaction[]

List of Transaction instances returned from API

Exceptions

Exception

at line 119
Dispute[] GetDisputesForWallet(string $walletId, Pagination $pagination = null, Sorting $sorting = null, FilterDisputes $filter = null)

Gets dispute's documents for wallet

Parameters

string $walletId

Wallet identifier
Pagination $pagination

Pagination object
Sorting $sorting

Object to sorting data
FilterDisputes $filter

Filtering object

Return Value

Dispute[]

List of dispute instances returned from API

Exceptions

Exception

at line 133
Dispute[] GetDisputesForUser(string $userId, Pagination $pagination = null, Sorting $sorting = null, FilterDisputes $filter = null)

Gets user's disputes

Parameters

string $userId

User identifier
Pagination $pagination

Pagination object
Sorting $sorting

Object to sorting data
FilterDisputes $filter

Filtering object

Return Value

Dispute[]

List of Dispute instances returned from API

Exceptions

Exception

at line 143
Repudiation GetRepudiation(string $repudiationId)

Gets repudiation

Parameters

string $repudiationId

Repudiation identifier

Return Value

Repudiation

Repudiation instance returned from API

at line 154
Transfer CreateSettlementTransfer(SettlementTransfer $settlementTransfer, string $repudiationId, $idempotencyKey = null)

Creates settlement transfer

Parameters

SettlementTransfer $settlementTransfer

Settlement transfer
string $repudiationId

Repudiation identifier
$idempotencyKey

Return Value

Transfer

Transfer instance returned from API

at line 164
SettlementTransfer GetSettlementTransfer(string $settlementTransferId)

Gets settlement transfer

Parameters

string $settlementTransferId

Settlement transfer identifier

Return Value

SettlementTransfer

Transfer instance returned from API

at line 178
DisputeDocument[] GetDocumentsForDispute(string $disputeId, Pagination $pagination = null, Sorting $sorting = null, FilterDisputeDocuments $filter = null)

Gets documents for dispute

Parameters

string $disputeId

Dispute identifier
Pagination $pagination

Pagination object
Sorting $sorting

Object to sorting data
FilterDisputeDocuments $filter

Filtering object

Return Value

DisputeDocument[]

List of DisputeDocument instances returned from API

Exceptions

Exception

at line 189
DisputeDocument UpdateDisputeDocument(string $disputeId, DisputeDocument $disputeDocument)

Update dispute document

Parameters

string $disputeId

Dispute identifier
DisputeDocument $disputeDocument

Dispute document to save

Return Value

DisputeDocument

Document returned from API

at line 200
DisputeDocument CreateDisputeDocument(string $disputeId, DisputeDocument $disputeDocument, $idempotencyKey = null)

Creates document for dispute

Parameters

string $disputeId

Dispute identifier
DisputeDocument $disputeDocument

Dispute document to be created
$idempotencyKey

Return Value

DisputeDocument

Dispute document returned from API

at line 211
CreateDisputeDocumentPage(string $disputeId, string $disputeDocumentId, DisputeDocumentPage $disputeDocumentPage, $idempotencyKey = null)

Creates document's page for dispute

Parameters

string $disputeId

Dispute identifier
string $disputeDocumentId

Dispute document identifier
DisputeDocumentPage $disputeDocumentPage

Dispute document page object
$idempotencyKey

at line 229
CreateDisputeDocumentPageFromFile(string $disputeId, string $disputeDocumentId, string $file, $idempotencyKey = null)

Creates document's page for dispute from file

Parameters

string $disputeId

Dispute identifier
string $disputeDocumentId

Dispute document identifier
string $file

File path
$idempotencyKey

Exceptions

Exception