Payment Request CTA Templates (Brazil)

WhatsApp Business Messaging API: Payment Request CTA Button (Brazil)

• Simplified Integration Payment codes (Pix, Boleto, Payment Link) can be embedded in templates with minimal API complexity.
• Flexible Payment Requests Choose any supported payment method and customize payment details.
• Flexible Button Combinations Payment request buttons can be combined with other button types within a message template, allowing businesses to offer a variety of actions—not limited to payments—in a single message.
• Multiple Payment Options Businesses can include up to three payment request buttons in a message, each supporting a different payment method. This enables customers to choose their preferred payment option directly from the conversation.

• Pix Dynamic Code
• Boleto
• Payment Link

1. Click on create template
2. Select Utility or Marketing category to see the Default template format option.
3. Select Default template format, and click Next
4. Enter the desired template name and supported locale
   • Depending on the number of locales selected there will be an equal number of template variants and businesses need to fill in the template details in respective locale.
5. Fill in template components such as Header, Body and optional footer text.
   • For the Header, you can choose one of three media types: Text, Image or Document. Choose Document if you want to send PDF files in the header of this template.
6. Add a button of type ‘Request Payment’ from the Buttons menu.
7. Select ‘Pix’, ‘Boleto’, or ‘Payment Link’ from the Payment Type dropdown menu. Enter a sample value in the provided field.

   Note: The value entered is for demonstration purposes only. The actual code or URI will be unique to each customer interaction and will be included in the send payload.

1. Click submit.
2. Once submitted, templates will be categorized as per the guidelines and undergo the approval process.
3. The template will be approved or rejected after the template components are verified by the system.
   • If business believe the category determined is not consistent with our template category guidelines, please confirm there are no common issues that leads to rejections and if you are looking for further clarification you may request a review of the template via Business Support⁠ . Once approved template status will be changed to ACTIVE
   • Please be informed that template’s status can change automatically from ACTIVE to PAUSED or DISABLED based on customer feedback and engagement. We recommend that you monitor status changes and take appropriate actions whenever such change occurs.

POST /{PHONE_NUMBER_ID}/messages

{
  "messaging_product": "whatsapp",
  "recipient_type": "individual",
  "to": "<PHONE_NUMBER>",
  "type": "template",
  "template": {
    "name": "<TEMPLATE_NAME>",
    "language": {
      "code": "<LANGUAGE>"
    },
    "components": [
      {
        "type": "button",
        "sub_type": "payment_request",
        "index": "0",
        "parameters": [
          {
            "type": "action",
            "action": {
              "payment_request": {
                "payment_setting": {
                  "type": "boleto",
                  "boleto": {
                    "digitable_line": "03399026944140000002628346101018898510000008848"
                  }
                }
              }
            }
          }
        ]
      },
      {
        "type": "button",
        "sub_type": "payment_request",
        "index": "1",
        "parameters": [
          {
            "type": "action",
            "action": {
              "payment_request": {
                "payment_setting": {
                  "type": "pix_dynamic_code",
                  "pix_dynamic_code": {
                    "code": "00020101021226700014br.gov.bcb.pix2548pix.example.com..."
                  }
                }
              }
            }
          }
        ]
      },
      {
        "type": "button",
        "sub_type": "payment_request",
        "index": "2",
        "parameters": [
          {
            "type": "action",
            "action": {
              "payment_request": {
                "payment_setting": {
                  "type": "payment_link",
                  "payment_link": {
                    "uri": "https://my-payment-link-url"
                  }
                }
              }
            }
          }
        ]
      }
    ]
  }
}

{
  "messaging_product": "whatsapp",
  "contacts": [
    {
      "input": "<PHONE_NUMBER>",
      "wa_id": "<PHONE_NUMBER>"
    }
  ],
  "messages": [
    {
      "id": "wamid.HBgNNTUxMTk4Nzg2NjI5NRUCABEYEjUxOTBGNEU0RDA2MjdCMUVBOQA=",
      "message_status": "accepted"
    }
  ]
}