Payments API - Brazil
Updated: Jun 30, 2026
Copy for LLM
Payments API enables businesses to accept payments from their customers via WhatsApp. Businesses send
order_details messages (Orders API) to their customers, then get notified about payment status updates via webhook notifications.Based on the selected use case, businesses can collect payment from the customers using one of the following integrations:
How it works
First, the business composes and sends an
order_details message, which is a new type of interactive message. The order_details message contains four main components: header, body, footer, and action. Inside the action component, the business includes all the information needed for the customer to complete their payment.Each
order_details message must contain a unique reference_id provided by the business. The business uses this reference_id throughout the flow to track the order.After the business sends the message, it waits for a payment or transaction status update. The type of the update depends on the integration type (for example, Pix, or Payment Links). WhatsApp doesn’t support payment reconciliation. The business must reconcile the payment with their payment service provider (PSP) using the
reference_id of the order.Purchase flow in app
In the WhatsApp customer app, the purchase flow has the following steps:
- Buyers communicate with businesses and select a product.
- Businesses send an
order_detailsmessage to the buyer. - Buyers pay the order. For Pix, they switch to their bank app and use the Pix Copy and Paste functionality. For Payment Links, the payment or checkout link opens in the web browser, and they complete the payment there.
- Businesses send an
order_statusmessage indicating that the order is nowprocessing.