ZAzahlo
Payment Links

Deactivate a payment link

Deactivate a payment link. Use the response status and request ID to decide whether to retry, reconcile, or ask the customer for action.

post/api/v1/payment-links/{id}/deactivate

Request

  • Base URL
    https://merchant.zahlo.eu
  • Auth
    API key in header x-api-key

Path parameters

idstring required

The resource identifier returned by the merchant API.

Response

Successful response

idstring required
object'payment_link' required
urlstring uri required
activeboolean required
couponIdstring nullable
allowPromotionCodesboolean
paymentMethodTypesstring[] nullable

Per-link override; null uses the merchant default.

collectCustomerEmailtrue required
inactiveMessagestring nullable

Shown on the link page once the link is off or sold out; null shows the default text.

submitType'auto' | 'pay' | 'book' | 'donate'

The payment page's button label: auto keeps the default, the others say Pay, Book or Donate.

metadataobject

Up to 50 key-value pairs; keys up to 40 characters, values strings up to 500 characters.

Changes

No recorded changes to this operation across all 1 revision of this API.