HEhel
Paylink

Disable a Pay Link

Disable an active paylink, preventing any further payments from being made through it.

patch/v1/paylink/{id}/disable

Request

  • Base URL
    https://api.hel.io
  • URL
    https://api.hel.io/v1/paylink/{id}/disable
  • Auth
    HTTP bearer

Path parameters

idstring required

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

Query parameters

disabledtrue | false required

Set to true to disable the pay link or false to enable it.

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

apiKeystring 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.

Changes

No recorded changes to this operation across all 2 revisions of this API.