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

Объекты

acquiring_payments = payment_list​

Используйте acquiring_payments для API v1 и payment_list для API v2.

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

НазваниеОбязательностьТипОписание
id+stringУникальный идентификатор платежа
status+stringСтатус платежа. Возможные варианты: succeeded, in_progress, pending, failed
created_at+stringДата создания в формате ISO 8601
payment_details+objectПлатежные данные
amount_details+objectСумма
amounts-objectКомиссия за операцию
finished_at-stringДата завершения в формате ISO 8601
customer+objectДанные пользователя (отправителя платежа)
recurrent-objectТокен для проведения рекуррентных платежей
participant_details-objectДанные об участниках
refunds-arrayСписок возвратов
customer_interaction-objectДанные для взаимодействия с пользователем
transaction_info-objectДанные о транзакции
payment_options-objectПараметры для проведения платежа
metadata-*Любая дополнительная информация
error-objectОписание ошибки

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

  • in_progress — в обработке;
  • pending — ожидает вашего подтверждения (session/confirm) или отмены (session/cancel);
  • succeeded — оплата прошла успешно;
  • failed — оплата не прошла из-за ошибки.

acquiring_widget​

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

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

amount_details​

Сумма.

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

amounts​

Комиссия за операцию.

НазваниеОбязательностьТипОписание
fee-objectДанные о взимаемой комиссии

bank_account​

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

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

bank_card​

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

НазваниеОбязательностьТипОписание
number+stringНомер карты
expiration_month- (обязателен для приема платежей при наличии на карте)stringМесяц
expiration_year- (обязателен для приема платежей при наличии на карте)stringГод
security_code- (обязателен для приема платежей при наличии на карте)stringСекретный код CVC
cardholder_name-stringИмя владельца карты

card​

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

НазваниеОбязательностьТипОписание
type+ (не возвращается в ответе)stringТип передачи данных карты. Возможные варианты: bank_card, encrypted_card, tokenized_card
bank_card- (обязателен для type = bank_card)objectДанные карты
encrypted_card- (обязателен для type = encrypted_card)objectШифрованные данные карты
tokenized_card- (обязателен для type = tokenized_card)objectТокенизированный номер карты
brand-stringИнформация о карте. Возвращается в уведомлениях, нужна для отображения пользователям
last4-stringИнформация о карте. Возвращается в уведомлениях, нужна для отображения пользователям
bin-stringИдентификационный номер банка (первые 6 цифр номера карты)
card_id-stringСквозной идентификатор карты
country_iso3-stringКод страны (ISO 3166-1 alpha-3)

card_elements​

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

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

contacts​

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

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

customer​

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

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

customer_interaction​

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

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

data​

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

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

encrypted_card​

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

НазваниеОбязательностьТипОписание
number_hash+stringХеш номера карты
expiration_date_hash-stringХеш срока действия
security_code_hash-stringХеш секретного кода CVC
cardholder_name_hash-stringХеш имени владельца карты

fee​

Взимаемая комиссия.

НазваниеОбязательностьТипОписание
merchant_fee+objectСумма и валюта комиссии

error​

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

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

faster_payment_system​

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

НазваниеОбязательностьТипОписание
phone- (обязателен для выплат)stringТелефон получателя выплаты
bank_id- (обязателен для выплат)stringИдентификатор банка получателя выплаты в СБП
description- (*)stringНазначение выплаты или платежа (от 15 до 140 знаков)

(*) Чтобы узнать, обязателен ли параметр description, обратитесь к своему менеджеру.

faster_payment_system_verification​

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

НазваниеОбязательностьТипОписание
phone+stringТелефон получателя
bank_id+stringИдентификатор банка получателя в СБП

fps_no_account_widget​

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

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

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

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

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

НазваниеОбязательностьТипОписание
number_hash+stringХеш номера карты, полученный из виджета токенизации
brand+stringПлатежная система, например visa
last4+stringПоследние 4 цифры номера карты
type+stringВид токена. Всегда: card

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

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

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

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

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

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

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

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

info (данные токенизированной карты)​

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

Возвращается в ответ на запрос tokenize/elements.

НазваниеОбязательностьТипОписание
masked_card_number+stringМаскированный номер карты
card_network+stringПлатежная система карты
card_type+stringТип карты

inform​

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

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

merchant_fee​

Сумма и валюта комиссии.

НазваниеОбязательностьТипОписание
amount+intЗначение суммы в минорных единицах валюты. Если комиссия 1 USD, передается 100
currency+stringКод валюты согласно ISO 4217. Регистр не важен

metadata​

Этот блок может содержать любую дополнительную информацию. Это может быть строка, целое число или объект.

Он обязателен для транзакций, обрабатываемых от имени субпартнеров или субпартнером. В этом случае передайте поле submerchant. Вы можете добавить любые другие поля и назвать их по своему усмотрению — поля ниже даны только для примера.

НазваниеОбязательностьТипОписание
submerchant+stringЛюбое уникальное значение, например URL платежной страницы
merchant-stringID или название партнера
merchant_order_id-stringНомер заказа
user_os-stringОперационная система пользователя
user_location-stringСтрана пользователя
user_ip-stringIP пользователя
Примеры
{
  "metadata": {
    "merchant": "",
    "submerchant": "https://submerchant-site-url.com"
  }
}

