Возврат
Запрос
Параметры запроса
| Имя | Тип параметра | Описание |
|---|---|---|
| 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}