whatsapp-docs-mcp 1.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LICENSE +22 -0
- package/README.md +181 -0
- package/dist/index.d.ts +3 -0
- package/dist/index.d.ts.map +1 -0
- package/dist/index.js +65 -0
- package/dist/index.js.map +1 -0
- package/dist/prompts.d.ts +22 -0
- package/dist/prompts.d.ts.map +1 -0
- package/dist/prompts.js +305 -0
- package/dist/prompts.js.map +1 -0
- package/dist/resources.d.ts +24 -0
- package/dist/resources.d.ts.map +1 -0
- package/dist/resources.js +132 -0
- package/dist/resources.js.map +1 -0
- package/dist/tools.d.ts +6 -0
- package/dist/tools.d.ts.map +1 -0
- package/dist/tools.js +379 -0
- package/dist/tools.js.map +1 -0
- package/dist/utils/fileLoader.d.ts +19 -0
- package/dist/utils/fileLoader.d.ts.map +1 -0
- package/dist/utils/fileLoader.js +126 -0
- package/dist/utils/fileLoader.js.map +1 -0
- package/dist/utils/search.d.ts +27 -0
- package/dist/utils/search.d.ts.map +1 -0
- package/dist/utils/search.js +91 -0
- package/dist/utils/search.js.map +1 -0
- package/docs/QUICK_REFERENCE.md +223 -0
- package/docs/anuncios_com_clique_para_whatsapp/AGENTS.md +8 -0
- package/docs/anuncios_com_clique_para_whatsapp/welcome_message_sequences.md +449 -0
- package/docs/ativos_da_conta/AGENTS.md +9 -0
- package/docs/ativos_da_conta/outros_ativos/AGENTS.md +12 -0
- package/docs/ativos_da_conta/outros_ativos/business_profiles.md +137 -0
- package/docs/ativos_da_conta/outros_ativos/display_names.md +108 -0
- package/docs/ativos_da_conta/outros_ativos/official_business_accounts.md +123 -0
- package/docs/ativos_da_conta/outros_ativos/qr_codes.md +198 -0
- package/docs/ativos_da_conta/outros_ativos/whatsapp_business_accounts.md +99 -0
- package/docs/ativos_da_conta/telefones_comerciais/AGENTS.md +11 -0
- package/docs/ativos_da_conta/telefones_comerciais/conversational_components.md +347 -0
- package/docs/ativos_da_conta/telefones_comerciais/phone_numbers.md +486 -0
- package/docs/ativos_da_conta/telefones_comerciais/registration.md +171 -0
- package/docs/ativos_da_conta/telefones_comerciais/two_step_verification.md +66 -0
- package/docs/catalogos/AGENTS.md +12 -0
- package/docs/catalogos/receive_responses.md +28 -0
- package/docs/catalogos/sell_products_and_services.md +24 -0
- package/docs/catalogos/set_commerce_settings.md +163 -0
- package/docs/catalogos/share_products.md +401 -0
- package/docs/catalogos/upload_inventory.md +28 -0
- package/docs/comecar/AGENTS.md +8 -0
- package/docs/comecar/get_started.md +127 -0
- package/docs/dados_privacidade_e_politica/AGENTS.md +16 -0
- package/docs/dados_privacidade_e_politica/block_users.md +549 -0
- package/docs/dados_privacidade_e_politica/data_privacy_and_security.md +78 -0
- package/docs/dados_privacidade_e_politica/encryption.md +8 -0
- package/docs/dados_privacidade_e_politica/getting_opt_in.md +41 -0
- package/docs/dados_privacidade_e_politica/identity_change.md +34 -0
- package/docs/dados_privacidade_e_politica/local_storage.md +277 -0
- package/docs/dados_privacidade_e_politica/no_storage.md +132 -0
- package/docs/dados_privacidade_e_politica/policy_enforcement.md +85 -0
- package/docs/dados_privacidade_e_politica/policy_enforcement_violations.md +127 -0
- package/docs/grupos/AGENTS.md +15 -0
- package/docs/grupos/error_codes.md +170 -0
- package/docs/grupos/faq.md +30 -0
- package/docs/grupos/get_started.md +73 -0
- package/docs/grupos/groups.md +75 -0
- package/docs/grupos/groups_messaging.md +340 -0
- package/docs/grupos/pricing.md +322 -0
- package/docs/grupos/reference.md +1059 -0
- package/docs/grupos/webhooks.md +298 -0
- package/docs/index.md +318 -0
- package/docs/insights/AGENTS.md +8 -0
- package/docs/insights/analytics.md +944 -0
- package/docs/ligacoes/AGENTS.md +20 -0
- package/docs/ligacoes/app_review_guidelines.md +48 -0
- package/docs/ligacoes/business_initiated_calls.md +858 -0
- package/docs/ligacoes/call_button_messages_deep_links.md +454 -0
- package/docs/ligacoes/call_settings.md +643 -0
- package/docs/ligacoes/calling.md +130 -0
- package/docs/ligacoes/faq.md +468 -0
- package/docs/ligacoes/integration_patterns.md +121 -0
- package/docs/ligacoes/pricing.md +339 -0
- package/docs/ligacoes/reference.md +1923 -0
- package/docs/ligacoes/sip.md +1090 -0
- package/docs/ligacoes/troubleshooting.md +483 -0
- package/docs/ligacoes/user_call_permissions.md +672 -0
- package/docs/ligacoes/user_initiated_calls.md +1030 -0
- package/docs/mensagens/AGENTS.md +46 -0
- package/docs/mensagens/limites_de_mensagens/AGENTS.md +9 -0
- package/docs/mensagens/limites_de_mensagens/messaging_limits.md +91 -0
- package/docs/mensagens/limites_de_mensagens/upcoming_changes.md +8 -0
- package/docs/mensagens/recursos_adicionais/AGENTS.md +13 -0
- package/docs/mensagens/recursos_adicionais/contextual_replies.md +82 -0
- package/docs/mensagens/recursos_adicionais/link_previews.md +58 -0
- package/docs/mensagens/recursos_adicionais/mark_message_as_read.md +111 -0
- package/docs/mensagens/recursos_adicionais/media.md +419 -0
- package/docs/mensagens/recursos_adicionais/payload_encryption.md +8 -0
- package/docs/mensagens/recursos_adicionais/typing_indicators.md +117 -0
- package/docs/mensagens/tipos_de_mensagens/AGENTS.md +24 -0
- package/docs/mensagens/tipos_de_mensagens/address_messages.md +465 -0
- package/docs/mensagens/tipos_de_mensagens/audio_messages.md +211 -0
- package/docs/mensagens/tipos_de_mensagens/contacts_messages.md +482 -0
- package/docs/mensagens/tipos_de_mensagens/document_messages.md +232 -0
- package/docs/mensagens/tipos_de_mensagens/image_messages.md +176 -0
- package/docs/mensagens/tipos_de_mensagens/interactive_cta_url_messages.md +240 -0
- package/docs/mensagens/tipos_de_mensagens/interactive_flow_messages.md +8 -0
- package/docs/mensagens/tipos_de_mensagens/interactive_list_messages.md +300 -0
- package/docs/mensagens/tipos_de_mensagens/interactive_reply_buttons_messages.md +271 -0
- package/docs/mensagens/tipos_de_mensagens/location_messages.md +156 -0
- package/docs/mensagens/tipos_de_mensagens/location_request_messages.md +310 -0
- package/docs/mensagens/tipos_de_mensagens/message_with_link.md +8 -0
- package/docs/mensagens/tipos_de_mensagens/reaction_messages.md +144 -0
- package/docs/mensagens/tipos_de_mensagens/sticker_messages.md +157 -0
- package/docs/mensagens/tipos_de_mensagens/template_messages.md +20 -0
- package/docs/mensagens/tipos_de_mensagens/text_messages.md +142 -0
- package/docs/mensagens/tipos_de_mensagens/video_messages.md +149 -0
- package/docs/mensagens/visao_geral/AGENTS.md +8 -0
- package/docs/mensagens/visao_geral/send_messages.md +370 -0
- package/docs/mensagens_de_marketing/AGENTS.md +10 -0
- package/docs/mensagens_de_marketing/implementacao/AGENTS.md +10 -0
- package/docs/mensagens_de_marketing/implementacao/get_started.md +107 -0
- package/docs/mensagens_de_marketing/implementacao/onboard_business_customers.md +180 -0
- package/docs/mensagens_de_marketing/implementacao/send_marketing_messages.md +260 -0
- package/docs/mensagens_de_marketing/recursos/AGENTS.md +12 -0
- package/docs/mensagens_de_marketing/recursos/automatic_creative_optimization.md +8 -0
- package/docs/mensagens_de_marketing/recursos/conversion_measurement.md +8 -0
- package/docs/mensagens_de_marketing/recursos/deep_links.md +302 -0
- package/docs/mensagens_de_marketing/recursos/track_click_events.md +119 -0
- package/docs/mensagens_de_marketing/recursos/view_metrics.md +338 -0
- package/docs/mensagens_de_marketing/visao_geral/AGENTS.md +8 -0
- package/docs/mensagens_de_marketing/visao_geral/overview.md +26 -0
- package/docs/modelos/AGENTS.md +12 -0
- package/docs/modelos/gerenciamento_de_modelos/AGENTS.md +21 -0
- package/docs/modelos/gerenciamento_de_modelos/components.md +717 -0
- package/docs/modelos/gerenciamento_de_modelos/supported_languages.md +462 -0
- package/docs/modelos/gerenciamento_de_modelos/tap_target_url_title_override.md +211 -0
- package/docs/modelos/gerenciamento_de_modelos/template_categorization.md +499 -0
- package/docs/modelos/gerenciamento_de_modelos/template_comparison.md +136 -0
- package/docs/modelos/gerenciamento_de_modelos/template_library.md +526 -0
- package/docs/modelos/gerenciamento_de_modelos/template_management.md +148 -0
- package/docs/modelos/gerenciamento_de_modelos/template_media.md +8 -0
- package/docs/modelos/gerenciamento_de_modelos/template_migration.md +164 -0
- package/docs/modelos/gerenciamento_de_modelos/template_pacing.md +38 -0
- package/docs/modelos/gerenciamento_de_modelos/template_pausing.md +58 -0
- package/docs/modelos/gerenciamento_de_modelos/template_quality.md +47 -0
- package/docs/modelos/gerenciamento_de_modelos/template_review.md +74 -0
- package/docs/modelos/gerenciamento_de_modelos/time_to_live.md +88 -0
- package/docs/modelos/modelos_de_autenticacao/AGENTS.md +13 -0
- package/docs/modelos/modelos_de_autenticacao/authentication_best_practices.md +73 -0
- package/docs/modelos/modelos_de_autenticacao/authentication_templates.md +252 -0
- package/docs/modelos/modelos_de_autenticacao/autofill_button_authentication_templates.md +732 -0
- package/docs/modelos/modelos_de_autenticacao/copy_code_button_authentication_templates.md +402 -0
- package/docs/modelos/modelos_de_autenticacao/error_signals.md +143 -0
- package/docs/modelos/modelos_de_autenticacao/zero_tap_authentication_templates.md +742 -0
- package/docs/modelos/modelos_de_marketing/AGENTS.md +18 -0
- package/docs/modelos/modelos_de_marketing/call_permission_request_message_template.md +221 -0
- package/docs/modelos/modelos_de_marketing/catalog_templates.md +308 -0
- package/docs/modelos/modelos_de_marketing/coupon_templates.md +425 -0
- package/docs/modelos/modelos_de_marketing/custom_marketing_templates.md +537 -0
- package/docs/modelos/modelos_de_marketing/limited_time_offer_templates.md +496 -0
- package/docs/modelos/modelos_de_marketing/marketing_templates.md +112 -0
- package/docs/modelos/modelos_de_marketing/media_card_carousel_templates.md +770 -0
- package/docs/modelos/modelos_de_marketing/mpm_templates.md +717 -0
- package/docs/modelos/modelos_de_marketing/per_user_limits.md +42 -0
- package/docs/modelos/modelos_de_marketing/product_card_carousel_templates.md +515 -0
- package/docs/modelos/modelos_de_marketing/spm_templates.md +466 -0
- package/docs/modelos/modelos_de_utilidade/AGENTS.md +8 -0
- package/docs/modelos/modelos_de_utilidade/utility_templates.md +583 -0
- package/docs/modelos/visao_geral/AGENTS.md +8 -0
- package/docs/modelos/visao_geral/overview.md +163 -0
- package/docs/pagamentos/AGENTS.md +9 -0
- package/docs/pagamentos/pagamentos_na_india/AGENTS.md +19 -0
- package/docs/pagamentos/pagamentos_na_india/checkout_button_templates.md +1332 -0
- package/docs/pagamentos/pagamentos_na_india/enhanced_payment_links.md +93 -0
- package/docs/pagamentos/pagamentos_na_india/onboarding_apis.md +580 -0
- package/docs/pagamentos/pagamentos_na_india/orderdetailstemplate.md +205 -0
- package/docs/pagamentos/pagamentos_na_india/orderstatustemplate.md +143 -0
- package/docs/pagamentos/pagamentos_na_india/overview.md +102 -0
- package/docs/pagamentos/pagamentos_na_india/payment_links.md +581 -0
- package/docs/pagamentos/pagamentos_na_india/pg.md +1228 -0
- package/docs/pagamentos/pagamentos_na_india/upi_intent/AGENTS.md +12 -0
- package/docs/pagamentos/pagamentos_na_india/upi_intent/dynamic_vpa.md +572 -0
- package/docs/pagamentos/pagamentos_na_india/upi_intent/pg_guide_billdesk.md +343 -0
- package/docs/pagamentos/pagamentos_na_india/upi_intent/pg_guide_cashfree.md +145 -0
- package/docs/pagamentos/pagamentos_na_india/upi_intent/pg_guide_ccavenue.md +146 -0
- package/docs/pagamentos/pagamentos_na_india/upi_intent/upi_intent.md +660 -0
- package/docs/pagamentos/pagamentos_no_brasil/AGENTS.md +14 -0
- package/docs/pagamentos/pagamentos_no_brasil/boleto.md +104 -0
- package/docs/pagamentos/pagamentos_no_brasil/offsite_pix.md +128 -0
- package/docs/pagamentos/pagamentos_no_brasil/one_click_payments.md +226 -0
- package/docs/pagamentos/pagamentos_no_brasil/orderdetailstemplate.md +180 -0
- package/docs/pagamentos/pagamentos_no_brasil/orders.md +768 -0
- package/docs/pagamentos/pagamentos_no_brasil/overview.md +32 -0
- package/docs/pagamentos/pagamentos_no_brasil/payment_links.md +104 -0
- package/docs/parceiros/AGENTS.md +12 -0
- package/docs/parceiros/analise_do_app/AGENTS.md +8 -0
- package/docs/parceiros/analise_do_app/app_review.md +91 -0
- package/docs/parceiros/gerenciamento/AGENTS.md +14 -0
- package/docs/parceiros/gerenciamento/gerenciar_ativos_do_cliente/AGENTS.md +15 -0
- package/docs/parceiros/gerenciamento/gerenciar_ativos_do_cliente/manage_accounts.md +274 -0
- package/docs/parceiros/gerenciamento/gerenciar_ativos_do_cliente/manage_system_users.md +106 -0
- package/docs/parceiros/gerenciamento/gerenciar_ativos_do_cliente/manage_webhooks.md +277 -0
- package/docs/parceiros/gerenciamento/gerenciar_ativos_do_cliente/numeros_de_telefone/AGENTS.md +9 -0
- package/docs/parceiros/gerenciamento/gerenciar_ativos_do_cliente/numeros_de_telefone/manage_phone_numbers.md +248 -0
- package/docs/parceiros/gerenciamento/gerenciar_ativos_do_cliente/numeros_de_telefone/registering_phone_numbers.md +373 -0
- package/docs/parceiros/gerenciamento/gerenciar_ativos_do_cliente/share_and_revoke_credit_lines.md +551 -0
- package/docs/parceiros/gerenciamento/partner_led_business_verification.md +367 -0
- package/docs/parceiros/gerenciamento/pixel_tracking.md +35 -0
- package/docs/parceiros/gerenciamento/suporte_ao_parceiro/AGENTS.md +18 -0
- package/docs/parceiros/gerenciamento/suporte_ao_parceiro/adding_waba_to_mps.md +64 -0
- package/docs/parceiros/gerenciamento/suporte_ao_parceiro/business_customer_support.md +102 -0
- package/docs/parceiros/gerenciamento/suporte_ao_parceiro/migrating_customers_off_solutions_via_embedded_signup.md +151 -0
- package/docs/parceiros/gerenciamento/suporte_ao_parceiro/migrating_customers_off_solutions_via_meta_business_suite.md +234 -0
- package/docs/parceiros/gerenciamento/suporte_ao_parceiro/migrating_phone_numbers_among_solution_partners_programmatically.md +292 -0
- package/docs/parceiros/gerenciamento/suporte_ao_parceiro/migrating_phone_numbers_among_solution_partners_via_embedded_signup.md +118 -0
- package/docs/parceiros/gerenciamento/suporte_ao_parceiro/migrating_wabas_among_solution_partners_via_embedded_signup.md +76 -0
- package/docs/parceiros/gerenciamento/suporte_ao_parceiro/migrating_wabas_among_solutions_via_embedded_signup.md +90 -0
- package/docs/parceiros/gerenciamento/suporte_ao_parceiro/migrating_wabas_among_solutions_via_meta_business_suite.md +265 -0
- package/docs/parceiros/gerenciamento/suporte_ao_parceiro/support.md +48 -0
- package/docs/parceiros/gerenciamento/suporte_ao_parceiro/transferring_wabas_to_customers.md +8 -0
- package/docs/parceiros/integracao_de_clientes/AGENTS.md +9 -0
- package/docs/parceiros/integracao_de_clientes/cadastro_incorporado/AGENTS.md +26 -0
- package/docs/parceiros/integracao_de_clientes/cadastro_incorporado/app_only_install.md +135 -0
- package/docs/parceiros/integracao_de_clientes/cadastro_incorporado/automatic_events_api.md +204 -0
- package/docs/parceiros/integracao_de_clientes/cadastro_incorporado/bypass_phone_addition.md +52 -0
- package/docs/parceiros/integracao_de_clientes/cadastro_incorporado/custom_flows.md +40 -0
- package/docs/parceiros/integracao_de_clientes/cadastro_incorporado/default_flow.md +90 -0
- package/docs/parceiros/integracao_de_clientes/cadastro_incorporado/errors.md +185 -0
- package/docs/parceiros/integracao_de_clientes/cadastro_incorporado/hosted_es.md +153 -0
- package/docs/parceiros/integracao_de_clientes/cadastro_incorporado/implementation.md +417 -0
- package/docs/parceiros/integracao_de_clientes/cadastro_incorporado/onboarding_business_app_users.md +926 -0
- package/docs/parceiros/integracao_de_clientes/cadastro_incorporado/onboarding_customers_as_a_solution_partner.md +402 -0
- package/docs/parceiros/integracao_de_clientes/cadastro_incorporado/onboarding_customers_as_a_tech_provider.md +332 -0
- package/docs/parceiros/integracao_de_clientes/cadastro_incorporado/overview.md +168 -0
- package/docs/parceiros/integracao_de_clientes/cadastro_incorporado/pre_filled_data.md +524 -0
- package/docs/parceiros/integracao_de_clientes/cadastro_incorporado/pre_verified_numbers.md +291 -0
- package/docs/parceiros/integracao_de_clientes/cadastro_incorporado/versions/AGENTS.md +12 -0
- package/docs/parceiros/integracao_de_clientes/cadastro_incorporado/versions/version_2_public_preview.md +88 -0
- package/docs/parceiros/integracao_de_clientes/cadastro_incorporado/versions/version_3.md +98 -0
- package/docs/parceiros/integracao_de_clientes/cadastro_incorporado/versions/version_3_public_preview.md +88 -0
- package/docs/parceiros/integracao_de_clientes/cadastro_incorporado/versions/version_4.md +92 -0
- package/docs/parceiros/integracao_de_clientes/cadastro_incorporado/versions/versions.md +463 -0
- package/docs/parceiros/integracao_de_clientes/cadastro_incorporado/website_optional.md +57 -0
- package/docs/parceiros/integracao_de_clientes/outras_opcoes_de_integracao/AGENTS.md +11 -0
- package/docs/parceiros/integracao_de_clientes/outras_opcoes_de_integracao/multi_partner_solution_embedded_creation.md +178 -0
- package/docs/parceiros/integracao_de_clientes/outras_opcoes_de_integracao/multi_partner_solutions.md +775 -0
- package/docs/parceiros/integracao_de_clientes/outras_opcoes_de_integracao/multi_solution_conversations.md +319 -0
- package/docs/parceiros/integracao_de_clientes/outras_opcoes_de_integracao/partner_initiated_waba_creation.md +74 -0
- package/docs/parceiros/seja_um_parceiro/AGENTS.md +11 -0
- package/docs/parceiros/seja_um_parceiro/get_started_for_solution_partners.md +280 -0
- package/docs/parceiros/seja_um_parceiro/get_started_for_tech_providers.md +194 -0
- package/docs/parceiros/seja_um_parceiro/measurement_partners.md +146 -0
- package/docs/parceiros/seja_um_parceiro/upgrade_to_tech_partner.md +94 -0
- package/docs/parceiros/visao_geral/AGENTS.md +8 -0
- package/docs/parceiros/visao_geral/overview.md +190 -0
- package/docs/recado/AGENTS.md +9 -0
- package/docs/recado/precos/AGENTS.md +11 -0
- package/docs/recado/precos/pricing.md +915 -0
- package/docs/recado/precos/pricing_authentication_international_rates.md +464 -0
- package/docs/recado/precos/pricing_conversation_based_pricing.md +773 -0
- package/docs/recado/precos/pricing_updates_to_pricing.md +8 -0
- package/docs/recado/sobre_a_plataforma/AGENTS.md +10 -0
- package/docs/recado/sobre_a_plataforma/about_the_platform.md +217 -0
- package/docs/recado/sobre_a_plataforma/access_tokens.md +110 -0
- package/docs/recado/sobre_a_plataforma/permissions.md +55 -0
- package/docs/referencia/AGENTS.md +92 -0
- package/docs/referencia/bot_do_whatsapp_business/AGENTS.md +8 -0
- package/docs/referencia/bot_do_whatsapp_business/bot_details_api.md +762 -0
- package/docs/referencia/business/AGENTS.md +14 -0
- package/docs/referencia/business/add_phone_numbers_api.md +726 -0
- package/docs/referencia/business/client_whatsapp_business_accounts_api.md +1006 -0
- package/docs/referencia/business/owned_whatsapp_business_accounts.md +802 -0
- package/docs/referencia/business/whatsapp_business_accounts_api.md +1550 -0
- package/docs/referencia/business/whatsapp_business_partner_onboarding_to_mm_lite_api.md +783 -0
- package/docs/referencia/business/whatsapp_business_pre_verified_phone_number_sharing_api.md +790 -0
- package/docs/referencia/business/whatsapp_business_pre_verified_phone_numbers_api.md +886 -0
- package/docs/referencia/changelog.md +10 -0
- package/docs/referencia/conta_do_whatsapp_business/AGENTS.md +24 -0
- package/docs/referencia/conta_do_whatsapp_business/assigned_users_management_api.md +2202 -0
- package/docs/referencia/conta_do_whatsapp_business/business_account_api.md +267 -0
- package/docs/referencia/conta_do_whatsapp_business/business_account_extended_credits_api.md +275 -0
- package/docs/referencia/conta_do_whatsapp_business/conversational_automation_api.md +782 -0
- package/docs/referencia/conta_do_whatsapp_business/flows_api.md +1532 -0
- package/docs/referencia/conta_do_whatsapp_business/in_progress_on_behalf_requests_api.md +8 -0
- package/docs/referencia/conta_do_whatsapp_business/migration_intent_api.md +1581 -0
- package/docs/referencia/conta_do_whatsapp_business/obo_mobility_intent_api.md +8 -0
- package/docs/referencia/conta_do_whatsapp_business/phone_number_management_api.md +1686 -0
- package/docs/referencia/conta_do_whatsapp_business/schedules_api.md +1772 -0
- package/docs/referencia/conta_do_whatsapp_business/set_obo_mobility_intent_api.md +8 -0
- package/docs/referencia/conta_do_whatsapp_business/set_solution_migration_intent_api.md +8 -0
- package/docs/referencia/conta_do_whatsapp_business/subscribed_apps_api.md +2178 -0
- package/docs/referencia/conta_do_whatsapp_business/template_api.md +976 -0
- package/docs/referencia/conta_do_whatsapp_business/whatsapp_business_account_activities_api.md +842 -0
- package/docs/referencia/conta_do_whatsapp_business/whatsapp_business_account_api.md +1384 -0
- package/docs/referencia/conta_do_whatsapp_business/whatsapp_business_account_solutions_list_api.md +854 -0
- package/docs/referencia/grupo/AGENTS.md +11 -0
- package/docs/referencia/grupo/groups_invite_link_api.md +304 -0
- package/docs/referencia/grupo/groups_join_requests_api.md +686 -0
- package/docs/referencia/grupo/groups_participants_api.md +274 -0
- package/docs/referencia/grupo/groups_query_api.md +436 -0
- package/docs/referencia/historico_de_mensagens/AGENTS.md +8 -0
- package/docs/referencia/historico_de_mensagens/whatsapp_business_message_history_events_api.md +866 -0
- package/docs/referencia/inscricao/AGENTS.md +10 -0
- package/docs/referencia/inscricao/application_connected_client_businesses.md +812 -0
- package/docs/referencia/inscricao/application_solutions_api.md +874 -0
- package/docs/referencia/inscricao/solution_creation_api.md +824 -0
- package/docs/referencia/intencao_de_migracao_da_conta_do_whatsapp_business/AGENTS.md +8 -0
- package/docs/referencia/intencao_de_migracao_da_conta_do_whatsapp_business/migration_intent_details_api.md +724 -0
- package/docs/referencia/midias/AGENTS.md +9 -0
- package/docs/referencia/midias/media_api.md +342 -0
- package/docs/referencia/midias/media_download_api.md +160 -0
- package/docs/referencia/numero_da_conta_do_whatsapp/AGENTS.md +8 -0
- package/docs/referencia/numero_da_conta_do_whatsapp/whatsapp_account_number_api.md +778 -0
- package/docs/referencia/perfil_do_whatsapp_business/AGENTS.md +8 -0
- package/docs/referencia/perfil_do_whatsapp_business/whatsapp_business_profile_node_api.md +1494 -0
- package/docs/referencia/solucao_do_whatsapp_business/AGENTS.md +14 -0
- package/docs/referencia/solucao_do_whatsapp_business/accept_deactivation_request_api.md +762 -0
- package/docs/referencia/solucao_do_whatsapp_business/access_token_api.md +704 -0
- package/docs/referencia/solucao_do_whatsapp_business/reject_deactivation_request_api.md +812 -0
- package/docs/referencia/solucao_do_whatsapp_business/send_deactivation_request_api.md +778 -0
- package/docs/referencia/solucao_do_whatsapp_business/solution_accept_api.md +812 -0
- package/docs/referencia/solucao_do_whatsapp_business/solution_details_api.md +768 -0
- package/docs/referencia/solucao_do_whatsapp_business/solution_reject_api.md +798 -0
- package/docs/referencia/telefone_do_whatsapp_business/AGENTS.md +29 -0
- package/docs/referencia/telefone_do_whatsapp_business/block_api.md +542 -0
- package/docs/referencia/telefone_do_whatsapp_business/business_compliance_information_api.md +1608 -0
- package/docs/referencia/telefone_do_whatsapp_business/business_encryption_api.md +1402 -0
- package/docs/referencia/telefone_do_whatsapp_business/calling_api.md +598 -0
- package/docs/referencia/telefone_do_whatsapp_business/encrypted_messages_api.md +482 -0
- package/docs/referencia/telefone_do_whatsapp_business/groups_management_api.md +485 -0
- package/docs/referencia/telefone_do_whatsapp_business/marketing_messages_lite_api.md +315 -0
- package/docs/referencia/telefone_do_whatsapp_business/media_upload_api.md +188 -0
- package/docs/referencia/telefone_do_whatsapp_business/message_api.md +1798 -0
- package/docs/referencia/telefone_do_whatsapp_business/phone_number_api.md +377 -0
- package/docs/referencia/telefone_do_whatsapp_business/phone_number_deregister_api.md +714 -0
- package/docs/referencia/telefone_do_whatsapp_business/phone_number_registration.md +780 -0
- package/docs/referencia/telefone_do_whatsapp_business/phone_number_verification_request_code_api.md +734 -0
- package/docs/referencia/telefone_do_whatsapp_business/register_api.md +411 -0
- package/docs/referencia/telefone_do_whatsapp_business/settings_api.md +674 -0
- package/docs/referencia/telefone_do_whatsapp_business/verify_code_api.md +746 -0
- package/docs/referencia/telefone_do_whatsapp_business/whatsapp_business_account_message_history_api.md +932 -0
- package/docs/referencia/telefone_do_whatsapp_business/whatsapp_business_account_official_business_account_status_api.md +1540 -0
- package/docs/referencia/telefone_do_whatsapp_business/whatsapp_business_account_phone_number_api.md +1600 -0
- package/docs/referencia/telefone_do_whatsapp_business/whatsapp_business_profile_api.md +1478 -0
- package/docs/referencia/telefone_do_whatsapp_business/whatsapp_business_qr_code_api.md +1179 -0
- package/docs/referencia/telefone_do_whatsapp_business/whatsapp_business_qr_code_management_api.md +1315 -0
- package/docs/referencia/telefone_pre_verificado_do_whatsapp_business/AGENTS.md +11 -0
- package/docs/referencia/telefone_pre_verificado_do_whatsapp_business/request_verification_code_api.md +778 -0
- package/docs/referencia/telefone_pre_verificado_do_whatsapp_business/verify_code_api.md +768 -0
- package/docs/referencia/telefone_pre_verificado_do_whatsapp_business/whatsapp_business_pre_verified_phone_number_api.md +1382 -0
- package/docs/referencia/telefone_pre_verificado_do_whatsapp_business/whatsapp_business_pre_verified_phone_number_partners_api.md +820 -0
- package/docs/referencia/usuario/AGENTS.md +8 -0
- package/docs/referencia/usuario/assigned_whatsapp_business_accounts_api.md +864 -0
- package/docs/referencia/webhooks/AGENTS.md +8 -0
- package/docs/referencia/webhooks/whatsapp_incoming_webhook_payload.md +1655 -0
- package/docs/suporte/AGENTS.md +13 -0
- package/docs/suporte/api_status_page.md +134 -0
- package/docs/suporte/error_codes.md +1194 -0
- package/docs/suporte/experiments.md +26 -0
- package/docs/suporte/health_status.md +225 -0
- package/docs/suporte/load_testing.md +340 -0
- package/docs/suporte/support.md +408 -0
- package/docs/visao_geral/AGENTS.md +8 -0
- package/docs/visao_geral/overview.md +2590 -0
- package/docs/webhooks/AGENTS.md +41 -0
- package/docs/webhooks/referencia/AGENTS.md +20 -0
- package/docs/webhooks/referencia/account_alerts.md +190 -0
- package/docs/webhooks/referencia/account_review_update.md +90 -0
- package/docs/webhooks/referencia/account_update.md +379 -0
- package/docs/webhooks/referencia/business_capability_update.md +121 -0
- package/docs/webhooks/referencia/history.md +302 -0
- package/docs/webhooks/referencia/message_template_components_update.md +179 -0
- package/docs/webhooks/referencia/message_template_quality_update.md +136 -0
- package/docs/webhooks/referencia/message_template_status_update.md +253 -0
- package/docs/webhooks/referencia/messages/AGENTS.md +24 -0
- package/docs/webhooks/referencia/messages/audio.md +298 -0
- package/docs/webhooks/referencia/messages/button.md +170 -0
- package/docs/webhooks/referencia/messages/contacts.md +491 -0
- package/docs/webhooks/referencia/messages/document.md +307 -0
- package/docs/webhooks/referencia/messages/errors.md +132 -0
- package/docs/webhooks/referencia/messages/image.md +304 -0
- package/docs/webhooks/referencia/messages/interactive.md +225 -0
- package/docs/webhooks/referencia/messages/location.md +296 -0
- package/docs/webhooks/referencia/messages/messages.md +44 -0
- package/docs/webhooks/referencia/messages/order.md +208 -0
- package/docs/webhooks/referencia/messages/reaction.md +178 -0
- package/docs/webhooks/referencia/messages/status.md +364 -0
- package/docs/webhooks/referencia/messages/sticker.md +298 -0
- package/docs/webhooks/referencia/messages/system.md +140 -0
- package/docs/webhooks/referencia/messages/text.md +322 -0
- package/docs/webhooks/referencia/messages/unsupported.md +165 -0
- package/docs/webhooks/referencia/messages/video.md +304 -0
- package/docs/webhooks/referencia/outros_webhooks/AGENTS.md +16 -0
- package/docs/webhooks/referencia/outros_webhooks/partner_solutions.md +114 -0
- package/docs/webhooks/referencia/outros_webhooks/payment_configuration_update.md +135 -0
- package/docs/webhooks/referencia/outros_webhooks/phone_number_name_update.md +129 -0
- package/docs/webhooks/referencia/outros_webhooks/phone_number_quality_update.md +172 -0
- package/docs/webhooks/referencia/outros_webhooks/security.md +108 -0
- package/docs/webhooks/referencia/outros_webhooks/smb_app_state_sync.md +146 -0
- package/docs/webhooks/referencia/outros_webhooks/smb_message_echoes.md +143 -0
- package/docs/webhooks/referencia/outros_webhooks/template_category_update.md +154 -0
- package/docs/webhooks/referencia/outros_webhooks/user_preferences.md +150 -0
- package/docs/webhooks/visao_geral/AGENTS.md +11 -0
- package/docs/webhooks/visao_geral/message_echoes.md +8 -0
- package/docs/webhooks/visao_geral/override.md +235 -0
- package/docs/webhooks/visao_geral/overview.md +158 -0
- package/docs/webhooks/visao_geral/set_up_whatsapp_echo_bot.md +109 -0
- package/package.json +50 -0
|
@@ -0,0 +1,581 @@
|
|
|
1
|
+
<!-- Source: https://developers.facebook.com/documentation/business-messaging/whatsapp/payments/payments-in/payment-links -->
|
|
2
|
+
<!-- Scraped: 2025-12-20T17:45:28.215Z -->
|
|
3
|
+
|
|
4
|
+
# Como aceitar pagamentos por meio de links
|
|
5
|
+
|
|
6
|
+
Updated: 14 de nov de 2025
|
|
7
|
+
|
|
8
|
+
Esse recurso ainda não está disponível para o público. Para saber mais, entre em contato com whatsappindia-bizpayments-support@meta.com.
|
|
9
|
+
|
|
10
|
+
Para permitir que os clientes paguem pelos pedidos, suas empresas podem incluir no WhatsApp todas as formas de pagamento aceitas na sua plataforma. As empresas podem enviar mensagens de fatura aos clientes (`order_details`) e, em seguida, receber notificações sobre atualizações no status de pagamento por meio de webhooks do gateway de pagamento.
|
|
11
|
+
|
|
12
|
+
## Visão geral
|
|
13
|
+
|
|
14
|
+
Atualmente, os clientes navegam pelos catálogos das empresas, adicionam produtos ao carrinho e enviam pedidos usando nosso conjunto de soluções de mensagens comerciais, que inclui [mensagem de produto única, mensagem de vários produtos e página de detalhes do produto](/documentation/business-messaging/whatsapp/catalogs/sell-products-and-services/share-products).
|
|
15
|
+
|
|
16
|
+
Com a API de Mensagens do WhatsApp, as empresas podem enviar uma fatura aos clientes para concluir o pedido com um dos instrumentos de pagamento aceitos.
|
|
17
|
+
|
|
18
|
+
## Como funciona
|
|
19
|
+
|
|
20
|
+
A empresa deve enviar uma mensagem `order_details` para o consumidor iniciar o pagamento. Essas mensagens são um novo tipo de mensagem interativa e sempre contêm os mesmos quatro componentes principais: **cabeçalho**, **corpo**, **rodapé** e **ação**. Dentro do componente de **ação**, a empresa inclui todas as informações necessárias para que o cliente conclua o pagamento.
|
|
21
|
+
|
|
22
|
+
Cada mensagem `order_details` contém um `reference_id` único fornecido pela empresa, e esse número é usado em todo o fluxo para rastrear o pedido. Esse `reference_id` é usado para gerar o link de pagamento do Gateway de Pagamento.
|
|
23
|
+
|
|
24
|
+
Depois que a mensagem é enviada, a empresa aguarda por atualizações de status de pagamento ou transação diretamente no gateway de pagamento. Ao receber o sinal de pagamento de um pedido, a empresa deve repassar esse sinal ao cliente por meio de uma mensagem interativa de status do pedido (`order_status`).
|
|
25
|
+
|
|
26
|
+
É importante informar o usuário sobre o sinal de pagamento, pois essa mensagem atualiza os detalhes e a visualização do pedido, refletindo a confirmação da compra pelo comerciante. Isso será mostrado com um exemplo nas seções subsequentes.
|
|
27
|
+
|
|
28
|
+
## Fluxo de compra no app
|
|
29
|
+
|
|
30
|
+
No app para clientes do WhatsApp, o fluxo de compra tem estas etapas:
|
|
31
|
+
|
|
32
|
+
- O cliente envia um pedido com produtos selecionados para a empresa ou a empresa identifica os produtos nos quais o cliente demonstrou interesse em comprar.
|
|
33
|
+
- Após receber o pedido ou identificar o produto, se a empresa aceitar outras formas de pagamento, como cartões de crédito ou carteiras digitais etc., ela enviará uma mensagem ao cliente para saber qual forma de pagamento prefere usar no pedido.
|
|
34
|
+
|
|
35
|
+

