# Webhooks

O cadastro das rotas para nossos webhooks são feitas de forma manual, entre em contato com o nosso time.

# Transação

É com esse evento que avisamos se a transação foi aprovada ou negada. A rota é sempre do tipo POST e possui o seguinte body:

Nome	Tipo	Descrição	Obrigatório
`transactionId`	`string`	Id da cobrança no nosso sistema	`sim`
`orderId`	`string`	Identificador da compra	`sim`
`action`	`APPROVED \| DENIED`	Decisão da transação	`sim`

É com esse evento que atualizamos as etapas do onboarding em que o cliente se encontra. A rota é sempre do tipo POST e possui o seguinte body:

Nome	Tipo	Descrição	Obrigatório
`transactionId`	`string`	Id da cobrança no nosso sistema	`sim`
`orderId`	`string`	Identificador da compra do parceiro	`sim`
`action`	`STEP`	Identifica ação de step do Webhook	`sim`
`step`	`Step`	Atual etapa do Onboarding	`sim`
`hasInsurance`	`boolean`	Identifica se compra possui seguro adicionado	`não`
`interestRatePM`	`number`	Taxa de juros por mês	`não`
`interestRatePA`	`number`	Taxa de juros por ano	`não`
`numberOfInstallments`	`number`	Número de parcelas	`não`
`paymentInstallments`	`number`	Valor da parcela com juros e encargos	`não`
`downPaymentValue`	`number`	Valor de entrada	`não`
`financedAmount`	`number`	Valor financiado ([preço do(s) produto(s) + taxa de entrega + tarifa de cadastro] - valor de entrada)	`não`
`totalAmount`	`number`	Valor total com juros e encargos	`não`

É com esse evento que avisamos se a Nota Fiscal foi aprovada ou negada. A rota é sempre do tipo POST e possui o seguinte body:

Nome	Tipo	Descrição	Obrigatório
`transactionId`	`string`	Id da cobrança no nosso sistema	`sim`
`orderId`	`string`	Identificador da compra	`sim`
`action`	`ValidationResult`	Decisão da Validação	`sim`
`message`	`string`	Feedback da validação, caso exista	`não`

Abaixo, estão listados os possíveis motivos de reprovação de uma Nota Fiscal (podendo haver mais de um para a mesma nota):

Motivo de reprovação	Descrição
Sem carimbo	O recibo não possui o carimbo necessário.
CPF discrepante	O CPF informado na nota fiscal não corresponde ao CPF do cliente.
Valor da Nota inferior ao sistema	O valor da nota fiscal é inferior ao valor da compra registrado no sistema interno da Parcelex.
Problema para abrir o arquivo	Houve um erro ao tentar abrir o arquivo da nota fiscal. O formato utilizado deve ser sempre PDF

Caso existam motivo(s) de reprovação, o campo message conterá uma lista com os motivos separados por vírgula.