Повернути
Прохання
Параметри запиту
| Назва | Тип параметра | Визначення |
|---|---|---|
| address* | string | Адреса, до якої слід повернути кошти |
| is_subtract* | boolean | Чи приймати комісію з балансу торговця чи від суми повернення коштів true - Візьміть комісію з балансу торговців false - зменшити повернені суми на суму комісії |
| uuid* | uuidrequired_without: order_id | Рахунок -фактура UUID |
| order_id* | stringmin:1max:128alpha_dashrequired_without: uuid | Ідентифікатор замовлення рахунків -фактур |
Тип параметра
stringВизначення
Адреса, до якої слід повернути коштиТип параметра
booleanВизначення
Чи приймати комісію з балансу торговця чи від суми повернення коштів true - Візьміть комісію з балансу торговців false - зменшити повернені суми на суму комісіїТип параметра
uuidrequired_without: order_idВизначення
Рахунок -фактура UUIDТип параметра
stringmin:1max:128alpha_dashrequired_without: uuidВизначення
Ідентифікатор замовлення рахунків -фактур
* - обов'язковий параметр
Приклад запиту
curl https://api.cryptomus.com/v1/payment/refund \
-X POST \
-H 'merchant: 8b03432e-385b-4670-8d06-064591096795' \
-H 'sign: fe99035f86fa436181717b302b95bacff1' \
-H 'Content-Type: application/json' \
-d '{
"uuid": "8b03432e-385b-4670-8d06-064591096795",
"address": "TDD97yguPESTpcrJMqU6h2ozZbibv4Vaqm",
"is_subtract": "true"
}'Реакція
Приклад відповіді
1{
2 "state": 0,
3 "result": []
4}Можливі помилки
Помилки перевірки
кодування : 422
Приклад відповіді:
Якщо рахунок -фактура з uuid або order_id, який ви надали, не існує:
1{
2 "state": 1,
3 "message": "Payment was not found"
4} Якщо ви не передасте uuid і order_id , ви отримаєте це повідомлення. Це означає, що потрібен принаймні один із параметрів.
1{
2 "state": 1,
3 "errors": {
4 "uuid": ["validation.required_without"],
5 "order_id": ["validation.required_without"]
6 }
7}Якщо виплата заблокована на вашому торговцям, ви отримаєте це повідомлення про помилку. Це відбувається, наприклад, коли ви змінюєте пароль, а виплати заблоковані протягом 24 годин.
1{
2 "state": 1,
3 "message": "You are forbidden"
4}
5Якщо торговий гаманець, який підключений до рахунку -фактури, не існує:
1{
2 "state": 1,
3 "message": "Undefined merchant wallet"
4}Якщо рахунок -фактура не доопрацьована чи не сплачена.
1{
2 "state": 1,
3 "message": "Refunds are made only for completed payments"
4}Якщо сума, яку потрібно повернути, перевищує суму платежу рахунку -фактури:
1{
2 "state": 1,
3 "message": "The refund amount should not be more than the amount paid"
4}Якщо відбувається технічна робота і платіж тимчасово недоступний, ви можете отримати це повідомлення про помилку:
1{
2 "state": 1,
3 "message": "Server error"
4}