Заблокировать статический кошелек
post https://api.cryptomus.com/v1/wallet/block-address Скопировать
Когда вам нужно заблокировать статический кошелек вашего клиента, все дальнейшие платежи не будут зачислены на его баланс. Вы можете произвести возврат этих средств только один раз. Средства будут возвращены на адреса, с которых они поступили.
Запрос
Параметры запроса
Имя | Тип параметра | Значение по умолчанию | Описание |
---|---|---|---|
uuid | stringuuidrequired_without: order_id | - | uuid статического кошелька |
order_id | stringmin:1max:32alpha_dashrequired_without: uuid | - | Идентификатор заказа статического кошелька |
is_force_refund | boolean | false | Верните все входящие платежи на адрес отправителя |
Тип параметра
stringuuidrequired_without: order_idЗначение по умолчанию
-Описание
uuid статического кошелькаТип параметра
stringmin:1max:32alpha_dashrequired_without: uuidЗначение по умолчанию
-Описание
Идентификатор заказа статического кошелькаТип параметра
booleanЗначение по умолчанию
falseОписание
Верните все входящие платежи на адрес отправителя
Вам необходимо передать один из обязательных параметров, если Вы передадите оба, аккаунт будет идентифицирован с помощью order_id
Пример запроса
curl https://api.cryptomus.com/v1/wallet/block-address \
-X POST \
-H 'merchant: 8b03432e-385b-4670-8d06-064591096795' \
-H 'sign: fe99035f86fa436181717b302b95bacff1' \
-H 'Content-Type: application/json' \
-d '{
"order_id": "1"
}'
СкопироватьОтвет
Параметры отклика
Имя | Описание |
---|---|
uuid | uuid статического кошелька |
status | Статус статического кошелька.Доступные опции:• blocked• active• in_active |
Описание
uuid статического кошелькаОписание
Статус статического кошелька.Доступные опции:- blocked- active- in_active
Пример ответа
1{
2 "state": 0,
3 "result": {
4 "uuid": "fcc40793-39f9-4fa9-85b2-93148039a72b",
5 "status": "blocked"
6 }
7}
СкопироватьВозможные ошибки
Ошибки проверки
код : 422
примеры ответов:
1{
2 "state": 1
3}
Скопировать
1{
2 "state": 1,
3 "errors": {
4 "uuid": ["validation.required_without"],
5 "order_id": ["validation.required_without"]
6 }
7}
СкопироватьВнутренняя ошибка сервера
код : 500
примеры ответов:
1{
2 "message": "Server error, #1",
3 "code": 500,
4 "error": null
5}
Скопировать