ApiRecipients
class ApiRecipients extends ApiBase (View source)
Class to management MangoPay API for recipients
Properties
protected MangoPayApi | $_root | Root/parent instance that holds the OAuthToken and Configuration instance |
from ApiBase |
Methods
Constructor Root/parent instance that holds the OAuthToken and Configuration instance
Create object in API
Get entity object from API
Get lst with entities object from API
Save object in API
Executes a POST request
Cast response object to entity object
Get all recipients associated with a specific user
See payout methods available to your platform by currency and country
Get a Recipient schema
Deactivate a Recipient
Details
protected mixed
getLogger()
No description
__construct(MangoPayApi $root)
Constructor Root/parent instance that holds the OAuthToken and Configuration instance
protected string
GetRequestUrl(string $key)
Get URL for REST Mango Pay API
protected RequestType
GetRequestType(string $key)
Get request type for REST Mango Pay API
protected object
CreateObject(string $methodKey, object $entity, object $responseClassName = null, string $entityId = null, $subEntityId = null, $idempotencyKey = null)
Create object in API
protected object
GetObject(string $methodKey, object $responseClassName, $firstEntityId = null, $secondEntityId = null, $thirdEntityId = null, $clientIdRequired = true)
Get entity object from API
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
protected object
SaveObject(string $methodKey, object $entity, object $responseClassName = null, $secondEntityId = null, $thirdEntityId = null)
Save object in API
protected
DeleteObject($methodKey, $entity, $responseClassName = null)
No description
protected object
ExecutePostRequest($methodKey, $entity, $responseClassName, $entityId = null)
Executes a POST request
protected Error
CastResponseToError(object $response)
Cast response object to an error object
protected
CastResponseToEntity(object $response, string $entityClassName, $asDependentObject = false)
Cast response object to entity object
protected array
BuildRequestData(object $entity)
Get array with request data
protected
GetObjectForIdempotencyUrl($url)
No description
Recipient
Get(string $recipientId)
Get a recipient
Recipient[]
GetUserRecipients(string $userId, Pagination $pagination = null, $sorting = null)
Get all recipients associated with a specific user
PayoutMethods
GetPayoutMethods(string $country, string $currency)
See payout methods available to your platform by currency and country
RecipientSchema
GetSchema(string $payoutMethodType, string $recipientType, string $currency)
Get a Recipient schema
Validate(Recipient $recipient, string $userId, $idempotencyKey = null)
Validate recipient data
Recipient
Deactivate(string $recipientId)
Deactivate a Recipient