Skip to main content
PATCH
/
v1
/
paylink
/
{id}
/
disable
Disable a Pay Link
curl --request PATCH \
  --url https://api.hel.io/v1/paylink/{id}/disable \
  --header 'Authorization: Bearer <token>'
{
  "disabled": true
}
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

​
id
string
required

The unique ID of the pay link you want to disable or enable.

Query Parameters

​
disabled
enum<boolean>
required

Toggle this to true to disable the pay link, or false to re-enable it. Set to true to disable the pay link or false to enable it.

Available options:
true,
false
​
apiKey
string
required

Your API key can be generated on the Helio Dashboard’s settings page.

Response

Indicates whether the pay link has been successfully disabled or re-enabled.