Skip to content

Latest commit

 

History

History
502 lines (393 loc) · 31.4 KB

docs.md

File metadata and controls

502 lines (393 loc) · 31.4 KB

Table of contents

Class: \YandexCheckoutPayout\Client

Класс клиента API

Example
<?php
    $keychain = new Keychain('publicCert.cer', 'privateCert.pem', 'password');
    $client = new Client('000000', $keychain);
    $response = $client->createDeposition($request);
    $response->getXmlResponse()->getStatus();
Visibility Function
public __construct(string $agentId='', \YandexCheckoutPayout\Request\Keychain $keychain=null, null $curlConfiguration=null) : void
Client constructor.
public createCsr(mixed $organizationInfo, string/mixed $outputDir='C:\Intel\OSPanel\domains\payout-sdk-test.local\lib', string $privateKeyPassword='') : string/string[]
Создает приватный ключ и запрос на сертификат для Яндекс.Денег. Возвращает подпись
public createDeposition(\YandexCheckoutPayout\AbstractDepositionRequest/array $request, string/int $clientOrderId=null) : \YandexCheckoutPayout\Common\ResponseObject
Создание выплаты. Метод принимает объект запроса Make
public getBalance() : \YandexCheckoutPayout\Common\ResponseObject
Возвращает баланс
public getSynonymCard(\YandexCheckoutPayout\SynonymCardRequest/array $request) : \YandexCheckoutPayout\Common\ResponseSynonymCard
Возвращает синоним карты Принимает объект запроса SynonymCardRequest

This class extends \YandexCheckoutPayout\Client\CurlClient

Class: \YandexCheckoutPayout\Common\ResponseObject

Класс объекта ответа, возвращаемого API при запросе выплаты, баланса

Visibility Function
public __construct(null $config=null) : void
ResponseObject constructor.
public getBody() : mixed
public getCode() : mixed
public getHeaders() : mixed
public getXmlResponse() : \YandexCheckoutPayout\Common\ResponseXmlObject

Class: \YandexCheckoutPayout\Common\ResponseXmlObject

Класс объекта ответа, возвращаемого API, для работы с xml

Visibility Function
public __construct(mixed $xml) : void
ResponseXmlObject constructor.
public getBalance() : string
public getClientOrderId() : string
public getFullXmlResponse() : string
public getIdentification() : string
public getProcessedDT() : string
public getStatus() : int
public getTechMessage() : string

Class: \YandexCheckoutPayout\Common\ResponseSynonymCard

Класс объекта ответа, возвращаемого API при запросе синонима карты

Visibility Function
public __construct(mixed $body) : void
public getReason() : string
public getSkrCardBin() : string
public getSkrCardLast4() : string
public getSkrDestinationCardCountryCode() : string
public getSkrDestinationCardPanmask() : string
public getSkrDestinationCardProductCode() : string
public getSkrDestinationCardSynonim() : string
public getSkrDestinationCardType() : string

Class: \YandexCheckoutPayout\Model\CurrencyCode

CurrencyCode - Код валюты перевода

Visibility Function

This class extends \YandexCheckoutPayout\Common\AbstractEnum

Class: \YandexCheckoutPayout\Model\DstAccount

DstAccount - Идентификатор получателя перевода. Зависит от того, куда вы отправляете перевод.

Код Описание
BANK_CARD перевод на банковскую карту
BANK_ACCOUNT перевод на банковский счет
Visibility Function

This class extends \YandexCheckoutPayout\Common\AbstractEnum

Class: \YandexCheckoutPayout\Model\FormatType

FormatType - формат запроса

Значения
JSON
XML
Visibility Function

This class extends \YandexCheckoutPayout\Common\AbstractEnum

Class: \YandexCheckoutPayout\Model\Organization

Класс для построения данных организации при генерации запроса на сертификат

Example
<?php
    $organization = new Organization();
    $organization->setEmailAddress('[email protected]')
                 ->setOrganizationName('OOO Predpriyatie')
                 ->setCommonName('/business/predpriyatie');
    $signature = $client->createCsr($organization, 'path/to/output/dir', 'password_for_private_key');
