Перейти к основному содержимому

Объекты

account_info​

Описание банковского счета получателя выплаты.

НазваниеОбязательностьТипОписание
payment_system+stringСистема банковских платежей. Варианты: fps_info, fps_info_verification
fps_info- (обязателен для payment_system = fps_info)objectДанные получателя в Системе быстрых платежей
fps_info_verification- (обязателен для payment_system = fps_info_verification)objectДанные для проверки регистрации получателя в Системе быстрых платежей

card_details​

Данные карты в открытом виде.

НазваниеОбязательностьТипОписание
card_number+stringНомер карты
card_exp_month- (обязателен для приема платежей при наличии на карте)stringМесяц
card_exp_year- (обязателен для приема платежей при наличии на карте)stringГод
card_code- (обязателен для приема платежей при наличии на карте)stringСекретный код CVC
name_on_card-stringИмя владельца карты

card_elements​

Данные банковской карты для токенизации.

НазваниеОбязательностьТипОписание
ref+stringФиксированное значение, всегда number
type+stringФиксированное значение, всегда card_number
card_number+stringНомер карты

card_info​

Данные банковской карты получателя выплаты.

НазваниеОбязательностьТипОписание
type+ (не возвращается в ответе)stringТип передачи данных карты. Возможные варианты: card_details, hashed_card_details, tokenized_card
card_details- (обязателен для type = card_details)objectДанные карты
hashed_card_details- (обязателен для type = hashed_card_details)objectШифрованные данные карты
tokenized_card- (обязателен для type = tokenized_card)objectТокенизированный номер карты
card_network-stringИнформация о карте. Возвращается в уведомлениях, нужна для отображения пользователям
card_last4-stringИнформация о карте. Возвращается в уведомлениях, нужна для отображения пользователям
card_bin-stringИдентификационный номер банка (первые 6 цифр номера карты)
card_identifier-stringСквозной идентификатор карты
country_code_alpha3-stringКод страны (ISO 3166-1 alpha-3)

card_token​

Токен и данные токенизированной карты.

НазваниеОбязательностьТипОписание
token+stringТокен

card_tokenize​

Настройки для виджета токенизации.

НазваниеОбязательностьТипОписание
allow_tokenization+boolМожет ли этот публичный ключ использовать виджет токенизации

contact_info​

Контакты пользователя (получателя выплаты или отправителя платежа).

НазваниеОбязательностьТипОписание
email_address-stringЭлектронная почта пользователя
phone_number-stringТелефон пользователя

data​

Токен и токенизированный номер карты.

НазваниеОбязательностьТипОписание
card_token+objectДанные о токене

destination_info​

Данные для редиректа (перенаправления пользователя).

НазваниеОбязательностьТипОписание
url_address+stringАдрес для редиректа вместе с GET-параметрами
domain+stringАдрес для редиректа
http_method+stringМетод отправки. Возможные значения: GET, POST
additional_params-map<string,string>Набор параметров в зависимости от способа прохождения операции
extra_params-map<string,*>Набор параметров в зависимости от способа прохождения операции
  • Проверьте, есть ли какие-либо параметры в объектах additional_params и extra_params.
  • Перенаправьте пользователя на адрес из domain при помощи метода, указанного в http_method, включив все необходимые параметры в URL или в тело запроса.

error_info​

Описание ошибки.

НазваниеОбязательностьТипОписание
error_code-stringКод ошибки
error_description-stringОписание ошибки

fps_info​

Данные пользователя Системы быстрых платежей при выплатах и платежах.

НазваниеОбязательностьТипОписание
phone_number- (обязателен для выплат)stringТелефон получателя выплаты
bank_identifier- (обязателен для выплат)stringИдентификатор банка получателя выплаты в СБП
money_purpose- (обязателен для выплат)stringНазначение выплаты или платежа

fps_info_verification​

Данные для проверки регистрации пользователя в Системе быстрых платежей.

НазваниеОбязательностьТипОписание
phone_number+stringТелефон получателя
bank_identifier+stringИдентификатор банка получателя в СБП. Чтобы получить идентификатор, используйте метод fps/banks

fps_widget​

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

НазваниеОбязательностьТипОписание
session_id+stringИдентификатор платежной сессии

hashed_card_details​

Карта с шифрованными полями (токенизированная). Передается при проведении выплаты или оплаты через виджет.

