POST receipt.cancel

Метод предназначен для отмены транзакции.

warning

Если у партнёра отсутствует доступ к методу /cancel, отмена платежа производится через обращение в службу поддержки Beepul. Для обработки запроса необходимо предоставить идентификатор чека (Beepul ID) и описание причины отмены.
Если статус платежа находится в значениях Cancelled (21) или Ожидание ответа поставщика (57), отмена такого платежа невозможна.
Тип мерчанта MerchantType = TezQR не поддерживает отмену транзакции. Для таких мерчантов метод CancelTransaction недоступен.

Отмена транзакции `POST /api/v1/partner/receipt/cancel`

info

Метод CancelTransaction используется для отмены как созданной, так и уже проведённой транзакции.

Пример запроса

{
  "id": "01JXHV0TP2MK3KC4QQ083ZRGH7",
  "reason": "Пользователь отменил оплату",
  "cancelledBy": "partner-service"
}

Свойства запрос

Параметр	Тип	Описание
`id`	string	Идентификатор платежа, сформированный Beepul и возвращаемый в ответе метода `/create` после успешного создания чека.
`reason`	string	(Опционально) Причина отмены, передаётся партнёром при необходимости.
`cancelledBy`	string	Наименование партнёра, инициировавшего отмену.

Пример успешного ответа

{
  "tid": "T123456",
  "id": "01JXHV0TP2MK3KC4QQ083ZRGH7",
  "state": 21,
  "create_date": 1713628800,
  "pay_date": 1713632400,
  "cancel_date": 1713636000,
  "error": null,
  "type": 1,
  "description": "Оплата заказа #1001",
  "merchant": {
    "merchant_id": 10001,
    "merchant_name": "Test Merchant",
    "category_id": 5411,
    "category_name": "Retail Grocery",
    "logo_url": "https://example.com/logo.png",
    "min_amount": 1000,
    "max_amount": 5000000
  },
  "account": [
    {
      "key": "orderid",
      "value": "1001",
      "label": "Order ID"
    },
    {
      "key": "customer",
      "value": "John Doe",
      "label": "Customer Name"
    }
  ],
  "ofd": {
    "id": "9f3b1a2c-6a44-4db0-8329-8c1b92f9e2b4",
    "code": 0,
    "message": "Registered successfully",
    "terminalId": "TERM123",
    "receiptId": 123456789,
    "time": "2025-08-21T13:30:00Z",
    "fiscalSign": "ABC123XYZ",
    "qrCodeUrl": "https://example.com/qrcode.png",
    "partnerFiscaliztionUrl": "https://partner.com/fiscal",
    "tin": "305123456",
    "spic": "998877",
    "vatRate": 15.0,
    "label": "Чек",
    "packageCode": "PKG123",
    "type": "sale",
    "merchantInfo": {
      "name": "ООО Example",
      "tin": "305123456",
      "address": "Tashkent, Amir Temur street 12"
    },
    "items": [
      {
        "name": "Товар 1",
        "price": 50000,
        "quantity": 2,
        "sum": 100000
      },
      {
        "name": "Товар 2",
        "price": 25000,
        "quantity": 1,
        "sum": 25000
      }
    ]
  },
  "amount": 125000,
  "init_amount": 125000,
  "currency": 860,
  "comission": 500,
  "is_verify": true,
  "rrn": "123456789012",
  "card_number": "860012******1234"
}

Свойства ответ

Свойство	Тип и пример значения	Описание
`tid`	string, уникальное строковое значение для партнера	Идентификатор транзакции, сформированный инициатором при создании чека (`receipt/create`)
`id`	string	Идентификатор платежа, сформированный Beepul и возвращаемый в ответе метода `/create` после успешного создания чека. Используется в последующих методах: `/authorize`, `/pay` и `/check-id`.
`state`	integer `ReceiptState`	Состояние чека
`create_date`	integer, timestamp	Время создания чека (в формате timestamp)
`pay_date`	integer, timestamp	Время оплаты чека (в формате timestamp)
`type`	integer `ReceiptType`	Тип чека
`description`	string	Описание платежа
`merchant`	object `MerchantDetails`	Информация о поставщике
`account`	array `account`	Дополнительные детали платежа по мерчанту
`ofd`	object `OFDResponseDetails`	Фискальные данные ОФД (доступны только для чека в статусе "Продажа")
`amount`	long	Сумма платежа в тийнах
`init_amount`	long	Первоначальная сумма платежа (указывается при частичном возврате)
`currency`	integer `ISO 4217`	Код валюты в соответствии со стандартом ISO 4217
`commission`	long	Сумма комиссии
`is_verify`	boolean	Признак необходимости авторизации. При true, переход в метод /authorize, false переход в метод /pay
`rrn`	string	RRN списания в платежной системе
`card_number`	string	Номер карты в маскированном виде.

Отмена транзакции POST /api/v1/partner/receipt/cancel​

Свойства запрос​

Свойства ответ​

Отмена транзакции `POST /api/v1/partner/receipt/cancel`

Свойства запрос

Свойства ответ