Возвраты

Создание возврата

Создает возврат успешного платежа на указанную сумму. Платеж можно вернуть только в течение трех лет с момента его создания: https://yookassa.ru/developers/api#create_payment. Комиссия ЮKassa за проведение платежа не возвращается.

post/refunds

Headers

Idempotence-Keystring required

Request body

payment_idstring required

Идентификатор платежа в ЮKassa.

descriptionstring

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

metadataMetadata

Любые дополнительные данные, которые нужны вам для работы (например, ваш внутренний идентификатор заказа). Передаются в виде набора пар «ключ-значение» и возвращаются в ответе от ЮKassa. Ограничения: максимум 16 ключей, имя ключа не больше 32 символов, значение ключа не больше 512 символов, тип данных — строка в формате UTF-8.

Example request

{
  "payment_id": "1da5c87d-0984-50e8-a7f3-8de646dd9ec9",
  "amount": {
    "value": "1000.00",
    "currency": "RUB"
  },
  "receipt": {
    "customer": {
      "full_name": "Иванов Иван Иванович",
      "inn": "6321341814",
      "email": "user@yoomoney.ru",
      "phone": "79000000000"
    },
    "items": [
      {
        "amount": {
          "value": "1000.00",
          "currency": "RUB"
        },
        "quantity": 1,
        "measure": "piece",
        "mark_quantity": {
          "numerator": 1,
          "denominator": 100
        },
        "country_of_origin_code": "RU",
        "customs_declaration_number": "10714040/140917/0090376",
        "excise": "20.00",
        "product_code": "00 00 00 01 00 21 FA 41 00 23 05 41 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 12 00 AB 00",
        "mark_mode": "0",
        "payment_subject_industry_details": [
          {
            "federal_id": "001",
            "document_date": "2020-11-18",
            "value": "123/43"
          }
        ]
      }
    ],
    "receipt_industry_details": [
      {
        "federal_id": "001",
        "document_date": "2020-11-18",
        "value": "123/43"
      }
    ],
    "receipt_operational_details": {
      "created_at": "2020-07-03T11:52:31.827Z"
    }
  },
  "sources": [
    {
      "account_id": "123",
      "amount": {
        "value": "1000.00",
        "currency": "RUB"
      },
      "platform_fee_amount": {
        "value": "1000.00",
        "currency": "RUB"
      }
    }
  ],
  "deal": {
    "refund_settlements": [
      {
        "type": "payout",
        "amount": {
          "value": "1000.00",
          "currency": "RUB"
        }
      }
    ]
  },
  "refund_method_data": {
    "type": "sbp",
    "electronic_certificate": {
      "amount": {
        "value": "1000.00",
        "currency": "RUB"
      },
      "basket_id": "110200010001100000000001"
    },
    "articles": [
      {
        "article_number": 1,
        "payment_article_number": 1,
        "tru_code": "329921120.06001010200080001643",
        "quantity": 10
      }
    ]
  }
}

Response

Запрос успешно обработан

idstring required

Идентификатор возврата платежа в ЮKassa.

payment_idstring required

Идентификатор платежа в ЮKassa.

status'pending' | 'succeeded' | 'canceled' required

Статус возврата платежа. Возможные значения: pending — возврат создан, но пока еще обрабатывается; succeeded — возврат успешно завершен, указанная в запросе сумма переведена на платежное средство пользователя (финальный и неизменяемый статус); canceled — возврат отменен, инициатор и причина отмены указаны в объекте cancellation_details (финальный и неизменяемый статус).

receipt_registration'pending' | 'succeeded' | 'canceled'

Статус регистрации чека. Возможные значения: pending — данные в обработке; succeeded — чек успешно зарегистрирован; canceled — чек зарегистрировать не удалось; если используете Чеки от ЮKassa: https://yookassa.ru/developers/payment-acceptance/receipts/54fz/yoomoney/basics, обратитесь в техническую поддержку, в остальных случаях сформируйте чек вручную. Присутствует, если вы используете решения ЮKassa для отправки чеков в налоговую: https://yookassa.ru/developers/payment-acceptance/receipts/basics.

created_atstring date-time required

Время создания возврата. Указывается по UTC: https://ru.wikipedia.org/wiki/%D0%92%D1%81%D0%B5%D0%BC%D0%B8%D1%80%D0%BD%D0%BE%D0%B5_%D0%BA%D0%BE%D0%BE%D1%80%D0%B4%D0%B8%D0%BD%D0%B8%D1%80%D0%BE%D0%B2%D0%B0%D0%BD%D0%BD%D0%BE%D0%B5_%D0%B2%D1%80%D0%B5%D0%BC%D1%8F и передается в формате ISO 8601: https://en.wikipedia.org/wiki/ISO_8601, например 2017-11-03T11:52:31.827Z