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.
Files changed (406) hide show
  1. package/LICENSE +22 -0
  2. package/README.md +181 -0
  3. package/dist/index.d.ts +3 -0
  4. package/dist/index.d.ts.map +1 -0
  5. package/dist/index.js +65 -0
  6. package/dist/index.js.map +1 -0
  7. package/dist/prompts.d.ts +22 -0
  8. package/dist/prompts.d.ts.map +1 -0
  9. package/dist/prompts.js +305 -0
  10. package/dist/prompts.js.map +1 -0
  11. package/dist/resources.d.ts +24 -0
  12. package/dist/resources.d.ts.map +1 -0
  13. package/dist/resources.js +132 -0
  14. package/dist/resources.js.map +1 -0
  15. package/dist/tools.d.ts +6 -0
  16. package/dist/tools.d.ts.map +1 -0
  17. package/dist/tools.js +379 -0
  18. package/dist/tools.js.map +1 -0
  19. package/dist/utils/fileLoader.d.ts +19 -0
  20. package/dist/utils/fileLoader.d.ts.map +1 -0
  21. package/dist/utils/fileLoader.js +126 -0
  22. package/dist/utils/fileLoader.js.map +1 -0
  23. package/dist/utils/search.d.ts +27 -0
  24. package/dist/utils/search.d.ts.map +1 -0
  25. package/dist/utils/search.js +91 -0
  26. package/dist/utils/search.js.map +1 -0
  27. package/docs/QUICK_REFERENCE.md +223 -0
  28. package/docs/anuncios_com_clique_para_whatsapp/AGENTS.md +8 -0
  29. package/docs/anuncios_com_clique_para_whatsapp/welcome_message_sequences.md +449 -0
  30. package/docs/ativos_da_conta/AGENTS.md +9 -0
  31. package/docs/ativos_da_conta/outros_ativos/AGENTS.md +12 -0
  32. package/docs/ativos_da_conta/outros_ativos/business_profiles.md +137 -0
  33. package/docs/ativos_da_conta/outros_ativos/display_names.md +108 -0
  34. package/docs/ativos_da_conta/outros_ativos/official_business_accounts.md +123 -0
  35. package/docs/ativos_da_conta/outros_ativos/qr_codes.md +198 -0
  36. package/docs/ativos_da_conta/outros_ativos/whatsapp_business_accounts.md +99 -0
  37. package/docs/ativos_da_conta/telefones_comerciais/AGENTS.md +11 -0
  38. package/docs/ativos_da_conta/telefones_comerciais/conversational_components.md +347 -0
  39. package/docs/ativos_da_conta/telefones_comerciais/phone_numbers.md +486 -0
  40. package/docs/ativos_da_conta/telefones_comerciais/registration.md +171 -0
  41. package/docs/ativos_da_conta/telefones_comerciais/two_step_verification.md +66 -0
  42. package/docs/catalogos/AGENTS.md +12 -0
  43. package/docs/catalogos/receive_responses.md +28 -0
  44. package/docs/catalogos/sell_products_and_services.md +24 -0
  45. package/docs/catalogos/set_commerce_settings.md +163 -0
  46. package/docs/catalogos/share_products.md +401 -0
  47. package/docs/catalogos/upload_inventory.md +28 -0
  48. package/docs/comecar/AGENTS.md +8 -0
  49. package/docs/comecar/get_started.md +127 -0
  50. package/docs/dados_privacidade_e_politica/AGENTS.md +16 -0
  51. package/docs/dados_privacidade_e_politica/block_users.md +549 -0
  52. package/docs/dados_privacidade_e_politica/data_privacy_and_security.md +78 -0
  53. package/docs/dados_privacidade_e_politica/encryption.md +8 -0
  54. package/docs/dados_privacidade_e_politica/getting_opt_in.md +41 -0
  55. package/docs/dados_privacidade_e_politica/identity_change.md +34 -0
  56. package/docs/dados_privacidade_e_politica/local_storage.md +277 -0
  57. package/docs/dados_privacidade_e_politica/no_storage.md +132 -0
  58. package/docs/dados_privacidade_e_politica/policy_enforcement.md +85 -0
  59. package/docs/dados_privacidade_e_politica/policy_enforcement_violations.md +127 -0
  60. package/docs/grupos/AGENTS.md +15 -0
  61. package/docs/grupos/error_codes.md +170 -0
  62. package/docs/grupos/faq.md +30 -0
  63. package/docs/grupos/get_started.md +73 -0
  64. package/docs/grupos/groups.md +75 -0
  65. package/docs/grupos/groups_messaging.md +340 -0
  66. package/docs/grupos/pricing.md +322 -0
  67. package/docs/grupos/reference.md +1059 -0
  68. package/docs/grupos/webhooks.md +298 -0
  69. package/docs/index.md +318 -0
  70. package/docs/insights/AGENTS.md +8 -0
  71. package/docs/insights/analytics.md +944 -0
  72. package/docs/ligacoes/AGENTS.md +20 -0
  73. package/docs/ligacoes/app_review_guidelines.md +48 -0
  74. package/docs/ligacoes/business_initiated_calls.md +858 -0
  75. package/docs/ligacoes/call_button_messages_deep_links.md +454 -0
  76. package/docs/ligacoes/call_settings.md +643 -0
  77. package/docs/ligacoes/calling.md +130 -0
  78. package/docs/ligacoes/faq.md +468 -0
  79. package/docs/ligacoes/integration_patterns.md +121 -0
  80. package/docs/ligacoes/pricing.md +339 -0
  81. package/docs/ligacoes/reference.md +1923 -0
  82. package/docs/ligacoes/sip.md +1090 -0
  83. package/docs/ligacoes/troubleshooting.md +483 -0
  84. package/docs/ligacoes/user_call_permissions.md +672 -0
  85. package/docs/ligacoes/user_initiated_calls.md +1030 -0
  86. package/docs/mensagens/AGENTS.md +46 -0
  87. package/docs/mensagens/limites_de_mensagens/AGENTS.md +9 -0
  88. package/docs/mensagens/limites_de_mensagens/messaging_limits.md +91 -0
  89. package/docs/mensagens/limites_de_mensagens/upcoming_changes.md +8 -0
  90. package/docs/mensagens/recursos_adicionais/AGENTS.md +13 -0
  91. package/docs/mensagens/recursos_adicionais/contextual_replies.md +82 -0
  92. package/docs/mensagens/recursos_adicionais/link_previews.md +58 -0
  93. package/docs/mensagens/recursos_adicionais/mark_message_as_read.md +111 -0
  94. package/docs/mensagens/recursos_adicionais/media.md +419 -0
  95. package/docs/mensagens/recursos_adicionais/payload_encryption.md +8 -0
  96. package/docs/mensagens/recursos_adicionais/typing_indicators.md +117 -0
  97. package/docs/mensagens/tipos_de_mensagens/AGENTS.md +24 -0
  98. package/docs/mensagens/tipos_de_mensagens/address_messages.md +465 -0
  99. package/docs/mensagens/tipos_de_mensagens/audio_messages.md +211 -0
  100. package/docs/mensagens/tipos_de_mensagens/contacts_messages.md +482 -0
  101. package/docs/mensagens/tipos_de_mensagens/document_messages.md +232 -0
  102. package/docs/mensagens/tipos_de_mensagens/image_messages.md +176 -0
  103. package/docs/mensagens/tipos_de_mensagens/interactive_cta_url_messages.md +240 -0
  104. package/docs/mensagens/tipos_de_mensagens/interactive_flow_messages.md +8 -0
  105. package/docs/mensagens/tipos_de_mensagens/interactive_list_messages.md +300 -0
  106. package/docs/mensagens/tipos_de_mensagens/interactive_reply_buttons_messages.md +271 -0
  107. package/docs/mensagens/tipos_de_mensagens/location_messages.md +156 -0
  108. package/docs/mensagens/tipos_de_mensagens/location_request_messages.md +310 -0
  109. package/docs/mensagens/tipos_de_mensagens/message_with_link.md +8 -0
  110. package/docs/mensagens/tipos_de_mensagens/reaction_messages.md +144 -0
  111. package/docs/mensagens/tipos_de_mensagens/sticker_messages.md +157 -0
  112. package/docs/mensagens/tipos_de_mensagens/template_messages.md +20 -0
  113. package/docs/mensagens/tipos_de_mensagens/text_messages.md +142 -0
  114. package/docs/mensagens/tipos_de_mensagens/video_messages.md +149 -0
  115. package/docs/mensagens/visao_geral/AGENTS.md +8 -0
  116. package/docs/mensagens/visao_geral/send_messages.md +370 -0
  117. package/docs/mensagens_de_marketing/AGENTS.md +10 -0
  118. package/docs/mensagens_de_marketing/implementacao/AGENTS.md +10 -0
  119. package/docs/mensagens_de_marketing/implementacao/get_started.md +107 -0
  120. package/docs/mensagens_de_marketing/implementacao/onboard_business_customers.md +180 -0
  121. package/docs/mensagens_de_marketing/implementacao/send_marketing_messages.md +260 -0
  122. package/docs/mensagens_de_marketing/recursos/AGENTS.md +12 -0
  123. package/docs/mensagens_de_marketing/recursos/automatic_creative_optimization.md +8 -0
  124. package/docs/mensagens_de_marketing/recursos/conversion_measurement.md +8 -0
  125. package/docs/mensagens_de_marketing/recursos/deep_links.md +302 -0
  126. package/docs/mensagens_de_marketing/recursos/track_click_events.md +119 -0
  127. package/docs/mensagens_de_marketing/recursos/view_metrics.md +338 -0
  128. package/docs/mensagens_de_marketing/visao_geral/AGENTS.md +8 -0
  129. package/docs/mensagens_de_marketing/visao_geral/overview.md +26 -0
  130. package/docs/modelos/AGENTS.md +12 -0
  131. package/docs/modelos/gerenciamento_de_modelos/AGENTS.md +21 -0
  132. package/docs/modelos/gerenciamento_de_modelos/components.md +717 -0
  133. package/docs/modelos/gerenciamento_de_modelos/supported_languages.md +462 -0
  134. package/docs/modelos/gerenciamento_de_modelos/tap_target_url_title_override.md +211 -0
  135. package/docs/modelos/gerenciamento_de_modelos/template_categorization.md +499 -0
  136. package/docs/modelos/gerenciamento_de_modelos/template_comparison.md +136 -0
  137. package/docs/modelos/gerenciamento_de_modelos/template_library.md +526 -0
  138. package/docs/modelos/gerenciamento_de_modelos/template_management.md +148 -0
  139. package/docs/modelos/gerenciamento_de_modelos/template_media.md +8 -0
  140. package/docs/modelos/gerenciamento_de_modelos/template_migration.md +164 -0
  141. package/docs/modelos/gerenciamento_de_modelos/template_pacing.md +38 -0
  142. package/docs/modelos/gerenciamento_de_modelos/template_pausing.md +58 -0
  143. package/docs/modelos/gerenciamento_de_modelos/template_quality.md +47 -0
  144. package/docs/modelos/gerenciamento_de_modelos/template_review.md +74 -0
  145. package/docs/modelos/gerenciamento_de_modelos/time_to_live.md +88 -0
  146. package/docs/modelos/modelos_de_autenticacao/AGENTS.md +13 -0
  147. package/docs/modelos/modelos_de_autenticacao/authentication_best_practices.md +73 -0
  148. package/docs/modelos/modelos_de_autenticacao/authentication_templates.md +252 -0
  149. package/docs/modelos/modelos_de_autenticacao/autofill_button_authentication_templates.md +732 -0
  150. package/docs/modelos/modelos_de_autenticacao/copy_code_button_authentication_templates.md +402 -0
  151. package/docs/modelos/modelos_de_autenticacao/error_signals.md +143 -0
  152. package/docs/modelos/modelos_de_autenticacao/zero_tap_authentication_templates.md +742 -0
  153. package/docs/modelos/modelos_de_marketing/AGENTS.md +18 -0
  154. package/docs/modelos/modelos_de_marketing/call_permission_request_message_template.md +221 -0
  155. package/docs/modelos/modelos_de_marketing/catalog_templates.md +308 -0
  156. package/docs/modelos/modelos_de_marketing/coupon_templates.md +425 -0
  157. package/docs/modelos/modelos_de_marketing/custom_marketing_templates.md +537 -0
  158. package/docs/modelos/modelos_de_marketing/limited_time_offer_templates.md +496 -0
  159. package/docs/modelos/modelos_de_marketing/marketing_templates.md +112 -0
  160. package/docs/modelos/modelos_de_marketing/media_card_carousel_templates.md +770 -0
  161. package/docs/modelos/modelos_de_marketing/mpm_templates.md +717 -0
  162. package/docs/modelos/modelos_de_marketing/per_user_limits.md +42 -0
  163. package/docs/modelos/modelos_de_marketing/product_card_carousel_templates.md +515 -0
  164. package/docs/modelos/modelos_de_marketing/spm_templates.md +466 -0
  165. package/docs/modelos/modelos_de_utilidade/AGENTS.md +8 -0
  166. package/docs/modelos/modelos_de_utilidade/utility_templates.md +583 -0
  167. package/docs/modelos/visao_geral/AGENTS.md +8 -0
  168. package/docs/modelos/visao_geral/overview.md +163 -0
  169. package/docs/pagamentos/AGENTS.md +9 -0
  170. package/docs/pagamentos/pagamentos_na_india/AGENTS.md +19 -0
  171. package/docs/pagamentos/pagamentos_na_india/checkout_button_templates.md +1332 -0
  172. package/docs/pagamentos/pagamentos_na_india/enhanced_payment_links.md +93 -0
  173. package/docs/pagamentos/pagamentos_na_india/onboarding_apis.md +580 -0
  174. package/docs/pagamentos/pagamentos_na_india/orderdetailstemplate.md +205 -0
  175. package/docs/pagamentos/pagamentos_na_india/orderstatustemplate.md +143 -0
  176. package/docs/pagamentos/pagamentos_na_india/overview.md +102 -0
  177. package/docs/pagamentos/pagamentos_na_india/payment_links.md +581 -0
  178. package/docs/pagamentos/pagamentos_na_india/pg.md +1228 -0
  179. package/docs/pagamentos/pagamentos_na_india/upi_intent/AGENTS.md +12 -0
  180. package/docs/pagamentos/pagamentos_na_india/upi_intent/dynamic_vpa.md +572 -0
  181. package/docs/pagamentos/pagamentos_na_india/upi_intent/pg_guide_billdesk.md +343 -0
  182. package/docs/pagamentos/pagamentos_na_india/upi_intent/pg_guide_cashfree.md +145 -0
  183. package/docs/pagamentos/pagamentos_na_india/upi_intent/pg_guide_ccavenue.md +146 -0
  184. package/docs/pagamentos/pagamentos_na_india/upi_intent/upi_intent.md +660 -0
  185. package/docs/pagamentos/pagamentos_no_brasil/AGENTS.md +14 -0
  186. package/docs/pagamentos/pagamentos_no_brasil/boleto.md +104 -0
  187. package/docs/pagamentos/pagamentos_no_brasil/offsite_pix.md +128 -0
  188. package/docs/pagamentos/pagamentos_no_brasil/one_click_payments.md +226 -0
  189. package/docs/pagamentos/pagamentos_no_brasil/orderdetailstemplate.md +180 -0
  190. package/docs/pagamentos/pagamentos_no_brasil/orders.md +768 -0
  191. package/docs/pagamentos/pagamentos_no_brasil/overview.md +32 -0
  192. package/docs/pagamentos/pagamentos_no_brasil/payment_links.md +104 -0
  193. package/docs/parceiros/AGENTS.md +12 -0
  194. package/docs/parceiros/analise_do_app/AGENTS.md +8 -0
  195. package/docs/parceiros/analise_do_app/app_review.md +91 -0
  196. package/docs/parceiros/gerenciamento/AGENTS.md +14 -0
  197. package/docs/parceiros/gerenciamento/gerenciar_ativos_do_cliente/AGENTS.md +15 -0
  198. package/docs/parceiros/gerenciamento/gerenciar_ativos_do_cliente/manage_accounts.md +274 -0
  199. package/docs/parceiros/gerenciamento/gerenciar_ativos_do_cliente/manage_system_users.md +106 -0
  200. package/docs/parceiros/gerenciamento/gerenciar_ativos_do_cliente/manage_webhooks.md +277 -0
  201. package/docs/parceiros/gerenciamento/gerenciar_ativos_do_cliente/numeros_de_telefone/AGENTS.md +9 -0
  202. package/docs/parceiros/gerenciamento/gerenciar_ativos_do_cliente/numeros_de_telefone/manage_phone_numbers.md +248 -0
  203. package/docs/parceiros/gerenciamento/gerenciar_ativos_do_cliente/numeros_de_telefone/registering_phone_numbers.md +373 -0
  204. package/docs/parceiros/gerenciamento/gerenciar_ativos_do_cliente/share_and_revoke_credit_lines.md +551 -0
  205. package/docs/parceiros/gerenciamento/partner_led_business_verification.md +367 -0
  206. package/docs/parceiros/gerenciamento/pixel_tracking.md +35 -0
  207. package/docs/parceiros/gerenciamento/suporte_ao_parceiro/AGENTS.md +18 -0
  208. package/docs/parceiros/gerenciamento/suporte_ao_parceiro/adding_waba_to_mps.md +64 -0
  209. package/docs/parceiros/gerenciamento/suporte_ao_parceiro/business_customer_support.md +102 -0
  210. package/docs/parceiros/gerenciamento/suporte_ao_parceiro/migrating_customers_off_solutions_via_embedded_signup.md +151 -0
  211. package/docs/parceiros/gerenciamento/suporte_ao_parceiro/migrating_customers_off_solutions_via_meta_business_suite.md +234 -0
  212. package/docs/parceiros/gerenciamento/suporte_ao_parceiro/migrating_phone_numbers_among_solution_partners_programmatically.md +292 -0
  213. package/docs/parceiros/gerenciamento/suporte_ao_parceiro/migrating_phone_numbers_among_solution_partners_via_embedded_signup.md +118 -0
  214. package/docs/parceiros/gerenciamento/suporte_ao_parceiro/migrating_wabas_among_solution_partners_via_embedded_signup.md +76 -0
  215. package/docs/parceiros/gerenciamento/suporte_ao_parceiro/migrating_wabas_among_solutions_via_embedded_signup.md +90 -0
  216. package/docs/parceiros/gerenciamento/suporte_ao_parceiro/migrating_wabas_among_solutions_via_meta_business_suite.md +265 -0
  217. package/docs/parceiros/gerenciamento/suporte_ao_parceiro/support.md +48 -0
  218. package/docs/parceiros/gerenciamento/suporte_ao_parceiro/transferring_wabas_to_customers.md +8 -0
  219. package/docs/parceiros/integracao_de_clientes/AGENTS.md +9 -0
  220. package/docs/parceiros/integracao_de_clientes/cadastro_incorporado/AGENTS.md +26 -0
  221. package/docs/parceiros/integracao_de_clientes/cadastro_incorporado/app_only_install.md +135 -0
  222. package/docs/parceiros/integracao_de_clientes/cadastro_incorporado/automatic_events_api.md +204 -0
  223. package/docs/parceiros/integracao_de_clientes/cadastro_incorporado/bypass_phone_addition.md +52 -0
  224. package/docs/parceiros/integracao_de_clientes/cadastro_incorporado/custom_flows.md +40 -0
  225. package/docs/parceiros/integracao_de_clientes/cadastro_incorporado/default_flow.md +90 -0
  226. package/docs/parceiros/integracao_de_clientes/cadastro_incorporado/errors.md +185 -0
  227. package/docs/parceiros/integracao_de_clientes/cadastro_incorporado/hosted_es.md +153 -0
  228. package/docs/parceiros/integracao_de_clientes/cadastro_incorporado/implementation.md +417 -0
  229. package/docs/parceiros/integracao_de_clientes/cadastro_incorporado/onboarding_business_app_users.md +926 -0
  230. package/docs/parceiros/integracao_de_clientes/cadastro_incorporado/onboarding_customers_as_a_solution_partner.md +402 -0
  231. package/docs/parceiros/integracao_de_clientes/cadastro_incorporado/onboarding_customers_as_a_tech_provider.md +332 -0
  232. package/docs/parceiros/integracao_de_clientes/cadastro_incorporado/overview.md +168 -0
  233. package/docs/parceiros/integracao_de_clientes/cadastro_incorporado/pre_filled_data.md +524 -0
  234. package/docs/parceiros/integracao_de_clientes/cadastro_incorporado/pre_verified_numbers.md +291 -0
  235. package/docs/parceiros/integracao_de_clientes/cadastro_incorporado/versions/AGENTS.md +12 -0
  236. package/docs/parceiros/integracao_de_clientes/cadastro_incorporado/versions/version_2_public_preview.md +88 -0
  237. package/docs/parceiros/integracao_de_clientes/cadastro_incorporado/versions/version_3.md +98 -0
  238. package/docs/parceiros/integracao_de_clientes/cadastro_incorporado/versions/version_3_public_preview.md +88 -0
  239. package/docs/parceiros/integracao_de_clientes/cadastro_incorporado/versions/version_4.md +92 -0
  240. package/docs/parceiros/integracao_de_clientes/cadastro_incorporado/versions/versions.md +463 -0
  241. package/docs/parceiros/integracao_de_clientes/cadastro_incorporado/website_optional.md +57 -0
  242. package/docs/parceiros/integracao_de_clientes/outras_opcoes_de_integracao/AGENTS.md +11 -0
  243. package/docs/parceiros/integracao_de_clientes/outras_opcoes_de_integracao/multi_partner_solution_embedded_creation.md +178 -0
  244. package/docs/parceiros/integracao_de_clientes/outras_opcoes_de_integracao/multi_partner_solutions.md +775 -0
  245. package/docs/parceiros/integracao_de_clientes/outras_opcoes_de_integracao/multi_solution_conversations.md +319 -0
  246. package/docs/parceiros/integracao_de_clientes/outras_opcoes_de_integracao/partner_initiated_waba_creation.md +74 -0
  247. package/docs/parceiros/seja_um_parceiro/AGENTS.md +11 -0
  248. package/docs/parceiros/seja_um_parceiro/get_started_for_solution_partners.md +280 -0
  249. package/docs/parceiros/seja_um_parceiro/get_started_for_tech_providers.md +194 -0
  250. package/docs/parceiros/seja_um_parceiro/measurement_partners.md +146 -0
  251. package/docs/parceiros/seja_um_parceiro/upgrade_to_tech_partner.md +94 -0
  252. package/docs/parceiros/visao_geral/AGENTS.md +8 -0
  253. package/docs/parceiros/visao_geral/overview.md +190 -0
  254. package/docs/recado/AGENTS.md +9 -0
  255. package/docs/recado/precos/AGENTS.md +11 -0
  256. package/docs/recado/precos/pricing.md +915 -0
  257. package/docs/recado/precos/pricing_authentication_international_rates.md +464 -0
  258. package/docs/recado/precos/pricing_conversation_based_pricing.md +773 -0
  259. package/docs/recado/precos/pricing_updates_to_pricing.md +8 -0
  260. package/docs/recado/sobre_a_plataforma/AGENTS.md +10 -0
  261. package/docs/recado/sobre_a_plataforma/about_the_platform.md +217 -0
  262. package/docs/recado/sobre_a_plataforma/access_tokens.md +110 -0
  263. package/docs/recado/sobre_a_plataforma/permissions.md +55 -0
  264. package/docs/referencia/AGENTS.md +92 -0
  265. package/docs/referencia/bot_do_whatsapp_business/AGENTS.md +8 -0
  266. package/docs/referencia/bot_do_whatsapp_business/bot_details_api.md +762 -0
  267. package/docs/referencia/business/AGENTS.md +14 -0
  268. package/docs/referencia/business/add_phone_numbers_api.md +726 -0
  269. package/docs/referencia/business/client_whatsapp_business_accounts_api.md +1006 -0
  270. package/docs/referencia/business/owned_whatsapp_business_accounts.md +802 -0
  271. package/docs/referencia/business/whatsapp_business_accounts_api.md +1550 -0
  272. package/docs/referencia/business/whatsapp_business_partner_onboarding_to_mm_lite_api.md +783 -0
  273. package/docs/referencia/business/whatsapp_business_pre_verified_phone_number_sharing_api.md +790 -0
  274. package/docs/referencia/business/whatsapp_business_pre_verified_phone_numbers_api.md +886 -0
  275. package/docs/referencia/changelog.md +10 -0
  276. package/docs/referencia/conta_do_whatsapp_business/AGENTS.md +24 -0
  277. package/docs/referencia/conta_do_whatsapp_business/assigned_users_management_api.md +2202 -0
  278. package/docs/referencia/conta_do_whatsapp_business/business_account_api.md +267 -0
  279. package/docs/referencia/conta_do_whatsapp_business/business_account_extended_credits_api.md +275 -0
  280. package/docs/referencia/conta_do_whatsapp_business/conversational_automation_api.md +782 -0
  281. package/docs/referencia/conta_do_whatsapp_business/flows_api.md +1532 -0
  282. package/docs/referencia/conta_do_whatsapp_business/in_progress_on_behalf_requests_api.md +8 -0
  283. package/docs/referencia/conta_do_whatsapp_business/migration_intent_api.md +1581 -0
  284. package/docs/referencia/conta_do_whatsapp_business/obo_mobility_intent_api.md +8 -0
  285. package/docs/referencia/conta_do_whatsapp_business/phone_number_management_api.md +1686 -0
  286. package/docs/referencia/conta_do_whatsapp_business/schedules_api.md +1772 -0
  287. package/docs/referencia/conta_do_whatsapp_business/set_obo_mobility_intent_api.md +8 -0
  288. package/docs/referencia/conta_do_whatsapp_business/set_solution_migration_intent_api.md +8 -0
  289. package/docs/referencia/conta_do_whatsapp_business/subscribed_apps_api.md +2178 -0
  290. package/docs/referencia/conta_do_whatsapp_business/template_api.md +976 -0
  291. package/docs/referencia/conta_do_whatsapp_business/whatsapp_business_account_activities_api.md +842 -0
  292. package/docs/referencia/conta_do_whatsapp_business/whatsapp_business_account_api.md +1384 -0
  293. package/docs/referencia/conta_do_whatsapp_business/whatsapp_business_account_solutions_list_api.md +854 -0
  294. package/docs/referencia/grupo/AGENTS.md +11 -0
  295. package/docs/referencia/grupo/groups_invite_link_api.md +304 -0
  296. package/docs/referencia/grupo/groups_join_requests_api.md +686 -0
  297. package/docs/referencia/grupo/groups_participants_api.md +274 -0
  298. package/docs/referencia/grupo/groups_query_api.md +436 -0
  299. package/docs/referencia/historico_de_mensagens/AGENTS.md +8 -0
  300. package/docs/referencia/historico_de_mensagens/whatsapp_business_message_history_events_api.md +866 -0
  301. package/docs/referencia/inscricao/AGENTS.md +10 -0
  302. package/docs/referencia/inscricao/application_connected_client_businesses.md +812 -0
  303. package/docs/referencia/inscricao/application_solutions_api.md +874 -0
  304. package/docs/referencia/inscricao/solution_creation_api.md +824 -0
  305. package/docs/referencia/intencao_de_migracao_da_conta_do_whatsapp_business/AGENTS.md +8 -0
  306. package/docs/referencia/intencao_de_migracao_da_conta_do_whatsapp_business/migration_intent_details_api.md +724 -0
  307. package/docs/referencia/midias/AGENTS.md +9 -0
  308. package/docs/referencia/midias/media_api.md +342 -0
  309. package/docs/referencia/midias/media_download_api.md +160 -0
  310. package/docs/referencia/numero_da_conta_do_whatsapp/AGENTS.md +8 -0
  311. package/docs/referencia/numero_da_conta_do_whatsapp/whatsapp_account_number_api.md +778 -0
  312. package/docs/referencia/perfil_do_whatsapp_business/AGENTS.md +8 -0
  313. package/docs/referencia/perfil_do_whatsapp_business/whatsapp_business_profile_node_api.md +1494 -0
  314. package/docs/referencia/solucao_do_whatsapp_business/AGENTS.md +14 -0
  315. package/docs/referencia/solucao_do_whatsapp_business/accept_deactivation_request_api.md +762 -0
  316. package/docs/referencia/solucao_do_whatsapp_business/access_token_api.md +704 -0
  317. package/docs/referencia/solucao_do_whatsapp_business/reject_deactivation_request_api.md +812 -0
  318. package/docs/referencia/solucao_do_whatsapp_business/send_deactivation_request_api.md +778 -0
  319. package/docs/referencia/solucao_do_whatsapp_business/solution_accept_api.md +812 -0
  320. package/docs/referencia/solucao_do_whatsapp_business/solution_details_api.md +768 -0
  321. package/docs/referencia/solucao_do_whatsapp_business/solution_reject_api.md +798 -0
  322. package/docs/referencia/telefone_do_whatsapp_business/AGENTS.md +29 -0
  323. package/docs/referencia/telefone_do_whatsapp_business/block_api.md +542 -0
  324. package/docs/referencia/telefone_do_whatsapp_business/business_compliance_information_api.md +1608 -0
  325. package/docs/referencia/telefone_do_whatsapp_business/business_encryption_api.md +1402 -0
  326. package/docs/referencia/telefone_do_whatsapp_business/calling_api.md +598 -0
  327. package/docs/referencia/telefone_do_whatsapp_business/encrypted_messages_api.md +482 -0
  328. package/docs/referencia/telefone_do_whatsapp_business/groups_management_api.md +485 -0
  329. package/docs/referencia/telefone_do_whatsapp_business/marketing_messages_lite_api.md +315 -0
  330. package/docs/referencia/telefone_do_whatsapp_business/media_upload_api.md +188 -0
  331. package/docs/referencia/telefone_do_whatsapp_business/message_api.md +1798 -0
  332. package/docs/referencia/telefone_do_whatsapp_business/phone_number_api.md +377 -0
  333. package/docs/referencia/telefone_do_whatsapp_business/phone_number_deregister_api.md +714 -0
  334. package/docs/referencia/telefone_do_whatsapp_business/phone_number_registration.md +780 -0
  335. package/docs/referencia/telefone_do_whatsapp_business/phone_number_verification_request_code_api.md +734 -0
  336. package/docs/referencia/telefone_do_whatsapp_business/register_api.md +411 -0
  337. package/docs/referencia/telefone_do_whatsapp_business/settings_api.md +674 -0
  338. package/docs/referencia/telefone_do_whatsapp_business/verify_code_api.md +746 -0
  339. package/docs/referencia/telefone_do_whatsapp_business/whatsapp_business_account_message_history_api.md +932 -0
  340. package/docs/referencia/telefone_do_whatsapp_business/whatsapp_business_account_official_business_account_status_api.md +1540 -0
  341. package/docs/referencia/telefone_do_whatsapp_business/whatsapp_business_account_phone_number_api.md +1600 -0
  342. package/docs/referencia/telefone_do_whatsapp_business/whatsapp_business_profile_api.md +1478 -0
  343. package/docs/referencia/telefone_do_whatsapp_business/whatsapp_business_qr_code_api.md +1179 -0
  344. package/docs/referencia/telefone_do_whatsapp_business/whatsapp_business_qr_code_management_api.md +1315 -0
  345. package/docs/referencia/telefone_pre_verificado_do_whatsapp_business/AGENTS.md +11 -0
  346. package/docs/referencia/telefone_pre_verificado_do_whatsapp_business/request_verification_code_api.md +778 -0
  347. package/docs/referencia/telefone_pre_verificado_do_whatsapp_business/verify_code_api.md +768 -0
  348. package/docs/referencia/telefone_pre_verificado_do_whatsapp_business/whatsapp_business_pre_verified_phone_number_api.md +1382 -0
  349. package/docs/referencia/telefone_pre_verificado_do_whatsapp_business/whatsapp_business_pre_verified_phone_number_partners_api.md +820 -0
  350. package/docs/referencia/usuario/AGENTS.md +8 -0
  351. package/docs/referencia/usuario/assigned_whatsapp_business_accounts_api.md +864 -0
  352. package/docs/referencia/webhooks/AGENTS.md +8 -0
  353. package/docs/referencia/webhooks/whatsapp_incoming_webhook_payload.md +1655 -0
  354. package/docs/suporte/AGENTS.md +13 -0
  355. package/docs/suporte/api_status_page.md +134 -0
  356. package/docs/suporte/error_codes.md +1194 -0
  357. package/docs/suporte/experiments.md +26 -0
  358. package/docs/suporte/health_status.md +225 -0
  359. package/docs/suporte/load_testing.md +340 -0
  360. package/docs/suporte/support.md +408 -0
  361. package/docs/visao_geral/AGENTS.md +8 -0
  362. package/docs/visao_geral/overview.md +2590 -0
  363. package/docs/webhooks/AGENTS.md +41 -0
  364. package/docs/webhooks/referencia/AGENTS.md +20 -0
  365. package/docs/webhooks/referencia/account_alerts.md +190 -0
  366. package/docs/webhooks/referencia/account_review_update.md +90 -0
  367. package/docs/webhooks/referencia/account_update.md +379 -0
  368. package/docs/webhooks/referencia/business_capability_update.md +121 -0
  369. package/docs/webhooks/referencia/history.md +302 -0
  370. package/docs/webhooks/referencia/message_template_components_update.md +179 -0
  371. package/docs/webhooks/referencia/message_template_quality_update.md +136 -0
  372. package/docs/webhooks/referencia/message_template_status_update.md +253 -0
  373. package/docs/webhooks/referencia/messages/AGENTS.md +24 -0
  374. package/docs/webhooks/referencia/messages/audio.md +298 -0
  375. package/docs/webhooks/referencia/messages/button.md +170 -0
  376. package/docs/webhooks/referencia/messages/contacts.md +491 -0
  377. package/docs/webhooks/referencia/messages/document.md +307 -0
  378. package/docs/webhooks/referencia/messages/errors.md +132 -0
  379. package/docs/webhooks/referencia/messages/image.md +304 -0
  380. package/docs/webhooks/referencia/messages/interactive.md +225 -0
  381. package/docs/webhooks/referencia/messages/location.md +296 -0
  382. package/docs/webhooks/referencia/messages/messages.md +44 -0
  383. package/docs/webhooks/referencia/messages/order.md +208 -0
  384. package/docs/webhooks/referencia/messages/reaction.md +178 -0
  385. package/docs/webhooks/referencia/messages/status.md +364 -0
  386. package/docs/webhooks/referencia/messages/sticker.md +298 -0
  387. package/docs/webhooks/referencia/messages/system.md +140 -0
  388. package/docs/webhooks/referencia/messages/text.md +322 -0
  389. package/docs/webhooks/referencia/messages/unsupported.md +165 -0
  390. package/docs/webhooks/referencia/messages/video.md +304 -0
  391. package/docs/webhooks/referencia/outros_webhooks/AGENTS.md +16 -0
  392. package/docs/webhooks/referencia/outros_webhooks/partner_solutions.md +114 -0
  393. package/docs/webhooks/referencia/outros_webhooks/payment_configuration_update.md +135 -0
  394. package/docs/webhooks/referencia/outros_webhooks/phone_number_name_update.md +129 -0
  395. package/docs/webhooks/referencia/outros_webhooks/phone_number_quality_update.md +172 -0
  396. package/docs/webhooks/referencia/outros_webhooks/security.md +108 -0
  397. package/docs/webhooks/referencia/outros_webhooks/smb_app_state_sync.md +146 -0
  398. package/docs/webhooks/referencia/outros_webhooks/smb_message_echoes.md +143 -0
  399. package/docs/webhooks/referencia/outros_webhooks/template_category_update.md +154 -0
  400. package/docs/webhooks/referencia/outros_webhooks/user_preferences.md +150 -0
  401. package/docs/webhooks/visao_geral/AGENTS.md +11 -0
  402. package/docs/webhooks/visao_geral/message_echoes.md +8 -0
  403. package/docs/webhooks/visao_geral/override.md +235 -0
  404. package/docs/webhooks/visao_geral/overview.md +158 -0
  405. package/docs/webhooks/visao_geral/set_up_whatsapp_echo_bot.md +109 -0
  406. package/package.json +50 -0
