geckon01/yookassa-sdk-php
1
0
Fork 0
mirror of https://git.yoomoney.ru/scm/sdk/yookassa-sdk-php.git synced 2026-08-30 20:17:36 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
31dc0221be7e09f1bfdabbe00ce94ffeeab930c9
yookassa-sdk-php/docs/classes/YooKassa-Request-SelfEmployed-SelfEmployedRequest.md
T
Антон Н. Николаев 31dc0221be Добавлено поле refund_method в возвратах. Добавлено поле sbp_operation_id в PaymentMethodSbp 
Добавлено поле `merchant_customer_bank_account` в объекте `FraudData`
Добавлен статус самозанятого `unregistered`
Добавлен список провайдеров онлайн-касс `FiscalizationProvider`
Добавлен объект Me с подобъектом `Fiscalization`
2023-12-11 15:15:42 +03:00

24 KiB
Raw Blame History

YooKassa API SDK

Class: \YooKassa\Request\SelfEmployed\SelfEmployedRequest

Namespace: \YooKassa\Request\SelfEmployed

Summary:

Класс, представляющий модель SelfEmployedRequest.

Description:

Запрос на создание объекта самозанятого.

Examples

Пример использования билдера

try {
    $selfEmployedBuilder = \YooKassa\Request\SelfEmployed\SelfEmployedRequest::builder();
    $selfEmployedBuilder
        ->setItn('123456789012')
        ->setPhone('79001002030')
        ->setConfirmation(['type' => \YooKassa\Model\SelfEmployed\SelfEmployedConfirmationType::REDIRECT])
    ;

    // Создаем объект запроса
    $request = $selfEmployedBuilder->build();

    $idempotenceKey = uniqid('', true);
    $response = $client->createSelfEmployed($request, $idempotenceKey);
} catch (Exception $e) {
    $response = $e;
}

var_dump($response);

Constants

  • No constants found

Properties

Visibility Name Flag Summary
public $confirmation Сценарий подтверждения пользователем заявки ЮMoney на получение прав для регистрации чеков в сервисе Мой налог.
public $itn ИНН самозанятого. Формат: 12 цифр без пробелов. Обязательный параметр, если не передан phone.
public $phone Телефон самозанятого, который привязан к личному кабинету в сервисе Мой налог.

Methods

Visibility Name Flag Summary
public __construct() AbstractObject constructor.
public __get() Возвращает значение свойства.
public __isset() Проверяет наличие свойства.
public __set() Устанавливает значение свойства.
public __unset() Удаляет свойство.
public builder() Возвращает билдер объектов запросов создания платежа.
public clearValidationError() Очищает статус валидации текущего запроса.
public fromArray() Устанавливает значения свойств текущего объекта из массива.
public getConfirmation() Возвращает сценарий подтверждения.
public getItn() Возвращает ИНН самозанятого.
public getLastValidationError() Возвращает последнюю ошибку валидации.
public getPhone() Возвращает телефон самозанятого.
public getValidator()
public hasConfirmation() Проверяет наличие сценария подтверждения самозанятого в запросе.
public hasItn() Проверяет наличие ИНН самозанятого в запросе.
public hasPhone() Проверяет наличие телефона самозанятого в запросе.
public jsonSerialize() Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации.
public offsetExists() Проверяет наличие свойства.
public offsetGet() Возвращает значение свойства.
public offsetSet() Устанавливает значение свойства.
public offsetUnset() Удаляет свойство.
public setConfirmation() Устанавливает сценарий подтверждения.
public setItn() Устанавливает ИНН самозанятого.
public setPhone() Устанавливает телефон самозанятого.
public toArray() Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации Является алиасом метода AbstractObject::jsonSerialize().
public validate() Проверяет на валидность текущий объект
protected getUnknownProperties() Возвращает массив свойств которые не существуют, но были заданы у объекта.
protected setValidationError() Устанавливает ошибку валидации.
protected validatePropertyValue()

Details

Tags

Tag Version Description
category Class
author cms@yoomoney.ru

Properties

public $confirmation : null|\YooKassa\Request\SelfEmployed\SelfEmployedRequestConfirmation

Description

Сценарий подтверждения пользователем заявки ЮMoney на получение прав для регистрации чеков в сервисе Мой налог.

Type: SelfEmployedRequestConfirmation

Details:

public $itn : null|string

Description

ИНН самозанятого. Формат: 12 цифр без пробелов. Обязательный параметр, если не передан phone.

Type: null|string

Details:

public $phone : null|string

Description

Телефон самозанятого, который привязан к личному кабинету в сервисе Мой налог.

Type: null|string

Details:

Methods

public __construct() : mixed

public __construct(array|null $data = []) : mixed

Summary

AbstractObject constructor.

Details:

Parameters:
Type Name Description
array OR null data

Returns: mixed -

public __get() : mixed

public __get(string $propertyName) : mixed

Summary

Возвращает значение свойства.

Details:

Parameters:
Type Name Description
string propertyName Имя свойства

Returns: mixed - Значение свойства

public __isset() : bool

public __isset(string $propertyName) : bool

Summary

Проверяет наличие свойства.

Details:

Parameters:
Type Name Description
string propertyName Имя проверяемого свойства

Returns: bool - True если свойство имеется, false если нет

public __set() : void

public __set(string $propertyName, mixed $value) : void

Summary

Устанавливает значение свойства.

Details:

Parameters:
Type Name Description
string propertyName Имя свойства
mixed value Значение свойства

Returns: void -

public __unset() : void

public __unset(string $propertyName) : void

Summary

Удаляет свойство.

Details:

Parameters:
Type Name Description
string propertyName Имя удаляемого свойства

