geckon01/yookassa-sdk-php

Fork 0

mirror of https://git.yoomoney.ru/scm/sdk/yookassa-sdk-php.git synced 2026-08-17 18:53:59 +00:00

Files

T

Антон Н. Николаев 27c2aef05a Добавлена поддержка кассовых ссылок в СБП

2025-07-01 14:52:30 +03:00

24 KiB

Raw Blame History

YooKassa API SDK

Class: \YooKassa\Model\Notification\NotificationWaitingForCapture

Namespace: \YooKassa\Model\Notification

Summary:

Класс объекта, присылаемого API при изменении статуса платежа на "waiting_for_capture".

Examples

Пример скрипта обработки уведомления

require_once '../vendor/autoload.php';

try {
    $source = file_get_contents('php://input');
    $data = json_decode($source, true);

    $factory = new \YooKassa\Model\Notification\NotificationFactory();
    $notificationObject = $factory->factory($data);
    $responseObject = $notificationObject->getObject();

    $client = new \YooKassa\Client();

    if (!$client->isNotificationIPTrusted($_SERVER['REMOTE_ADDR'])) {
        header('HTTP/1.1 400 Something went wrong');

        exit;
    }

    if (\YooKassa\Model\Notification\NotificationEventType::PAYMENT_SUCCEEDED === $notificationObject->getEvent()) {
        $someData = [
            'paymentId' => $responseObject->getId(),
            'paymentStatus' => $responseObject->getStatus(),
        ];
    // Специфичная логика
    // ...
    } elseif (\YooKassa\Model\Notification\NotificationEventType::PAYMENT_WAITING_FOR_CAPTURE === $notificationObject->getEvent()) {
        $someData = [
            'paymentId' => $responseObject->getId(),
            'paymentStatus' => $responseObject->getStatus(),
        ];
    // Специфичная логика
    // ...
    } elseif (\YooKassa\Model\Notification\NotificationEventType::PAYMENT_CANCELED === $notificationObject->getEvent()) {
        $someData = [
            'paymentId' => $responseObject->getId(),
            'paymentStatus' => $responseObject->getStatus(),
        ];
    // Специфичная логика
    // ...
    } elseif (\YooKassa\Model\Notification\NotificationEventType::REFUND_SUCCEEDED === $notificationObject->getEvent()) {
        $someData = [
            'refundId' => $responseObject->getId(),
            'refundStatus' => $responseObject->getStatus(),
            'paymentId' => $responseObject->getPaymentId(),
        ];
    // ...
    // Специфичная логика
    } else {
        header('HTTP/1.1 400 Something went wrong');

        exit;
    }

    // Специфичная логика
    // ...

    $client->setAuth('xxxxxx', 'test_XXXXXXX');

    // Получим актуальную информацию о платеже
    if ($paymentInfo = $client->getPaymentInfo($someData['paymentId'])) {
        $paymentStatus = $paymentInfo->getStatus();
    // Специфичная логика
    // ...
    } else {
        header('HTTP/1.1 400 Something went wrong');

        exit;
    }
} catch (Exception $e) {
    header('HTTP/1.1 400 Something went wrong');

    exit;
}

Constants

No constants found

Properties

Visibility	Name	Summary
public	$event	Тип события
public	$object	Объект с информацией о платеже, который можно подтвердить или отменить
public	$type	Тип уведомления в виде строки
protected	$_event
protected	$_type

Methods

Visibility	Name	Summary
public	__construct()	AbstractObject constructor.
public	__get()	Возвращает значение свойства.
public	__isset()	Проверяет наличие свойства.
public	__set()	Устанавливает значение свойства.
public	__unset()	Удаляет свойство.
public	fromArray()	Конструктор объекта нотификации о возможности подтверждения платежа.
public	getEvent()	Возвращает тип события.
public	getObject()	Возвращает объект с информацией о платеже, уведомление о котором хранится в текущем объекте.
public	getType()	Возвращает тип уведомления.
public	getValidator()
public	jsonSerialize()	Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации.
public	offsetExists()	Проверяет наличие свойства.
public	offsetGet()	Возвращает значение свойства.
public	offsetSet()	Устанавливает значение свойства.
public	offsetUnset()	Удаляет свойство.
public	setObject()	Устанавливает объект с информацией о платеже, уведомление о которой хранится в текущем объекте.
public	toArray()	Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации Является алиасом метода AbstractObject::jsonSerialize().
protected	getUnknownProperties()	Возвращает массив свойств которые не существуют, но были заданы у объекта.
protected	setEvent()	Устанавливает тип события.
protected	setType()	Устанавливает тип уведомления.
protected	validatePropertyValue()