@@ -0,0 +1,14 @@
1
+ # Pagamentos no Brasil
2
+
3
+ Pagamentos no Brasil
4
+
5
+ ## Documentos Disponíveis
6
+
7
+ - [Boleto](./boleto.md)
8
+ - [Offsite Pix](./offsite_pix.md)
9
+ - [One Click Payments](./one_click_payments.md)
10
+ - [Orderdetailstemplate](./orderdetailstemplate.md)
11
+ - [Orders](./orders.md)
12
+ - [Overview](./overview.md)
13
+ - [Payment Links](./payment_links.md)
14
+
@@ -0,0 +1,104 @@
1
+ <!-- Source: https://developers.facebook.com/documentation/business-messaging/whatsapp/payments/payments-br/boleto -->
2
+ <!-- Scraped: 2025-12-20T17:46:53.510Z -->
3
+
4
+ # Boleto
5
+
6
+ Updated: 14 de nov de 2025
7
+
8
+ A API de Pagamentos também permite que as empresas recebam pagamentos dos clientes pelo WhatsApp usando boleto.
9
+
10
+ Ao usar essa integração, o WhatsApp apenas facilita a comunicação entre comerciantes e compradores. Os comerciantes são responsáveis por fazer a integração com um provedor de serviços de pagamento (PSP), por meio do qual podem gerar códigos de boleto e confirmar o pagamento.
11
+
12
+ ## Antes de começar
13
+
14
+ - Familiarize-se com a [API de Pedidos](/documentation/business-messaging/whatsapp/payments/payments-br/orders). Os pedidos são o ponto de entrada para a coleta de pagamentos no WhatsApp.- Você precisará de uma integração existente com um PSP para gerar códigos de boleto e fazer a reconciliação automática quando o pagamento for efetuado.- É preciso atualizar o status do pedido assim que o pagamento for feito.
15
+
16
+ ## Etapas de integração
17
+
18
+ O diagrama de sequência a seguir mostra a integração típica com o Boleto.
19
+
20
+ ![Image](https://scontent-gru1-2.xx.fbcdn.net/v/t39.2365-6/561622607_1339318274593490_8768265383653853535_n.jpg?_nc_cat=110&ccb=1-7&_nc_sid=e280be&_nc_ohc=SnB66c6-s0AQ7kNvwFohHwL&_nc_oc=AdlQ4zTSReclsvsPbd-51iMVeTohz-ElcrAOEG_KBmoNk2eKiC0VHSkvo2RlmiLQHbI&_nc_zt=14&_nc_ht=scontent-gru1-2.xx&_nc_gid=f8WK7bpjbUnrd_wPF7SkVg&oh=00_AfnyhIzNhwpPgcdU6ZIEkTgy52JSaHnOvgqWG-VMBBVHTQ&oe=69611B05)
21
+
22
+ ### 1\. Enviar uma mensagem com detalhes do pedido
23
+
24
+ Para saber mais, consulte a página da [API de Pedidos](/documentation/business-messaging/whatsapp/payments/payments-br/orders).
25
+
26
+ Caso o pagamento com boleto esteja disponível para o pedido, será preciso fornecer um objeto `boleto` no atributo `payment_settings`.
27
+
28
+ #### Objeto de parâmetros
29
+
30
+ Nome do campo
31
+
32
+ Opcional?
33
+
34
+ Tipo
35
+
36
+ Descrição
37
+
38
+ `payment_settings`
39
+
40
+ Opcional
41
+
42
+ [Objeto de configurações de pagamento](#paymentsettingsobject)
43
+
44
+ Lista de objetos de configuração relacionados a pagamentos.
45
+
46
+ #### Configurações de pagamento
47
+
48
+ Nome do campo
49
+
50
+ Opcional?
51
+
52
+ Tipo
53
+
54
+ Descrição
55
+
56
+ `type`
57
+
58
+ Obrigatório
59
+
60
+ String
61
+
62
+ Precisa ser `boleto`.
63
+
64
+ `boleto`
65
+
66
+ Obrigatório
67
+
68
+ [Objeto de boleto](#boletoobject)
69
+
70
+ Objeto de boleto que será usado para renderizar a opção aos compradores durante o fluxo de finalização da compra.
71
+
72
+ #### Objeto de boleto
73
+
74
+ **Nome do campo**
75
+
76
+ **Opcional?**
77
+
78
+ **Tipo**
79
+
80
+ **Descrição**
81
+
82
+ `digitable_line`
83
+
84
+ Obrigatório
85
+
86
+ String
87
+
88
+ O código/linha do boleto digital que será copiado para a área de transferência quando o usuário tocar no botão de CTA do boleto.
89
+
90
+ #### Exemplo de carga
91
+
92
+ ```
93
+ POST: /v1/messages{ "recipient_type": "individual", "to": "[recipient-wa-id]", "type": "interactive", "interactive": {   "type": "order_details",   "body": {     "text": "Your message content"   },   "action": {     "name": "review_and_pay",     "parameters": {       "reference_id": "unique-reference-id",       "type": "digital-goods",       "payment_type": "br",       "payment_settings": [         {           "type": "boleto",           "boleto": {             "digitable_line": "03399026944140000002628346101018898510000008848",           }         }       ],       "currency": "BRL",       "total_amount": {         "value": 50000,         "offset": 100       },       "order": {         "status": "pending",         "tax": {           "value": 0,           "offset": 100,           "description": "optional text"           },         "items": [           {             "retailer_id": "1234567",             "name": "Cake",             "amount": {               "value": 50000,               "offset": 100             },             "quantity": 1           }         ],         "subtotal": {           "value": 50000,           "offset": 100         }       }     }   } }}
94
+ ```
95
+
96
+ ### 2\. Enviar uma atualização de status do pedido
97
+
98
+ Após a confirmação do pagamento, você deve enviar uma atualização de status do pedido. Siga o guia de integração na [página da API de Pedidos](/documentation/business-messaging/whatsapp/payments/payments-br/orders).
99
+
100
+ Você achou esta página útil?
101
+
102
+ ![Ícone de polegar para cima](https://static.xx.fbcdn.net/rsrc.php/yR/r/OEXJ0_DJeZv.svg)
103
+
104
+ ![Ícone de polegar para baixo](https://static.xx.fbcdn.net/rsrc.php/yb/r/qKPgNVNeatU.svg)
@@ -0,0 +1,128 @@
1
+ <!-- Source: https://developers.facebook.com/documentation/business-messaging/whatsapp/payments/payments-br/offsite-pix -->
2
+ <!-- Scraped: 2025-12-20T17:46:36.090Z -->
3
+
4
+ # Pagamentos com Pix fora do site
5
+
6
+ Updated: 14 de nov de 2025
7
+
8
+ A API de Pagamentos também permite que as empresas recebam pagamentos dos clientes pelo WhatsApp usando códigos de Pix dinâmicos.
9
+
10
+ Ao usar essa integração, o WhatsApp apenas facilita a comunicação entre comerciantes e compradores. Os comerciantes são responsáveis por fazer a integração com um banco ou um provedor de serviços de pagamento (PSP) para gerar códigos Pix dinâmicos e confirmar o pagamento.
11
+
12
+ ## Antes de começar
13
+
14
+ - Familiarize-se com a [API de Pedidos](/documentation/business-messaging/whatsapp/payments/payments-br/orders). Os pedidos são o ponto de entrada para a coleta de pagamentos no WhatsApp.- Você precisará de uma integração existente com um banco ou PSP para gerar códigos de Pix dinâmicos e fazer a reconciliação automática quando o pagamento for efetuado. É preciso atualizar o status do pedido assim que o pagamento for feito.
15
+
16
+ ## Etapas de integração
17
+
18
+ O diagrama de sequência a seguir mostra a integração típica com o Pix.
19
+
20
+ ![Image](https://scontent-gru1-1.xx.fbcdn.net/v/t39.2365-6/559928787_1339318127926838_2798974158408097525_n.jpg?_nc_cat=101&ccb=1-7&_nc_sid=e280be&_nc_ohc=mVnXNLaZjf4Q7kNvwFpuMc3&_nc_oc=AdkraLHPG0L-wad_njnzYQdsnU50MbqR2cB9vI6umzUEEdj7-TZXg_xgKsneOIEnCm4&_nc_zt=14&_nc_ht=scontent-gru1-1.xx&_nc_gid=fBCKmvTFlo7HeFT5qQxzPQ&oh=00_AfmnEgvocmRfLfZQG7k60fiRAc3iTrjTAdA_csYSYIbV2Q&oe=69610B2D)
21
+
22
+ ### 1\. Enviar uma mensagem com detalhes do pedido
23
+
24
+ Para saber mais, consulte a página da [API de Pedidos](/documentation/business-messaging/whatsapp/payments/payments-br/orders).
25
+
26
+ Caso o Pix esteja disponível para o pedido, será necessário fornecer um `pix_dynamic_code` para o atributo `payment_settings`.
27
+
28
+ #### Objeto de parâmetros
29
+
30
+ Nome do campo
31
+
32
+ Opcional?
33
+
34
+ Tipo
35
+
36
+ Descrição
37
+
38
+ `payment_settings`
39
+
40
+ Opcional
41
+
42
+ [Objeto de configurações de pagamento](#paymentsettingsobject)
43
+
44
+ Lista de objetos de configuração relacionados a pagamentos.
45
+
46
+ #### Configurações de pagamento
47
+
48
+ Nome do campo
49
+
50
+ Opcional?
51
+
52
+ Tipo
53
+
54
+ Descrição
55
+
56
+ `type`
57
+
58
+ Obrigatório
59
+
60
+ String
61
+
62
+ Deve ser `pix_dynamic_code`.
63
+
64
+ `pix_dynamic_code`
65
+
66
+ Obrigatório
67
+
68
+ [Objeto dinâmico do Pix](#dynamicpixobject)
69
+
70
+ Objeto de código Pix dinâmico que será usado para renderizar a opção aos compradores durante o fluxo de finalização da compra.
71
+
72
+ #### Objeto do código Pix dinâmico
73
+
74
+ **Nome do campo**
75
+
76
+ **Opcional?**
77
+
78
+ **Tipo**
79
+
80
+ **Descrição**
81
+
82
+ `code`
83
+
84
+ Obrigatório
85
+
86
+ String
87
+
88
+ O código Pix dinâmico que será copiado pelo comprador.
89
+
90
+ `merchant_name`
91
+
92
+ Obrigatório
93
+
94
+ String
95
+
96
+ Nome do titular da conta. Exibido no app para o comprador para fins informativos.
97
+
98
+ `key`
99
+
100
+ Obrigatório
101
+
102
+ String
103
+
104
+ Chave Pix. Exibido no app para o comprador para fins informativos.
105
+
106
+ `key_type`
107
+
108
+ Obrigatório
109
+
110
+ String
111
+
112
+ Tipo de chave Pix. Uma das opções: `CPF`, `CNPJ`, `EMAIL`, `PHONE` ou `EVP`.
113
+
114
+ #### Exemplo de carga
115
+
116
+ ```
117
+ POST: /v1/messages{ "recipient_type": "individual", "to": "[recipient-wa-id]", "type": "interactive", "interactive": {   "type": "order_details",   "body": {     "text": "Your message content"   },   "action": {     "name": "review_and_pay",     "parameters": {       "reference_id": "unique-reference-id",       "type": "digital-goods",       "payment_type": "br",       "payment_settings": [         {           "type": "pix_dynamic_code",           "pix_dynamic_code": {             "code": "00020101021226700014br.gov.bcb.pix2548pix.example.com...",             "merchant_name": "Account holder name",             "key": "39580525000189",             "key_type": "CNPJ"           }         }       ],       "currency": "BRL",       "total_amount": {         "value": 50000,         "offset": 100       },       "order": {         "status": "pending",         "tax": {           "value": 0,           "offset": 100,           "description": "optional text"           },         "items": [           {             "retailer_id": "1234567",             "name": "Cake",             "amount": {               "value": 50000,               "offset": 100             },             "quantity": 1           }         ],         "subtotal": {           "value": 50000,           "offset": 100         }       }     }   } }}
118
+ ```
119
+
120
+ ### 2\. Enviar uma atualização de status do pedido
121
+
122
+ Após a confirmação do pagamento, você deve enviar uma atualização de status do pedido. Siga o guia de integração na [página da API de Pedidos](/documentation/business-messaging/whatsapp/payments/payments-br/orders).
123
+
124
+ Você achou esta página útil?
125
+
126
+ ![Ícone de polegar para cima](https://static.xx.fbcdn.net/rsrc.php/yR/r/OEXJ0_DJeZv.svg)
127
+
128
+ ![Ícone de polegar para baixo](https://static.xx.fbcdn.net/rsrc.php/yb/r/qKPgNVNeatU.svg)
@@ -0,0 +1,226 @@
1
+ <!-- Source: https://developers.facebook.com/documentation/business-messaging/whatsapp/payments/payments-br/one-click-payments -->
2
+ <!-- Scraped: 2025-12-20T17:47:02.236Z -->
3
+
4
+ # Pagamentos com um clique
5
+
6
+ Updated: 14 de nov de 2025
7
+
8
+ Esse recurso ainda não está disponível para o público em geral e só pode ser usado por empresas com sede no Brasil e seus clientes brasileiros. Para habilitar os pagamentos para sua empresa, entre em contato com seu parceiro de soluções.
9
+
10
+ A API de Pagamentos também permite que as empresas recebam pagamentos de clientes pelo WhatsApp usando os pagamentos com um clique.
11
+
12
+ Ao usar essa integração, o WhatsApp facilita a comunicação entre comerciantes e compradores. Os comerciantes são responsáveis por armazenar as credenciais de pagamento e integrar um provedor de serviços de pagamento (PSP) para enviar essas credenciais, concluir e confirmar os pagamentos.
13
+
14
+ ## Antes de começar
15
+
16
+ - Familiarize-se com a [API de Pedidos](/documentation/business-messaging/whatsapp/payments/payments-br/orders). Os pedidos são o ponto de entrada para a coleta de pagamentos no WhatsApp.- Você precisará de uma integração existente com um PSP e deverá fazer a reconciliação automática quando o pagamento for efetuado.- É preciso atualizar o status do pedido assim que o pagamento for feito.
17
+
18
+ ## Etapas de integração
19
+
20
+ O diagrama de sequência a seguir mostra a integração típica com os pagamentos com um clique.
21
+
22
+ ![Image](https://scontent-gru2-2.xx.fbcdn.net/v/t39.2365-6/560189002_1339318344593483_6488145365318201089_n.jpg?_nc_cat=102&ccb=1-7&_nc_sid=e280be&_nc_ohc=WhyYWHnb7ukQ7kNvwETfm8x&_nc_oc=AdkRb2ddT2pg3HTwsP58Zd3l4gAqm8GYL3owKuMF4pX3AvJGpjuXyuoNW_-zQloBAk0&_nc_zt=14&_nc_ht=scontent-gru2-2.xx&_nc_gid=HEB4GkdP4JJqeuSKIAJNkg&oh=00_AfmfCCpPL0QDlpOpA6rw2wHsXwl-aQbx3U-ogBGU0Rzl6g&oe=69613DE8)
23
+
24
+ ### 1\. Enviar uma mensagem com detalhes do pedido
25
+
26
+ Para saber mais, consulte a página da [API de Pedidos](/documentation/business-messaging/whatsapp/payments/payments-br/orders).
27
+
28
+ Caso o recurso de pagamentos com um clique esteja disponível para o pedido, será necessário fornecer um objeto `offsite_card_pay` no atributo `payment_settings`.
29
+
30
+ #### Objeto de parâmetros
31
+
32
+ Nome do campo
33
+
34
+ Opcional?
35
+
36
+ Tipo
37
+
38
+ Descrição
39
+
40
+ `payment_settings`
41
+
42
+ Opcional
43
+
44
+ [Objeto de configurações de pagamento](#paymentsettingsobject)
45
+
46
+ Lista de objetos de configuração relacionados a pagamentos.
47
+
48
+ #### Configurações de pagamento
49
+
50
+ Nome do campo
51
+
52
+ Opcional?
53
+
54
+ Tipo
55
+
56
+ Descrição
57
+
58
+ `type`
59
+
60
+ Obrigatório
61
+
62
+ String
63
+
64
+ Deve ser `offsite_card_pay`.
65
+
66
+ `offsite_card_pay`
67
+
68
+ Obrigatório
69
+
70
+ [Objeto de pagamento com cartão fora do site](#offsitecardpayobject)
71
+
72
+ Objeto de pagamento com cartão fora do site que será usado para renderizar a opção aos compradores durante o fluxo de finalização da compra.
73
+
74
+ #### Objeto de pagamento com cartão fora do site
75
+
76
+ **Nome do campo**
77
+
78
+ **Opcional?**
79
+
80
+ **Tipo**
81
+
82
+ **Descrição**
83
+
84
+ `last_four_digits`
85
+
86
+ Obrigatório
87
+
88
+ String
89
+
90
+ Os quatro últimos dígitos do cartão, que serão exibidos ao usuário para confirmação antes que ele aceite o pagamento (ao tocar no botão de CTA "Enviar pagamento").
91
+
92
+ `credential_id`
93
+
94
+ Obrigatório
95
+
96
+ String
97
+
98
+ A identificação da credencial associada ao cartão. Depois que o usuário tocar no botão de CTA "Enviar pagamento", o comerciante receberá um webhook da Meta notificando a confirmação do usuário. A carga do webhook terá o credential\_id, que será usado pelo comerciante para determinar o cartão ou a credencial para pagamentos.
99
+
100
+ #### Exemplo de carga de detalhes do pedido
101
+
102
+ ```
103
+ POST: /v1/messages
104
+ {
105
+ "recipient_type": "individual",
106
+ "to": "<RECIPIENT_WHATSAPP_ID>",
107
+ "type": "interactive",
108
+ "interactive": {
109
+ "type": "order_details",
110
+ "body": {
111
+ "text": "Your message content"
112
+ },
113
+ "action": {
114
+ "name": "review_and_pay",
115
+ "parameters": {
116
+ "reference_id": "<UNIQUE_REFERENCE_ID>",
117
+ "type": "digital-goods",
118
+ "payment_type": "br",
119
+ "payment_settings": [
120
+ {
121
+ "type": "offsite_card_pay",
122
+ "offsite_card_pay": {
123
+ "last_four_digits": "5235",
124
+ "credential_id": "1234567"
125
+ }
126
+ }
127
+ ],
128
+ "currency": "BRL",
129
+ "total_amount": {
130
+ "value": 50000,
131
+ "offset": 100
132
+ },
133
+ "order": {
134
+ "status": "pending",
135
+ "tax": {
136
+ "value": 0,
137
+ "offset": 100,
138
+ "description": "optional text"
139
+ },
140
+ "items": [
141
+ {
142
+ "retailer_id": "1234567",
143
+ "name": "Cake",
144
+ "amount": {
145
+ "value": 50000,
146
+ "offset": 100
147
+ },
148
+ "quantity": 1
149
+ }
150
+ ],
151
+ "subtotal": {
152
+ "value": 50000,
153
+ "offset": 100
154
+ }
155
+ }
156
+ }
157
+ }
158
+ }
159
+ }
160
+ ```
161
+
162
+ ### 2\. Receber a notificação de webhook
163
+
164
+ Esse webhook confirma a intenção do comprador de efetuar um pagamento e inclui o ID da credencial a ser usada.
165
+
166
+ #### Exemplo de carga de notificação de webhook
167
+
168
+ ```
169
+ {
170
+ "object": "whatsapp_business_account",
171
+ "entry": [
172
+ {
173
+ "id": "[<WHATSAPP_BUSINESS_ACCOUNT_ID>]",
174
+ "changes": [
175
+ {
176
+ "value": {
177
+ "messaging_product": "whatsapp",
178
+ "metadata": {
179
+ "display_phone_number": "[<BUSINESS_DISPLAY_PHONE_NUMBER>]",
180
+ "phone_number_id": "[<BUSINESS_PHONE_NUMBER_ID>]"
181
+ },
182
+ "contacts": [
183
+ {
184
+ "profile": {
185
+ "name": "[<WHATSAPP_USER_NAME>]"
186
+ },
187
+ "wa_id": "[<WHATSAPP_USER_ID>]"
188
+ }
189
+ ],
190
+ "messages": [
191
+ {
192
+ "from": "[<WHATSAPP_USER_PHONE_NUMBER>]",
193
+ "id": "[<WHATSAPP_MESSAGE_ID>]",
194
+ "timestamp": "[<WEBHOOK_SENT_TIMESTAMP>]",
195
+ "from_logical_id": "64244926160970",
196
+ "type": "interactive",
197
+ "interactive": {
198
+ "type": "payment_method",
199
+ "payment_method": {
200
+ "payment_method": "offsite_card_pay",
201
+ "payment_timestamp": 1726170122,
202
+ "reference_id": "pix_test_webhook",
203
+ "last_four_digits": "5235",
204
+ "credential_id": "1234567"
205
+ }
206
+ }
207
+ }
208
+ ]
209
+ },
210
+ "field": "messages"
211
+ }
212
+ ]
213
+ }
214
+ ]
215
+ }
216
+ ```
217
+
218
+ ### 3\. Enviar uma atualização de status do pedido
219
+
220
+ Após a confirmação do pagamento, você deve enviar uma atualização de status do pedido. Siga o guia de integração na [página da API de Pedidos](/documentation/business-messaging/whatsapp/payments/payments-br/orders).
221
+
222
+ Você achou esta página útil?
223
+
224
+ ![Ícone de polegar para cima](https://static.xx.fbcdn.net/rsrc.php/yR/r/OEXJ0_DJeZv.svg)
225
+
226
+ ![Ícone de polegar para baixo](https://static.xx.fbcdn.net/rsrc.php/yb/r/qKPgNVNeatU.svg)
@@ -0,0 +1,180 @@
1
+ <!-- Source: https://developers.facebook.com/documentation/business-messaging/whatsapp/payments/payments-br/orderdetailstemplate -->
2
+ <!-- Scraped: 2025-12-20T17:47:10.582Z -->
3
+
4
+ # Como enviar mensagem de modelo com detalhes do pedido
5
+
6
+ Updated: 4 de nov de 2025
7
+
8
+ ## Visão geral
9
+
10
+ O modelo de mensagem com detalhes do pedido é um modelo com [componentes interativos](/documentation/business-messaging/whatsapp/templates/overview#components) que amplia o botão de chamada para ação para permitir o envio de detalhes do pedido e fornece uma experiência mais completa em comparação com os modelos que contêm apenas componentes de texto.
11
+
12
+ Depois que os modelos de mensagem com detalhes do pedido forem criados e aprovados, será possível usar o modelo aprovado para enviar mensagens com informações do pedido ou da fatura, incentivando os clientes a efetuar o pagamento.
13
+
14
+ Antes de enviar uma mensagem de modelo com detalhes do pedido, as empresas precisam criar um modelo com um botão de chamada para ação "Detalhes do pedido". Para ver mais informações sobre os pré-requisitos e o processo de criação de um modelo, consulte [Como criar modelos de mensagem para a sua conta do WhatsApp Business](https://www.facebook.com/business/help/2055875911147364?id=2129163877102343).
15
+
16
+ ## Como criar um modelo de detalhes do pedido no Gerenciador do WhatsApp
17
+
18
+ Para criar um modelo de detalhes do pedido, a empresa precisa ter um portfólio empresarial com uma conta do WhatsApp Business.
19
+
20
+ Em **Gerenciador do WhatsApp** > **Ferramentas da conta**:
21
+
22
+ - Clique em `create template`.- Selecione a categoria `Utility` ou `Marketing` para ver a opção de formato de modelo `Order details`.- Selecione o formato de modelo `Order details` e clique em **Avançar**.- Insira o `template name` desejado e o `locale` compatível.
23
+ - Dependendo do número de `locales` selecionados, haverá um número igual de variantes de modelo, e as empresas precisarão preencher os detalhes do modelo no respectivo idioma.- Preencha os componentes do modelo, como o texto dos campos `Header`, `Body` e, opcionalmente, `footer`.
24
+ - Para `Header`, é possível escolher um destes três tipos de mídia: `Text`, `Image` ou `Document`. Escolha `Document` se quiser enviar **arquivos PDF** no cabeçalho deste modelo.- Clique em Enviar.- Depois do envio, os modelos serão [categorizados conforme as diretrizes](/documentation/business-messaging/whatsapp/templates/template-categorization#template-category-guidelines) e passarão pelo [processo de aprovação](/documentation/business-messaging/whatsapp/templates/template-review#approval-process).- O modelo será aprovado ou rejeitado depois que os componentes forem verificados pelo sistema.
25
+ - Se a empresa acreditar que a categoria determinada não é consistente com nossas diretrizes de categorias de modelos, verifique se há [problemas comuns](/documentation/business-messaging/whatsapp/templates/template-review) que levam a rejeições. Se estiver buscando outros esclarecimentos, [peça uma análise](/documentation/business-messaging/whatsapp/templates/template-categorization#requesting-review) do modelo por meio do [suporte para empresas](https://business.facebook.com/business-support-home/)- Após a aprovação, o [status](/documentation/business-messaging/whatsapp/templates/overview#template-status) do modelo será alterado para `ACTIVE`
26
+ - Informamos que o status do modelo pode mudar automaticamente de `ACTIVE` para `PAUSED` ou `DISABLED` com base no engajamento e no feedback dos clientes. Recomendamos que você [monitore as alterações de status](/documentation/business-messaging/whatsapp/templates/template-review#common-rejection-reasons) e tome as medidas apropriadas sempre que ocorrer uma alteração.
27
+
28
+ ## Como criar um modelo de detalhes de pedido usando as APIs de criação de modelo
29
+
30
+ Para criar um modelo por meio da API e entender a sintaxe geral, as categorias e os componentes necessários, consulte [API de modelos](/documentation/business-messaging/whatsapp/templates/overview#creating-templates). Todas as diretrizes descritas acima na criação de modelos também se aplicam à API.
31
+
32
+ O modelo de detalhes do pedido pode ser categorizado como um modelo de "utilidade" ou "marketing". Além de "nome" e "idioma", o modelo tem componentes gerais, como CABEÇALHO, CORPO, RODAPÉ e um BOTÃO fixo com o tipo "ORDER\_DETAILS".
33
+
34
+ ```
35
+ POST https://graph.facebook.com/<API_VERSION>/<WHATSAPP_BUSINESS_ACCOUNT_ID>/message_templates
36
+ {
37
+ "name": "<TEMPLATE_NAME>",
38
+ "language": "<LANGUAGE_CODE>",
39
+ "category": "UTILITY or MARKETING",
40
+ "display_format": "ORDER_DETAILS",
41
+ "components": [
42
+ {
43
+ "type": "HEADER",
44
+ "format": "TEXT" OR "IMAGE" OR "DOCUMENT",
45
+ "text": "<HEADER_TEXT>"
46
+ },
47
+ {
48
+ "type": "BODY",
49
+ "text": "<BODY_TEXT>"
50
+ },
51
+ {
52
+ "type": "FOOTER",
53
+ "text": "<FOOTER_TEXT>"
54
+ },
55
+ {
56
+ "type": "BUTTONS",
57
+ "buttons": [
58
+ {
59
+ "type": "ORDER_DETAILS",
60
+ "text": "<COPY_PIX_CODE>"
61
+ }
62
+ ]
63
+ }
64
+ ]
65
+ }
66
+ ```
67
+
68
+ ## Enviar um modelo de mensagem com detalhes do pedido
69
+
70
+ O modelo de mensagem com detalhes do pedido permite que as empresas enviem mensagens de fatura (order\_details) como parâmetros predefinidos do componente de botão de chamada para ação `order details`. Permite que as empresas enviem toda a integração de pagamento (como [Código pix dinâmico](/documentation/business-messaging/whatsapp/payments/payments-br/offsite-pix), [Links de pagamento](/documentation/business-messaging/whatsapp/payments/payments-br/payment-links), [Boleto](/documentation/business-messaging/whatsapp/payments/payments-br/boleto) etc;) como parâmetros de botão.
71
+
72
+ Para enviar um modelo de mensagem com detalhes do pedido, faça uma chamada `POST` ao ponto de extremidade `/PHONE_NUMBER_ID/messages` e anexe um objeto de mensagem com `type=template`. Depois, adicione um objeto de modelo com um botão de chamada para ação `order details` predefinido.
73
+
74
+ Como opção, é possível incluir um **arquivo PDF** como anexo no componente `header` do modelo de mensagem. Para isso, use `type=document` no objeto `parameter` do componente `header`, conforme descrito em nosso documento [Componentes](/documentation/business-messaging/whatsapp/templates/components#media-header).
75
+
76
+ Por exemplo, a amostra a seguir descreve como enviar a opção [Copiar código Pix](/documentation/business-messaging/whatsapp/payments/payments-br/offsite-pix) nos parâmetros de mensagem de modelo de detalhes do pedido para pedir que o consumidor faça um pagamento.
77
+
78
+ ```
79
+ POST https://graph.facebook.com/<API_VERSION>/<PHONE_NUMBER_ID>/messages
80
+ {
81
+ "messaging_product": "whatsapp",
82
+ "recipient_type": "individual",
83
+ "to": "<PHONE_NUMBER>",
84
+ "type": "template",
85
+ "template": {
86
+ "name": "<TEMPLATE_NAME>",
87
+ "language": {
88
+ "policy": "deterministic",
89
+ "code": "<LANGUAGE_AND_LOCALE_CODE>"
90
+ },
91
+ "components": [
92
+ {
93
+ "type": "button",
94
+ "sub_type": "order_details",
95
+ "index": 0,
96
+ "parameters": [
97
+ {
98
+ "type": "action",
99
+ "action": {
100
+ "order_details": {
101
+ "reference_id": "<UNIQUE_REFERENCE_ID>",
102
+ "type": "digital-goods",
103
+ "payment_type": "br",
104
+ "payment_settings": [
105
+ {
106
+ "type": "pix_dynamic_code",
107
+ "pix_dynamic_code": {
108
+ "code": "00020101021226700014br.gov.bcb.pix2548pix.example.com...",
109
+ "merchant_name": "Account holder name",
110
+ "key": "39580525000189",
111
+ "key_type": "CNPJ"
112
+ }
113
+ }
114
+ ],
115
+ "currency": "BRL",
116
+ "total_amount": {
117
+ "value": 50000,
118
+ "offset": 100
119
+ },
120
+ "order": {
121
+ "status": "pending",
122
+ "tax": {
123
+ "value": 0,
124
+ "offset": 100,
125
+ "description": "optional text"
126
+ },
127
+ "items": [
128
+ {
129
+ "retailer_id": "1234567",
130
+ "name": "Cake",
131
+ "amount": {
132
+ "value": 50000,
133
+ "offset": 100
134
+ },
135
+ "quantity": 1
136
+ }
137
+ ],
138
+ "subtotal": {
139
+ "value": 50000,
140
+ "offset": 100
141
+ }
142
+ }
143
+ }
144
+ }
145
+ }
146
+ ]
147
+ }
148
+ ]
149
+ }
150
+ }
151
+ ```
152
+
153
+ Depois que o modelo de mensagem com detalhes do pedido for entregue, a resposta de sucesso incluirá um objeto com um identificador prefixado com "wamid". Use o ID listado depois de "wamid" para acompanhar o status da mensagem.
154
+
155
+ ```
156
+ {
157
+ "messaging_product": "whatsapp",
158
+ "contacts": [
159
+ {
160
+ "input": "<PHONE_NUMBER>",
161
+ "wa_id": "<WHATSAPP_ID>"
162
+ }
163
+ ],
164
+ "messages": [
165
+ {
166
+ "id": "wamid.ID"
167
+ }
168
+ ]
169
+ }
170
+ ```
171
+
172
+ ## Fluxo após o envio do modelo de mensagem com detalhes do pedido
173
+
174
+ Após a entrega do modelo de mensagem com detalhes do pedido, o restante do fluxo de pagamento será "Enviar fatura na janela da sessão do cliente" e dependerá dos parâmetros de detalhes do pedido da [integração de pagamento](/documentation/business-messaging/whatsapp/payments/payments-br/overview) escolhida.
175
+
176
+ Você achou esta página útil?
177
+
178
+ ![Ícone de polegar para cima](https://static.xx.fbcdn.net/rsrc.php/yR/r/OEXJ0_DJeZv.svg)
179
+
180
+ ![Ícone de polegar para baixo](https://static.xx.fbcdn.net/rsrc.php/yb/r/qKPgNVNeatU.svg)