Visibility Function
public __construct(mixed $organizationInfo=null) : void
public buildByArray(mixed $options) : void
public getCommonName() : string
public getCountryName() : string
public getEmailAddress() : string
public getLocalityName() : string
public getOrganizationName() : string
public getOrganizationalUnitName() : string
public getStateOrProvinceName() : string
public setCommonName(mixed $commonName) : \YandexCheckoutPayout\Model\Organization
public setCountryName(string $countryName='RU') : \YandexCheckoutPayout\Model\Organization
public setEmailAddress(mixed $emailAddress) : \YandexCheckoutPayout\Model\Organization
public setLocalityName(string $localityName) : \YandexCheckoutPayout\Model\Organization
public setOrganizationName(mixed $organizationName) : \YandexCheckoutPayout\Model\Organization
public setOrganizationalUnitName(string $organizationalUnitName) : \YandexCheckoutPayout\Model\Organization
public setStateOrProvinceName(string $stateOrProvinceName='Russia') : \YandexCheckoutPayout\Model\Organization
public toArray() : void

Class: \YandexCheckoutPayout\Model\RequestDateTime

Класс позволяет получить дату в необходимом для выплаты формате

Visibility Function
public static getDateTime() : mixed

Class: \YandexCheckoutPayout\Model\Recipient\BankAccountRecipient

Класс для построения параметров получателя при выплате на банковский счет, затем можно передать в setPaymentParams() у (Make|Test)DepositionRequest

Example
<?php
    $recipient = new BankAccountRecipient();
    $recipient->setBankCity('bank city')
              ->setBankName('bank name')
              ->setBankBIK('999999999')
              ->setPaymentPurpose('payment purpose 74')
              ->setBankCorAccount('11111111111111111111')
              ->setPofOfferAccepted(true)
              ->setPdrDocIssueDate('05.05.2019')
              ->setCustAccount('11111111111111111111')
              ->setPdrMiddleName('Владимирович')
              ->setPdrLastName('Владимиров')
              ->setPdrFirstName('Владимир')
              ->setPdrBirthDate('05.05.1990')
              ->setPdrAddress('пос. Большие Васюки, ул. Комиссара Козявкина, д. 4')
              ->setDocNumber('4002109067')
              ->setSmsPhoneNumber('79653457676');
    
    $depositionRequest = new MakeDepositionRequest();
    $depositionRequest->setPaymentParams($recipient);
Visibility Function
public getBankBIK() : mixed
public getBankCity() : mixed
public getBankCorAccount() : mixed
public getBankName() : mixed
public getCustAccount() : mixed
public getPaymentPurpose() : mixed
public setBankBIK(mixed $value) : void
public setBankCity(mixed $value) : void
public setBankCorAccount(mixed $value) : void
public setBankName(mixed $value) : void
public setCustAccount(mixed $value) : void
public setPaymentPurpose(mixed $value) : void
public toArray() : array

This class extends \YandexCheckoutPayout\Model\Recipient\BaseRecipient

Class: \YandexCheckoutPayout\Model\Recipient\BankCardRecipient

Класс для построения параметров получателя при выплате на банковскую карту, затем можно передать в setPaymentParams() у (Make|Test)DepositionRequest

Example
<?php
     $recipient = new BankCardRecipient();
     $recipient->setPdrLastName('Иванов')
               ->setPdrFirstName('Иван')
               ->setPdrMiddleName('Иванович')
               ->setDocNumber('1234567890')
               ->setPofOfferAccepted(true)
               ->setPdrDocIssueDate('01.02.2018')
               ->setSmsPhoneNumber('79999999999')
               ->setSkrDestinationCardSynonym('R8zigwjuuzlxmfOfJ8SPDzLU.SC.000.202002');

     $depositionRequest = new MakeDepositionRequest();
     $depositionRequest->setPaymentParams($recipient);
Visibility Function
public getCpsYmAccount() : mixed
public getPdrCity() : mixed
public getPdrPostcode() : mixed
public getSkrDestinationCardSynonym() : mixed
public hasCpsYmAccount() : bool
public setCpsYmAccount(mixed $value) : void
public setPdrCity(mixed $value) : void
public setPdrPostcode(mixed $value) : void
public setSkrDestinationCardSynonym(mixed $value) : void
public toArray() : void

This class extends \YandexCheckoutPayout\Model\Recipient\BaseRecipient

Class: \YandexCheckoutPayout\Model\Recipient\BaseRecipient

Класс для построения параметров получателя при выплате на моб.телефон, затем можно передать в setPaymentParams() у (Make|Test)DepositionRequest

Example
<?php
 $recipient = new BaseRecipient();
 $recipient->setPofOfferAccepted(true);

 $depositionRequest = new MakeDepositionRequest();
 $depositionRequest->setPaymentParams($recipient);
