Skip to main content

Отменить платеж

/v2/Cancel

POST

https://securepay.tinkoff.ru/v2/Cancel

Метод отменяет платеж.

Подробнее об отмене платежа.

Авторизация

Security

Bearer API Token

Запрос

Request body schema application/json

Required

TerminalKey

String

Идентификатор терминала. Выдается мерчанту в Т‑Бизнес при заведении терминала.

Required

PaymentId

String

Идентификатор платежа в системе Т‑Бизнес.

Required

Token

String

Подпись запроса. Формируется по инструкции.

IP

String

IP-адрес покупателя.

Amount

Number

Сумма в копейках. Если не передан, используется Amount, переданный в методе Инициировать платеж.

При отмене операции в статусе NEW поле Amount игнорируется, даже если оно заполнено. Отмена проводится на полную сумму.

Receipt

Object

JSON-объект с данными чека. Параметр обязательный, если подключена онлайн-касса. При частичной отмене, данные, которые передаются в этом запросе, могут отличаться от данных, которые были переданы в методе Инициировать платеж. При полной отмене структура чека не передается, при частичной — передаются товары, которые нужно отменить.

oneOf

Required

FfdVersion

String

Версия ФФД. Возможные значения — 1.2 и 1.05.

Версия ФФД по умолчанию — 1.05.

ClientInfo

Object (ClientInfo)

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

Birthdate

String

Тег ФФД: 1243

Дата рождения клиента в формате ДД.ММ.ГГГГ.

Citizenship

String

Тег ФФД: 1244

Числовой код страны, гражданином которой является клиент. Код страны указывается в соответствии с Общероссийским классификатором стран мира ОКСМ.

DocumentСode

String

Тег ФФД: 1245

Числовой код вида документа, удостоверяющего личность.

Может принимать только следующие значения:

  • 21 ‑ Паспорт гражданина Российской Федерации
  • 22 ‑ Паспорт гражданина Российской Федерации, дипломатический паспорт, служебный паспорт, удостоверяющие личность гражданина Российской Федерации за пределами Российской Федерации
  • 26 ‑ Временное удостоверение личности гражданина Российской Федерации, выдаваемое на период оформления паспорта гражданина Российской Федерации
  • 27 ‑ Свидетельство о рождении гражданина Российской Федерации — для граждан Российской Федерации в возрасте до 14 лотереи
  • 28 ‑ Иные документы, признаваемые документами, удостоверяющими личность гражданина Российской Федерации в соответствии с законодательством Российской Федерации
  • 31 ‑ Паспорт иностранного гражданина
  • 32 ‑ Иные документы, признаваемые документами, удостоверяющими личность иностранного гражданина в соответствии с законодательством Российской Федерации и международным договором Российской Федерации
  • 33 ‑ Документ, выданный иностранным государством и признаваемый в соответствии с международным договором Российской Федерации в качестве документа, удостоверяющего личность лица безгражданства
  • 34 ‑ Вид на жительство — для лиц без гражданства
  • 35 - Разрешение на временное проживание — для лиц без гражданства
  • 36 ‑ Свидетельство о рассмотрении ходатайства о признании лица без гражданства беженцем на территории Российской Федерации по существу
  • 37 ‑ Удостоверение беженца
  • 38 ‑ Иные документы, признаваемые документами, удостоверяющими личность лиц без гражданства в соответствии с законодательством Российской Федерации и международным договором Российской Федерации
  • 40 ‑ Документ, удостоверяющий личность лица, не имеющего действительного документа, удостоверяющего личность, на период рассмотрения заявления о признании гражданином Российской Федерации или о приеме в гражданство Российской Федерации

DocumentData

String

Тег ФФД: 1246

Реквизиты документа, удостоверяющего личность. Например, серия и номер паспорта.

Address

String

Requirements: <= 256 characters

Тег ФФД: 1254

Адрес клиента-грузополучателя.

Required

Taxation

String

Requirements: [osn, usn_income, usn_income_outcome, esn, patent]

Тег ФФД: 1055

