mirror of
https://git.yoomoney.ru/scm/sdk/yookassa-sdk-php.git
synced 2026-08-25 20:28:01 +00:00
Антон Н. Николаев
2db9951ff6
Информация про чеки самозанятых в платежах и возвратах удалена - больше не поддерживаем сервисы для самозанятых Добавлена возможность выставления счета по смс и email Добавлена поддержка работы со списками выплат Обновлен Copyright
356 lines
12 KiB
PHP
356 lines
12 KiB
PHP
<?php
|
||
|
||
/*
|
||
* The MIT License
|
||
*
|
||
* Copyright (c) 2026 "YooMoney", NBСO LLC
|
||
*
|
||
* Permission is hereby granted, free of charge, to any person obtaining a copy
|
||
* of this software and associated documentation files (the "Software"), to deal
|
||
* in the Software without restriction, including without limitation the rights
|
||
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||
* copies of the Software, and to permit persons to whom the Software is
|
||
* furnished to do so, subject to the following conditions:
|
||
*
|
||
* The above copyright notice and this permission notice shall be included in
|
||
* all copies or substantial portions of the Software.
|
||
*
|
||
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
|
||
* THE SOFTWARE.
|
||
*/
|
||
|
||
namespace YooKassa\Model\Payment\PaymentMethod;
|
||
|
||
use YooKassa\Common\AbstractObject;
|
||
use YooKassa\Validator\Constraints as Assert;
|
||
|
||
/**
|
||
* Класс, описывающий модель BankCard.
|
||
*
|
||
* Объект банковской карты
|
||
*
|
||
* @category Class
|
||
* @package YooKassa\Model
|
||
* @author cms@yoomoney.ru
|
||
* @link https://yookassa.ru/developers/api
|
||
*
|
||
* @property string $first6 Первые 6 цифр номера карты
|
||
* @property string $last4 Последние 4 цифры номера карты
|
||
* @property string $expiryYear Срок действия, год
|
||
* @property string $expiry_year Срок действия, год
|
||
* @property string $expiryMonth Срок действия, месяц
|
||
* @property string $expiry_month Срок действия, месяц
|
||
* @property string $cardType Тип банковской карты
|
||
* @property string $card_type Тип банковской карты
|
||
* @property string $cardProduct Карточный продукт платежной системы, с которым ассоциирована банковская карта.
|
||
* @property string $card_product Карточный продукт платежной системы, с которым ассоциирована банковская карта.
|
||
* @property string $issuerCountry Код страны, в которой выпущена карта
|
||
* @property string $issuer_country Код страны, в которой выпущена карта
|
||
* @property string $issuerName Тип банковской карты
|
||
* @property string $issuer_name Тип банковской карты
|
||
* @property string $source Тип банковской карты
|
||
*/
|
||
class BankCard extends AbstractObject
|
||
{
|
||
/**
|
||
* @var int Длина кода страны по ISO 3166 https://www.iso.org/obp/ui/#iso:pub:PUB500001:en
|
||
*/
|
||
public const ISO_3166_CODE_LENGTH = 2;
|
||
|
||
/**
|
||
* Первые 6 цифр номера карты (BIN). При оплате картой, [сохраненной в ЮKassa](/developers/payment-acceptance/scenario-extensions/recurring-payments) и других сервисах, переданный BIN может не соответствовать значениям `last4`, `expiry_year`, `expiry_month`.
|
||
*
|
||
* @var string|null
|
||
*/
|
||
#[Assert\Type('string')]
|
||
#[Assert\Regex("/^[0-9]{6}$/")]
|
||
private ?string $_first6 = null;
|
||
|
||
/**
|
||
* Последние 4 цифры номера карты.
|
||
*
|
||
* @var string|null
|
||
*/
|
||
#[Assert\NotBlank]
|
||
#[Assert\Type('string')]
|
||
#[Assert\Regex("/^[0-9]{4}$/")]
|
||
private ?string $_last4 = null;
|
||
|
||
/**
|
||
* Срок действия, год, YYYY.
|
||
*
|
||
* @var string|null
|
||
*/
|
||
#[Assert\NotBlank]
|
||
#[Assert\Type('string')]
|
||
#[Assert\Regex("/^[0-9]{4}$/")]
|
||
private ?string $_expiry_year = null;
|
||
|
||
/**
|
||
* Срок действия, месяц, MM.
|
||
*
|
||
* @var string|null
|
||
*/
|
||
#[Assert\NotBlank]
|
||
#[Assert\Type('string')]
|
||
#[Assert\Regex("/^(0?[1-9]|1[0-2])$/")]
|
||
private ?string $_expiry_month = null;
|
||
|
||
/**
|
||
* Тип банковской карты
|
||
*
|
||
* @var string|null
|
||
*/
|
||
#[Assert\NotBlank]
|
||
#[Assert\Type('string')]
|
||
#[Assert\Choice(callback: [BankCardType::class, 'getValidValues'])]
|
||
private ?string $_card_type = null;
|
||
|
||
/**
|
||
* Карточный продукт платежной системы, с которым ассоциирована банковская карта.
|
||
* Например, карточные продукты платежной системы Мир: `Mir Classic`, `Mir Classic Credit`, `MIR Privilege Plus` и другие.
|
||
*
|
||
* @var BankCardProduct|null
|
||
*/
|
||
#[Assert\Type(BankCardProduct::class)]
|
||
private ?BankCardProduct $_card_product = null;
|
||
|
||
/**
|
||
* Код страны, в которой выпущена карта. Передается в формате [ISO-3166 alpha-2](https://www.iso.org/obp/ui/#iso:pub:PUB500001:en). Пример: ~`RU`.
|
||
*
|
||
* @var string|null
|
||
*/
|
||
#[Assert\Type('string')]
|
||
#[Assert\Regex("/^[A-Z]{2}$/")]
|
||
private ?string $_issuer_country = null;
|
||
|
||
/**
|
||
* Наименование банка, выпустившего карту.
|
||
*
|
||
* @var string|null
|
||
*/
|
||
#[Assert\Type('string')]
|
||
private ?string $_issuer_name = null;
|
||
|
||
/**
|
||
* Источник данных банковской карты
|
||
*
|
||
* @var string|null
|
||
*/
|
||
#[Assert\Type('string')]
|
||
#[Assert\Choice(callback: [BankCardSource::class, 'getValidValues'])]
|
||
private ?string $_source = null;
|
||
|
||
/**
|
||
* Возвращает первые 6 цифр номера карты (BIN).
|
||
*
|
||
* @return string|null Первые 6 цифр номера карты (BIN)
|
||
*/
|
||
public function getFirst6(): ?string
|
||
{
|
||
return $this->_first6;
|
||
}
|
||
|
||
/**
|
||
* Устанавливает первые 6 цифр номера карты (BIN).
|
||
*
|
||
* @param string|null $first6 Первые 6 цифр номера карты (BIN). При оплате картой, [сохраненной в ЮKassa](/developers/payment-acceptance/scenario-extensions/recurring-payments) и других сервисах, переданный BIN может не соответствовать значениям `last4`, `expiry_year`, `expiry_month`.
|
||
*
|
||
* @return self
|
||
*/
|
||
public function setFirst6(?string $first6 = null): self
|
||
{
|
||
$this->_first6 = $this->validatePropertyValue('_first6', $first6);
|
||
return $this;
|
||
}
|
||
|
||
/**
|
||
* Возвращает последние 4 цифры номера карты.
|
||
*
|
||
* @return string|null Последние 4 цифры номера карты
|
||
*/
|
||
public function getLast4(): ?string
|
||
{
|
||
return $this->_last4;
|
||
}
|
||
|
||
/**
|
||
* Устанавливает последние 4 цифры номера карты.
|
||
*
|
||
* @param string|null $last4 Последние 4 цифры номера карты.
|
||
*
|
||
* @return self
|
||
*/
|
||
public function setLast4(?string $last4 = null): self
|
||
{
|
||
$this->_last4 = $this->validatePropertyValue('_last4', $last4);
|
||
return $this;
|
||
}
|
||
|
||
/**
|
||
* Возвращает срок действия, год, YYYY.
|
||
*
|
||
* @return string|null Срок действия, год, YYYY
|
||
*/
|
||
public function getExpiryYear(): ?string
|
||
{
|
||
return $this->_expiry_year;
|
||
}
|
||
|
||
/**
|
||
* Устанавливает срок действия, год, YYYY.
|
||
*
|
||
* @param string|null $expiry_year Срок действия, год, YYYY.
|
||
*
|
||
* @return self
|
||
*/
|
||
public function setExpiryYear(?string $expiry_year = null): self
|
||
{
|
||
$this->_expiry_year = $this->validatePropertyValue('_expiry_year', $expiry_year);
|
||
return $this;
|
||
}
|
||
|
||
/**
|
||
* Возвращает срок действия, месяц, MM.
|
||
*
|
||
* @return string|null Срок действия, месяц, MM
|
||
*/
|
||
public function getExpiryMonth(): ?string
|
||
{
|
||
return $this->_expiry_month;
|
||
}
|
||
|
||
/**
|
||
* Устанавливает срок действия, месяц, MM.
|
||
*
|
||
* @param string|null $expiry_month Срок действия, месяц, MM.
|
||
*
|
||
* @return self
|
||
*/
|
||
public function setExpiryMonth(?string $expiry_month = null): self
|
||
{
|
||
$this->_expiry_month = $this->validatePropertyValue('_expiry_month', $expiry_month);
|
||
return $this;
|
||
}
|
||
|
||
/**
|
||
* Возвращает тип банковской карты.
|
||
*
|
||
* @return string|null Тип банковской карты
|
||
*/
|
||
public function getCardType(): ?string
|
||
{
|
||
return $this->_card_type;
|
||
}
|
||
|
||
/**
|
||
* Устанавливает тип банковской карты.
|
||
*
|
||
* @param string|null $card_type Тип банковской карты
|
||
*
|
||
* @return self
|
||
*/
|
||
public function setCardType(?string $card_type = null): self
|
||
{
|
||
$this->_card_type = $this->validatePropertyValue('_card_type', $card_type);
|
||
return $this;
|
||
}
|
||
|
||
/**
|
||
* Возвращает карточный продукт платежной системы.
|
||
*
|
||
* @return BankCardProduct|null Карточный продукт платежной системы
|
||
*/
|
||
public function getCardProduct(): ?BankCardProduct
|
||
{
|
||
return $this->_card_product;
|
||
}
|
||
|
||
/**
|
||
* Устанавливает карточный продукт платежной системы.
|
||
*
|
||
* @param BankCardProduct|array|null $card_product Карточный продукт платежной системы
|
||
*
|
||
* @return self
|
||
*/
|
||
public function setCardProduct(mixed $card_product = null): self
|
||
{
|
||
$this->_card_product = $this->validatePropertyValue('_card_product', $card_product);
|
||
return $this;
|
||
}
|
||
|
||
/**
|
||
* Возвращает код страны, в которой выпущена карта. Передается в формате ISO-3166 alpha-2.
|
||
*
|
||
* @return string|null Код страны, в которой выпущена карта
|
||
*/
|
||
public function getIssuerCountry(): ?string
|
||
{
|
||
return $this->_issuer_country;
|
||
}
|
||
|
||
/**
|
||
* Устанавливает код страны, в которой выпущена карта.
|
||
*
|
||
* @param string|null $issuer_country Код страны, в которой выпущена карта. Передается в формате [ISO-3166 alpha-2](https://www.iso.org/obp/ui/#iso:pub:PUB500001:en). Пример: ~`RU`.
|
||
*
|
||
* @return self
|
||
*/
|
||
public function setIssuerCountry(?string $issuer_country = null): self
|
||
{
|
||
$this->_issuer_country = $this->validatePropertyValue('_issuer_country', $issuer_country);
|
||
return $this;
|
||
}
|
||
|
||
/**
|
||
* Возвращает наименование банка, выпустившего карту.
|
||
*
|
||
* @return string|null Наименование банка, выпустившего карту
|
||
*/
|
||
public function getIssuerName(): ?string
|
||
{
|
||
return $this->_issuer_name;
|
||
}
|
||
|
||
/**
|
||
* Устанавливает наименование банка, выпустившего карту.
|
||
*
|
||
* @param string|null $issuer_name Наименование банка, выпустившего карту.
|
||
*
|
||
* @return self
|
||
*/
|
||
public function setIssuerName(?string $issuer_name = null): self
|
||
{
|
||
$this->_issuer_name = $this->validatePropertyValue('_issuer_name', $issuer_name);
|
||
return $this;
|
||
}
|
||
|
||
/**
|
||
* Возвращает источник данных банковской карты.
|
||
*
|
||
* @return string|null Источник данных банковской карты
|
||
*/
|
||
public function getSource(): ?string
|
||
{
|
||
return $this->_source;
|
||
}
|
||
|
||
/**
|
||
* Устанавливает источник данных банковской карты.
|
||
*
|
||
* @param string|null $source Источник данных банковской карты
|
||
*
|
||
* @return self
|
||
*/
|
||
public function setSource(?string $source = null): self
|
||
{
|
||
$this->_source = $this->validatePropertyValue('_source', $source);
|
||
return $this;
|
||
}
|
||
}
|