16 KiB
YooKassa API SDK
Class: \YooKassa\Model\AuthorizationDetails
Namespace: \YooKassa\Model
Summary:
AuthorizationDetails - Данные об авторизации платежа
Constants
- No constants found
Properties
| Visibility | Name | Flag | Summary |
|---|---|---|---|
| public | $authCode | Код авторизации банковской карты | |
| public | $rrn | Retrieval Reference Number — уникальный идентификатор транзакции в системе эмитента | |
| public | $threeDSecure | Данные о прохождении пользователем аутентификации по 3‑D Secure |
Methods
| Visibility | Name | Flag | Summary |
|---|---|---|---|
| public | __construct() | AbstractObject constructor. | |
| public | __get() | Возвращает значение свойства | |
| public | __isset() | Проверяет наличие свойства | |
| public | __set() | Устанавливает значение свойства | |
| public | __unset() | Удаляет свойство | |
| public | fromArray() | Устанавливает значения свойств текущего объекта из массива | |
| public | getAuthCode() | Возвращает код авторизации банковской карты | |
| public | getRrn() | Возвращает уникальный идентификатор транзакции | |
| public | getThreeDSecure() | Возвращает данные о прохождении пользователем аутентификации по 3‑D Secure | |
| public | jsonSerialize() | ||
| public | offsetExists() | ||
| public | offsetGet() | ||
| public | offsetSet() | ||
| public | offsetUnset() | ||
| public | setAuthCode() | Устанавливает код авторизации банковской карты | |
| public | setRrn() | Устанавливает уникальный идентификатор транзакции | |
| public | setThreeDSecure() | Устанавливает данные о прохождении пользователем аутентификации по 3‑D Secure | |
| public | toArray() | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации Является алиасом метода AbstractObject::jsonSerialize() | |
| protected | getUnknownProperties() | Возвращает массив свойств которые не существуют, но были заданы у объекта |
Details
- File: lib/Model/AuthorizationDetails.php
- Package: YooKassa
- Class Hierarchy:
- \YooKassa\Common\AbstractObject
- \YooKassa\Model\AuthorizationDetails
- Implements:
Properties
public $authCode : string
Description
Код авторизации банковской карты
Type: string
Details:
public $rrn : string
Description
Retrieval Reference Number — уникальный идентификатор транзакции в системе эмитента
Type: string
Details:
public $threeDSecure : \YooKassa\Model\ThreeDSecure
Description
Данные о прохождении пользователем аутентификации по 3‑D Secure
Type: ThreeDSecure
Details:
Methods
public __construct() : mixed
public __construct(array $data = array()) : mixed
Summary
AbstractObject constructor.
Details:
- Inherited From: \YooKassa\Common\AbstractObject
Parameters:
| Type | Name | Description |
|---|---|---|
array |
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() : mixed
public __set(string $propertyName, mixed $value) : mixed
Summary
Устанавливает значение свойства
Details:
- Inherited From: \YooKassa\Common\AbstractObject
Parameters:
| Type | Name | Description |
|---|---|---|
string |
propertyName | Имя свойства |
mixed |
value | Значение свойства |
Returns: mixed -
public __unset() : mixed
public __unset(string $propertyName) : mixed
Summary
Удаляет свойство
Details:
- Inherited From: \YooKassa\Common\AbstractObject
Parameters:
| Type | Name | Description |
|---|---|---|
string |
propertyName | Имя удаляемого свойства |
Returns: mixed -
public fromArray() : mixed
public fromArray(mixed $sourceArray) : mixed
Summary
Устанавливает значения свойств текущего объекта из массива
Details:
- Inherited From: \YooKassa\Model\AuthorizationDetails
Parameters:
| Type | Name | Description |
|---|---|---|
mixed |
sourceArray | Ассоциативный массив с настройками |
Returns: mixed -
public getAuthCode() : string|null
public getAuthCode() : string|null
Summary
Возвращает код авторизации банковской карты
Details:
- Inherited From: \YooKassa\Model\AuthorizationDetails
Returns: string|null - Код авторизации банковской карты
public getRrn() : string|null
public getRrn() : string|null
Summary
Возвращает уникальный идентификатор транзакции
Details:
- Inherited From: \YooKassa\Model\AuthorizationDetails
Returns: string|null - Уникальный идентификатор транзакции
public getThreeDSecure() : \YooKassa\Model\ThreeDSecure|null
public getThreeDSecure() : \YooKassa\Model\ThreeDSecure|null
Summary
Возвращает данные о прохождении пользователем аутентификации по 3‑D Secure
Details:
- Inherited From: \YooKassa\Model\AuthorizationDetails
Returns: \YooKassa\Model\ThreeDSecure|null - Объект с данными о прохождении пользователем аутентификации по 3‑D Secure
public jsonSerialize() : mixed
public jsonSerialize() : mixed
Details:
- Inherited From: \YooKassa\Common\AbstractObject
Returns: mixed -
public offsetExists() : mixed
public offsetExists(mixed $offset) : mixed
Details:
- Inherited From: \YooKassa\Common\AbstractObject
Parameters:
| Type | Name | Description |
|---|---|---|
mixed |
offset |
Returns: mixed -
public offsetGet() : mixed
public offsetGet(mixed $offset) : mixed
Details:
- Inherited From: \YooKassa\Common\AbstractObject
Parameters:
| Type | Name | Description |
|---|---|---|
mixed |
offset |
Returns: mixed -
public offsetSet() : mixed
public offsetSet(mixed $offset, mixed $value) : mixed
Details:
- Inherited From: \YooKassa\Common\AbstractObject
Parameters:
| Type | Name | Description |
|---|---|---|
mixed |
offset | |
mixed |
value |
Returns: mixed -
public offsetUnset() : mixed
public offsetUnset(mixed $offset) : mixed
Details:
- Inherited From: \YooKassa\Common\AbstractObject
Parameters:
| Type | Name | Description |
|---|---|---|
mixed |
offset |
Returns: mixed -
public setAuthCode() : mixed
public setAuthCode($value) : mixed
Summary
Устанавливает код авторизации банковской карты
Details:
- Inherited From: \YooKassa\Model\AuthorizationDetails
Parameters:
| Type | Name | Description |
|---|---|---|
|
value |
Throws:
| Type | Description |
|---|---|
| \YooKassa\Common\Exceptions\InvalidPropertyValueTypeException |
Returns: mixed -
public setRrn() : mixed
public setRrn($value) : mixed
Summary
Устанавливает уникальный идентификатор транзакции
Details:
- Inherited From: \YooKassa\Model\AuthorizationDetails
Parameters:
| Type | Name | Description |
|---|---|---|
|
value |
Throws:
| Type | Description |
|---|---|
| \YooKassa\Common\Exceptions\InvalidPropertyValueTypeException |
Returns: mixed -
public setThreeDSecure() : mixed
public setThreeDSecure(\YooKassa\Model\ThreeDSecure|array $value) : mixed
Summary
Устанавливает данные о прохождении пользователем аутентификации по 3‑D Secure
Details:
- Inherited From: \YooKassa\Model\AuthorizationDetails
Parameters:
| Type | Name | Description |
|---|---|---|
\YooKassa\Model\ThreeDSecure OR array |
value | Данные о прохождении аутентификации по 3‑D Secure |
Throws:
| Type | Description |
|---|---|
| \YooKassa\Common\Exceptions\InvalidPropertyValueTypeException |
Returns: mixed -
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 - Ассоциативный массив с не существующими у текущего объекта свойствами
Top Namespaces
Reports
This document was automatically generated from source code comments on 2023-04-06 using phpDocumentor
© 2023 YooMoney