Unlock a wallet

POST

/v1/admin/wallet/{handle}/unlock

curl --request POST \
  --url https://api.gampeon.com/v1/admin/wallet/example/unlock \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "reason": "example" }'

• Production

Requires the role admin.

Not available with access tokens.

Authorizations

• session

Parameters

Path Parameters

handle

required

string

/^[a-z0-9_]{3,24}$/

Handle of the account

Request Body^required

Media typeapplication/json

object

reason

required

Reason, 5 to 500 characters. Stored in the audit log.

string

>= 5 characters <= 500 characters

Example ^generated

{
  "reason": "example"
}

Responses

200

Unlocked

Media typeapplication/json

object

handle

required

string

locked

required

Example

{
  "locked": false
}

400

Error codes: invalid_field

Media typeapplication/json

object

error

required

Machine-readable error code, for example not_found or rate_limited.

string

message

Human-readable detail. Only present for some errors.

string

Example ^generated

{
  "error": "example",
  "message": "example"
}

401

Error codes: unauthorized

Media typeapplication/json

object

error

required

Machine-readable error code, for example not_found or rate_limited.

string

message

Human-readable detail. Only present for some errors.

string

Example ^generated

{
  "error": "example",
  "message": "example"
}

403

Error codes: forbidden, token_not_allowed, four_eyes_required

Media typeapplication/json

object

error

required

Machine-readable error code, for example not_found or rate_limited.

string

message

Human-readable detail. Only present for some errors.

string

Example ^generated

{
  "error": "example",
  "message": "example"
}

404

Error codes: not_found

Media typeapplication/json

object

error

required

Machine-readable error code, for example not_found or rate_limited.

string

message

Human-readable detail. Only present for some errors.

string

Example ^generated

{
  "error": "example",
  "message": "example"
}