Visibility Function
public getPdrAddress() : mixed
public getPdrBirthDate() : mixed
public getPdrDocIssueDate() : mixed
public getPdrDocNumber() : mixed
public getPdrFirstName() : mixed
public getPdrLastName() : mixed
public getPdrMiddleName() : mixed
public getPofOfferAccepted() : mixed
public getSmsPhoneNumber() : mixed
public setDocNumber(mixed $value) : \YandexCheckoutPayout\Model\Recipient$this
public setPdrAddress(mixed $value) : \YandexCheckoutPayout\Model\Recipient$this
public setPdrBirthDate(mixed $value) : \YandexCheckoutPayout\Model\Recipient$this
public setPdrDocIssueDate(mixed $value) : \YandexCheckoutPayout\Model\Recipient$this
public setPdrFirstName(mixed $value) : \YandexCheckoutPayout\Model\Recipient$this
public setPdrLastName(mixed $value) : \YandexCheckoutPayout\Model\Recipient$this
public setPdrMiddleName(mixed $value) : \YandexCheckoutPayout\Model\Recipient$this
public setPofOfferAccepted(bool $value) : \YandexCheckoutPayout\Model\Recipient$this
public setSmsPhoneNumber(mixed $value) : \YandexCheckoutPayout\Model\Recipient$this
public toArray() : void

Class: \YandexCheckoutPayout\Notification\ErrorDepositionNotification

Класс для обработки входящих уведомлений

Example
<?php
 $notification = new ErrorDepositionNotification($notificationBody);
 $error = $notification->getError();
 $response = $notification->createResponse(0, $keychain);
Visibility Function
public __construct(mixed $body) : void
ErrorDepositionNotification constructor.
public createResponse(mixed $status, mixed $keychain) : string
public getAmount() : string
public getClientOrderId() : string
public getCurrency() : string
public getDstAccount() : string
public getError() : string
public getRequestDT() : string

Class: \YandexCheckoutPayout\Notification\ErrorDepositionNotificationResponse

Класс для создания ответа на errorDepositionNotification

Example
<?php
    $response = new ErrorDepositionNotificationResponse($clientOrderId, $status);
    return $response->build($keychain);
Visibility Function
public __construct(mixed $clientOrderId, mixed $status, string $processedDT='') : void
public build(\YandexCheckoutPayout\Request\Keychain $keychain) : string
Строит ответ на запрос, упаковывает его в PKCS#7 пакет.
public getClientOrderId() : string
public getProcessedDT() : string
public getStatus() : string
public setClientOrderId(string $clientOrderId) : \YandexCheckoutPayout\Notification$this
public setProcessedDT(string $processedDT) : \YandexCheckoutPayout\Notification$this
public setStatus(string $status) : \YandexCheckoutPayout\Notification$this

Class: \YandexCheckoutPayout\Request\AbstractDepositionRequest (abstract)

Class AbstractDepositionRequest

Example
<?php
    $depositionRequest = new MakeDepositionRequest();
    $depositionRequest->setDstAccount('41001614575714')
                      ->setAmount(100)
                      ->setCurrency(CurrencyCode::RUB)
                      ->setContract('test')
                      ->setPaymentParams($params);
Visibility Function
public getAmount() : mixed
public getContract() : mixed
public getCurrency() : mixed
public getDstAccount() : mixed
public getPaymentParams() : \YandexCheckoutPayout\Request\BankAccountRecipient/\YandexCheckoutPayout\Request\BankCardRecipient/array
public getSerializer() : \YandexCheckoutPayout\Request\Serializers\DepositionRequestSerializer
public hasPaymentParams() : bool
public setAmount(mixed $value) : \YandexCheckoutPayout\Request$this
public setContract(mixed $value) : \YandexCheckoutPayout\Request\AbstractDepositionRequest
public setCurrency(mixed $value=643) : \YandexCheckoutPayout\Request$this
public setDstAccount(string/int $value) : \YandexCheckoutPayout\Request\AbstractDepositionRequest
public setPaymentParams(\YandexCheckoutPayout\Request\BaseRecipient/\YandexCheckoutPayout\Request\BankCardRecipient/\YandexCheckoutPayout\Request\BankAccountRecipient/array $params) : \YandexCheckoutPayout\Request$this
public abstract validate() : bool True если запрос валиден, false если нет
Валидирует текущий запрос, проверяет все ли нужные свойства установлены

This class extends \YandexCheckoutPayout\Request\AbstractRequest

Class: \YandexCheckoutPayout\Request\AbstractRequest (abstract)

Class AbstractRequest