НазваниеОбязательностьТипОписание
hashed_card_number+stringХэш номера карты
hashed_card_exp_date-stringХэш срока действия
hashed_card_code-stringХэш секретного кода CVC
hashed_name_on_card-stringХэш имени владельца карты

internet_banking​

Информация об оплате через платежные системы.

НазваниеОбязательностьТипОписание
type+stringПлатежная система. Возможные значения: sber_pay
sber_pay+objectИнформация об оплате через SberPay

moneyback​

Информация о возврате.

НазваниеОбязательностьТипОписание
id+stringУникальный идентификатор возврата
transaction_status+stringСтатус возврата. Возможные значения: in_progress, accepted, declined, error
sum_info+objectСумма возврата
created_date+stringДата создания
completed_date-stringДата завершения
chargeback-boolПоказывает, совершен ли возврат в рамках чарджбека
transaction_info-objectДанные о транзакции

Статусы возврата (transaction_status)​

  • in_progress — в обработке;
  • accepted — возврат прошел успешно;
  • declined — Zetplat отклонил возврат;
  • error — возврат не прошел из-за ошибки.

participant_info​

Данные об участниках выплаты.

НазваниеОбязательностьТипОписание
payer_info-objectДанные отправителя
payee_info-objectДанные получателя

payee_info​

Данные получателя. Набор необходимых данных зависит от способа получения выплаты.

НазваниеОбязательностьТипОписание
full_name- (обязательно при выплатах на любые карты)stringПолное имя
given_name-stringИмя
family_name-stringФамилия
patronymic-stringОтчество
legal_name-stringНазвание компании
user_id-stringИдентификатор получателя на вашей стороне
tax_id-stringИдентификатор налогоплательщика
beneficiary_id- (обязательно при платежах и выплатах, у которых есть бенефициар или выгодоприобретатель)stringИНН бенефициара или выгодоприобретателя
country_code_alpha3-stringСтрана (ISO-3166-1 alpha-3)

payer_info​

Данные отправителя. Набор необходимых данных зависит от способа получения выплаты.

НазваниеОбязательностьТипОписание
full_name-stringПолное имя
given_name-stringИмя
family_name-stringФамилия
patronymic-stringОтчество
legal_name-stringНазвание компании
user_id-stringИдентификатор получателя на вашей стороне
tax_id-stringИдентификатор налогоплательщика
beneficiary_id- (обязателен для платежей и выплат, у которых есть бенефициар или выгодоприобретатель)stringИНН бенефициара или выгодоприобретателя
country_code_alpha3-stringСтрана (ISO-3166-1 alpha-3)
ipv4_address-stringIPv4-адрес устройства отправителя
ipv6_address-stringIPv6-адрес устройства отправителя

payment_form_config​

Настройки виджета платежной формы для проведения платежей банковской картой.

НазваниеОбязательностьТипОписание
session_id+stringИдентификатор платежной сессии, по которой будет производиться оплата
show_autopay_option-boolНужно ли отображать в интерфейсе виджета чекбокс Соглашаюсь на автоплатежи
succeeded_url-stringURL, на который нужно перенаправить пользователя после успешного платежа
failed_url-stringURL, на который нужно перенаправить пользователя после ошибки при оплате
show_hold_message-boolНужно ли показывать плательщику сообщение об успешном платеже на этапе холдирования. По умолчанию false и виджет показывает экран загрузки до завершения холда
redirect_option-stringПравило, как будет открываться ссылка при редиректе после платежа:
- top — поверх всех фреймов,
- self — в том же фрейме,
- parent — во фрейме выше уровнем, если фреймы вложены один в другой.
Значение по умолчанию: top

payment_info​

Описание способа проведения платежа.

НазваниеОбязательностьТипОписание
type+stringТип способа оплаты. Возможные варианты: card_info, recurring_token_info, fps_info, faster_payment_system_binding
card_info- (обязателен для type = card_info)objectДанные банковской карты
recurring_token_info- (обязателен для type = recurrent)objectДанные для повтора платежа по токену
fps_info- (обязателен для type = fps_info)objectДанные для платежа по СБП

payment_qr​

Информация о способе платежа.

НазваниеОбязательностьТипОписание
qr_data-objectQR-код для оплаты по СБП

payments​

Все данные платежа.

