VUZDevelopers

List payment pages for a business

GET
/payment-pages

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

Response Body

application/json

curl -X GET "https://example.com/payment-pages"
[  {    "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    }  }]