Visibility Function
public __construct(mixed $clientOrderId=null) : void
public clearValidationError() : void
Очищает статус валидации текущего запроса
public getClientOrderId() : string
public getFormatType() : \YandexCheckoutPayout\Model\FormatType
Возвращает формат запроса xml
public getLastValidationError() : string Последняя произошедшая ошибка валидации
Возвращает последнюю ошибку валидации
public getRequestDT() : \YandexCheckoutPayout\Request\DateTime/string
Возвращает установленое время запроса
public getRequestName() : string
public abstract getSerializer() : \YandexCheckoutPayout\Request\Serializers\AbstractRequestSerializer
public setClientOrderId(string $clientOrderId) : \YandexCheckoutPayout\Request$this
public setFormatType(\YandexCheckoutPayout\Model\FormatType $type) : \YandexCheckoutPayout\Request$this
Устанавливает формат запроса xml
public setRequestDT(string $requestDT) : \YandexCheckoutPayout\Request$this
Устанавливает время запроса
public setRequestName(mixed $value) : \YandexCheckoutPayout\Request$this
public abstract validate() : bool True если запрос валиден, false если нет
Валидирует текущий запрос, проверяет все ли нужные свойства установлены

Class: \YandexCheckoutPayout\Request\BalanceRequest

Класс для создания запроса баланса

Visibility Function
public getSerializer() : \YandexCheckoutPayout\Request\Serializers\AbstractRequestSerializer/\YandexCheckoutPayout\Request\BalanceRequestSerializer
public validate() : bool True если запрос валиден, false если нет
Валидирует текущий запрос, проверяет все ли нужные свойства установлены

This class extends \YandexCheckoutPayout\Request\AbstractRequest

Class: \YandexCheckoutPayout\Request\Keychain

Класс ключница

Visibility Function
public __construct(mixed $publicCert, mixed $privateKey, string $keyPassword='') : void
public getKeyPassword() : string
public getPrivateKey() : string
public getPublicCert() : string
public setKeyPassword(string $keyPassword) : \YandexCheckoutPayout\Request\Keychain
public setPrivateKey(string $privateKey) : \YandexCheckoutPayout\Request\Keychain
public setPublicCert(string $publicCert) : \YandexCheckoutPayout\Request\Keychain

Class: \YandexCheckoutPayout\Request\MakeDepositionRequest

Класс для создания запроса на выплату

Visibility Function
public static getBuilder(null/string/int $clientOrderId=null) : \YandexCheckoutPayout\Request\Builders\MakeDepositionRequestBuilder
public validate() : bool True если запрос валиден, false если нет
Валидирует текущий запрос, проверяет все ли нужные свойства установлены

This class extends \YandexCheckoutPayout\Request\AbstractDepositionRequest

Class: \YandexCheckoutPayout\Request\SynonymCardRequest

Класс для создания запроса на получение синонима карты

Example
<?php
     $synonymRequest = new SynonymCardRequest();
     $synonymRequest->setSkrDestinationCardNumber('5555555555554444')
                    ->setSkrErrorUrl('http://money.yandex.ru')
                    ->setSkrSuccessUrl('http://money.yandex.ru');
     $client->getSynonymCard($synonymRequest);
Visibility Function
public __construct() : void
SynonymCardRequest constructor.
public static getBuilder() : \YandexCheckoutPayout\Request\Builders\SynonymCardRequestBuilder
public getSerializer() : \YandexCheckoutPayout\Request\Serializers\SynonymCardRequestSerializer
public getSkrDestinationCardNumber() : string
public getSkrErrorUrl() : string
public getSkrResponseFormat() : string
public getSkrSuccessUrl() : string
public setSkrDestinationCardNumber(string $skrDestinationCardNumber) : \YandexCheckoutPayout\Request$this
public setSkrErrorUrl(string $skrErrorUrl) : \YandexCheckoutPayout\Request\SynonymCardRequest
public setSkrResponseFormat(string $skrResponseFormat='json') : \YandexCheckoutPayout\Request\SynonymCardRequest
public setSkrSuccessUrl(string $skrSuccessUrl) : \YandexCheckoutPayout\Request\SynonymCardRequest

Class: \YandexCheckoutPayout\Request\TestDepositionRequest

Класс для создания запроса на проверку возможности выплаты

Visibility Function
public static getBuilder(null/string/int $clientOrderId=null) : \YandexCheckoutPayout\Request\Builders\TestDepositionRequestBuilder
public validate() : bool True если запрос валиден, false если нет
Валидирует текущий запрос, проверяет все ли нужные свойства установлены

This class extends \YandexCheckoutPayout\Request\AbstractDepositionRequest