|
|
36
|
+
- Quando os consumidores optarem por usar outra forma de pagamento, a empresa deverá gerar o link de pagamento chamando o Gateway de Pagamento e fornecendo o "reference-id" único e outras informações, como valor, validade etc. Depois, a empresa poderá usar o link de pagamento gerado para elaborar a mensagem com os detalhes do pedido e enviá-la ao consumidor.
|
|
37
|
+
|
|
38
|
+

|
|
39
|
+
- Quando o consumidor tocar no botão Pagar agora/Continuar, ele será redirecionado para o link de pagamento no navegador no app, que apresenta a lista de opções compatíveis, como cartão de crédito, cartão de débito, carteira ou apps de UPI. É possível escolher qualquer uma das opções da UPI para pagar o pedido.
|
|
40
|
+
|
|
41
|
+
Veja a seguir um exemplo de redirecionamento de link de pagamento no navegador no app que aceita diversas formas de pagamento, como cartão de crédito, cartão de débito, carteira e apps de UPI.
|
|
42
|
+
|
|
43
|
+

|
|
44
|
+
- Após a conclusão do pagamento, a empresa recebe uma notificação do Gateway de Pagamento e precisa enviar atualizações de status do pedido para o cliente, notificando sobre o progresso do pedido. Isso atualizará as CTAs da mensagem, a tela de detalhes do pedido e o status do pedido. O status do pedido deve conter o "reference-id" correspondente aos detalhes do pedido.
|
|
45
|
+
|
|
46
|
+

