Passar para o conteúdo principal

Como Usar a API do Modelo de Botão de Checkout

Atualizado há mais de 2 semanas

Resumo

Deseja agilizar os pagamentos no WhatsApp? O modelo de botão de checkout do Facebook facilita que os negócios coletem pagamentos diretamente no chat. Este guia fornece uma visão geral rápida de como esses modelos funcionam com a WhatsApp Cloud API, para que você possa começar a oferecer uma experiência de checkout fluida aos seus clientes.

Instruções

O modelo de botão de checkout é um recurso da WhatsApp Cloud API que permite incorporar um botão Pagar Agora ou Comprar Agora diretamente em uma mensagem. Quando tocado, o botão abre uma experiência de pagamento segura para que o cliente possa concluir sua compra em poucos cliques.

O que você precisa para começar

Antes de usar os modelos de botão de checkout, certifique-se de ter:

  • Uma conta de negócios verificada no WhatsApp (WABA)

  • Acesso à WhatsApp Cloud API

  • Uma conta de pagamento Meta (configurada via Meta Commerce Manager)

  • Uma loja virtual ou experiência de pagamento hospedada (via Meta ou provedor de terceiros)

Como os modelos de botão de checkout funcionam

O botão de checkout é enviado usando um modelo de mensagem que inclui:

  • Cabeçalho: Opcional, pode incluir texto ou mídia

  • Corpo: Descreve o produto ou solicitação de pagamento

  • Botão: Inicia o fluxo de checkout quando tocado

Assim que o cliente tocar no botão, será direcionado a uma experiência de pagamento pré-configurada. Isso pode ser uma página de checkout única ou vinculada a um produto ou carrinho específico.

Principais benefícios

  • Compras mais rápidas: Os clientes não precisam sair do WhatsApp para pagar

  • Melhor engajamento: Reduz abandonos durante o checkout

  • Transações seguras: Os pagamentos são processados pela infraestrutura verificada da Meta

Casos de uso

  • Compartilhar uma mensagem "Pagar Agora" após a confirmação do pedido

  • Enviar um link de pagamento para pré-vendas ou assinaturas

  • Habilitar pedidos rápidos para clientes recorrentes

Endereço da API

POST https://{your-account-endpoint}/api/v1/checkout_button_template

O endpoint checkout_button_template permite incorporar um botão Pagar Agora ou Comprar Agora diretamente em uma mensagem. Quando tocado, o botão abre uma experiência de pagamento segura para que o cliente possa concluir sua compra em poucos cliques.

Passo 1: Localize seu endpoint da API

Você pode encontrar seu endpoint de API específico na seção /api-docs da sua conta Wati. Será algo assim: https://live-server-xxxx.wati.io

Seu endpoint final para enviar o pedido será:

POST https://{your-account-endpoint}/api/v1/checkout_button_template

Aqui está a lista de parâmetros para este endpoint:

phone_number: Este é o número de telefone do destinatário da mensagem.

template_name: É o nome do modelo que você criou.

custom_params: Isso depende das variáveis no modelo.

order_details: A quantidade de cards de carrossel em order_details deve ser a mesma que no modelo.

reference_id: Este é um ID único para cada pedido.

Passo 2: Como enviar o modelo de botão de checkout usando o endpoint da API

Aqui está uma carga útil de exemplo para um checkout_button_template com 3 cards de carrossel:

Exemplo de carga útil

