Update a payment page

Authorization

X-Api-Key<token>

Business API key, e.g. vuz_ab12cdef... Created via Settings → Integrations → API Keys. Unlike partner keys, a public API key's STRING does not encode its environment — isolation instead comes from a completely separate sandbox database: a key minted on the Sandbox server (above) only ever reads/writes sandbox data and can never see or affect production, regardless of what the key looks like.

In: header

Path Parameters

pageId*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

slug?string

Globally unique public slug for the /p/:slug URL. Auto-generated from pageName when omitted.

embedEnabled?boolean

Allow this page to be embedded on explicitly allowlisted origins

Defaultfalse

allowedOrigins?array<string>

Exact merchant origins allowed to embed this page (normalized by the server)

Itemsitems <= 20

Default[]

pageName?string

Page name (Hebrew/default)

pageNameEn?string

Page name (English)

headerText?string

Header text (Hebrew/default)

headerTextEn?string

Header text (English)

extendedDescription?string

Extended description (Hebrew/default)

extendedDescriptionEn?string

Extended description (English)

businessCopy?string

Free-text "about this business" block for the public page (Hebrew/default)

businessCopyEn?string

Free-text "about this business" block for the public page (English)

mode?string

Deprecated

DEPRECATED — superseded by kind. How this page collects money. Retained for backward compat with the existing builder UI, which still derives and sends a value on every call purely to keep validating (Payment Pages Phase 3 backend cleanup). No longer required — omit it and kind alone is authoritative; the server derives a default mode from kind when omitted.

Value in

"one_time_fixed"
"one_time_flexible"
"recurring"

kind?string

Authoritative one-time-vs-recurring flag. Supersedes mode for branching logic — when omitted, derived from mode (RECURRING -> RECURRING, else -> ONE_TIME).

Value in

"one_time"
"recurring"

currency?string

Currency code

Default"ILS"

items?array<>

