Proteside Docs
Referência de endpointsPáginas de pagamento

Criar ou alterar uma página de pagamento

POST
/stores/{id}/pages

Identificada por store_id + url_pattern (curinga * suportado).

Autorização

bearerAuth
headerAutorizaçãoBearer <token>

Token de API criado em Configurações → API. Os escopos ficam vinculados ao token; cada operação lista o escopo exigido em x-scope.

Parâmetros de caminho

id*string
Formatouuid

Parâmetros de consulta

org_id?string

Somente parceiros (orgs:manage): atua sobre esta organização filha. Também pode ser enviado como org_id em corpos JSON.

Formatouuid

Parâmetros de cabeçalho

Idempotency-Key?string

Reproduz a resposta original por 24 h

Tamanho1 <= length <= 255

Corpo da requisição

application/json
  1. body
url_pattern*string

Path starting with '/', '*' wildcard allowed

payment_methods?array<>
mode?string
Valor em"monitor""block"

Corpo da resposta

Página

application/json
  1. response
id?string
Formatouuid
store_id?|
Formatouuid
url_pattern?string
url?string
domain?string
is_payment_page?boolean
mode?string
payment_methods?array<>
status?string
created_at?string
Formatodate-time
curl -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"}