Система налогообложения. Возможные значения:

  • osn — общая СН;
  • usn_income — упрощенная СН (доходы);
  • usn_income_outcome — упрощенная СН (доходы минус расходы);
  • esn — единый сельскохозяйственный налог;
  • patent — патентная СН.

Email

String<email>

Requirements: <= 64 characters

Тег ФФД: 1008

Электронная почта клиента. Параметр обязательный, если не передан Phone.

Phone

String

Requirements: <= 64 characters

Тег ФФД: 1008

Телефон клиента в формате +{Ц}. Параметр обязательный, если не передан Email.

Customer

String

Тег ФФД: 1227

Идентификатор/имя клиента.

CustomerInn

String

Тег ФФД: 1228

ИНН клиента.

Required

Items

Array (Items_FFD_12)

Массив, содержащий в себе информацию о товарах. Количество товаров чеке не более 100.

Параметры, которые предусмотрены в протоколе для отправки чеков по маркируемым товарам, не являются обязательными для товаров без маркировки. Если используется ФФД 1.2, но реализуемый товар не подлежит маркировке, поля можно не отправлять или отправить со значением null.

AgentData

Object (AgentData)

Данные агента. Параметр обязательный, если используется агентская схема.

AgentSign

String

Тег ФФД: 1222

Признак агента. Возможные значения:

  • bank_paying_agent — банковский платежный агент;
  • bank_paying_subagent — банковский платежный субагент;
  • paying_agent — платежный агент;
  • paying_subagent — платежный субагент;
  • attorney — поверенный;
  • commission_agent — комиссионер;
  • another — другой тип агента.

OperationName

String

Requirements: <= 64 characters

Тег ФФД: 1044

Наименование операции.

Параметр обязательный, если AgentSign передан в значениях bank_paying_agent или bank_paying_subagent.

Phones

Array

Requirements: <= 19 characters

Тег ФФД: 1073

Телефоны платежного агента в формате +{Ц}.

Параметр обязательный, если AgentSign передан в значениях:

  • bank_paying_agent;
  • bank_paying_subagent;
  • paying_agent;
  • paying_subagent.

ReceiverPhones

Requirements: <= 19 characters

Тег ФФД: 1074

Телефоны оператора по приему платежей в формате +{Ц}.

Параметр обязательный, если AgentSign передан в значениях paying_agent или paying_subagent.

TransferPhones

Requirements: <= 19 characters

Тег ФФД: 1075

Телефоны оператора перевода в формате +{Ц}.

Параметр обязательный, если AgentSign передан в значениях bank_paying_agent или bank_paying_subagent.

OperatorName

String

Requirements: <= 64 characters

Тег ФФД: 1026

Наименование оператора перевода.

Параметр обязательный, если AgentSign передан в значениях bank_paying_agent или bank_paying_subagent.

OperatorAddress

String

Requirements: <= 243 characters

Тег ФФД: 1005

Адрес оператора перевода.

Параметр обязательный, если AgentSign передан в значениях bank_paying_agent или bank_paying_subagent.

OperatorInn

String

Requirements: <= 12 characters

Тег ФФД: 1016

ИНН оператора перевода. Параметр обязательный, если AgentSign передан в значениях bank_paying_agent или bank_paying_subagent.

SupplierInfo

Object (SupplierInfo)

Данные поставщика платежного агента. Параметр обязательный, если передается значение AgentSign в объекте AgentData.

Phones

Array

Requirements: <= 19 characters

Тег ФФД: 1171

Телефон поставщика в формате +{Ц}. Параметр обязательный, если передается значение AgentSign в объекте AgentData.

Name

String

Requirements: <= 239 characters

Тег ФФД: 1225

Наименование поставщика. Параметр обязательный, если передается значение AgentSign в объекте AgentData. Состоит из 239 символов, в которые включаются телефоны поставщика — + 4 символа на каждый телефон.

Например, если передано два телефона поставщика длиной 12 и 14 символов, максимальная длина наименования поставщика будет 239 – (12 + 4) – (14 + 4) = 205 символов.

