Skip to main content

Payments API - Brazil | Developer Documentation

ChatArchitect availability: Payments API Brazil. ChatArchitect supports ordinary links to an external payment website. Brazil's native Payments API is not provided through ChatArchitect.

Use the external payment-link guide for the supported customer workflow. Your payment service handles checkout and transaction confirmation; WhatsApp delivery callbacks do not confirm payment. The imported Meta implementation below is retained as a separate reference and does not describe an available ChatArchitect setup.

Payments API - Brazil

Updated: Nov 14, 2025
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 use case, businesses can collect payment from the customers using one of the following integrations:
    Dynamic Pix CodesPayment LinksBoletoOne-click offsite card paymentOrder 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:
      Buyers communicate with businesses and select a product.Businesses send an order_details message to the buyer.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.Businesses send an order_status message indicating that the order is now processing.

      No comments to display

      Back to top