Payments API - Brazil

Payments API enable 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 usecase, businesses can collect payment from the customers using one of the following integrations:

• Dynamic Pix Codes
• Payment Links
• Boleto
• Order Details Template

How It Works

First, the business composes and sends an order_details message, which is a new type of interactive message. It contains the same 4 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. This reference id is used throughout the flow to track the order.

Once the message is sent, the business waits for a payment or transaction status update. The type of the update depends on the integration type (e.g.: Pix, Payment Links, etc.). WhatsApp does NOT support payment reconciliations. 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:

1. Buyers communiticate with businesses and select a product.
2. Businesses send an order_details message to the buyer.
3. Buyers pay the order. For Pix, they will switch to their bank app and use the Pix Copy and Paste functionality. For Payment Links, the payment/checkout link opens in the web browser, and they complete the payment there.
4. Once the payment has been confirmed, the business will be notified via a webhook notification.
5. Businesses send an order_status message indicating that the order is now processing.