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

ApiClients

class ApiClients 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(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
Client
Get()

Get client information

Client
Update(Client $client)

Save client

UploadLogo(ClientLogoUpload $logoUpload, string|null $idempotencyKey = null)

Upload a logo for client.

UploadLogoFromFile(string $file, $idempotencyKey = null)

Upload a logo for client from file.

Wallet[]
GetWallets(FundsType $fundsType = null, Sorting $sorting = null)

View your client wallets. To see your fees or credit wallets for each currency set second $fundsType parameter.

Wallet
GetWallet(FundsType $fundsType, CurrencyIso $currencyIso)

View one of your client wallets (fees or credit) with a particular currency.

Transaction[]
GetWalletTransactions(FundsType $fundsType = null, CurrencyIso $currencyIso = null, Pagination $pagination = null, FilterTransactions $filter = null)

View the transactions linked to your client wallets (fees and credit)

CreateBankAccount($bankAccount, $idempotencyKey = null)

No description

CreatePayOut($payOut, $idempotencyKey = null)

No description

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 15
Client Get()

Get client information

Return Value

Client

Client object returned from API

at line 25
Client Update(Client $client)

Save client

Parameters

Client $client

Client object to save

Return Value

Client

Client object returned from API

Upload a logo for client.

Only GIF, PNG, JPG, JPEG, BMP, PDF and DOC formats are accepted, and file must be less than about 7MB

Parameters

ClientLogoUpload $logoUpload

ClientLogoUpload object
string|null $idempotencyKey

at line 61
UploadLogoFromFile(string $file, $idempotencyKey = null)

Upload a logo for client from file.

Only GIF, PNG, JPG, JPEG, BMP, PDF and DOC formats are accepted, and file must be less than about 7MB

Parameters

string $file

Path of file with logo
$idempotencyKey

Exceptions

Exception

at line 95
Wallet[] GetWallets(FundsType $fundsType = null, Sorting $sorting = null)

View your client wallets. To see your fees or credit wallets for each currency set second $fundsType parameter.

Parameters

FundsType $fundsType

FundsType enum
Sorting $sorting

Sorting object

Return Value

Wallet[]

List with your client wallets

at line 118
Wallet GetWallet(FundsType $fundsType, CurrencyIso $currencyIso)

View one of your client wallets (fees or credit) with a particular currency.

Parameters

FundsType $fundsType

FundsType enum
CurrencyIso $currencyIso

CurrencyIso enum

Return Value

Wallet

Wallet (fees or credit) with a particular currency

at line 154
Transaction[] GetWalletTransactions(FundsType $fundsType = null, CurrencyIso $currencyIso = null, Pagination $pagination = null, FilterTransactions $filter = null)

View the transactions linked to your client wallets (fees and credit)

Parameters

FundsType $fundsType

FundsType enum
CurrencyIso $currencyIso

CurrencyIso enum
Pagination $pagination

Pagination object
FilterTransactions $filter

Object to filter data

Return Value

Transaction[]

Transactions linked to your client wallets (fees and credit)

at line 177
CreateBankAccount($bankAccount, $idempotencyKey = null)

No description

Parameters

$bankAccount
$idempotencyKey

at line 182
CreatePayOut($payOut, $idempotencyKey = null)

No description

Parameters

$payOut
$idempotencyKey