НазваниеОбязательностьТипОписание
id+stringУникальный идентификатор платежа
transaction_status+stringСтатус платежа. Возможные варианты: successful, ongoing, pending, unsuccessful
created_date+stringДата создания в формате ISO 8601
payment_info+objectПлатежные данные
sum_info+objectСумма
completed_date-stringДата завершения в формате ISO 8601
user_info+objectДанные пользователя (отправителя платежа)
recurring_token_info-objectТокен для проведения рекуррентных платежей
participant_info-objectДанные об участниках
moneyback-arrayСписок возвратов
user_action-objectДанные для взаимодействия с пользователем
transaction_info-objectДанные о транзакции
extra_info-objectДополнительная информация. Любые данные, которые вам необходимы для проведения операции. Возвращаются в ответах и вебхуках
error_info-objectОписание ошибки
 

Статусы платежа (transaction_status)​

  • ongoing — в обработке;
  • pending — ожидает вашего подтверждения (transaction/approve) или отмены (transaction/cancel);
  • successful — оплата прошла успешно;
  • unsuccessful — оплата не прошла из-за ошибки.

payment_settings​

Параметры для проведения платежа.

НазваниеОбязательностьТипОписание
back_url-stringURL, на который нужно перенаправить пользователя после проведения платежа. URL должен быть валидным
allow_recurring-boolНужно ли провести платеж с помощью сохраненного токена

payout_info​

Описание способа получения выплаты.

НазваниеОбязательностьТипОписание
type+stringТип способа получения выплаты. Возможные варианты: card_info, recurring_token_info, tokenized_card
card_info- (обязателен для type = card_info)objectБанковская карта получателя
recurring_token_info- (обязателен для type = recurrent)objectДанные токена
tokenized_card- (обязателен для type = tokenized_card)objectТокенизированный номер карты

payouts​

Все данные выплаты.

НазваниеОбязательностьТипОписание
id+stringИдентификатор выплаты
transaction_status+stringСтатус. Возможные варианты: successful, ongoing, pending, unsuccessful
created_date+stringДата создания в формате ISO 8601
payout_info+objectСпособ получения выплаты
sum_info+objectСумма
completed_date-stringДата завершения в формате ISO 8601
user_info-objectДанные получателя в вашей системе. Например, логин, по которому вы сможете идентифицировать получателя на своей стороне
participant_info-objectДанные об участниках выплаты. Например, имя и адрес отправителя и получателя
moneyback-arrayСписок возвратов
transaction_info-objectДанные о транзакции
extra_info-objectДополнительная информация. Любые данные, которые вам необходимы для проведения операции. Возвращаются в ответах и вебхуках
error_info-objectОписание ошибки
 

Статусы выплаты (transaction_status)​

  • ongoing — в обработке;
  • pending — ожидает вашего подтверждения (transaction/approve) или отмены (transaction/cancel);
  • successful — выплата прошла успешно;
  • unsuccessful — выплата не прошла из-за ошибки.

public_token​

Публичный токен.

НазваниеОбязательностьТипОписание
token+stringТокен

qr_data​

QR-код для оплаты по СБП.

НазваниеОбязательностьТипОписание
qr_content+stringСсылка на QR-код
qr_image+stringСодержимое QR-кода

recurring_token​

Токен для рекуррентных платежей и выплат.

НазваниеОбязательностьТипОписание
token+stringТокен

recurring_token_info (токен для рекуррентных платежей и выплат)​

Токен для рекуррентных платежей и выплат.

Входит в объекты: payout_info, payment_info.

НазваниеОбязательностьТипОписание
token+stringТокен
initiated_by-stringВид рекуррентного платежа. Возможные значения: merchant — платеж MIT (по умолчанию), client — платеж CIT

recurring_token_info (информация о токене для рекуррентных платежей и выплат)​

Информация о токене для рекуррентных платежей и выплат.

Входит в объекты: payments.

НазваниеОбязательностьТипОписание
token+stringТокен
created_date+stringДата создания в формате ISO 8601
completed_date+stringДата завершения в формате ISO 8601
token_active+boolМожно ли проводить операции по этому токену: true — можно,  false — нельзя
initiated_by-stringВид рекуррентного платежа. Возможные значения: merchant — платеж MIT (по умолчанию), client — платеж CIT
type+stringВид токена. Всегда: recurring_token

sber_pay​

Информация для оплаты через SberPay.

НазваниеОбязательностьТипОписание
phone_number-stringНомер телефона для отправки PUSH или СМС. Формат: 7**********
channel+enumКанал приема оплаты через SberPay. Возможные значения: app, web_mobile, web

