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

ApiDeposits

class ApiDeposits extends ApiBase (View source)

Class to management MangoPay API for users

Properties

protected MangoPayApi $_root

Root/parent instance that holds the OAuthToken and Configuration instance

 from  ApiBase

Methods

mixed
getLogger()

No description

from  ApiBase
__construct($root)

Constructor

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
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
Deposit
Create(CreateDeposit $deposit)

Create Deposit

Deposit
Get(string $depositId)

Get Deposit

Deposit
Cancel(string $depositId, CancelDeposit $dto)

Cancel Deposit

Details

in ApiBase at line 19
protected mixed getLogger()

No description

Return Value

mixed

in ApiBase at line 242
__construct($root)

Constructor

Parameters

$root

in ApiBase at line 252
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 262
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 275
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 311
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 341
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 378
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 413
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 439
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 526
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 583
protected GetObjectForIdempotencyUrl($url)

No description

Parameters

$url

at line 15
Deposit Create(CreateDeposit $deposit)

Create Deposit

Parameters

CreateDeposit $deposit

Deposit object to save

Return Value

Deposit

Deposit object returned from API

at line 25
Deposit Get(string $depositId)

Get Deposit

Parameters

string $depositId

Deposit identifier

Return Value

Deposit

Deposit object returned from API

at line 36
Deposit Cancel(string $depositId, CancelDeposit $dto)

Cancel Deposit

Parameters

string $depositId

Deposit identifier
CancelDeposit $dto

Cancel deposit body

Return Value

Deposit

Deposit object returned from API