Details

File: lib/Model/Notification/NotificationWaitingForCapture.php
Package: YooKassa\Model
Class Hierarchy:
- \YooKassa\Common\AbstractObject
- \YooKassa\Model\Notification\AbstractNotification
- \YooKassa\Model\Notification\NotificationWaitingForCapture
See Also:
- При создании платежа с флагом "capture" равным false, после того как клиент проводит платёж, от API на эндпоинт, указанный в настройках API посылается уведомление о том, что платёж теперь может быть проведён. В классе описана структура такого объекта для магазинов, которые получают уведомления на HTTPS endpoint.

Tag	Version	Description
category		Class
author		cms@yoomoney.ru

Properties

public $event : string

Description

Тип события

Type: string

Details:

Inherited From: \YooKassa\Model\Notification\AbstractNotification

public $object : \YooKassa\Model\Payment\PaymentInterface

Description

Объект с информацией о платеже, который можно подтвердить или отменить

Type: PaymentInterface

Details:

public $type : string

Description

Тип уведомления в виде строки

Type: string

Details:

Inherited From: \YooKassa\Model\Notification\AbstractNotification

protected $_event : ?string

Type: ?string Тип произошедшего события Details:

Inherited From: \YooKassa\Model\Notification\AbstractNotification

protected $_type : ?string

Type: ?string Тип уведомления Details:

Inherited From: \YooKassa\Model\Notification\AbstractNotification

Methods

public __construct() : mixed

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

Summary

AbstractObject constructor.

Details:

Inherited From: \YooKassa\Common\AbstractObject

Parameters:

Type	Name	Description
`array OR null`	data

Returns: mixed -

public __get() : mixed

public __get(string $propertyName) : mixed

Summary

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

Details:

Inherited From: \YooKassa\Common\AbstractObject

Parameters:

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

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

public __isset() : bool

public __isset(string $propertyName) : bool

Summary

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

Details:

Inherited From: \YooKassa\Common\AbstractObject

Parameters:

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

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

public __set() : void

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

Summary

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

Details:

Inherited From: \YooKassa\Common\AbstractObject

Parameters:

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

Returns: void -

public __unset() : void

public __unset(string $propertyName) : void

Summary

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

Details:

Inherited From: \YooKassa\Common\AbstractObject

Parameters:

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

Returns: void -

public fromArray() : void

public fromArray(array $sourceArray) : void

Summary

Конструктор объекта нотификации о возможности подтверждения платежа.

Description

Инициализирует текущий объект из ассоциативного массива, который просто путём JSON десериализации получен из тела пришедшего запроса. При конструировании проверяется валидность типа передаваемого уведомления, если передать уведомление не того типа, будет сгенерировано исключение типа {@link}

Details:

Inherited From: \YooKassa\Model\Notification\NotificationWaitingForCapture

Parameters:

Type	Name	Description
`array`	sourceArray	Ассоциативный массив с информацией об уведомлении

Throws:

Type	Description
\YooKassa\Common\Exceptions\InvalidPropertyValueException	Генерируется если значение типа нотификации или события не равны "notification" и "payment.waiting_for_capture" соответственно, что может говорить о том, что переданные в конструктор данные не являются уведомлением нужного типа.

Returns: void -

public getEvent() : string|null

public getEvent() : string|null

Summary

Возвращает тип события.

Description

Тип события - одна из констант, указанных в перечислении {@link}.

Details:

Inherited From: \YooKassa\Model\Notification\AbstractNotification

Returns: string|null - Тип события

public getObject() : \YooKassa\Model\Payment\PaymentInterface

public getObject() : \YooKassa\Model\Payment\PaymentInterface

Summary

Возвращает объект с информацией о платеже, уведомление о котором хранится в текущем объекте.

Description

Так как нотификация может быть сгенерирована и поставлена в очередь на отправку гораздо раньше, чем она будет получена на сайте, то опираться на статус пришедшего платежа не стоит, лучше запросить текущую информацию о платеже у API.

Details:

Inherited From: \YooKassa\Model\Notification\NotificationWaitingForCapture