Returns: void -

public builder() : \YooKassa\Request\SelfEmployed\SelfEmployedRequestBuilder

Static public builder() : \YooKassa\Request\SelfEmployed\SelfEmployedRequestBuilder

Summary

Возвращает билдер объектов запросов создания платежа.

Details:

Returns: \YooKassa\Request\SelfEmployed\SelfEmployedRequestBuilder -

public clearValidationError() : void

public clearValidationError() : void

Summary

Очищает статус валидации текущего запроса.

Details:

Returns: void -

public fromArray() : void

public fromArray(array|\Traversable $sourceArray) : void

Summary

Устанавливает значения свойств текущего объекта из массива.

Details:

Parameters:
Type Name Description
array OR \Traversable sourceArray Ассоциативный массив с настройками

Returns: void -

public getConfirmation() : \YooKassa\Request\SelfEmployed\SelfEmployedRequestConfirmation|null

public getConfirmation() : \YooKassa\Request\SelfEmployed\SelfEmployedRequestConfirmation|null

Summary

Возвращает сценарий подтверждения.

Details:

Returns: \YooKassa\Request\SelfEmployed\SelfEmployedRequestConfirmation|null - Сценарий подтверждения

public getItn() : string|null

public getItn() : string|null

Summary

Возвращает ИНН самозанятого.

Details:

Returns: string|null - ИНН самозанятого

public getLastValidationError() : string|null

public getLastValidationError() : string|null

Summary

Возвращает последнюю ошибку валидации.

Details:

Returns: string|null - Последняя произошедшая ошибка валидации

public getPhone() : string|null

public getPhone() : string|null

Summary

Возвращает телефон самозанятого.

Details:

Returns: string|null - Телефон самозанятого

public getValidator() : \YooKassa\Validator\Validator

public getValidator() : \YooKassa\Validator\Validator

Details:

Returns: \YooKassa\Validator\Validator -

public hasConfirmation() : bool

public hasConfirmation() : bool

Summary

Проверяет наличие сценария подтверждения самозанятого в запросе.

Details:

Returns: bool - True если сценарий подтверждения самозанятого задан, false если нет

public hasItn() : bool

public hasItn() : bool

Summary

Проверяет наличие ИНН самозанятого в запросе.

Details:

Returns: bool - True если ИНН самозанятого задан, false если нет

public hasPhone() : bool

public hasPhone() : bool

Summary

Проверяет наличие телефона самозанятого в запросе.

Details:

Returns: bool - True если телефон самозанятого задан, false если нет

public jsonSerialize() : array

public jsonSerialize() : array

Summary

Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации.

Details:

Returns: array - Ассоциативный массив со свойствами текущего объекта

public offsetExists() : bool

public offsetExists(string $offset) : bool

Summary

Проверяет наличие свойства.

Details:

Parameters:
Type Name Description
string offset Имя проверяемого свойства

Returns: bool - True если свойство имеется, false если нет

public offsetGet() : mixed

public offsetGet(string $offset) : mixed

Summary

Возвращает значение свойства.

Details:

Parameters:
Type Name Description
string offset Имя свойства

Returns: mixed - Значение свойства

public offsetSet() : void

public offsetSet(string $offset, mixed $value) : void

Summary

Устанавливает значение свойства.

Details:

Parameters:
Type Name Description
string offset Имя свойства
mixed value Значение свойства

Returns: void -

public offsetUnset() : void

public offsetUnset(string $offset) : void

Summary

Удаляет свойство.

Details:

Parameters:
Type Name Description
string offset Имя удаляемого свойства

Returns: void -

public setConfirmation() : $this

public setConfirmation(null|array|\YooKassa\Model\SelfEmployed\SelfEmployedConfirmation $confirmation = null) : $this

Summary

Устанавливает сценарий подтверждения.

Details:

Parameters:
Type Name Description
null OR array OR \YooKassa\Model\SelfEmployed\SelfEmployedConfirmation confirmation Сценарий подтверждения

Returns: $this -

public setItn() : self

public setItn(string|null $itn = null) : self

Summary

Устанавливает ИНН самозанятого.

Details:

Parameters:
Type Name Description
string OR null itn ИНН самозанятого

Returns: self -

public setPhone() : self

public setPhone(string|array|null $phone = null) : self

Summary

Устанавливает телефон самозанятого.

Details:

Parameters:
Type Name Description
string OR array OR null phone Телефон самозанятого

Returns: self -

public toArray() : array

public toArray() : array

Summary

Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации Является алиасом метода AbstractObject::jsonSerialize().

Details:

Returns: array - Ассоциативный массив со свойствами текущего объекта

public validate() : bool

public validate() : bool

Summary

Проверяет на валидность текущий объект

Details:

Returns: bool - True если объект запроса валиден, false если нет

protected getUnknownProperties() : array

protected getUnknownProperties() : array

Summary

Возвращает массив свойств которые не существуют, но были заданы у объекта.

Details:

Returns: array - Ассоциативный массив с не существующими у текущего объекта свойствами

protected setValidationError() : void

protected setValidationError(string $value) : void

Summary

Устанавливает ошибку валидации.

Details:

Parameters:
Type Name Description
string value Ошибка, произошедшая при валидации объекта

Returns: void -

protected validatePropertyValue() : mixed

protected validatePropertyValue(string $propertyName, mixed $propertyValue) : mixed

Details:

Parameters:
Type Name Description
string propertyName
mixed propertyValue

Returns: mixed -

Top Namespaces

Reports

This document was automatically generated from source code comments on 2023-12-11 using phpDocumentor

© 2023 YooMoney

Reference in New Issue View Git Blame Copy Permalink