Inn

String

Requirements: >= 10 characters and <= 12 characters

Тег ФФД: 1226

ИНН поставщика в формате ЦЦЦЦЦЦЦЦЦЦ. Параметр обязательный, если передается значение AgentSign в объекте AgentData.

Required

Name

String

Requirements: <= 128 characters

Тег ФФД: 1030

Наименование товара.

Required

Price

Number

Тег ФФД: 1079

Цена в копейках.

Required

Quantity

Number

Requirements: <= 8 characters

Тег ФФД: 1023

Количество или вес товара. Максимальное количество символов — 8, где:

  • целая часть — не больше 5 знаков,
  • дробная — не больше 3 знаков для Атол и 2 знаков для CloudPayments.

Required

Amount

Number

Requirements: <= 10 characters

Тег ФФД: 1043

Стоимость товара в копейках. Произведение Quantity и Price.

Required

Tax

String

Requirements: [none, vat0, vat5, vat7, vat10, vat20, vat105, vat107, vat110, vat120]

Тег ФФД: 1199

Ставка НДС. Возможные значения:

  • none — без НДС;
  • vat0 — НДС по ставке 0%;
  • vat5 — НДС по ставке 5%;
  • vat7 — НДС по ставке 7%;
  • vat10 — НДС по ставке 10%;
  • vat20 — НДС по ставке 20%;
  • vat105 — НДС чека по расчетной ставке 5/105;
  • vat107 — НДС чека по расчетной ставке 7/107;
  • vat110 — НДС чека по расчетной ставке 10/110;
  • vat120 — НДС чека по расчетной ставке 20/120.

Required

PaymentMethod

String

Requirements: [full_prepayment, prepayment, advance, full_payment, partial_payment, credit, credit_payment]

Default: full_payment

Тег ФФД: 1214

Признак способа расчета. Возможные значения:

  • full_prepayment — предоплата 100%;
  • prepayment — предоплата;
  • advance — аванс;
  • full_payment — полный расчет;
  • partial_payment — частичный расчет и кредит;
  • credit — передача в кредит;
  • credit_payment — оплата кредита.

Если значение не передано, по умолчанию в онлайн-кассу отправляется признак предмета расчета full_payment.

Required

PaymentObject

String

Requirements: [commodity, excise, job, service, gambling_bet, gambling_prize, lottery, lottery_prize, intellectual_activity, payment, agent_commission, contribution, property_rights, unrealization, tax_reduction, trade_fee, resort_tax, pledge, income_decrease, ie_pension_insurance_without_payments, ie_pension_insurance_with_payments, ie_medical_insurance_without_payments, ie_medical_insurance_with_payments, social_insurance, casino_chips, agent_payment, excisable_goods_without_marking_code, excisable_goods_with_marking_code, goods_without_marking_code, goods_with_marking_code, another]

Тег ФФД: 1212

Значения реквизита «признак предмета расчета» — тег 1212, таблица 101. Возможные значения:

  • commodity — товар;
  • excise — подакцизный товар;
  • job — работа;
  • service — услуга;
  • gambling_bet — ставка азартной игры;
  • gambling_prize — выигрыш азартной игры;
  • lottery — лотерейный билет;
  • lottery_prize — выигрыш лотереи;
  • intellectual_activity — предоставление, результатов интеллектуальной деятельности;
  • payment — платеж;
  • agent_commission — агентское вознаграждение;
  • contribution — выплата;
  • property_rights — имущественное право;
  • unrealization — внереализационный доход;
  • tax_reduction — иные платежи и взносы;
  • trade_fee — торговый сбор;
  • resort_tax — курортный сбор;
  • pledge — залог;
  • income_decrease — расход;
  • ie_pension_insurance_without_payments — взносы на ОПС ИП;
  • ie_pension_insurance_with_payments — взносы на ОПС;
  • ie_medical_insurance_without_payments — взносы на ОМС ИП;
  • ie_medical_insurance_with_payments — взносы на ОМС;
  • social_insurance — взносы на ОСС;
  • casino_chips — платеж казино;
  • agent_payment — выдача ДС;
  • excisable_goods_without_marking_code — АТНМ;
  • excisable_goods_with_marking_code — АТМ;
  • goods_without_marking_code — ТНМ;
  • goods_with_marking_code — ТМ;
  • another — иной предмет расчета.

