Block static wallet
post
https://api.cryptomus.com/v1/wallet/block-address
When you need to block your clients static wallet, all the further payments will not be credited to his balance. You can make a refund of this funds only once. The funds will be returned to the addresses from which they came.
Request
Query parameters
| Name | Parameter type | Default value | Definition |
|---|---|---|---|
| uuid | stringuuidrequired_without: order_id | uuid of a static wallet | |
| order_id | stringmin:1max:32alpha_dashrequired_without: uuid | Order ID of a static wallet | |
| is_force_refund | boolean | false | Refund all incoming payments to sender’s address |
Parameter type
stringuuidrequired_without: order_idDefinition
uuid of a static walletParameter type
stringmin:1max:32alpha_dashrequired_without: uuidDefinition
Order ID of a static walletParameter type
booleanDefinition
Refund all incoming payments to sender’s address
You need to pass one of the required parameters, if you pass both, the account will be identified by order_id
Request example
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"
}'Response
Response parameters
| Name | Definition |
|---|---|
| uuid | uuid of the static wallet |
| status | Status of the static wallet.Available options:• blocked• active• in_active |
Definition
uuid of the static walletDefinition
Status of the static wallet.Available options:- blocked- active- in_active
Response example
1{
2 "state": 0,
3 "result": {
4 "uuid": "fcc40793-39f9-4fa9-85b2-93148039a72b",
5 "status": "blocked"
6 }
7}Possible errors
Validation errors
code : 422
Example responses:
1{
2 "state": 1
3}
1{
2 "state": 1,
3 "errors": {
4 "uuid": ["validation.required_without"],
5 "order_id": ["validation.required_without"]
6 }
7}Internal server error
code : 500
Example responses:
1{
2 "message": "Server error, #1",
3 "code": 500,
4 "error": null
5}