Webhooks de Pedidos

Se você tem uma plataforma própria de pagamentos, envie seus pedidos ao Hotzapp para conversão e pós venda. É necessário ter conhecimentos de programação.

Para adicionar o seu produto (ou loja), vá na Configuração do Hotzapp e clique em Lojas. Clique no botão verde Adicionar Lojas e informe os dados do seu produto ou loja, selecionando a plataforma de pedidos Própria.

Após criar a nova loja no Hotzapp, clique em Instruções de Integração e copie a URL de webhook. Você enviará os seus pedidos em formato JSON via HTTP POST para esta URL.

Nosso sistema retornará o status HTTP 200, se der tudo certo. Junto com o status 200 enviamos uma String (exemplo: "ok_5ca8639ad1f0b82dd8d3c9f3") que serve como protocolo de entrega em nosso sistema. Recomendamos que você armezene ambas informações no seu sistema.

Importante: só damos suporte para essa integração nos planos Hotzapp Growth ou superior. É 100% sua responsabilidade: 1) construir essa integração; 2) garantir que os pedidos estão sendo enviados aos nossos sistemas de forma correta; 3) salvar os protocolos de entrega (exemplo: "ok_5ca8639ad1f0b82dd8d3c9f3").

Dica: ao construir a integração, procure enviar dados reais ou o mais próximo dos dados reais. Isso é de fundamental importância para não ter payloads descartados por duplicidade.

Lista de Parâmetros

Nome do Parâmetro Descrição Formato Exemplo
created_at data de criação do pedido String "2019-04-25T22:15:19.794Z"
transaction_id código da transação. Se não enviar este campo, será considerado como abandono de carrinho. String "88561324"
order_number número do pedido, caso exista String "2797"
name nome do comprador String "Filipe de Castro Maia"
phone telefone do comprador String "11988122895"
email e-mail do comprador String "fillipe@gmail.com"
address_street rua do endereço de entrega String "Rua Helio Castro Neves"
address_number número da casa ou edifício String "497"
address_complement complemento String "apto 1501"
address_district bairro String "Centro"
address_zip_code CEP String "01228200"
address_city cidade String "São Paulo"
address_state estado String "SP"
address_country país String "Brasil"
doc CPF ou CPNJ do comprador String "98765432100"
currency moeda da compra String "R$"
cms_vendor comissão do produtor Float 397.00
total_price valor total da compra Float 497.00
receiver_type se é venda de produtor ou afiliado String "PRODUCER" ou "AFFILIATE"
cms_aff comissão do afiliado Float 100.00
aff código de identificação do afiliado String "3452735427"
aff_name nome do afiliado String "Leandro Mantelli"
pix_code Código de pagamento do PIX String ***código que o cliente usa para fazer o pagamento do pix***
pix_url URL do PIX String https://api.pagar.me/1/pix/live_cjiurmaa432487263ax7c
billet_url URL do boleto String https://api.pagar.me/1/boletos/live_cjiurmaa432487263ax7c
abandoned_checkout_url URL da página de carrinho abandonado String https://meudominio.com/fjdshdfsufysiud
billet_barcode código de barras do boleto String 23791229285000164932190000046905475730000028990
transaction_error_msg motivo da recusa de cartão String Saldo insuficiente no seu cartão.
paid_at data do pagamento String "2019-04-25T22:15:19.794Z"
payment_method forma de pagamento. Consultar tabela de formas e status de pagamento. String "billet"
financial_status status do pagamento. Consultar tabela de formas e status de pagamento. String "issued"
risk_level nível de risco de uma transação no cartão de crédito String "unknown", "low", "moderated", "high" ou "very_high"
line_items itens do carrinho Array de objetos [{
product_name: "Camisa social",
quantity: 2,
price: 197.00,
}]
line_items.product_name descrição do produto String "Camisa social"
line_items.quantity quantidade do item Integer 2
line_items.price preço unitário Float 197.00
subscription_status status da recorrência (assinatura) String nova: "started"
atrasada: "past_due"
cancelada: "canceled"
ativa: "active"
name_subscription_plan nome do plano de recorrência String "Gold Trimestral"
recurrency_period período da recorrência String "30 dias"
recurrency quantidade de pagamentos efetuados Integer 3
src src do pedido String "fbad1"
utm_source utm_source do pedido String "fbad1"
utm_medium utm_medium do pedido String "fbad1"
utm_content utm_content do pedido String "fbad1"
utm_campaign utm_campaign do pedido String "fbad1"
utm_term utm_term do pedido String "fbad1"

Formas de Pagamentos

Evento payment_method financial_status
PIX Gerado "pix" "issued"
PIX Pago "pix" "paid"
Boleto Impresso "billet" "issued"
Boleto Pago "billet" "paid"
Cartão de Crédito Recusado "credit" "refused"
Cartão de Crédito Pago "credit" "paid"
Cartão de Débito Recusado "debit" "refused"
Cartão de Débito Pago "debit" "paid"
Transferência Bancária Recusada "transfer" "refused"
Transferência Bancária Paga "transfer" "paid"
PayPal Recusado "paypal" "refused"
PayPal Pago "paypal" "paid"