UserData

String

Тег ФФД: 1191

Дополнительный реквизит предмета расчета.

Excise

String

Тег ФФД: 1229

Сумма акциза в рублях с учетом копеек, которая включена в стоимость предмета расчета:

  • целая часть — не больше 8 знаков;
  • дробная часть — не больше 2 знаков;
  • значение не может быть отрицательным.

CountryCode

String

Requirements: <= 3 characters

Тег ФФД: 1230

Цифровой код страны происхождения товара в соответствии с Общероссийским классификатором стран мира — 3 цифры.

DeclarationNumber

String

Requirements: <= 32 characters

Тег ФФД: 1231

Номер таможенной декларации.

Required

MeasurementUnit

String

Тег ФФД: 2108

Единицы измерения.

Возможные варианты:

  • шт ‑ применяется для предметов расчета, которые могут быть реализованы поштучно или единицами;
  • г ‑ грамм;
  • кг ‑ килограмм;
  • т ‑ тонна;
  • см ‑ сантиметр;
  • дм ‑ дециметр;
  • м ‑ метр;
  • см2 ‑ квадратный сантиметр;
  • дм2 ‑ квадратный дециметр;
  • м2 ‑ квадратный метр;
  • мл ‑ миллиметр;
  • л ‑ китр;
  • м3 ‑ кубический метр;
  • кВт*ч ‑ киловатт/час;
  • Гкал ‑ гигакалория;
  • сут или дн ‑ сутки или день;
  • ч ‑ час;
  • мин ‑ минута;
  • с ‑ секунда;
  • Кбайт ‑ килобайт;
  • Мбайт ‑ мегабайт;
  • Гбайт ‑ гигабайт;
  • Тбайт ‑ терабайт;
  • - ‑ применяется при использовании иных едениц измерения

Также возможна передача произвольных значений.

Параметр обязательный, если версия ФФД онлайн-кассы — 1.2.

MarkProcessingMode

String

Тег ФФД: 2102

Режим обработки кода маркировки. Должен принимать значение, равное 0. Включается в чек , если предметом расчета является товар, который подлежит обязательной маркировке сканером — соответствующий код в поле paymentObject.

MarkCode

Array (MarkCode)

Тег ФФД: 1163

Код маркировки. Предназначен для нанесения на потребительскую упаковку, товары или товарный ярлык.

Включается в чек, если предметом расчета является товар, который подлежит обязательной маркировке сканером — соответствующий код в поле paymentObject.

Required

MarkCodeType

String

Тип штрих кода. Возможные значения:

  • UNKNOWN — код товара, формат которого не идентифицирован, как один из реквизитов;
  • EAN8 — код товара в формате EAN-8;
  • EAN13 — код товара в формате EAN-13;
  • ITF14 — код товара в формате ITF-14;
  • GS10 — код товара в формате GS1, который нанесен на товар, не подлежащий маркировке;
  • GS1M — код товара в формате GS1, который нанесен на товар, подлежащий маркировке;
  • SHORT — код товара в формате короткого кода маркировки, который нанесен на товар;
  • FUR — контрольно-идентификационный знак мехового изделия;
  • EGAIS20 — код товара в формате ЕГАИС-2.0;
  • EGAIS30 — код товара в формате ЕГАИС-3.0;
  • RAWCODE — код маркировки, как он был прочитан сканером.

Required

Value

String

Код маркировки.

MarkQuantity

Object (MarkQuantity)

Реквизит «дробное количество маркированного товара». Передается, только если расчет осуществляется за маркированный товар — соответствующий код в поле paymentObject и значение в поле measurementUnit равно 0.

Пример:

{ "numenator": "1" "denominator" "2" }

