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

ApiPayOuts

class ApiPayOuts extends ApiBase (View source)

Class to management MangoPay API for pay-outs

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
PayOut
Create(PayOut $payOut, $idempotencyKey = null)

Create new pay-out

PayOutEligibilityResponse
CheckInstantPayoutEligibility(PayOutEligibilityRequest $payOutEligibility, $idempotencyKey = null)

This method is used to check whether or not the destination bank is eligible for instant payout.

PayOut
Get(string $payOutId)

Get pay-out object

PayOut
GetBankwire(string $payOutId)

Get bankwire pay-out object

Refund[]
GetRefunds(string $payOutId, Pagination $pagination = null, FilterRefunds $filter = null, Sorting $sorting = null)

Returns a list of Refunds pertaining to a certain PayOut.

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
PayOut Create(PayOut $payOut, $idempotencyKey = null)

Create new pay-out

Parameters

PayOut $payOut
$idempotencyKey

Return Value

PayOut

Object returned from API

at line 27
PayOutEligibilityResponse CheckInstantPayoutEligibility(PayOutEligibilityRequest $payOutEligibility, $idempotencyKey = null)

This method is used to check whether or not the destination bank is eligible for instant payout.

Parameters

PayOutEligibilityRequest $payOutEligibility
$idempotencyKey

Return Value

PayOutEligibilityResponse

Object returned for the API

at line 44
PayOut Get(string $payOutId)

Get pay-out object

Parameters

string $payOutId

PayOut identifier

Return Value

PayOut

Object returned from API

at line 55
PayOut GetBankwire(string $payOutId)

Get bankwire pay-out object

Parameters

string $payOutId

PayOut identifier

Return Value

PayOut

Object returned from API

Exceptions

Exception

at line 68
Refund[] GetRefunds(string $payOutId, Pagination $pagination = null, FilterRefunds $filter = null, Sorting $sorting = null)

Returns a list of Refunds pertaining to a certain PayOut.

Parameters

string $payOutId

ID of the PayOut for which to retrieve Refunds
Pagination $pagination

Pagination object
FilterRefunds $filter

Filtering object
Sorting $sorting

Sorting object

Return Value

Refund[]

List of Refunds for the PayOut