Payment Links

Update a payment link

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

patch/api/v1/payment-links/{id}

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.

Request body

couponIdstring

A coupon applied to every checkout from the link. Not with allowPromotionCodes.

allowPromotionCodesboolean

The payment page asks for an optional promotion code (a coupon's code). Not with couponId.

paymentMethodTypesstring[] nullable

Per-link override; null uses the merchant default.

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' nullable

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.

Response

Resource updated

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.