Default cart for this page (used when a sale doesn't specify its own items)

taxMode?string

How VAT is applied on this page

Default"auto"

Value in

"exempt"
"taxable"
"auto"

requireId?boolean

Require the payer ID number (ת.ז./ח.פ.)

Defaultfalse

requireName?boolean

Require the payer full name

Defaulttrue

requirePhone?boolean

Require the payer phone number

Defaultfalse

requestAddress?boolean

Request the payer address

Defaultfalse

requireTos?boolean

Require Terms of Service acceptance

Defaultfalse

tosLink?string

captcha?boolean

Require CAPTCHA before submitting payment

Defaultfalse

maxPayments?number

Max number of payments allowed (1 = single use)

Range1 <= value

Default1

maxPaymentsAdvanced?string

Advanced max-payments rule string (e.g. "SUM:NUM;...")

docType?string

Explicit document type to issue on payment. Unset = resolved by business type.

Value in

"order"
"delivery_note"
"agent_delivery_note"
"return_note"
"tax_invoice"
"consolidated_invoice"
"tax_invoice_receipt"
"credit_note"
"reservation_invoice"
"agent_invoice"
"receipt"
"donation_receipt"
"cash_withdrawal"
"bank_deposit"
"purchase_order"
"purchase_delivery_note"
"purchase_return"
"purchase_tax_invoice"
"purchase_credit_note"
"opening_balance"
"inventory_in"
"inventory_out"
"warehouse_transfer"
"inventory_adjustment"
"production_in"
"production_out"
"quote"
"deal_bill"
"work_order"

frequency?string

Billing frequency for the mandate this page spawns

Value in

"weekly"
"monthly"
"yearly"
"custom_days"

frequencyDay?number

Day of frequency (0-6 weekly, 1-31 monthly)

Range0 <= value <= 31

frequencyInterval?number

Interval for custom_days frequency

Range1 <= value <= 365

yearlyMonth?number

Month for yearly frequency (1-12)

Range1 <= value <= 12

yearlyDay?number

Day for yearly frequency (1-31)

Range1 <= value <= 31

endDate?string

End date for the mandate this page spawns (ISO), null = indefinite

startAfterDays?number

Days after the sale before the first recurring charge fires

maxCharges?number

Max number of recurring charges (0/unset = unlimited)

logoUrl?string

Logo URL shown on the page

accentColor?string

Accent/brand color (hex)

customCss?string

Custom CSS injected into the public page. Sanitization is a Phase-3/rendering concern, NOT enforced by this DTO.

customHtml?string

Custom HTML block (RESERVED, unused — Phase 3.4). Stored verbatim, not rendered.

successUrl?string

URL to redirect the payer to after a successful payment

failureUrl?string

URL to redirect the payer to after a failed/declined payment

cancelUrl?string

URL to redirect the payer to when a checkout is cancelled (payment-pages-icount-realign Phase 5)

ipnUrl?string

IPN (server-to-server) callback URL fired on payment events

metadata?

Additional metadata

payerFieldsConfig?array<>

Merchant-defined payer custom fields collected at checkout (cap 10 entries)

visibility?string

Deprecated

DEPRECATED — superseded by apiOnly. Access control for the public slug. 'api_only' pages 404 on /p/:slug and are only reachable via authenticated generate_sale calls.

Default"public"

Value in

"public"
"api_only"

apiOnly?boolean

Whether the public /p/:slug route is disabled (404s). Supersedes visibility === 'api_only' with a plain boolean, same behavior.

Defaultfalse

minAmount?number

Minimum allowed sale amount

Range0 <= value

maxAmount?number

Maximum allowed sale amount

Range0 <= value

maxUses?number

Usage cap = max number of COMPLETED sales (paid/activated). Unset = unlimited.

Range1 <= value

pageExpiresAt?string

Page-level expiry (ISO datetime). Past this, the slug 404s.

defaultSaleTtlMinutes?number

Overrides the hard-coded 2h/14d checkout TTL for sales generated from this page, in minutes

Range1 <= value

resultPageConfig?

Copy for the VUZ-hosted default result page (/pay/result/:sid)

brandId?string

Brand (שם מסחרי) this page inherits logo/name/doc template from — dormant hook, no behavior until brands ship.

internalNotes?string

Internal notes — owner-only, never surfaced publicly

coverImageUrl?string

Cover/banner image URL shown at the top of the public page

backgroundStyle?string

Curated public-page background theme

Default"bright"

Value in

"bright"
"white"
"dark"

cornerStyle?string

Corner radius theme applied to the public page card

Default"rounded"

Value in

"rounded"
"square"

defaultLanguage?string

Default public-page language

Default"he"

Value in

"he"
"en"

allowLanguageToggle?boolean

Whether the public page renders a he/en language switch

Defaultfalse

builtInFieldsConfig?

Tri-state config for the STANDARD payer fields (name/email/phone/vatId/address/note)

consentsConfig?

Consent-checkbox config (marketing opt-in, cancellation-policy ack)

Response Body

`application/json`

curl -X PATCH "https://example.com/payment-pages/string" \  -H "Content-Type: application/json" \  -d '{}'

{  "id": "string",  "businessId": "string",  "slug": "string",  "embedEnabled": true,  "allowedOrigins": [    "string"  ],  "pageName": "string",  "pageNameEn": "string",  "headerText": "string",  "headerTextEn": "string",  "extendedDescription": "string",  "extendedDescriptionEn": "string",  "businessCopy": "string",  "businessCopyEn": "string",  "mode": "one_time_fixed",  "kind": "one_time",  "currency": "string",  "items": [    {      "description": "string",      "descriptionHe": "string",      "descriptionEn": "string",      "unitPrice": 0,      "unitPriceIncl": 0,      "quantity": 0,      "minQuantity": 0,      "maxQuantity": 0,      "defaultQuantity": 0,      "quantityStep": 0,      "sku": "string"    }  ],  "taxMode": "string",  "requireId": true,  "requireName": true,  "requirePhone": true,  "requestAddress": true,  "requireTos": true,  "tosLink": "string",  "captcha": true,  "maxPayments": 0,  "maxPaymentsAdvanced": "string",  "docType": "order",  "frequency": "weekly",  "frequencyDay": 0,  "frequencyInterval": 0,  "yearlyMonth": 0,  "yearlyDay": 0,  "endDate": "2019-08-24T14:15:22Z",  "startAfterDays": 0,  "maxCharges": 0,  "logoUrl": "string",  "accentColor": "string",  "customCss": "string",  "customHtml": "string",  "successUrl": "string",  "failureUrl": "string",  "cancelUrl": "string",  "ipnUrl": "string",  "status": "active",  "metadata": {},  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z",  "hasRequiredTerminal": true,  "payerFieldsConfig": [    {      "key": "caseNumber",      "labelHe": "string",      "labelEn": "string",      "type": "text",      "required": true,      "maxLength": 500,      "options": [        {          "value": "string",          "labelHe": "string",          "labelEn": "string"        }      ],      "placement": "checkout"    }  ],  "visibility": "public",  "apiOnly": true,  "minAmount": 0,  "maxAmount": 0,  "maxUses": 0,  "pageExpiresAt": "2019-08-24T14:15:22Z",  "defaultSaleTtlMinutes": 0,  "resultPageConfig": {    "successTitleHe": "string",    "successTitleEn": "string",    "successBodyHe": "string",    "successBodyEn": "string",    "failureTitleHe": "string",    "failureTitleEn": "string",    "failureBodyHe": "string",    "failureBodyEn": "string",    "showDocumentLink": true  },  "brandId": "string",  "internalNotes": "string",  "coverImageUrl": "string",  "backgroundStyle": "bright",  "cornerStyle": "rounded",  "defaultLanguage": "he",  "allowLanguageToggle": true,  "builtInFieldsConfig": {    "name": "off",    "email": "off",    "phone": "off",    "vatId": "off",    "address": "off",    "note": "off"  },  "consentsConfig": {    "tosRequired": true,    "marketingOptIn": true,    "cancellationPolicyAck": true  }}

Authorization

Path Parameters

Request Body

Response Body

200application/json

`application/json`