С помощью SDK можно возвращать платежи — полностью или частично. Порядок возврата зависит от способа оплаты
(payment_method) исходного платежа. При оплате банковской картой деньги возвращаются на карту,
которая была использована для проведения платежа. Как проводить возвраты
Часть способов оплаты (например, наличные) не поддерживают возвраты. Какие платежи можно вернуть
- Запрос на создание возврата
- Запрос на создание возврата через билдер
- Получить информацию о возврате
- Получить список возвратов с фильтрацией
Создание возврата в документации
Создает возврат успешного платежа на указанную сумму. Платеж можно вернуть только в течение трех лет с момента его создания. Комиссия ЮKassa за проведение платежа не возвращается.
В ответ на запрос придет объект возврата - RefundResponse в актуальном статусе.
import var_dump as var_dump
from yookassa import Refund
res = Refund.create({
"payment_id": "24e89cb0-000f-5000-9000-1de77fa0d6df",
"description": "Не подошел размер",
"amount": {
"value": "9000.00",
"currency": "RUB"
},
"sources": [
{
"account_id": "456",
"amount": {
"value": "9000.00",
"currency": "RUB"
}
}
]
})
var_dump.var_dump(res)Информация о создании возврата в документации
Билдер позволяет создать объект платежа — RefundRequest программным способом, через объекты.
import var_dump as var_dump
from yookassa import Refund
from yookassa.domain.models.currency import Currency
from yookassa.domain.models.refund_source import RefundSource
from yookassa.domain.request.refund_request_builder import RefundRequestBuilder
builder = RefundRequestBuilder()
builder.set_payment_id('24e89cb0-000f-5000-9000-1de77fa0d6df') \
.set_description("Не подошел размер") \
.set_amount({"value": 9000.0, "currency": Currency.RUB}) \
.set_sources([
RefundSource({
'account_id': 456,
'amount': {
'value': 9000.0,
'currency': Currency.RUB
},
"platform_fee_amount": {
"value": 10.01,
"currency": Currency.RUB
}
})
])
request = builder.build()
# Можно что-то поменять, если нужно
request.description = "Не подошел цвет и размер"
res = Refund.create(request)
var_dump.var_dump(res)Информация о возврате в документации
Запрос позволяет получить информацию о текущем состоянии возврата по его уникальному идентификатору.
В ответ на запрос придет объект возврата - RefundResponse в актуальном статусе.
import var_dump as var_dump
from yookassa import Refund
res = Refund.find_one('7894e5e2-a22e-434b-b6c1-e355ff096d1c')
var_dump.var_dump(res)Список возвратов в документации
Запрос позволяет получить список возвратов, отфильтрованный по заданным критериям.
В ответ на запрос вернется список возвратов с учетом переданных параметров. В списке будет информация о возвратах, созданных за последние 3 года. Список будет отсортирован по времени создания возвратов в порядке убывания.
Если результатов больше, чем задано в limit, список будет выводиться фрагментами. В этом случае в ответе на запрос
вернется фрагмент списка и параметр next_cursor с указателем на следующий фрагмент.
import var_dump as var_dump
from yookassa import Refund
cursor = None
data = {
"limit": 2, # Ограничиваем размер выборки
"payment_id": "21b23b5b-000f-5061-a000-0674e49a8c10", # Выбираем только по конкретному платежу
"created_at.gte": "2020-08-08T00:00:00.000Z", # Созданы начиная с 2020-08-08
"created_at.lt": "2020-10-20T00:00:00.000Z" # И до 2020-10-20
}
while True:
params = data
if cursor:
params['cursor'] = cursor
try:
res = Refund.list(params)
print(" items: " + str(len(res.items))) # Количество возвратов в выборке
print("cursor: " + str(res.next_cursor)) # Указательна следующую страницу
var_dump.var_dump(res)
if not res.next_cursor:
break
else:
cursor = res.next_cursor
except Exception as e:
print(" Error: " + str(e))
break