Numerator

Number

Тег ФФД: 1293

Числитель дробной части предмета расчета. Значение должно быть строго меньше значения реквизита «знаменатель».

Denominator

Number

Тег ФФД: 1294

Знаменатель дробной части предмета расчета. Значение равно количеству товара в партии (упаковке), которая имет общий код маркировки товара.

SectoralItemProps

Array (SectoralItemProps)

Отраслевой реквизит предмета расчета. Указывается только для товаров, которые подлежат обязательной маркировке сканером. Включение этого реквизита предусмотрено НПА отраслевого регулирования для соответствующей товарной группы.

Required

FederalId

String

Тег ФФД: 1262

Идентификатор ФОИВ — федеральный орган исполнительной власти.

Required

Date

String<date>

Тег ФФД: 1263

Дата нормативного акта ФОИВ.

Required

Number

String

Тег ФФД: 1264

Номер нормативного акта ФОИВ.

Required

Value

String

Тег ФФД: 1265

Состав значений, котрые определены нормативным актом ФОИВ.

Payments

Array (Payments)

Детали платежа.

Если объект не передан, будет автоматически указана итоговая сумма чека с видом оплаты «Безналичный».

Если передан объект receipt.Payments, значение в Electronic должно быть равно итоговому значению Amount в методе Инициировать платеж. При этом сумма введенных значений по всем видам оплат, включая Electronic, должна быть равна сумме (Amount) всех товаров, которые были переданы в объекте receipt.Items

Cash

Number

Requirements: <= 14 characters

Тег ФФД: 1031.

Вид оплаты «Наличные». Сумма к оплате в копейках.

Required

Electronic

Number

Requirements: <= 14 characters

Тег ФФД: 1081.

Вид оплаты «Безналичный».

AdvancePayment

Number

Requirements: <= 14 characters

Тег ФФД: 1215.

Вид оплаты «Предварительная оплата (Аванс)».

Credit

Number

Requirements: <= 14 characters

Тег ФФД: 1216.

Вид оплаты «Постоплата (Кредит)».

Provision

Number

Requirements: <= 14 characters

Тег ФФД: 1217.

Вид оплаты «Иная форма оплаты».

Shops

Array of objects ()

JSON-объект с данными маркетплейса. Обязательный для маркетплейсов.

Required

ShopCode

String

Код магазина.

Required

Amount

Number

Cумма в копейках, которая относится к указанному ShopCode.

Name

String

Requirements: <= 128 characters

Наименование товара.

QrMemberId

String

Код банка в классификации СБП, в который нужно выполнить возврат. Подробнее в параметре MemberId метода Получить список банков-пользователей QR.

Route

String

Requirements: [TCB, BNPL]

Способ платежа.

Source

String

Requirements: [installment, BNPL]

Источник платежа.

ExternalRequestId

String

Requirements: <= 256 characters

Идентификатор операции на стороне мерчанта.

Параметр обязательный для операций «Долями» и в рассрочку.

Параметр не работает для операций по СБП.

  • Если поле не передано или пустое (""), запрос будет обработан без проверки ранее созданных возвратов.
  • Если поле заполнено, перед проведением возврата будет проверен запрос на отмену с таким ExternalRequestId.
  • Если такой запрос уже есть, в ответе вернется текущее состояние платежной операции, если нет — платеж будет отменен.
  • Для операций «Долями» при заполнении параметра нужно генерировать значение в формате UUID v4.
  • Для операций в рассрочку при заполнении параметра нужно генерировать значение с типом string — ограничение 100 символов.

Ответ

200

OK

Это полезный материал?

Обратиться в поддержку
Loading...

openapi@tbank.ru

APIСценарииПодключение
Все сервисы T-API

АО «ТБанк» использует файлы «cookie» с целью персонализации сервисов и повышения удобства пользования веб-сайтом. «Cookie» представляют собой небольшие файлы, содержащие информацию о предыдущих посещениях веб-сайта. Если вы не хотите использовать файлы «cookie», измените настройки браузера.