Passar para o conteúdo principal

Como usar botão de checkout Template API

Atualizado há mais de uma semana

Resumo

Deseja simplificar os pagamentos no WhatsApp? O modelo de botão de checkout do Facebook torna fácil para as empresas coletar pagamentos diretamente na conversa. Este guia oferece uma visão geral rápida de como esses modelos funcionam com a API do WhatsApp Cloud, para que você possa começar a oferecer uma experiência de checkout sem interrupções para seus clientes.

Observação: Transmissões agora são Campanhas – mesmas funcionalidades poderosas, nome atualizado!

Instruções

O modelo de botão de checkout é um recurso da API do WhatsApp Cloud que permite embedar 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 apenas alguns cliques.

O que você precisa para começar

Antes de usar modelos de botão de checkout, certifique-se de que você tem:

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

  • Uma conta de pagamento da Meta (configurada via Gerenciador de comércio da Meta)

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

Como funcionam os modelos de botão de checkout

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: Aciona o fluxo de checkout quando tocado

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

Principais benefícios

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

  • Melhor engajamento: Reduz as quedas durante o checkout

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

Casos de uso de exemplo

  • Compartilhando uma mensagem "Pagar agora" após a confirmação do pedido

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

  • Habilitando a reorder rápida para clientes que retornam

Ponto de extremidade

POST https://{seu-ponto-de-extremidade-da-conta}/api/v1/checkout_button_template

O ponto de extremidade checkout_button_template permite que você embeda 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 apenas alguns cliques.

Etapa 1: Localize seu ponto de extremidade da API

Você pode encontrar seu ponto de extremidade da API específico na seção /api-docs em sua conta Wati. Ele terá uma aparência semelhante a esta: https://live-server-xxxx.wati.io

Seu ponto de extremidade final para enviar o pedido será:

POST https://{seu-ponto-de-extremidade-da-conta}/api/v1/checkout_button_template

Aqui está a lista de parâmetros para esse ponto de extremidade:

phone_number : Este é o número de telefone do receptor da mensagem.

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

custom_params : Isso depende das variáveis no modelo.

order_details : O valor de order_details deve ser o mesmo que o número de cartões de carrossel no modelo.

reference_id : Este é um ID exclusivo para cada pedido.

Etapa 2: Como enviar o modelo de botão de checkout usando o ponto de extremidade da API

Aqui está um payload de amostra para um checkout_button_template com os 3 cartões de carrossel:

Payload de amostra

curl --location 'https://mt-dev-gke-server.watiapp.io/103128/api/v1/checkout_' \
--header 'Authorization: Bearer <TOKEN>' \
--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": [
{
"name": "Blue Elf Aloe",
"quantity": 1,
"country_of_origin": "India",
"importer_name": "Lucky Shrub Imports and Exports",
"amount": {
"offset": 100,
"value": 200
},
"sale_amount": {
"offset": 100,
"value": 150
},
"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": [
{
"name": "Blue Elf Aloe",
"quantity": 1,
"country_of_origin": "India",
"importer_name": "Lucky Shrub Imports and Exports",
"amount": {
"offset": 100,
"value": 200
},
"sale_amount": {
"offset": 100,
"value": 150
},
"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": [
{
"name": "Blue Elf Aloe",
"quantity": 1,
"country_of_origin": "India",
"importer_name": "Lucky Shrub Imports and Exports",
"amount": {
"offset": 100,
"value": 200
},
"sale_amount": {
"offset": 100,
"value": 150
},
"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 acompanha pelas etapas para criar o modelo de botão de checkout em alguns cliques:

1. Faça login em sua conta Wati.

2. Vá para Campanhas e selecione Mensagens de modelo.

3. Clique em Nova mensagem de modelo.

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

5. Em Categoria, escolha Marketing.

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

7. Em Selecione modelo de marketing, escolha Modelo de checkout.

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

9. Adicione cartões de carrossel de acordo com suas necessidades.

Observação:

  • Você pode adicionar até 5 cartões.

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

  • Você pode inserir botões para cada cartão para que seus clientes possam tomar ação e se engajar.

Respondeu à sua pergunta?