Proteside Endpoint referencePayment pages
Create or update a payment page
POST
Keyed by store_id + url_pattern (* wildcard supported).
bearerAuthheader
AuthorizationBearer <token>API token created in Settings → API. Scopes are attached to the token; each operation lists its required scope in x-scope.
id*stringFormat
uuidorg_id?stringPartners only (orgs:manage): act on this child organization. May also be sent as org_id in JSON bodies.
Format
uuidIdempotency-Key?stringReplays the original response for 24 h
Length
1 <= length <= 255application/json- body
url_pattern*stringPath starting with '/', '*' wildcard allowed
payment_methods?array<>mode?stringValue in
"monitor""block"Page
application/json- response
id?stringFormat
uuidstore_id?|Format
uuidurl_pattern?stringurl?stringdomain?stringis_payment_page?booleanmode?stringpayment_methods?array<>status?stringcreated_at?stringFormat
date-timecurl -X POST "https://example.com/stores/497f6eca-6276-4993-bfeb-53cbbbba6f08/pages" \ -H "Content-Type: application/json" \ -d '{ "url_pattern": "/checkout/pagamento", "payment_methods": [ "pix" ], "mode": "block" }'{ "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "store_id": "7fe87115-950c-4ae8-bd7e-970406bc9ac0", "url_pattern": "string", "url": "string", "domain": "string", "is_payment_page": true, "mode": "string", "payment_methods": [ "pix" ], "status": "string", "created_at": "2019-08-24T14:15:22Z"}