Skip to main content
PATCH
/
v1
/
deposits
/
{depositId}
/
api-key
Enable or Disable a Deposit by ID
curl --request PATCH \
  --url https://api.hel.io/v1/deposits/{depositId}/api-key \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "disabled": true
}
'
{
  "message": "Api key or token is invalid",
  "code": 401
}
Note: When using the production environment at moonpay.hel.io, set your API endpoint to api.hel.io/v1 and generate API keys there. For the development environment, use api.dev.hel.io/v1 and generate API keys from moonpay.dev.hel.io.

Authorizations

​
Authorization
string
header
required

Authentication using JWT token

Path Parameters

​
depositId
string
required

The unique ID of the deposit.

Query Parameters

​
apiKey
string
required

Your API key, which can be generated from the Helio Dashboard settings page.

Body

application/json
​
disabled
boolean

Indicates whether the deposit customer is enabled or disabled. Set to true to disable, or false to enable.

Response

Deposit disabled state updated successfully.