Sign in

v1

latestOpenAPI 3.1.02026-07-2478315484.9 KB
Payment Links

Update Payment Link

Changes the status of a payment link. Set status to DISABLED to immediately stop the link from accepting new payments, or ACTIVE to re-enable a previously disabled link. Links in EXPIRED or USED status cannot be reactivated.

put/payment-links/v1/{payment_link_id}

Path parameters

payment_link_idstring uuid required
Example:a1b2c3d4-e5f6-7890-abcd-ef1234567890

Unique identifier of the payment link

Request body

status'ACTIVE' | 'DISABLED' required

The target status to set on a payment link. Only ACTIVE and DISABLED transitions are permitted via the update endpoint.

  • ACTIVE: Re-enables a previously disabled link so it can accept payments again. Cannot be set on links with EXPIRED or USED status.
  • DISABLED: Immediately prevents the link from accepting new payments. Can be re-enabled by setting status back to ACTIVE.

Response

Payment link updated successfully