curl --location 'https://mt-dev-gke-server.watiapp.io/103128/api/v1/checkout_
--header 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJqd
--header 'Content-Type: application/json' \
--data '{
"phone_number": "918606328257",
"template_name": "checkout_button_template_yzn_1",
"custom_params": [
{
"name": "name"
,
"value": "TEST_NAME"
}
],
"order_details": [
{
"reference_id": "yzn-test-7",
"type": "physical-goods",
"currency": "INR",
"payment_settings": [
{
"type": "payment_gateway",
"payment_gateway": {
"type": "razorpay",
"configuration_name": "razorpay_test_payment_2"
}
}
],
"shipping_info": {
"country": "IN",
"addresses": [
{
"name": "Nidhi Tripathi",
"phone_number": "919000090000",
"address": "Bandra Kurla Complex",
"city": "Mumbai",
"state": "Maharastra",
"in_pin_code": "400051",
"house_number": "12",
"tower_number": "5",
"building_name": "One BKC",
"landmark_area": "Near BKC Circle"
}
]
},
"order": {
"items": [
{
"amount": {
"offset": 100,
"value": 200
},
"sale_amount": {
"offset": 100,
"value": 150
},
"name": "Blue Elf Aloe"
,
"quantity": 1,
"country_of_origin": "India",
"importer_name": "Lucky Shrub Imports and Exports",
"importer_address": {
"address_line1": "One BKC",
"address_line2": "Bandra Kurla Complex",
"city": "Mumbai",
"zone_code": "MH",
"postal_code": "400051",
"country_code": "IN"
}
}
],
"subtotal": {
"offset": 100,
"value": 150
},
"shipping": {
"offset": 100,
"value": 20
},
"tax": {
"offset": 100,
"value": 10
},
"discount": {
"offset": 100,
"value": 15,
"description": "Additional 10% off"
},
"status": "pending",
"expiration": {
"timestamp": "1726627150",
"description": "description"
}
},
"total_amount": {
"offset": 100,
"value": 165
}
},
{
"reference_id": "yzn-test-8",
"type": "physical-goods",
"currency": "INR",
"payment_settings": [
{
"type": "payment_gateway",
"payment_gateway": {
"type": "razorpay",
"configuration_name": "razorpay_test_payment_2"
}
}
],
"shipping_info": {
"country": "IN",
"addresses": [
{
"name": "Nidhi Tripathi",
"phone_number": "919000090000",
"address": "Bandra Kurla Complex",
"city": "Mumbai",
"state": "Maharastra",
"in_pin_code": "400051",
"house_number": "12",
"tower_number": "5",
"building_name": "One BKC",
"landmark_area": "Near BKC Circle"
}
]
},
"order": {
"items": [
{
"amount": {
"offset": 100,
"value": 200
},
"sale_amount": {
"offset": 100,
"value": 150
},
"name": "Blue Elf Aloe"
,
"quantity": 1,
"country_of_origin": "India",
"importer_name": "Lucky Shrub Imports and Exports",
"importer_address": {
"address_line1": "One BKC",
"address_line2": "Bandra Kurla Complex",
"city": "Mumbai",
"zone_code": "MH",
"postal_code": "400051",
"country_code": "IN"
}
}
],
"subtotal": {
"offset": 100,
"value": 150
},
"shipping": {
"offset": 100,
"value": 20
},
"tax": {
"offset": 100,
"value": 10
},
"discount": {
"offset": 100,
"value": 15,
"description": "Additional 10% off"
},
"status": "pending",
"expiration": {
"timestamp": "1726627150",
"description": "description"
}
},
"total_amount": {
"offset": 100,
"value": 165
}
},
{
"reference_id": "yzn-test-9",
"type": "physical-goods",
"currency": "INR",
"payment_settings": [
{
"type": "payment_gateway",
"payment_gateway": {
"type": "razorpay",
"configuration_name": "razorpay_test_payment_2"
}
}
],
"shipping_info": {
"country": "IN",
"addresses": [
{
"name": "Nidhi Tripathi",
"phone_number": "919000090000",
"address": "Bandra Kurla Complex",
"city": "Mumbai",
"state": "Maharastra",
"in_pin_code": "400051",
"house_number": "12",
"tower_number": "5",
"building_name": "One BKC",
"landmark_area": "Near BKC Circle"
}
]
},
"order": {
"items": [
{
"amount": {
"offset": 100,
"value": 200
},
"sale_amount": {
"offset": 100,
"value": 150
},
"name": "Blue Elf Aloe"
,
"quantity": 1,
"country_of_origin": "India",
"importer_name": "Lucky Shrub Imports and Exports",
"importer_address": {
"address_line1": "One BKC",
"address_line2": "Bandra Kurla Complex",
"city": "Mumbai",
"zone_code": "MH",
"postal_code": "400051",
"country_code": "IN"
}
}
],
"subtotal": {
"offset": 100,
"value": 150
},
"shipping": {
"offset": 100,
"value": 20
},
"tax": {
"offset": 100,
"value": 10
},
"discount": {
"offset": 100,
"value": 15,
"description": "Additional 10% off"
},
"status": "pending",
"expiration": {
"timestamp": "1726627150",
"description": "description"
}
},
"total_amount": {
"offset": 100,
"value": 165
}
}
]
}'

Como criar um Modelo de Botão de Checkout no Wati

Este guia o orienta nos passos para criar o Modelo de Botão de Checkout em alguns cliques:

1. Faça login em sua conta Wati.

2. Vá para Transmissões e selecione Seus Modelos.

3. Clique em Nova Mensagem de Modelo.

4. Insira um nome para seu modelo para que você possa encontrá-lo facilmente mais tarde.

5. Na seção categoria, escolha Marketing.

6. Selecione o idioma em que deseja que o modelo esteja.

7. Na seção Selecionar Modelo de Marketing, escolha Modelo de Checkout.

8. Insira o conteúdo do corpo - esta é a mensagem principal que seu cliente verá.

9. Adicione cards de carrossel conforme suas necessidades.

Nota:

  • Você pode adicionar até 5 cards.

  • Para cada card, você pode adicionar uma imagem ou um vídeo.

  • Você pode inserir botões para cada card para que seus clientes possam agir e se envolver.

Artigos relacionados
Como Enviar Mensagens pelo WhatsApp via Wati (Usando Make.com - anteriormente Integromat)
Como posso usar o Wati para enviar mensagens em massa apenas para alguns clientes da minha loja Shopify?
Como notificar clientes usando o template de Status de Pedido da API Wati
Como Enviar uma Mensagem de Pedido Usando a API de Modelo de Detalhes do Pedido
Respondeu à sua pergunta?