POST - Cadastrar novo webhook

Nesta página

POST Cadastrar novo Webhook

https://api.premepay.com/stores/:id/endpoints

Lista de Parâmetros para cadastro de webhook

Parametro	Tipo	Significado
endpoint	string	Endpoint ao qual a Primefy vai notificar
description	string	Descrição
destination	string	Destino
secretKey	string	Chave-secreta opcional
events	array<int>
type	int	Qual tipo de notificação deve ser enviada para o Endpoint

Parâmetros relacionados a propriedade `destination`:

Parametro	Tipo	Destino
0	int	API
1	int	Pluga
2	int	Zappier
3	int	IFTTT

Parâmetros relacionados a propriedade `type`:

Parametro	Tipo	Descrição
0	Transaction Created	Para compras criadas que aguardam o pagamento como BOLETO e PIX
1	Transaction Succeded	Para Ordens de Pagamentos confirmadas via Cartão de Crédito, Boleto e PIX.
2	Transaction Canceled	Para pagamentos que sofreram Estorno Total ou Parcial
3	Transaction Failed	Para Ordens de Pagamentos falhada
4	Transaction Disputed	Para Ordem de Pagamento onde o Consumidor decidiu constestar, abrindo uma Disputa
5	Transaction Chargedback	Para quando a Disputa aberta foi perdida e o pagamento devolvido ao Consumidor
6	Transaction Dispute Succeded	Para quando o Consumidor perde a Disputa
7	Withdrawal Succeded	Saque liquidado

Exemplo de requisição

Este é um exemplo de como a sua requisição para cadastrar um novo webhook deve parecer.

Corpo do exemplo

Respostas

Caso a sua requisição seja bem sucedida, você irá receber o retorno do objeto do Voucher.

Caso sua requisição tenha os parâmetros de criação inválidos - por exemplo, especificando um campo ou um valor inválido - você pode receber como resposta o retorno de um erro. Veja abaixo a lista completa de respostas possíveis.

200: OK
400: Bad Request
401: Não autorizado
403: Proibido
500: Internal Server Error

Abaixo o objeto Json que o estabelecimento vai receber em sua API (se cadastrada como destino) quando um evento de notificação for disparado:

{
    "number": "P654762",
    "amount": "99.00",
    "status": "succeded",
    "payment": {
        "status": "succeded"
    },
    "paymentUrl": null,
    "metadata": {
        "test1": "test1",
        "test2": "test2"
    }
}

Se o destino for uma das ferramentas externas, o objeto é um pouco mais completo, conforme abaixo:

{
	"order": {
		"number": "P735831",
		"description": "Compra",
		"status": "Confirmado"
	},
	"customer": {
		"name": "Usuário Teste Exemplo 01",
		"identificationNumber": "52789024006",
		"email": "[email protected]",
		"phone": "(11) 12345-6789",
		"address": {
			"street": "Rua tal",
			"number": "123",
			"district": "Brás",
			"reference": "Casa",
			"zipcode": "02814000",
			"city": "São Paulo",
			"state": "SP",
			"country": "BR"
		}
	},
	"payment": {
		"installments": 3,
		"installment": 0, // só vai preenchido se for uma PARCELA de boleto
		"amount": "R$ 99,00",
		"type": "Cartão de Crédito",
		"status": "Confirmado",
		"receivedOn": "26/03/2022 06:38:32"
	},
	"metadata": {
		"teste1": "teste1",
		"teste2": "teste2"
	},
	"createdOn": "26/03/2022 06:38:31",
	"updatedOn": "26/03/2022 06:38:31"
}

Conteúdo Relacionado

<aside> <img src="https://s3-us-west-2.amazonaws.com/secure.notion-static.com/bfe6a9ef-6d9a-405e-9fbe-484666d3fb5e/PUT.png" alt="https://s3-us-west-2.amazonaws.com/secure.notion-static.com/bfe6a9ef-6d9a-405e-9fbe-484666d3fb5e/PUT.png" width="40px" /> PUT - Editar um webhook

</aside>

<aside> <img src="https://s3-us-west-2.amazonaws.com/secure.notion-static.com/e3aeb85f-a7e2-40f4-b805-7e883e3d72e2/DELETE.png" alt="https://s3-us-west-2.amazonaws.com/secure.notion-static.com/e3aeb85f-a7e2-40f4-b805-7e883e3d72e2/DELETE.png" width="40px" /> DELETE - Remover um webhook

</aside>