sum_info​

Сумма.

НазваниеОбязательностьТипОписание
sum+intЗначение суммы в минорных единицах валюты (в копейках). Если сумма платежа 100 рублей, передавайте 10000
currency_code+stringКод валюты согласно ISO 4217. Регистр не важен. Варианты: rub, eur

token_info (токенизированная карта)​

Данные о токенизированной банковской карте.

Возвращается в ответ на запрос token/state.

НазваниеОбязательностьТипОписание
hashed_card_number+stringТокен (токенизированный номер карты)
card_network+stringПлатежная система, например visa
card_last4+stringПоследние 4 цифры номера карты
type+stringВид токена. Всегда: card_info

token_info (публичный токен)​

Информация о публичном токене.

Возвращается в ответ на запрос token/state.

НазваниеОбязательностьТипОписание
token+stringТокен
created_date+stringДата создания в формате ISO 8601
completed_date+stringДата завершения в формате ISO 8601
token_active+boolМожно ли проводить операции по этому токену: true — можно,  false — нельзя
type+stringВид токена. Всегда: public_token

token_info (токен для рекуррентных платежей и выплат)​

Информация о токене для рекуррентных платежей и выплат.

Возвращается в ответ на запрос token/state.

НазваниеОбязательностьТипОписание
token+stringТокен
created_date+stringДата создания в формате ISO 8601
completed_date+stringДата завершения в формате ISO 8601
token_active+boolМожно ли проводить операции по этому токену: true — можно,  false — нельзя
initiated_by-stringВид рекуррентного платежа. Возможные значения: merchant — платеж MIT (по умолчанию), client — платеж CIT
type+stringВид токена. Всегда: recurring_token

tokenized_card​

Токенизированный номер карты.

НазваниеОбязательностьТипОписание
token+stringТокен

session_info​

Данные обо всех операциях, которые проводились в рамках одной платежной сессии.

Сессия необходима для проведения платежных операций. В рамках сессии может проходить одна или несколько операций одного или разных типов (например, несколько выплат, платеж и возврат, оплата с последующим разделением платежей).

НазваниеОбязательностьТипОписание
id+stringИдентификатор сессии
transaction_status+stringСтатус сессии
created_date+stringДата создания в формате ISO 8601
updated_at+stringДата обновления в формате ISO 8601
payouts-arrayСписок выплат в рамках сессии
payments-arrayСписок платежей в рамках сессии
next_step-stringОжидаемые действия
error_info-objectОписание ошибки

Статусы платежной сессии (transaction_status)​

  • created — сессия создана, ожидает старта или отмены;
  • in_progress — в обработке;
  • accepted — успешно завершена;
  • cancelled — отменена;
  • error — в процессе работы произошла непредвиденная ошибка.

    Внимание! Данный статус не является финальным. Обратитесь в поддержку Zetplat и дождитесь финального статуса транзакции.

Ожидаемые действия (next_step)​

Если это поле не пустое, значит, Zetplat ждет от вас определенных действий, чтобы продолжить операцию:

transaction_info​

Информация о транзакции.

НазваниеОбязательностьТипОписание
retrieval_ref_number-stringУникальный идентификатор транзакции (Retrieval Reference Number)
acquirer_ref_number-stringУникальный номер операции с кредитными картами (Acquirer Reference Number)
authorization_code-stringКод авторизации
fps_transaction_id-stringУникальный идентификатор операции в СБП

user_action​

Описание взаимодействия с пользователем.

НазваниеОбязательностьТипОписание
type+stringТип взаимодействия с пользователем. Возможные значения: destination_info, payment_qr
destination_info- (обязателен для type = destination_info)objectДанные для перенаправления пользователя
payment_qr- (обязателен для type = payment_qr)objectИнформация о способе платежа

user_info​

Данные о пользователе (получателе выплаты или отправителе платежа) в вашей системе. Например, логин, по которому вы сможете идентифицировать пользователя, и его контактная информация.

НазваниеОбязательностьТипОписание
user_id+stringИдентификатор пользователя (получателя выплаты или отправителя платежа) в вашей системе (до 128 символов)
contact_info-arrayСписок контактов пользователя

wallet_balance_info​

Данные о вашем балансе (счете обеспечения) для отправки выплат.

НазваниеОбязательностьТипОписание
id+stringИдентификатор баланса
sum_info+objectТекущий баланс