Возвраты

Объект возврата

Объект возврата (Refund) содержит актуальную информацию о возврате успешного платежа. Он приходит в ответ на любой запрос, связанный с возвратами.

Объект может содержать параметры и значения, не описанные в этом Справочнике API. Их следует игнорировать.

Параметр
Тип
Обязтелен
Описание

uuid

string

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

payment_uuid

string

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

status

string

Статус возврата. Возможные значения: pending, succeeded и canceled.

cancellation_details

object

Комментарий к статусу canceled: кто отменил платеж и по какой причине. Подробнее про неуспешные возвраты.

cancellation_details.party

string

Участник процесса возврата, который принял решение отменить транзакцию. Перечень и описание возможных значений

cancellation_details.reason

string

Причина отмены возврата. Перечень и описание возможных значений

amount

number

Возвращенная пользователю сумма в копейках.

description

string

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

receipt

object

Данные о чеке возврата. Отображается только при использовании сервиса Payvo.Чеки и у возвратов в статусе succeeded.

receipt.registration_status

string

Статус регистрации чека. Возможные значения:

  • pending — данные в обработке;

  • succeeded — чек успешно зарегистрирован;

  • canceled — чек зарегистрировать не удалось; обратитесь в техническую поддержку.

created_at

string

Время создания возврата. Указывается по UTC и передается в формате ISO 8601. Пример: 2025-07-10T11:52:31.827Z

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

Создает возврат успешного платежа на указанную сумму. Платеж можно вернуть только в течение трех лет с момента его создания. Комиссия Payvo за проведение платежа не возвращается.

POST https://api.payvo.ru/public/refunds

Параметры запроса

Параметр
Тип
Обязателен
Описание

payment_uuid

string

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

amount

number

Сумма в копейках, которую нужно вернуть пользователю.

description

string

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

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

curl https://api.payvo.ru/public/refunds \
  -X POST \
  -H "merchant-id: <ID магазина>" \
  -H "merchant-secret-key: <Секретный ключ>" \
  -H 'Content-Type: application/json' \
  -d '{
        "payment_uuid": "95ce46ab-0f52-42e5-a13b-d05b2dee9562",
        "amount": 1000
      }'

Ответ

В ответ на запрос придет объект возврата в актуальном статусе.

Пример тела ответа

{
  "errors": null,
  "refund": {
    "uuid": "eb0abe91-070a-4148-ba39-d984107a1547",
    "payment_uuid": "95ce46ab-0f52-42e5-a13b-d05b2dee9562",
    "status": "succeeded",
    "amount": 1000,
    "description": null,
    "created_at": "2025-07-11T09:18:56.000+03:00"
  }
}

Получение информации о возврате

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

GET https://api.payvo.ru/public/refunds/{refund_uuid}

Параметры запроса

Без параметров.

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

curl https://api.payvo.ru/public/refunds/{refund_uuid} \
  -H "merchant-id: <ID магазина>" \
  -H "merchant-secret-key: <Секретный ключ>"

Ответ

В ответ на запрос придет объект возврата в актуальном статусе.

Пример тела ответа

{
  "errors": null,
  "refund": {
    "uuid": "eb0abe91-070a-4148-ba39-d984107a1547",
    "payment_uuid": "95ce46ab-0f52-42e5-a13b-d05b2dee9562",
    "status": "succeeded",
    "amount": 1000,
    "description": null,
    "created_at": "2025-07-11T09:18:56.000+03:00"
  }
}
PreviousПлатежиNextПодтверждение платежа

Last updated

Was this helpful?