Webhooks: Notificações Automáticas

Documentação sobre o envio de webhooks (notificações automáticas) pelo sistema Vindi

Para realizar a atualização automática do pedido, a Vindi Commerce pode realizar a comunicação a cada alteração de status de uma transação, fazendo com que seu sistema acompanhe todo o fluxo de status e esteja sempre atualizado quanto a situação da transação.

Dessa forma você precisa configurar uma URL que receberá a chamada, processará os dados recebidos, e em seguida irá obter mais detalhes da transação através da API de Detalhes da Transação.

📘

Esse parâmetro está disponível em ambas as integrações (POST ou API) e chama-se transaction[url_notification]

Para receber a notificação automática de status, é necessário configurar uma URL que receberá a chamada, processará os dados recebidos, e em seguida irá obter mais detalhes da transação através de uma API específica.

A Vindi Commerce irá realizar o**POST** tipo formulário com a seguinte informação:

Parâmetro Descrição
token_transaction Token da transação
transaction[products][][extra] Informação Extra
transaction[products][][description] Descrição
transaction[products][][quantity] Quantidade do produto
transaction[products][][code] Código do produto
transaction[products][][price_unit] Valor unitário do produto
transaction[customer][email] e-mail do cliente
transaction[customer][address][postal_code] CEP
transaction[customer][address][city] Cidade
transaction[customer][address][street] Rua
transaction[customer][cpf] CPF
transaction[customer][address][state] Estado
transaction[customer][address][number] Número
transaction[customer][address][completion] Complemento
transaction[customer][token] Token do cliente
transaction[customer][address][neighborhood] Bairro
transaction[customer][name] Nome do Cliente
transaction[payment][payment_response] Response do Pagamento
transaction[payment][date_approval] Data de Aprovação do pagamento
transaction[payment][price_payment] Valor do pagamento
transaction[payment][number_of_voucher_sales] Número do comprovante
transaction[payment][selling_message] Mensagem do Vendedor
transaction[payment][url_payment] url do pagamentot
transaction[payment][payment_method_id] ID do Meio de Pagamento
transaction[payment][card_token] Token do cartão de crédito
transaction[payment][number_proccess] Número do processamento
transaction[payment][date_payment] Data do pagamento
transaction[payment][payment_method_name] Meio de pagamento
transaction[payment][split] Split do pagamento
transaction[company][name] Nome do Vendedor
transaction[company][contact] Número do contato do cliente
transaction[company][cnpj] CNPJ do Vendedor
transaction[company][url] URL da Empresa
transaction[company][cpf] CPF do Vendedor
transaction[company][token] Token do Vendedor
transaction[seller_token] Token do Vendedor
transaction[free] Campo Free
transaction[price_seller] Valor do Vendedor
transaction[price_payment] Valor
transaction[date_payment] Data do Pagamento
transaction[price_discount] Valor de desconto
transaction[status_id] ID do Status
transaction[shipping_price] Valor do Frete
transaction[price_additional] Valor adicional
transaction[payment_method_name] Meio de pagamento
transaction[status_name] Nome do Status
transaction[payment_method_id] ID do Meio de pagamentot
transaction[split] Parcelas
transaction[transaction_token] Token da Transação
transaction[order_number] Número do pedido
transaction[date_transaction] Data da Transação
transaction[shipping_type] Tipo de Frete
transaction[transaction_id] ID da Transação
transaction[price_original] Valor

A notificação será realizada através de um **POST**, que espera receber o retorno “HTTP 200” de sua aplicação.

Caso a página esteja fora do ar ou com algum outro erro e não retorne “HTTP 200”, serão feitas novas tentativas a cada 12 horas durante 3 dias.