Sign in
Возвраты

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

Запрос позволяет получить информацию о текущем состоянии возврата по его уникальному идентификатору.

get/refunds/{refund_id}

Path parameters

refund_idstring required

Идентификатор возврата.

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

descriptionstring

Основание для возврата денег пользователю.

metadataMetadata

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

Example response

{
  "id": "1ddd77af-0bd7-500d-895b-c475c55fdefc",
  "payment_id": "1da5c87d-0984-50e8-a7f3-8de646dd9ec9",
  "status": "succeeded",
  "cancellation_details": {
    "party": "yoo_money",
    "reason": "yoo_money_account_closed"
  },
  "receipt_registration": "succeeded",
  "created_at": "2017-11-03T11:52:31.827Z",
  "amount": {
    "value": "1000.00",
    "currency": "RUB"
  },
  "sources": [
    {
      "account_id": "123",
      "amount": {
        "value": "1000.00",
        "currency": "RUB"
      },
      "platform_fee_amount": {
        "value": "1000.00",
        "currency": "RUB"
      }
    }
  ],
  "deal": {
    "id": "dl-d68d2fe4-2abb-47e5-8112-32e28f87fb52",
    "refund_settlements": [
      {
        "type": "payout",
        "amount": {
          "value": "1000.00",
          "currency": "RUB"
        }
      }
    ]
  },
  "refund_method": {
    "type": "sbp",
    "sbp_operation_id": "1027088AE4CB48CB81287833347A8777"
  },
  "refund_authorization_details": {
    "rrn": "603668680243"
  }
}

Changes