number​

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

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

participant_details​

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

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

payment_details​

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

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

payment_method = payout_details​

Используйте payment_method для API v1 и payout_details для API v2.

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

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

payment_options​

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

НазваниеОбязательностьТипОписание
return_url-stringURL, на который нужно перенаправить пользователя после проведения платежа Обязательно для платежей без платежного виджета
recurrent-boolНужно ли провести платеж с помощью сохраненного токена
platform_details-objectДанные об устройстве пользователя

payments = payout_list​

Используйте payments для API v1 и payout_list для API v2.

Данные выплаты.

НазваниеОбязательностьТипОписание
id+stringИдентификатор выплаты
status+stringСтатус. Возможные варианты: succeeded, in_progress, pending, failed
created_at+stringДата создания в формате ISO 8601
payment_method/payout_details+objectСпособ получения выплаты
amount_details+objectСумма
amounts-objectКомиссия за операцию
finished_at-stringДата завершения в формате ISO 8601
customer-objectДанные получателя в вашей системе. Например, логин, по которому вы сможете идентифицировать получателя на своей стороне
participant_details-objectДанные об участниках выплаты. Например, имя и адрес отправителя и получателя
refunds-arrayСписок возвратов
transaction_info-objectДанные о транзакции
metadata-*Любая дополнительная информация
error-objectОписание ошибки
 

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

  • in_progress — в обработке;
  • pending — ожидает вашего подтверждения (session/confirm) или отмены (session/cancel);
  • succeeded — выплата прошла успешно;
  • failed — выплата не прошла из-за ошибки.

platform_details​

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

НазваниеОбязательностьТипОписание
type+stringТип устройства пользователя. Допустимые значения: desktop, mobile
os+stringОперационная система пользователя. Допустимые значения: ios, android, windows, linux
browser+stringБраузер пользователя. Допустимые значения: chrome, firefox, jivoMobile, microsoft edge, miui, opera, safari, samsung, webKit, weChat, yandex

public_token​

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

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

qr​

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

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

recipient​

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

НазваниеОбязательностьТипОписание
full_name- (обязательно при выплатах на любые карты)stringПолное имя
first_name-stringИмя
last_name-stringФамилия
middle_name-stringОтчество
company_name-stringНазвание компании
reference-stringИдентификатор получателя на вашей стороне
tax_reference-stringИдентификатор налогоплательщика
beneficiary_id- (обязательно при платежах и выплатах, у которых есть бенефициар или выгодоприобретатель)stringИНН бенефициара или выгодоприобретателя
country_iso3-stringСтрана (ISO-3166-1 alpha-3)

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

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

Входит в объекты: payment_method/payout_details, payment_details.

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

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

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

Входит в массивы: acquiring_payments/payment_list.

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

recurrent_token​

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

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

redirect​

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

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

refunds​

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

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

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

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

ru​

Данные банковского счета (в регионе ru).

НазваниеОбязательностьТипОписание
bik+stringБИК банка получателя
account+stringБанковский счет получателя
full_name+stringФИО физического лица. В случае выплаты на счет ИП, передается в следующем формате: ИП <ФИО>. При выплате юридическому лицу — наименование юрлица, если предусмотрено договором. Важно: если наименование или ФИО указано некорректно, банк-получатель может отказать в зачислении и деньги вернутся на счет отправителя
description+stringНазначение выплаты
inn- (обязательно при выплатах на счет юридического лица или ИП)stringИНН получателя, 10 цифр для юридических лиц, 12 цифр - для физических, в том числе для ИП
kpp- (обязательно при выплатах на счет юридического лица)stringКПП получателя, 9 цифр

sber_pay​

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

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

sender​

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

НазваниеОбязательностьТипОписание
full_name-stringПолное имя
first_name-stringИмя
last_name-stringФамилия
middle_name-stringОтчество
company_name-stringНазвание компании
reference-stringИдентификатор отправителя на вашей стороне
tax_reference-stringИдентификатор налогоплательщика
beneficiary_id- (обязателен для платежей и выплат, у которых есть бенефициар или выгодоприобретатель)stringИНН бенефициара или выгодоприобретателя
country_iso3-stringСтрана (ISO-3166-1 alpha-3)
city-stringГород
street-stringУлица и номер дома
postal_code-stringПочтовый индекс (до 6 цифр)
email-stringЭлектронная почта отправителя
ipv4-stringIPv4-адрес устройства отправителя
ipv6-stringIPv6-адрес устройства отправителя

session​

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

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

НазваниеОбязательностьТипОписание
id+stringИдентификатор сессии
status+stringСтатус. Возможные значения: created, in_progress, accepted, cancelled, error
created_at+stringДата создания в формате ISO 8601
updated_at+stringДата обновления в формате ISO 8601
payments/payout_list-arrayСписок выплат в рамках сессии
acquiring_payments/payment_list-arrayСписок платежей в рамках сессии
next_action-stringМетка, указывающая на действия для успешного прохождения транзакции. Возможные значения: confirm, capture
error-objectОписание ошибки

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

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

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

Дальнейшие действия (next_action)​

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

tokenized_card​

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

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

tokenize_widget​

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

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

transaction_info​

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

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

wallets​

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

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