post
https://api.heleket.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Визначення
Повернути всі вхідні платежі на адресу відправника
Вам потрібно пройти один із необхідних параметрів, якщо ви пройдете обидва, обліковий запис буде ідентифікований order_id
Приклад запиту
curl https://api.heleket.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}