CentralCSP
APIPayment Pages

Update a payment page

Changes a payment-page pattern or turns it off with enabled: false. Only the fields you send are changed, and the inventory is refreshed afterwards.

Requires the manager role on the website and the compliance plan feature.

PATCH
/v1/workspaces/{workspaceId}/websites/{websiteId}/compliance/payment-pages/{pageId}

Authorization

headerAuthorizationBearer <JWT>

An OpenID Connect access token from signing in to CentralCSP, acting as the signed-in user.

Path Parameters

workspaceId*string

The workspace's id.

websiteId*string

The website's id.

pageId*string

The payment page's id.

Request Body

application/json
  1. body

Only the fields you send are changed.

name?string

New display name.

Length1 <= length <= 255
urlPattern?string

New pattern to match page URLs against.

Length1 <= length <= 1024
patternType?PatternType

How urlPattern is read. glob uses * wildcards and is the default. regex is a regular expression.

Value in"glob""regex"
enabled?boolean

Turn the pattern on or off.

Response Body

A URL pattern that marks pages as taking payment.

application/json
  1. response
id*string
workspaceId*string
websiteId*string
name*string

Display name.

urlPattern*string

Pattern matched against the page URL a script loads on.

patternType*PatternType

How urlPattern is read. glob uses * wildcards and is the default. regex is a regular expression.

Value in"glob""regex"
enabled*boolean

A disabled pattern puts nothing in PCI scope.

createdAt*string
Formatdate-time
updatedAt*string
Formatdate-time
Example Request
curl -X PATCH 'https://api.centralcsp.com/v1/workspaces/01936b7a-6f2e-7c31-9a4d-2f8e1c5b7d90/websites/01936b7a-6f2e-7c31-9a4d-2f8e1c5b7d90/compliance/payment-pages/01936b7a-6f2e-7c31-9a4d-2f8e1c5b7d90' \  -H 'Content-Type: application/json' \  -d '{}'
Example Response
{  "id": "string",  "workspaceId": "string",  "websiteId": "string",  "name": "Checkout",  "urlPattern": "https://shop.example.com/checkout/*",  "patternType": "glob",  "enabled": true,  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z"}