> ## Documentation Index
> Fetch the complete documentation index at: https://docs.4seletpay.com.br/llms.txt
> Use this file to discover all available pages before exploring further.
# Criar Endpoint
> Cria um novo endpoint de webhook para a conta informada no header `account`. O endpoint receberá notificações POST para os eventos selecionados. Requer autenticação Bearer.
Requer o header `account` com o código da conta. O endpoint criado começa com status `Ativo` e receberá notificações POST para cada evento listado em `events`.
O campo `events` deve conter ao menos um evento válido. Consulte a [referência de eventos](/pages/webhook-endpoints/reference#eventos-disponíveis) para ver todos os valores aceitos.
## OpenAPI
````yaml POST /v1/webhook-endpoints
openapi: 3.1.0
info:
title: 4Selet Pay API
description: >
API de processamento de pagamentos da plataforma 4Selet Pay. Suporta
cobranças únicas, assinaturas recorrentes, PIX, Cartão de Crédito. Todas as
rotas autenticadas requerem um Bearer Token obtido via `/v1/login`.
version: 1.0.0
contact:
name: 4Selet Pay
email: suporte@4selet.com.br
servers:
- url: https://sandbox.4seletpay.com.br/api
description: Servidor de Sandbox
security:
- bearerAuth: []
tags:
- name: Autenticação
description: Rotas de autenticação e criação de usuários
- name: Cobranças
description: Criação, consulta, cancelamento e reembolso de cobranças
- name: Pedidos
description: Consulta de pedidos e gerenciamento de confirmações desafiadas
- name: Assinaturas
description: Criação e gerenciamento de assinaturas recorrentes
- name: Faturas
description: Gerenciamento de faturas e pagamento de faturas em atraso
- name: Clientes Bloqueados
description: Gerenciamento de lista negra de clientes
- name: Contas
description: Criação e gerenciamento de contas na plataforma
- name: Aplicativo
description: Endpoints para dashboard e uso via aplicativo mobile
- name: Notificações Push
description: Envio e gerenciamento de notificações push
- name: Utilitários
description: Endpoints utilitários como listagem de fusos horários
- name: Gestão
description: Relatórios gerenciais (acesso restrito a Super Admins)
- name: Webhooks
description: Endpoints para receber notificações de gateways de pagamento
- name: Endpoints de Webhook
description: >-
Gerenciamento de endpoints de webhook para receber notificações de eventos
da plataforma
- name: Links de Pagamento
description: Criação e gerenciamento de links de pagamento com checkout pré-configurado
paths:
/v1/webhook-endpoints:
post:
tags:
- Endpoints de Webhook
summary: Criar endpoint de webhook
description: >
Cria um novo endpoint de webhook para a conta informada no header
`account`. O endpoint receberá notificações POST para os eventos
selecionados. Requer autenticação Bearer.
operationId: createWebhookEndpoint
parameters:
- $ref: '#/components/parameters/AccountHeader'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/WebhookEndpointCreateRequest'
example:
url: https://meusite.com.br/webhook
events:
- order.paid
- charge.failed
- subscription.canceled
responses:
'201':
description: Webhook criado com sucesso
content:
application/json:
schema:
$ref: '#/components/schemas/SuccessResponse'
example:
mensagem: Webhook criado com sucesso
erro: false
mensagenserro: []
codigoretorno: 201
id: '42'
data: []
'401':
$ref: '#/components/responses/Unauthorized'
'404':
$ref: '#/components/responses/NotFound'
'500':
$ref: '#/components/responses/ServerError'
security:
- bearerAuth: []
components:
parameters:
AccountHeader:
name: account
in: header
required: true
description: Código da conta à qual a operação se aplica
schema:
type: string
example: acc_abc123xyz
schemas:
WebhookEndpointCreateRequest:
type: object
required:
- url
- events
properties:
url:
type: string
format: uri
description: URL que receberá as notificações via POST
example: https://meusite.com.br/webhook
events:
type: array
minItems: 1
description: >
Lista de eventos a monitorar. Valores aceitos: `welcome`,
`email.confirmation`, `email.recovery`, `account.bank.update`,
`account.team.invite`, `order.paid`, `order.failed`,
`order.refunded`, `order.challenged`, `order.unprocessed`,
`order.chargeback`, `pix.generated`, `charge.created`,
`charge.pending`, `charge.paid`, `charge.failed`, `charge.reproved`,
`charge.refunded`, `charge.partial_refunded`, `charge.expired`,
`charge.canceled`, `charge.challenged`, `charge.chargeback`,
`withdrawal.requested`, `purchase.many_failed`,
`subscription.canceled`, `subscription.delayed`,
`subscription.regularized`, `invoice.created`, `invoice.paid`,
`invoice.failed`
items:
type: string
enum:
- welcome
- email.confirmation
- email.recovery
- account.bank.update
- account.team.invite
- order.paid
- order.failed
- order.refunded
- order.challenged
- order.unprocessed
- order.chargeback
- pix.generated
- charge.created
- charge.pending
- charge.paid
- charge.failed
- charge.reproved
- charge.refunded
- charge.partial_refunded
- charge.expired
- charge.canceled
- charge.challenged
- charge.chargeback
- withdrawal.requested
- purchase.many_failed
- subscription.canceled
- subscription.delayed
- subscription.regularized
- invoice.created
- invoice.paid
- invoice.failed
example:
- order.paid
- charge.failed
SuccessResponse:
type: object
properties:
mensagem:
type: string
example: Operação realizada com sucesso
erro:
type: boolean
example: false
mensagenserro:
type: array
items:
type: string
example: []
codigoretorno:
type: integer
example: 200
id:
type: string
example: 00000000-0000-0000-0000-000000000000
data:
description: Dados retornados pela operação (objeto, array ou vazio)
nullable: true
ErrorResponse:
type: object
properties:
mensagem:
type: string
example: Um erro inesperado acabou de acontecer.
erro:
type: boolean
example: true
mensagenserro:
type: array
items:
type: string
example:
- Detalhe do erro ocorrido.
codigoretorno:
type: integer
example: 400
id:
type: string
example: 00000000-0000-0000-0000-000000000000
data:
type: array
example: []
responses:
Unauthorized:
description: Não autorizado — token inválido ou ausente
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
example:
mensagem: Unauthenticated.
erro: true
mensagenserro: []
codigoretorno: 401
id: 00000000-0000-0000-0000-000000000000
data: []
NotFound:
description: Recurso não encontrado
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
example:
mensagem: The charge code does not match any charge
erro: true
mensagenserro: []
codigoretorno: 404
id: 00000000-0000-0000-0000-000000000000
data: []
ServerError:
description: Erro interno do servidor
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
example:
mensagem: Um erro aconteceu.
erro: true
mensagenserro:
- Erro interno. Tente novamente mais tarde.
codigoretorno: 500
id: 00000000-0000-0000-0000-000000000000
data: []
securitySchemes:
bearerAuth:
type: http
scheme: bearer
bearerFormat: JWT
description: >-
Token JWT obtido via `POST /v1/login`. Envie no header `Authorization:
Bearer `.
````