Endpoint
POST https://conciliation.stone.com.br/v2/webhook
Headers
| Nome | Obrigatório | Tipo | Descrição |
|---|---|---|---|
x-user-type | não | string | Deve ser usado somente se você for cliente Stone, utilizando sua chave própria criada diretamente no portal (padrão: client) |
Content-Type | sim | string | (padrão: application/json) |
accept | não | string |
Corpo da requisição
| Campo | Tipo | Obrigatório | Descrição |
|---|---|---|---|
| url | string | sim | |
| headers | string | não |
É necessário cadastrar um webhook a partir do qual receberá o tipo do evento e a url de download do arquivo (.csv).
O webhook estará diretamente associado ao ClientId, não sendo possível ter múltiplos webhooks para um mesmo Client. Atualizações no webhook devem ser feitas por meio da rota desta seção.
Apenas eventos de tipo PIX utilizam essa estratégia de notificação.
O resultado será informado através do código de status HTTP da resposta.
| HTTP Status Code | Descrição |
|---|---|
| 201 | Webhook cadastrado com sucesso |
| 400 | Erro nos parâmetros informados |
| 404 | Erro no formato da URL ou no método enviado |
| 409 | Erro de conflito, pois webhook já foi cadastrado |
| 500 | Ocorreu um erro interno na API, por favor nos informe |
| 503 | Um dos sistemas da Stone falhou, por favor nos informe |
| 504 | Ocorreu um timeout e não foi possível concluir o trabalho, tente novamente |
Validação da URL de notificação
Ao cadastrar um webhook, nós enviaremos uma requisição de validação (HTTP POST) para a URL informada antes de concluir a operação. A URL precisa responder com sucesso (HTTP 2xx) dentro de 3 segundos; caso contrário, a requisição será rejeitada e o webhook não é cadastrado.
Corpo da notificação enviada
{
"type": "validation_notification"
}
Authorization: Conciliadoras
Authorization: Cliente Stone
Jornada: Baixar o arquivo de conciliação
Etapa 7 de 10