Payment Messages

1. OREDR DETAILS TEMPLATE

The Meta Order Details template is a WhatsApp message template that lets a business send a customer a structured order summary along with a payment request, right inside the chat.

Create Template Sample

{
  "name": "<TEMPLATE_NAME>",
  "language": "<LANGUAGE_CODE>",
  "category": "UTILITY",
  /* Businesses can create the order details template under marketing category by including display_format attribute */
  /* "display_format": "order_details",*/
  "components": [
    {
      "type": "HEADER",
      "format": "TEXT",
      "text": "<TEMPLATE_HEADER_TEXT>"
    },
    {
      "type": "BODY",
      "text": "<TEMPLATE_BODY_TEXT>"
    },
    {
      "type": "FOOTER",
      "text": "<TEMPLATE_FOOTER_TEXT>"
    },
    {
      "type": "BUTTONS",
      "buttons": [
        {
          "type": "ORDER_DETAILS",
          "text": "Review and Pay"
        }
      ]
    }
  ]
}

Template Message Sample

{
  "to": "<USER_PHONE_NUMBER>",
  "type": "template",
  "template": {
    "name": "<TEMPLATE_NAME>",
    "language": {
      "policy": "deterministic",
      "code": "<LANGUAGE_CODE>"
    },
    "components": [
      {
        "type": "header",
        "parameters": [
          {
            "type": "image", // Uses header with image as an example
            "image": {
              "link": "http(s)://the-url"
            }
          }
        ]
      },
      {
        "type": "button",
        "sub_type": "order_details",
        "index": 0,
        "parameters": [
          {
            "type": "action",
            "action": {
              "order_details": {
                "currency": "INR",
                "order": {
                  "discount": {
                    "offset": 100,
                    "value": 250
                  },
                  "items": [
                    {
                      "amount": {
                        "offset": 100,
                        "value": 400
                      },
                      "name": "<ORDER_ITEM_NAME>",
                      "quantity": 1,
                      "retailer_id": "<ORDER_ITEM_RETAILER_ID>",
                      "country_of_origin": "<ORIGIN_COUNTRY>",
                      "importer_name": "<IMPORTER_NAME>",
                      "importer_address": {
                        "address_line1": "<IMPORTER_ADDRESS>",
                        "city": "<CITY>",
                        "country_code": "<COUNTRY>",
                        "postal_code": "<ZIP_CODE>"
                      }
                    }
                  ],
                  "shipping": {
                    "offset": 100,
                    "value": 0
                  },
                  "status": "pending",
                  "subtotal": {
                    "offset": 100,
                    "value": 400
                  },
                  "tax": {
                    "offset": 100,
                    "value": 500
                  }
                },
                "payment_settings": [
                  {
                    "type": "upi_intent_link",
                    "upi_intent_link": {
                      "link": "upi://pay?pa=merchant_vpa&pn=merchant%20Name&mc=mc_code&purpose=purpose_code&tr=transaction_record"
                    }
                  }
                ],
                "payment_configuration": "unique_payment_config_id",
                "payment_type": "upi",
                "reference_id": "reference_id_value",
                "total_amount": {
                  "offset": 100,
                  "value": 650
                },
                "type": "digital-goods"
              }
            }
          }
        ]
      }
    ]
  }
}

Interactive Message Sample

{
  "to": "<USER_PHONE_NUMBER>",
  "type": "interactive",
  "interactive": {
    "type": "order_details",
    "header": {
      "type": "image",
      "image": {
        "link": "http(s)://the-url",
        "provider": {
          "name": "provider-name"
        }
      }
    },
    "body": {
      "text": "your-text-body-content"
    },
    "footer": {
      "text": "your-text-footer-content"
    },
    "action": {
      "name": "review_and_pay",
      "parameters": {
        "reference_id": "reference-id-value",
        "type": "digital-goods",
        "payment_type": "upi",
        "payment_settings": [
          {
            "type": "payment_link",
            "payment_link": {
              "uri": "https://the-payment-link"
            }
          }
        ],
        "currency": "INR",
        "total_amount": {
          "value": 21000,
          "offset": 100
        },
        "order": {
          "status": "pending",
          "catalog_id": "the-catalog_id",
          "expiration": {
            "timestamp": "utc_timestamp_in_seconds",
            "description": "cancellation-explanation"
          },
          "items": [
            {
              "retailer_id": "1234567",
              "name": "Product name, for example bread",
              "amount": {
                "value": 10000,
                "offset": 100
              },
              "quantity": 1,
              "sale_amount": {
                "value": 100,
                "offset": 100
              }
            }
          ],
          "subtotal": {
            "value": 20000,
            "offset": 100
          },
          "tax": {
            "value": 1000,
            "offset": 100,
            "description": "optional_text"
          },
          "shipping": {
            "value": 1000,
            "offset": 100,
            "description": "optional_text"
          },
          "discount": {
            "value": 1000,
            "offset": 100,
            "description": "optional_text",
            "discount_program_name": "optional_text"
          }
        }
      }
    }
  }
}

2. ORDER STATUS TEMPLATE

The WhatsApp order status template currently supports these status values: processing, partially_shipped, shipped, completed, and canceled. Each one lets a business push a real-time update to the customer about where their order stands — for example, letting them know when an order has shipped, or confirming when it's fully completed — even outside the usual 24-hour customer service window.

Create Template Sample

{
  "name": "<TEMPLATE_NAME>",
  "language": "<LANGUAGE_AND_LOCALE_CODE>",
  "category": "UTILITY",
  "sub_category": "ORDER_STATUS",
  "components": [
    {
      "type": "BODY",
      "text": "<TEMPLATE_BODY_TEXT>"
    },
    {
      "type": "FOOTER",
      "text": "<TEMPLATE_FOOTER_TEXT>"
    }
  ]
}

Template Message Sample

{
    "to": "<<USER_PHONE_NUMBER>>",
    "type": "template",
    "template": {
        "name": "<TEMPLATE_NAME>",
        "language": {
            "policy": "deterministic",
            "code": "<LANGUAGE_AND_LOCALE_CODE>"
        },
        "components": [
            {
                "type": "order_status",
                "parameters": [
                    {
                        "type": "order_status",
                        "order_status": {
                            "reference_id": "reference_id_value",
                            "order": {
                                "status": "processing | partially_shipped | shipped | completed | canceled",
                                "description": "<OPTIONAL_DESCRIPTION>"
                            }
                        }
                    }
                ]
            }
        ]
    }
}

Interactive Message Sample

{
  "to": "<USER_PHONE_NUMBER>",
  "type": "interactive",
  "interactive": {
    "type": "order_status",
    "body": {
      "text": "your-text-body-content"
    },
    "action": {
      "name": "review_order",
      "parameters": {
        "reference_id": "reference-id-value",
        "order": {
          "status": "processing | partially_shipped | shipped | completed | canceled",
          "description": "optional-text"
        }
      }
    }
  }
}

1. OREDR DETAILS TEMPLATE#

Create Template Sample#

Template Message Sample#

Interactive Message Sample#

2. ORDER STATUS TEMPLATE#

Create Template Sample#

Template Message Sample#

Interactive Message Sample#

1. OREDR DETAILS TEMPLATE

Create Template Sample

Template Message Sample

Interactive Message Sample

2. ORDER STATUS TEMPLATE

Create Template Sample

Template Message Sample

Interactive Message Sample