Returns: \YooKassa\Model\Payment\PaymentInterface - Объект с информацией о платеже, который можно подтвердить или отменить

public getType() : string|null

public getType() : string|null

Summary

Возвращает тип уведомления.

Description

Тип уведомления - одна из констант, указанных в перечислении {@link}.

Details:

Inherited From: \YooKassa\Model\Notification\AbstractNotification

Returns: string|null - Тип уведомления в виде строки

public getValidator() : \YooKassa\Validator\Validator

public getValidator() : \YooKassa\Validator\Validator

Details:

Inherited From: \YooKassa\Common\AbstractObject

Returns: \YooKassa\Validator\Validator -

public jsonSerialize() : array

public jsonSerialize() : array

Summary

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

Details:

Inherited From: \YooKassa\Common\AbstractObject

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

public offsetExists() : bool

public offsetExists(string $offset) : bool

Summary

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

Details:

Inherited From: \YooKassa\Common\AbstractObject

Parameters:

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

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

public offsetGet() : mixed

public offsetGet(string $offset) : mixed

Summary

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

Details:

Inherited From: \YooKassa\Common\AbstractObject

Parameters:

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

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

public offsetSet() : void

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

Summary

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

Details:

Inherited From: \YooKassa\Common\AbstractObject

Parameters:

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

Returns: void -

public offsetUnset() : void

public offsetUnset(string $offset) : void

Summary

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

Details:

Inherited From: \YooKassa\Common\AbstractObject

Parameters:

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

Returns: void -

public setObject() : self

public setObject(\YooKassa\Model\Payment\PaymentInterface|array $object) : self

Summary

Устанавливает объект с информацией о платеже, уведомление о которой хранится в текущем объекте.

Details:

Inherited From: \YooKassa\Model\Notification\NotificationWaitingForCapture

Parameters:

Type	Name	Description
`\YooKassa\Model\Payment\PaymentInterface OR array`	object

Returns: self -

public toArray() : array

public toArray() : array

Summary

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

Details:

Inherited From: \YooKassa\Common\AbstractObject

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

protected getUnknownProperties() : array

protected getUnknownProperties() : array

Summary

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

Details:

Inherited From: \YooKassa\Common\AbstractObject

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

protected setEvent() : self

protected setEvent(string|null $event) : self

Summary

Устанавливает тип события.

Details:

Inherited From: \YooKassa\Model\Notification\AbstractNotification

Parameters:

Type	Name	Description
`string OR null`	event	Тип события

Returns: self -

protected setType() : self

protected setType(string|null $type) : self

Summary

Устанавливает тип уведомления.

Details:

Inherited From: \YooKassa\Model\Notification\AbstractNotification

Parameters:

Type	Name	Description
`string OR null`	type	Тип уведомления

Returns: self -

protected validatePropertyValue() : mixed

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

Details:

Inherited From: \YooKassa\Common\AbstractObject

Parameters:

Type	Name	Description
`string`	propertyName
`mixed`	propertyValue

Returns: mixed -

Top Namespaces

\YooKassa

Reports

This document was automatically generated from source code comments on 2025-07-01 using phpDocumentor

24 KiB Raw Blame History

YooKassa API SDK

Class: \YooKassa\Model\Notification\NotificationWaitingForCapture

Namespace: \YooKassa\Model\Notification

Examples

Constants

Properties

Methods

Details

Tags

Properties

public $event : string

public $object : \YooKassa\Model\Payment\PaymentInterface

public $type : string

protected $_event : ?string

protected $_type : ?string

Methods

public __construct() : mixed

Parameters:

public __get() : mixed

Parameters:

public __isset() : bool

Parameters:

public __set() : void

Parameters:

public __unset() : void

Parameters:

public fromArray() : void

Parameters:

Throws:

public getEvent() : string|null

public getObject() : \YooKassa\Model\Payment\PaymentInterface

public getType() : string|null

public getValidator() : \YooKassa\Validator\Validator

public jsonSerialize() : array

public offsetExists() : bool

Parameters:

public offsetGet() : mixed

Parameters:

public offsetSet() : void

Parameters:

public offsetUnset() : void

Parameters:

public setObject() : self

Parameters:

public toArray() : array

protected getUnknownProperties() : array

protected setEvent() : self

Parameters:

protected setType() : self

Parameters:

protected validatePropertyValue() : mixed

Parameters:

Top Namespaces

Reports

24 KiB

Raw Blame History