|
|
47
|
+
|
|
48
|
+
|
|
49
|
+
## Etapas de integração
|
|
50
|
+
|
|
51
|
+
As etapas descritas abaixo partem do pressuposto de que a empresa está prestes a enviar a mensagem de detalhes do pedido ao cliente.
|
|
52
|
+
|
|
53
|
+
O diagrama de sequência a seguir exibe o fluxo de integração típico da API de Pagamentos do WhatsApp: 
|
|
54
|
+
|
|
55
|
+
### Etapa 1: obter o link de pagamento do gateway de pagamento
|
|
56
|
+
|
|
57
|
+
Assim que o cliente demonstrar interesse em comprar um item usando o link de pagamento. A empresa precisa chamar o gateway de pagamento com as informações necessárias, como identificação de referência, valor e validade, para gerar o link de pagamento. Este é um exemplo de link de pagamento:
|
|
58
|
+
|
|
59
|
+
```
|
|
60
|
+
https://rzp.io/i/rNiAagU8y
|
|
61
|
+
```
|
|
62
|
+
|
|
63
|
+
A empresa precisa usar a mesma identificação de referência, valor e validade na mensagem interativa da fatura (`order_details`)
|
|
64
|
+
|
|
65
|
+
### Etapa 2: criar o objeto interativo
|
|
66
|
+
|
|
67
|
+
Para enviar uma mensagem `order_details`, as empresas precisam montar um [objeto interativo](/documentation/business-messaging/whatsapp/reference/whatsapp-business-phone-number/message-api) do tipo `order_details` com estes componentes:
|
|
68
|
+
|
|
69
|
+
Objeto
|
|
70
|
+
|
|
71
|
+
Descrição
|
|
72
|
+
|
|
73
|
+
`type`
|
|
74
|
+
|
|
75
|
+
objeto
|
|
76
|
+
|
|
77
|
+
**Obrigatório.**
|
|
78
|
+
|
|
79
|
+
Deve ser "order\_details".
|
|
80
|
+
|
|
81
|
+
`header`
|
|
82
|
+
|
|
83
|
+
objeto
|
|
84
|
+
|
|
85
|
+
**Opcional.**
|
|
86
|
+
|
|
87
|
+
O conteúdo do cabeçalho exibido na parte superior da mensagem. Se nenhum cabeçalho for fornecido, a API usará uma imagem do primeiro produto disponível como cabeçalho
|
|
88
|
+
|
|
89
|
+
`body`
|
|
90
|
+
|
|
91
|
+
objeto
|
|
92
|
+
|
|
93
|
+
**Obrigatório.**
|
|
94
|
+
|
|
95
|
+
Um objeto com o corpo da mensagem. O objeto contém o seguinte campo:
|
|
96
|
+
|
|
97
|
+
String `text`
|
|
98
|
+
|
|
99
|
+
- **Obrigatório** se `body` estiver presente. O conteúdo da mensagem. Há compatibilidade com emojis e Markdown. O tamanho máximo é de 1.024 caracteres
|
|
100
|
+
|
|
101
|
+
`footer`
|
|
102
|
+
|
|
103
|
+
objeto
|
|
104
|
+
|
|
105
|
+
**Opcional.**
|
|
106
|
+
|
|
107
|
+
Um objeto com o rodapé da mensagem. O objeto contém os seguintes campos:
|
|
108
|
+
|
|
109
|
+
String `text`
|
|
110
|
+
|
|
111
|
+
- **Obrigatório** se `footer` estiver presente. O conteúdo do rodapé. É compatível com emojis, Markdown e links. O comprimento máximo é de 60 caracteres
|
|
112
|
+
|
|
113
|
+
`action`
|
|
114
|
+
|
|
115
|
+
objeto
|
|
116
|
+
|
|
117
|
+
**Obrigatório.**
|
|
118
|
+
|
|
119
|
+
Um objeto de ação que você deseja que o usuário execute após a leitura da mensagem. Esse objeto de ação contém os seguintes campos:
|
|
120
|
+
|
|
121
|
+
string `name`
|
|
122
|
+
|
|
123
|
+
- **Obrigatório.** Deve ser "review\_and\_pay"
|
|
124
|
+
|
|
125
|
+
Objeto `parameters`
|
|
126
|
+
|
|
127
|
+
- Para mais informações, consulte [Objeto de parâmetros](#paramobject)
|
|
128
|
+
|
|
129
|
+
#### Objeto de parâmetros
|
|
130
|
+
|
|
131
|
+
Objeto
|
|
132
|
+
|
|
133
|
+
Descrição
|
|
134
|
+
|
|
135
|
+
`reference_id`
|
|
136
|
+
|
|
137
|
+
string
|
|
138
|
+
|
|
139
|
+
**Obrigatório.**
|
|
140
|
+
|
|
141
|
+
O identificador único do pedido ou da fatura fornecido pela empresa. Essa string diferencia maiúsculas de minúsculas, não pode estar vazia e só pode conter letras, números, sublinhados, traços ou pontos, além de não ultrapassar 35 caracteres.
|
|
142
|
+
|
|
143
|
+
O `reference_id` deve ser único para cada mensagem `order_details` da mesma empresa. Se o parceiro quiser enviar várias mensagens de order\_details para o mesmo pedido, fatura ou item semelhante, recomendamos incluir um número de sequência no `reference_id` (por exemplo, <order-or-invoice-id>-<sequence-number>) para garantir a exclusividade do `reference_id`.
|
|
144
|
+
|
|
145
|
+
`type`
|
|
146
|
+
|
|
147
|
+
objeto
|
|
148
|
+
|
|
149
|
+
**Obrigatório.**
|
|
150
|
+
|
|
151
|
+
O tipo de produto a ser pago neste pedido. As opções compatíveis no momento são `digital-goods` e `physical-goods`
|
|
152
|
+
|
|
153
|
+
`beneficiaries`
|
|
154
|
+
|
|
155
|
+
matriz
|
|
156
|
+
|
|
157
|
+
**Obrigatório para mercadorias físicas enviadas.**
|
|
158
|
+
|
|
159
|
+
Uma matriz de beneficiários do pedido. O beneficiário é o destinatário designado para o envio dos produtos físicos do pedido. Contém os seguintes campos:
|
|
160
|
+
|
|
161
|
+
As informações sobre o beneficiário não são exibidas aos usuários, mas são necessárias por motivos legais e de conformidade.
|
|
162
|
+
|
|
163
|
+
string `name`
|
|
164
|
+
|
|
165
|
+
- **Obrigatório.** Nome do indivíduo ou empresa que recebeu os produtos físicos. Não pode ter mais de 200 caracteres
|
|
166
|
+
|
|
167
|
+
String `address_line1`
|
|
168
|
+
|
|
169
|
+
- **Obrigatório.** Endereço de entrega (número da porta/torre, nome da rua etc.). Não pode ter mais de 100 caracteres
|
|
170
|
+
|
|
171
|
+
String `address_line2`
|
|
172
|
+
|
|
173
|
+
- **Opcional.** Endereço de entrega (ponto de referência, área, entre outros). Não pode ter mais de 100 caracteres
|
|
174
|
+
|
|
175
|
+
String `city`
|
|
176
|
+
|
|
177
|
+
- **Obrigatório.** Nome da cidade.
|
|
178
|
+
|
|
179
|
+
String `state`
|
|
180
|
+
|
|
181
|
+
- **Obrigatório.** Nome do estado.
|
|
182
|
+
|
|
183
|
+
String `country`
|
|
184
|
+
|
|
185
|
+
- **Obrigatório.** Deve ser "Índia".
|
|
186
|
+
|
|
187
|
+
String `postal_code`
|
|
188
|
+
|
|
189
|
+
- **Obrigatório.** Código postal de seis dígitos do endereço de entrega.
|
|
190
|
+
|
|
191
|
+
`payment_type`
|
|
192
|
+
|
|
193
|
+
**Obrigatório.**
|
|
194
|
+
|
|
195
|
+
Deve ser "upi".
|
|
196
|
+
|
|
197
|
+
`payment_settings`
|
|
198
|
+
|
|
199
|
+
**Obrigatório.** Consulte [Objeto de configurações de pagamento](#payment_settings) para saber mais.
|
|
200
|
+
|
|
201
|
+
`currency`
|
|
202
|
+
|
|
203
|
+
**Obrigatório.**
|
|
204
|
+
|
|
205
|
+
A moeda usada para o pedido. No momento, o único valor aceito é `INR`.
|
|
206
|
+
|
|
207
|
+
`total_amount`
|
|
208
|
+
|
|
209
|
+
objeto
|
|
210
|
+
|
|
211
|
+
**Obrigatório.**
|
|
212
|
+
|
|
213
|
+
O objeto `total_amount` contém os seguintes campos:
|
|
214
|
+
|
|
215
|
+
`offset` é um número inteiro
|
|
216
|
+
|
|
217
|
+
- **Obrigatório.** Deve ser `100` para `INR`.
|
|
218
|
+
|
|
219
|
+
`value` é um número inteiro
|
|
220
|
+
|
|
221
|
+
- **Obrigatório.** Número inteiro positivo que representa o valor do montante multiplicado pelo fator de ajuste. Por exemplo, ₹12,34 tem o valor 1234.
|
|
222
|
+
|
|
223
|
+
`total_amount.value` deve ser igual a `order.subtotal.value` + `order.tax.value` + `order.shipping.value` - `order.discount.value`.
|
|
224
|
+
|
|
225
|
+
`order`
|
|
226
|
+
|
|
227
|
+
objeto
|
|
228
|
+
|
|
229
|
+
**Obrigatório.**
|
|
230
|
+
|
|
231
|
+
Consulte [Objeto de pedido](#ordobject) para saber mais.
|
|
232
|
+
|
|
233
|
+
#### Objeto de configuração de pagamento
|
|
234
|
+
|
|
235
|
+
Objeto
|
|
236
|
+
|
|
237
|
+
Descrição
|
|
238
|
+
|
|
239
|
+
String `type`
|
|
240
|
+
|
|
241
|
+
**Obrigatório.** Precisa ser `payment_link`.
|
|
242
|
+
|
|
243
|
+
Objeto `payment_link`
|
|
244
|
+
|
|
245
|
+
**Obrigatório.** Consulte [Objeto de link de pagamento](#payment_link) para saber mais.
|
|
246
|
+
|
|
247
|
+
#### Objeto de link de pagamento
|
|
248
|
+
|
|
249
|
+
Objeto
|
|
250
|
+
|
|
251
|
+
Descrição
|
|
252
|
+
|
|
253
|
+
String `uri`
|
|
254
|
+
|
|
255
|
+
**Obrigatório.** Um link de pagamento válido gerado no gateway de pagamento.
|
|
256
|
+
|
|
257
|
+
Os domínios de links de pagamento gerados precisam ser habilitados para aceitar pagamentos. Para saber mais, entre em contato com whatsappindia-bizpayments-support@meta.com.
|
|
258
|
+
|
|
259
|
+
String `success_url`
|
|
260
|
+
|
|
261
|
+
**Opcional.** O fluxo foi encerrado com status de sucesso, quando success\_url foi atingido.
|
|
262
|
+
|
|
263
|
+
String `cancel_url`
|
|
264
|
+
|
|
265
|
+
**Opcional.** O fluxo é encerrado com falha quando cancel\_url é disparado.
|
|
266
|
+
|
|
267
|
+
#### Objeto Order
|
|
268
|
+
|
|
269
|
+
Objeto
|
|
270
|
+
|
|
271
|
+
Descrição
|
|
272
|
+
|
|
273
|
+
`status`
|
|
274
|
+
|
|
275
|
+
string
|
|
276
|
+
|
|
277
|
+
**Obrigatório.**
|
|
278
|
+
|
|
279
|
+
O único valor aceito na mensagem `order_details` é `pending`.
|
|
280
|
+
|
|
281
|
+
Em uma mensagem `order_status`, `status` pode ser: `pending`, `captured` ou `failed`.
|
|
282
|
+
|
|
283
|
+
`type`
|
|
284
|
+
|
|
285
|
+
string
|
|
286
|
+
|
|
287
|
+
**Opcional.**
|
|
288
|
+
|
|
289
|
+
O único valor aceito é `quick_pay`. Quando o campo é transmitido, ocultamos o botão "Verificar e pagar" e exibimos apenas o botão "Pagar agora" no balão de detalhes do pedido.
|
|
290
|
+
|
|
291
|
+
`items`
|
|
292
|
+
|
|
293
|
+
objeto
|
|
294
|
+
|
|
295
|
+
**Obrigatório.**
|
|
296
|
+
|
|
297
|
+
Um objeto com a lista de itens do pedido, contendo os seguintes campos:
|
|
298
|
+
|
|
299
|
+
String `retailer_id`
|
|
300
|
+
|
|
301
|
+
- **Opcional.** A identificação de conteúdo de um item do pedido do seu catálogo.
|
|
302
|
+
|
|
303
|
+
String `name`
|
|
304
|
+
|
|
305
|
+
- **Obrigatório.** O nome do item que será exibido ao usuário. Não pode ter mais de 60 caracteres
|
|
306
|
+
|
|
307
|
+
Objeto `image`
|
|
308
|
+
|
|
309
|
+
- **Opcional.** Imagem personalizada do item que será exibida ao usuário. Consulte [Objeto de imagem de item](#item_image_object) para saber mais
|
|
310
|
+
|
|
311
|
+
O uso desse campo de imagem limitará a matriz de itens a um máximo de 10 itens e não poderá ser usado com `retailer_id` ou `catalog_id`.
|
|
312
|
+
|
|
313
|
+
Objeto `amount` com valor e fator de ajuste — consulte o campo de valor total acima
|
|
314
|
+
|
|
315
|
+
- **Obrigatório.** O preço por item
|
|
316
|
+
|
|
317
|
+
Objeto de quantia `sale_amount`
|
|
318
|
+
|
|
319
|
+
- **Opcional.** O preço com desconto de cada item. Esse valor deve ser menor que o original. Se for incluído, esse campo será usado para calcular o valor do subtotal
|
|
320
|
+
|
|
321
|
+
`quantity` é um número inteiro
|
|
322
|
+
|
|
323
|
+
- **Obrigatório.** O número de itens no pedido; este campo não pode conter valores decimais e deve ser um número inteiro.
|
|
324
|
+
|
|
325
|
+
String `country_of_origin`
|
|
326
|
+
|
|
327
|
+
- **Obrigatório** se `catalog_id` não estiver presente. O país de origem do produto
|
|
328
|
+
|
|
329
|
+
String `importer_name`
|
|
330
|
+
|
|
331
|
+
- **Obrigatório** se `catalog_id` não estiver presente. Nome da empresa importadora
|
|
332
|
+
|
|
333
|
+
String `importer_adress`
|
|
334
|
+
|
|
335
|
+
- **Obrigatório** se `catalog_id` não estiver presente. Endereço da empresa importadora
|
|
336
|
+
|
|
337
|
+
`subtotal`
|
|
338
|
+
|
|
339
|
+
objeto
|
|
340
|
+
|
|
341
|
+
**Obrigatório.**
|
|
342
|
+
|
|
343
|
+
O valor **deve ser igual** à soma de `order.amount.value` \* `order.amount.quantity`. Consulte a descrição de `total_amount` para ver explicações sobre os campos `offset` e `value`
|
|
344
|
+
|
|
345
|
+
Os seguintes campos fazem parte do objeto `subtotal`:
|
|
346
|
+
|
|
347
|
+
`offset` é um número inteiro
|
|
348
|
+
|
|
349
|
+
- **Obrigatório.** Deve ser `100` para `INR`
|
|
350
|
+
|
|
351
|
+
`value` é um número inteiro
|
|
352
|
+
|
|
353
|
+
- **Obrigatório.** Número inteiro positivo que representa o valor do montante multiplicado pelo fator de ajuste. Por exemplo, ₹12,34 tem o valor 1234
|
|
354
|
+
|
|
355
|
+
`tax`
|
|
356
|
+
|
|
357
|
+
objeto
|
|
358
|
+
|
|
359
|
+
**Obrigatório.**
|
|
360
|
+
|
|
361
|
+
As informações fiscais do pedido que contêm os seguintes campos:
|
|
362
|
+
|
|
363
|
+
`offset` é um número inteiro
|
|
364
|
+
|
|
365
|
+
- **Obrigatório.** Deve ser `100` para `INR`
|
|
366
|
+
|
|
367
|
+
`value` é um número inteiro
|
|
368
|
+
|
|
369
|
+
- **Obrigatório.** Número inteiro positivo que representa o valor do montante multiplicado pelo fator de ajuste. Por exemplo, ₹12,34 tem o valor 1234
|
|
370
|
+
|
|
371
|
+
String `description`
|
|
372
|
+
|
|
373
|
+
- **Opcional.** O limite máximo é de 60 caracteres
|
|
374
|
+
|
|
375
|
+
`shipping`
|
|
376
|
+
|
|
377
|
+
objeto
|
|
378
|
+
|
|
379
|
+
**Opcional.**
|
|
380
|
+
|
|
381
|
+
O custo de envio do pedido. O objeto contém os seguintes campos:
|
|
382
|
+
|
|
383
|
+
`offset` é um número inteiro
|
|
384
|
+
|
|
385
|
+
- **Obrigatório.** Deve ser `100` para `INR`
|
|
386
|
+
|
|
387
|
+
`value` é um número inteiro
|
|
388
|
+
|
|
389
|
+
- **Obrigatório.** Número inteiro positivo que representa o valor do montante multiplicado pelo fator de ajuste. Por exemplo, ₹12,34 tem o valor 1234
|
|
390
|
+
|
|
391
|
+
String `description`
|
|
392
|
+
|
|
393
|
+
- **Opcional.** O limite máximo é de 60 caracteres
|
|
394
|
+
|
|
395
|
+
`discount`
|
|
396
|
+
|
|
397
|
+
objeto
|
|
398
|
+
|
|
399
|
+
**Opcional.**
|
|
400
|
+
|
|
401
|
+
O desconto do pedido. O objeto contém os seguintes campos:
|
|
402
|
+
|
|
403
|
+
`offset` é um número inteiro
|
|
404
|
+
|
|
405
|
+
- **Obrigatório.** Deve ser `100` para `INR`
|
|
406
|
+
|
|
407
|
+
`value` é um número inteiro
|
|
408
|
+
|
|
409
|
+
- **Obrigatório.** Número inteiro positivo que representa o valor do montante multiplicado pelo fator de ajuste. Por exemplo, ₹12,34 tem o valor 1234
|
|
410
|
+
|
|
411
|
+
String `description`
|
|
412
|
+
|
|
413
|
+
- **Opcional.** O limite máximo é de 60 caracteres
|
|
414
|
+
|
|
415
|
+
String `discount_program_name`
|
|
416
|
+
|
|
417
|
+
- **Opcional.** Texto usado para definir pedidos om incentivos. Se o pedido incluir incentivos, o comerciante precisará definir essa informação. O limite máximo é de 60 caracteres
|
|
418
|
+
|
|
419
|
+
`catalog_id`
|
|
420
|
+
|
|
421
|
+
objeto
|
|
422
|
+
|
|
423
|
+
**Opcional.**
|
|
424
|
+
|
|
425
|
+
O identificador único do catálogo do Facebook usado pela empresa.
|
|
426
|
+
|
|
427
|
+
Se o campo não for fornecido, será necessário fornecer os seguintes campos dentro do objeto "items": `country_of_origin`, `importer_name` e `importer_address`
|
|
428
|
+
|
|
429
|
+
`expiration`
|
|
430
|
+
|
|
431
|
+
objeto
|
|
432
|
+
|
|
433
|
+
**Opcional.**
|
|
434
|
+
|
|
435
|
+
Validade do pedido. A empresa deve definir os seguintes campos no objeto:
|
|
436
|
+
|
|
437
|
+
String `timestamp` – registro de data e hora UTC em segundos do momento em que o pedido deve expirar. O limite mínimo é de 300 segundos
|
|
438
|
+
|
|
439
|
+
String `description` – texto que explica a validade. O limite máximo é de 120 caracteres
|
|
440
|
+
|
|
441
|
+
#### Objeto de imagem de item
|
|
442
|
+
|
|
443
|
+
Objeto
|
|
444
|
+
|
|
445
|
+
Descrição
|
|
446
|
+
|
|
447
|
+
String `link`
|
|
448
|
+
|
|
449
|
+
**Obrigatório.** Um link para a imagem que será exibida ao usuário. Deve ser `image/jpeg` ou `image/png` e 8 bits, RGB ou RGBA. Segue os mesmos requisitos de imagem em [mídia](/documentation/business-messaging/whatsapp/business-phone-numbers/media#supported-media-types)
|
|
450
|
+
|
|
451
|
+
O valor `parameters` é um objeto JSON convertido em string.
|
|
452
|
+
|
|
453
|
+
No final do processo, o objeto interativo terá aparência semelhante a esta em uma integração baseada em catálogo:
|
|
454
|
+
|
|
455
|
+
```
|
|
456
|
+
{ "interactive": { "type": "order_details", "header": { "type": "image", "image": { "link": "http(s)://the-url", "provider": { "name": "provider-name" } } }, "body": { "text": "your-text-body-content" }, "footer": { "text": "your-text-footer-content" }, "action": { "name": "review_and_pay", "parameters": { "reference_id": "reference-id-value", "type": "digital-goods", "payment_type": "upi", "payment_settings": [ { "type": "payment_link", "payment_link": { "uri": "https://the-payment-link" } } ], "currency": "INR", "total_amount": { "value": 21000, "offset": 100 }, "order": { "status": "pending", "catalog_id": "the-catalog_id", "expiration": { "timestamp": "utc_timestamp_in_seconds", "description": "cancellation-explanation" }, "items": [ { "retailer_id": "1234567", "name": "Product name, for example bread", "amount": { "value": 10000, "offset": 100 }, "quantity": 1, "sale_amount": { "value": 100, "offset": 100 } } ], "subtotal": { "value": 20000, "offset": 100 }, "tax": { "value": 1000, "offset": 100, "description": "optional_text" }, "shipping": { "value": 1000, "offset": 100, "description": "optional_text" }, "discount": { "value": 1000, "offset": 100, "description": "optional_text", "discount_program_name": "optional_text" } } } } }}
|
|
457
|
+
```
|
|
458
|
+
|
|
459
|
+
O valor `parameters` é um objeto JSON convertido em string.
|
|
460
|
+
|
|
461
|
+
Para uma integração não baseada em catálogo, ou seja, quando "catalog-id" não está presente, um exemplo de carga é o seguinte:
|
|
462
|
+
|
|
463
|
+
```
|
|
464
|
+
{ "interactive": { "type": "order_details", "header": { "type": "image", "image": { "id": "your-media-id" } }, "body": { "text": "your-text-body-content" }, "footer": { "text": "your-text-footer-content" }, "action": { "name": "review_and_pay", "parameters": { "reference_id": "reference-id-value", "type": "digital-goods", "payment_type": "upi", "payment_settings": [ { "type": "payment_link", "payment_link": { "uri": "https://the-payment-link" } } ], "currency": "INR", "total_amount": { "value": 21000, "offset": 100 }, "order": { "status": "pending", "expiration": { "timestamp": "utc_timestamp_in_seconds", "description": "cancellation-explanation" }, "items": [ { "name": "Product name, for example bread", "amount": { "value": 10000, "offset": 100 }, "quantity": 1, "sale_amount": { "value": 100, "offset": 100 }, "country_of_origin": "country-of-origin", "importer_name": "name-of-importer-business", "importer_address": { "address_line1": "B8/733 nand nagri", "address_line2": "police station", "city": "East Delhi", "zone_code": "DL", "postal_code": "110093", "country_code": "IN" } }, { "name": "Product name, for example bread", "amount": { "value": 10000, "offset": 100 }, "quantity": 1, "sale_amount": { "value": 100, "offset": 100 }, "country_of_origin": "country-of-origin", "importer_name": "name-of-importer-business", "importer_address": { "address_line1": "B8/733 nand nagri", "address_line2": "police station", "city": "East Delhi", "zone_code": "DL", "postal_code": "110093", "country_code": "IN" } } ], "subtotal": { "value": 20000, "offset": 100 }, "tax": { "value": 1000, "offset": 100, "description": "optional_text" }, "shipping": { "value": 1000, "offset": 100, "description": "optional_text" }, "discount": { "value": 1000, "offset": 100, "description": "optional_text", "discount_program_name": "optional_text" } } } } }}
|
|
465
|
+
```
|
|
466
|
+
|
|
467
|
+
### Etapa 3: adicionar parâmetros de mensagem comuns
|
|
468
|
+
|
|
469
|
+
Assim que o objeto interativo estiver pronto, anexe os outros parâmetros que compõem uma mensagem: `recipient_type`, `to` e `type`. Lembre-se de definir `type` como `interactive`.
|
|
470
|
+
|
|
471
|
+
```
|
|
472
|
+
{ "messaging_product": "whatsapp", "recipient_type": "individual", "to": "PHONE_NUMBER", "type": "interactive", "interactive": { // interactive object here } }
|
|
473
|
+
```
|
|
474
|
+
|
|
475
|
+
Estes são os [parâmetros comuns a todos os tipos de mensagem](/documentation/business-messaging/whatsapp/messages/send-messages#requests).
|
|
476
|
+
|
|
477
|
+
### Etapa 4: fazer uma chamada POST ao ponto de extremidade de mensagens
|
|
478
|
+
|
|
479
|
+
Faça uma chamada POST para o ponto de extremidade [`/[PHONE_NUMBER_ID]/messages`](/documentation/business-messaging/whatsapp/reference/whatsapp-business-phone-number/message-api) com o objeto `JSON` criado. Caso a mensagem seja enviada com sucesso, você receberá a seguinte resposta:
|
|
480
|
+
|
|
481
|
+
```
|
|
482
|
+
{ "messaging_product": "whatsapp", "contacts": [ { "input": "[PHONE_NUMBER_ID]", "wa_id": "[PHONE-NUMBER_ID]" } ], "messages": [ { "id": "wamid.HBgLMTY1MDUwNzY1MjAVAgARGBI5QTNDQTVCM0Q0Q0Q2RTY3RTcA" } ]}
|
|
483
|
+
```
|
|
484
|
+
|
|
485
|
+
#### Erros
|
|
486
|
+
|
|
487
|
+
###### Aceitação dos Termos de Serviço do Pagamentos no WhatsApp pendente
|
|
488
|
+
|
|
489
|
+
Caso veja o erro a seguir, aceite os Termos de Serviço do Pagamentos no WhatsApp usando o link fornecido na mensagem de erro antes de tentar novamente.
|
|
490
|
+
|
|
491
|
+
```
|
|
492
|
+
{ "error": { "message": "(#134011) WhatsApp Payments terms of service has not been accepted", "type": "OAuthException", "code": 134011, "error_data": { "messaging_product": "whatsapp", "details": "WhatsApp Payments Terms of Service acceptance pending for this WhatsApp Business Account.Please use the following link to accept terms of service before using Business APIs: https://fb.me/12345" } }}
|
|
493
|
+
```
|
|
494
|
+
|
|
495
|
+
Para ver todos os outros erros que podem ser retornados e as orientações sobre como tratá-los, consulte [API de Nuvem do WhatsApp, Códigos de erro](/documentation/business-messaging/whatsapp/support/error-codes).
|
|
496
|
+
|
|
497
|
+
### Etapa 5: o consumidor paga o pedido
|
|
498
|
+
|
|
499
|
+
Os consumidores podem pagar usando a forma de pagamento do WhatsApp ou qualquer app compatível com a UPI instalado no dispositivo.
|
|
500
|
+
|
|
501
|
+
### Etapa 6: receber notificações sobre atualizações no status da transação do gateway de pagamento
|
|
502
|
+
|
|
503
|
+
As empresas recebem atualizações sobre a fatura por meio de webhooks do gateway de pagamento, quando o status da transação iniciada pelo usuário é alterado. O identificador exclusivo (reference-id transmitido na mensagem `order_details`) pode ser usado para associar a transação à fatura do consumidor ou à mensagem interativa de detalhes do pedido.
|
|
504
|
+
|
|
505
|
+
### Etapa 7: atualizar o status do pedido
|
|
506
|
+
|
|
507
|
+
Ao receber os sinais de transação do gateway de pagamento por meio do webhook, a empresa deve atualizar o status do pedido para manter o usuário informado. No momento, aceitamos os seguintes valores de status do pedido:
|
|
508
|
+
|
|
509
|
+

|
|
510
|
+
|
|
511
|
+
Valor
|
|
512
|
+
|
|
513
|
+
Descrição
|
|
514
|
+
|
|
515
|
+
`pending`
|
|
516
|
+
|
|
517
|
+
O usuário ainda não fez o pagamento
|
|
518
|
+
|
|
519
|
+
`processing`
|
|
520
|
+
|
|
521
|
+
Pagamento do usuário autorizado, o comerciante/parceiro está atendendo ao pedido, realizando o serviço, entre outros
|
|
522
|
+
|
|
523
|
+
`partially-shipped`
|
|
524
|
+
|
|
525
|
+
Uma parte dos produtos do pedido foi enviada pelo comerciante
|
|
526
|
+
|
|
527
|
+
`shipped`
|
|
528
|
+
|
|
529
|
+
Todos os produtos do pedido foram enviados pelo comerciante
|
|
530
|
+
|
|
531
|
+
`completed`
|
|
532
|
+
|
|
533
|
+
O pedido foi concluído, e nenhuma outra ação é esperada do usuário ou do parceiro/comerciante
|
|
534
|
+
|
|
535
|
+
`canceled`
|
|
536
|
+
|
|
537
|
+
O parceiro/comerciante quer cancelar a mensagem `order_details` do pedido/fatura. A atualização de status falhará se já houver um pagamento `successful` ou `pending` para esta mensagem `order_details`
|
|
538
|
+
|
|
539
|
+
Normalmente, as empresas atualizam o `order_status` usando as notificações de alteração de status de pagamento do WhatsApp ou processos internos próprios. Para atualizar `order_status`, o parceiro envia uma mensagem `order_status` ao usuário.
|
|
540
|
+
|
|
541
|
+
```
|
|
542
|
+
{ "recipient_type": "individual", "to": "whatsapp-id", "type": "interactive", "interactive": { "type": "order_status", "body": { "text": "your-text-body-content" }, "action": { "name": "review_order", "parameters": { "reference_id": "reference-id-value", "order": { "status": "processing | partially_shipped | shipped | completed | canceled", "description": "optional-text" } } } }}
|
|
543
|
+
```
|
|
544
|
+
|
|
545
|
+
A tabela a seguir descreve os valores retornados:
|
|
546
|
+
|
|
547
|
+
Valor
|
|
548
|
+
|
|
549
|
+
Descrição
|
|
550
|
+
|
|
551
|
+
`reference_id`
|
|
552
|
+
|
|
553
|
+
A identificação fornecida pelo parceiro na mensagem `order_details`
|
|
554
|
+
|
|
555
|
+
`status`
|
|
556
|
+
|
|
557
|
+
`status` do novo pedido
|
|
558
|
+
|
|
559
|
+
`description`
|
|
560
|
+
|
|
561
|
+
Texto opcional para compartilhar informações relacionadas ao status em `order_details`. Pode ser útil ao enviar o cancelamento. O limite máximo é de 120 caracteres
|
|
562
|
+
|
|
563
|
+
Sempre que receber atualizações de transações relacionadas a um pedido, o comerciante deve enviar uma mensagem ao consumidor. já que a mensagem order\_details e a experiência na tela de detalhes do pedido dependem dessas atualizações de status.
|
|
564
|
+
|
|
565
|
+
### Etapa 8: reconciliar pagamentos
|
|
566
|
+
|
|
567
|
+
As empresas devem usar os extratos bancários para reconciliar os pagamentos com o `reference_id` fornecido nas mensagens `order_details`.
|
|
568
|
+
|
|
569
|
+
## Lista de verificação para comerciantes integrados
|
|
570
|
+
|
|
571
|
+
- Garanta que a mensagem `order_status` seja enviada ao consumidor para informá-lo sobre as atualizações de um pedido após o recebimento das atualizações de transação correspondentes.
|
|
572
|
+
- Garanta que o comerciante esteja verificado e que o contato WABA esteja marcado com o selo de verificação.
|
|
573
|
+
- Confirme se a WABA está associada ao nível adequado de mensagens iniciadas pelo comerciante (1 mil, 10 mil ou 100 mil por dia)
|
|
574
|
+
- O comerciante deve listar as informações de suporte ao cliente na tela de perfil caso o consumidor queira relatar problemas.
|
|
575
|
+
|
|
576
|
+
|
|
577
|
+
Você achou esta página útil?
|
|
578
|
+
|
|
579
|
+

|
|
580
|
+
|
|
581
|
+

|