# Payments

# Payments API — India | Developer Documentation

<div id="bkmrk-payments-api-%E2%80%94-india">## Payments API — India

<div><span>Updated: Nov 26, 2025</span></div><div>The Payments API enables you to accept payments from your customers through all UPI apps installed on their devices and other payment methods like cards, NetBanking, and wallets via WhatsApp.</div><div>You can send invoice (`order_details`) messages to your customers, then get notified about payment status updates through webhook notifications from the payment gateway.</div><div id="bkmrk-know-the-differences"><div id="bkmrk-know-the-differences-1"><div>### Know the differences in the models of integration

</div></div></div><div>The integration model you use depends on your payment gateway. The two models differ in the following ways:</div>
<span>**[UPI Intent Mode](/documentation/business-messaging/whatsapp/payments/payments-in/upi-intent)**: This mode can be used with any Payment Gateway provided they support UPI Intent generation.</span><span>**[Payment Gateway Deep Integration Mode](/books/meta-whatsapp/page/receive-payments-via-payment-gateways-on-whatsapp-developer-documentation)**: Currently supported for Razorpay, PayU, Billdesk and Zaakpay only.</span><div><table><thead><tr><th><span>User Experience </span></th><th><span>UPI Intent Mode </span></th><th><span>Payment Gateway Deep Integration Mode </span></th></tr></thead><tbody><tr><td><div><div>**Native support for “Other payment methods”**</div><div><div>For example: Netbanking, cards, wallets</div></div></div></td><td><div><div><div>❌</div></div><div><div>Alternative: Send payment links</div></div></div></td><td><div><div><div>✅</div></div></div></td></tr><tr><td><div><div>**Native support for UPI Intent**</div></div></td><td><div><div><div>✅</div></div></div></td><td><div><div><div>✅</div></div></div></td></tr><tr><td><div><div>**Native Payment Status Notification**</div></div></td><td><div><div><div>❌</div></div></div></td><td><div><div><div>✅</div></div></div></td></tr></tbody></table>

</div><div><table><thead><tr><th><span>Integration Features </span></th><th><span>UPI Intent Mode </span></th><th><span>Payment Gateway Deep Integration Mode </span></th></tr></thead><tbody><tr><td><div><div>**Refunds from WhatsApp APIs**</div></div></td><td><div><div><div>❌</div></div></div></td><td><div><div><div>✅</div></div></div></td></tr><tr><td><div><div>**Payment Status from WhatsApp webhooks**</div></div></td><td><div><div><div>❌</div></div></div></td><td><div><div><div>✅</div></div></div></td></tr></tbody></table>

</div><div id="bkmrk-prerequisites-for-in"><div id="bkmrk-prerequisites-for-in-1"><div>### Prerequisites for integration

</div></div></div>
<span>**Essential Payments APIs are available at SP/TP**</span><span>**Access to merchant order trigger APIs / CSVs** needed to trigger an order. (for example, amount, goods or service details)</span><span>**Access to payment posting APIs** needed to close an order (for example, ticket generation APIs to create tickets once payment is received)</span><div id="bkmrk-full-payment-gateway"><div id="bkmrk-full-payment-gateway-1"><div>#### Full payment gateway deep integration mode

</div></div></div>
<span>**Find out payment gateway account owner**: This authorizes linking the account to WhatsApp Business Manager.</span><div id="bkmrk-upi-intent-mode"><div id="bkmrk-upi-intent-mode-1"><div>#### UPI Intent mode

</div></div></div>
<span>**Find out VPA IDs, MCC, and PC** for your business from the merchant’s payment gateway.</span><span>**Access to payment gateway API docs**:</span><span>UPI Intent S2S calls</span><span>Webhook configuration for payment status</span><div id="bkmrk-example-use-cases-an"><div id="bkmrk-example-use-cases-an-1"><div>### Example use cases and features needed

</div></div></div><div><table><thead><tr><th><span>Use case </span></th><th><span>Essential Feature Set </span></th></tr></thead><tbody><tr><td><div><div>**Buying Tickets**</div><div><div>For example: Metro, bus, event tickets</div></div></div></td><td><div>
<span>Order Details Message</span><span>Payment Status Webhook/API</span><span>Order Status Message</span><span>Refund</span></div></td></tr><tr><td><div><div>**Payment Reminders**</div><div><div>Example: Bill payments, subscription renewals, insurance renewals</div></div></div></td><td><div>
<span>Order Details Template</span><span>Payment Status Webhook/API</span><span>Order Status Message</span><span>Refund</span></div></td></tr></tbody></table>

</div><div id="bkmrk-support"><div id="bkmrk-support-1"><div>### Support

</div></div></div>
<span>In case you run into an issue, reach out to [direct support<span>⁠</span>](https://business.facebook.com/direct-support/). *Make sure to choose the correct case type: **“WaBiz: Business Payments API”** so you get a faster resolution.*</span><span>[Sign up for office hours<span>⁠</span>](https://l.facebook.com/l.php?u=https%3A%2F%2Foutlook.office365.com%2Fowa%2Fcalendar%2FWhatsappBusinessPaymentsIndiaOfficeHourse%40meta.com%2Fbookings%2F&h=AT6wsVJpTW0Wz4BTokxLypmBeB5Pqdoh_Czg8odxxSfl1aJsw5I3vhAUDSDZDDWLQM3E1pKmA0pZgGk-soU9mBwLJ20F5a7ShpF-FuXZIV-2a8H1KpwRtXUirEXNlg0tzvuePWs0U2gdY8Tto-v4Nw). *Make sure to write down your issues in the form provided*</span></div>

# Onboarding APIs | Developer Documentation

<div id="bkmrk-onboarding-apisupdat">## Onboarding APIs

<div><span>Updated: Nov 14, 2025</span></div><div>To receive payments on WhatsApp, you must have a payment configuration linked to the corresponding WhatsApp Business Account. Each payment configuration is associated with a unique name. As part of the order_details message, you can specify the payment configuration to use for a specific checkout.</div><div>Onboarding APIs allows you to programatically perform certain operations:</div><span>Get all payment configurations linked to a WhatsApp Business Account.</span><span>Get a specific payment configuration linked to a WhatsApp Business Account.</span><span>Create a payment configuration.</span><span>Regenerate payment gateway OAuth link to link payment configuration to a payment gateway.</span><span>Remove a payment configuration.</span><div id="bkmrk-payment-configuratio"><div id="bkmrk-payment-configuratio-1"><div>### Payment Configuration Webhook

</div></div></div><div>Businesses receive updates via WhatsApp webhooks when the status of the payment configuration changes.</div><div>To receive webhook, Businesses must subscribe to “payment_configuration_update” event for their respective application.</div><div>Webhook contains the following fields:</div><div><table><thead><tr><th><span>Field </span></th><th><span>Description </span></th></tr></thead><tbody><tr><td><div><div>`configuration_name`</div><div>string</div></div></td><td><div><div>**Required.**</div><div>The name of the payment configuration to be used in the Order Details message.</div></div></td></tr><tr><td><div><div>`provider_name`</div><div>string</div></div></td><td><div><div>**Required.**</div><div>Provider name of the payment configuration. Must be one of [“razorpay”, “payu”, “zaakpay”].</div></div></td></tr><tr><td><div><div>`provider_mid`</div><div>string</div></div></td><td><div><div>**Required.**</div><div>Payment gateway account merchant ID.</div></div></td></tr><tr><td><div><div>`status`</div><div>string</div></div></td><td><div><div>**Required.**</div><div>Status of the payment configuration. Must be one of [“Active”, “Needs_Connecting”, “Needs_Testing”].</div></div></td></tr><tr><td><div><div>`created_timestamp`</div><div>integer</div></div></td><td><div><div>**Required.**</div><div>Time when payment configuration was created.</div></div></td></tr><tr><td><div><div>`updated_timestamp`</div><div>integer</div></div></td><td><div><div>**Required.**</div><div>Time when payment configuration was last updated.</div></div></td></tr></tbody></table>

</div><div id="bkmrk-sample-payment-confi"><div id="bkmrk-sample-payment-confi-1"><div>#### Sample Payment Configuration Webhook

</div></div></div><div id="bkmrk-errors"><div id="bkmrk-errors-1"><div>#### Errors

</div></div></div>###### WhatsApp Payments Terms of Service Acceptance Pending

<div>If you see the following error, accept the WhatsApp Payments terms of service using the link provided in the error message before trying again.</div><div>For all other errors that can be returned and guidance on how to handle them, see [WhatsApp Cloud API, Error Codes](/documentation/business-messaging/whatsapp/support/error-codes).</div></div>

# Receive UPI Payments Through WhatsApp(Recommended) | Developer Documentation

<div id="bkmrk-receive-upi-payments">## Receive UPI Payments Through WhatsApp(Recommended)

<div><span>Updated: Mar 11, 2026</span></div><div><div>For businesses working with Billdesk or Zaakpay payment gateways, use the deeper integration with these PGs. Refer to [Payment Gateway Integration Guide](/books/meta-whatsapp/page/receive-payments-via-payment-gateways-on-whatsapp-developer-documentation)</div><div>For businesses working with Razorpay, PayU, or Cashfree payment gateways, use a faster integration path. Refer to [Enhanced Payment Links](/books/meta-whatsapp/page/enhanced-payment-links-developer-documentation)</div></div><div><div>This is the recommended UPI Intent integration. Using the older payment configuration method? [See previous docs](/documentation/business-messaging/whatsapp/payments/payments-in/upi-intent/) and plan to migrate to dynamic VPA.</div></div><div>Your business can enable customers to pay for their orders using all the UPI Apps installed on their devices via WhatsApp. Businesses can send customers invoice (`order_details`) messages, then get notified about payment status updates via webhook notifications from Payment Gateway.</div><div id="bkmrk-overview"><div id="bkmrk-overview-1"><div>### Overview

</div></div></div><div>Currently, customers browse business catalogs, add products to cart, and send orders in with our set of commerce messaging solutions, which includes [Single Product Message, Multi Product Message, and Product Detail Page](/books/meta-whatsapp/page/share-products-with-whatsapp-users-developer-documentation).</div><div>With the WhatsApp Payments API, businesses can send customers a bill so the customer can complete their order with all the UPI Apps.</div><div id="bkmrk-how-it-works"><div id="bkmrk-how-it-works-1"><div>### How It Works

</div></div></div><div>The business must send an `order_details` message for the consumer to initiate payment. This type of message is a new type of interactive message, which always 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.</div><div>An order_details message contains the following fields that are worth noting:</div><span>`upi_intent_link` - Fields that will be supplied by your payment gateway and denote where a payment will be sent.</span><span>`reference_id` - This is used to track the lifecycle of the order. Payment statuses are published against this ID. This could be order-id or transaction-id used to create the upi-intent at payment gateway.</span><div>Once the message is sent, the business waits for a payment or transaction status updates directly from Payment Gateway. Upon receiving payment signal for an order, Business should relay this payment signal to consumer through interactive order status (`order_status`) message.</div><div>Updating users about the payment signal is important as this message updates the order details message and order details view for the consumer reflecting the order confirmation from the merchant. This is shown with an example in subsequent sections.</div><div id="bkmrk-purchase-flow-in-app"><div id="bkmrk-purchase-flow-in-app-1"><div>### Purchase Flow in App

</div></div></div><div>In the WhatsApp customer app, the purchase flow has the following steps:</div><div>Customer sends an order with selected products to the business, or the business identifies the products that the customer has shown interest to purchase.</div><div>After receiving the order/identifying the product, if a merchant accepts payment methods other than UPI, such as credit cards and payment wallets, then the merchant will send a message to the user to get their preferred payment method for the order.</div><div><div>![Image](https://support2.chatarchitect.com/uploads/images/gallery/2026-04/embedded-image-eolwzdvk.jpeg)</div></div><div>When consumers want to pay using UPI payment method, then merchants should retrieve the UPI payment intent by calling Payment Gateway. Merchant needs to use UPI intent to construct order details messages and send it to the consumer.</div><div><div>![Image](https://support2.chatarchitect.com/uploads/images/gallery/2026-04/embedded-image-jvtwwmbp.jpeg)![Image](https://support2.chatarchitect.com/uploads/images/gallery/2026-04/embedded-image-k1dn5g8m.jpeg)</div></div><div>When the consumer taps the Pay now/continue button, they will be given the option to choose UPI payment Apps - WhatsApp or any other UPI payments apps. Consumers may choose any UPI option to pay for the order.</div><div><div>![Image](https://support2.chatarchitect.com/uploads/images/gallery/2026-04/embedded-image-fpbdnmcs.jpeg)![Image](https://support2.chatarchitect.com/uploads/images/gallery/2026-04/embedded-image-b2xsflu8.jpeg)</div></div><div>Consumer pays for the order and the payment method is saved for the future and automatically selected for the next payment transaction. Also, one quick note is the order details screen order-status will continue to show “Order pending” until the merchant sends order status interactive message.</div><div><div>![Image](https://support2.chatarchitect.com/uploads/images/gallery/2026-04/embedded-image-hbl1q0k4.jpeg)![Image](https://support2.chatarchitect.com/uploads/images/gallery/2026-04/embedded-image-bguf1gaf.jpeg)</div></div><div>Once the payment is complete, the business receives a notification from Payment Gateway and the merchant needs to send order status updates to the consumer client notifying consumers about the progress to the order, this will update the order details message CTAs and order details screen - order status description.</div><div><div>![Image](https://support2.chatarchitect.com/uploads/images/gallery/2026-04/embedded-image-drjejodz.jpeg)![Image](https://support2.chatarchitect.com/uploads/images/gallery/2026-04/embedded-image-tlt7v5wx.jpeg)![Image](https://support2.chatarchitect.com/uploads/images/gallery/2026-04/embedded-image-gzoc2zam.jpeg)</div></div><div id="bkmrk-integration-steps"><div id="bkmrk-integration-steps-1"><div>### Integration Steps

</div></div></div><div>The steps outlined below assume that the business is about to send order details message to the consumer client.</div><div>The following sequence diagram demonstrates the typical integration flow for WA Payments API: ![Image](https://support2.chatarchitect.com/uploads/images/gallery/2026-04/embedded-image-ams8ue5n.jpeg)</div><div id="bkmrk-step-1%3A-get-upi-inte"><div id="bkmrk-step-1%3A-get-upi-inte-1"><div>#### Step 1: Get UPI Intent from Payment Gateway

</div></div></div><div>Once the consumer has expressed their interest to purchase an item using UPI payment method, merchant needs to call payment gateway to create a UPI intent, the following is the sample UPI intent link:</div><div><div>```
<span><span>upi://pay?pa=abc@psp&pn=ABC&tr=877376394&</span></span><br></br><span><span>  am=10.00&cu=INR&mode=00&purpose=00&mc=5399&tn=87</span><span>7376394</span></span><br></br>
```

</div></div><div>Merchant/Partner could send the entire UPI intent as it is in the `upi_intent_link` type payload. These will be discussed in detail below.</div><div id="bkmrk-step-2%3A-assemble-the"><div id="bkmrk-step-2%3A-assemble-the-1"><div>#### Step 2: Assemble the Interactive Object

</div></div></div><div>To send an `order_details` message, businesses must assemble an [interactive object](/books/meta-whatsapp/page/sending-messages-developer-documentation) of type `order_details` with the following components:</div><div><table><thead><tr><th><span>Object </span></th><th><span>Description </span></th></tr></thead><tbody><tr><td><div><div>`type`</div><div>object</div></div></td><td><div><div>**Required.**</div><div>Must be “order_details”.</div></div></td></tr><tr><td><div><div>`header`</div><div>object</div></div></td><td><div><div>**Optional.**</div><div>Header content displayed on top of a message. If a header is not provided, the API uses an image of the first available product as the header</div></div></td></tr><tr><td><div><div>`body`</div><div>object</div></div></td><td><div><div>**Required.**</div><div>An object with the body of the message. The object contains the following field:</div><div>`text` string</div><span>**Required** if `body` is present. The content of the message. Emojis and markdown are supported. Maximum length is 1024 characters</span></div></td></tr><tr><td><div><div>`footer`</div><div>object</div></div></td><td><div><div>**Optional.**</div><div>An object with the footer of the message. The object contains the following fields:</div><div>`text` string</div><span>**Required** if `footer` is present. The footer content. Emojis, markdown, and links are supported. Maximum length is 60 characters</span></div></td></tr><tr><td><div><div>`action`</div><div>object</div></div></td><td><div><div>**Required.**</div><div>An action object you want the user to perform after reading the message. This action object contains the following fields:</div><div>`name` string</div><span>**Required**. Must be “review\_and\_pay”</span><div>`parameters` object</div><span>See [Parameters Object](#bkmrk-parameters-object-1) for information</span></div></td></tr></tbody></table>

</div><div id="bkmrk-parameters-object"><div id="bkmrk-parameters-object-1"><div>##### Parameters Object

</div></div></div><div><table><thead><tr><th><span>Object </span></th><th><span>Description </span></th></tr></thead><tbody><tr><td><div><div>`reference_id`</div><div>string</div></div></td><td><div><div>**Required.**</div><div>Unique identifier for the order or invoice provided by the business. It is case sensitive and cannot be an empty string and can only contain English letters, numbers, underscores, dashes, or dots, and should not exceed 35 characters.</div><div>The reference_id must be unique for each order_details message for a given business. If there is a need to send multiple order_details messages for the same order, it is recommended to include a sequence number in the reference_id (for example, “BM345A-12”) to ensure reference_id uniqueness.</div></div></td></tr><tr><td><div><div>`type`</div><div>object</div></div></td><td><div><div>**Required.**</div><div>The type of goods being paid for in this order. Current supported options are `digital-goods` and `physical-goods`</div></div></td></tr><tr><td><div><div>`beneficiaries`</div><div>array</div></div></td><td><div><div>**Required for shipped physical-goods.**</div><div>An array of beneficiaries for this order. A beneficiary is an intended recipient for shipping the physical goods in the order. It contains the following fields:</div><div><div>Beneficiary information isn’t shown to users but is needed for legal and compliance reasons.</div></div><div>`name` string</div><span>**Required.** Name of the individual or business receiving the physical goods. Cannot exceed 200 characters</span><div>`address_line1` string</div><span>**Required.** Shipping address (Door/Tower Number, Street Name etc.). Cannot exceed 100 characters</span><div>`address_line2` string</div><span>**Optional.** Shipping address (Landmark, Area, etc.). Cannot exceed 100 characters</span><div>`city` string</div><span>**Required.** Name of the city.</span><div>`state` string</div><span>**Required.** Name of the state.</span><div>`country` string</div><span>**Required.** Must be “India”.</span><div>`postal_code` string</div><span>**Required.** 6-digit zip code of shipping address.</span></div></td></tr><tr><td><div><div>`currency`</div></div></td><td><div><div>**Required.**</div><div>The currency for this order. Currently the only supported value is `INR`.</div></div></td></tr><tr><td><div><div>`total_amount`</div><div>object</div></div></td><td><div><div>**Required.**</div><div>The `total_amount` object contains the following fields:</div><div>`offset` integer</div><span>**Required.** Must be `100` for `INR`.</span><div>`value` integer</div><span>**Required.** Positive integer representing the amount value multiplied by offset. For example, ₹12.34 has value 1234.</span><div><div>`total_amount.value` must be equal to `order.subtotal.value` + `order.tax.value` + `order.shipping.value` - `order.discount.value`.</div></div></div></td></tr><tr><td><div><div>`payment_settings`</div><div>object</div></div></td><td><div><div>**Required.**</div><div>See [Payment Settings object](#bkmrk-payment-settings-obj-1) for more information.</div></div></td></tr><tr><td><div><div>`order`</div><div>object</div></div></td><td><div><div>**Required.**</div><div>See [order object](#bkmrk-order-object-1) for more information.</div></div></td></tr></tbody></table>

</div><div id="bkmrk-payment-settings-obj"><div id="bkmrk-payment-settings-obj-1"><div>##### Payment Settings Object

</div></div></div><div>You can pass UPI intent as it is or parse the UPI intent parameters and pass them in a json structure. We support both the formats, so following are the two variants of payments settings objects:</div>###### Payment Settings Object for UPI intent link

<div><table><thead><tr><th><span>Object </span></th><th><span>Description </span></th></tr></thead><tbody><tr><td><div><div>`type`</div><div>string</div></div></td><td><div><div>**Required.**</div><div>Must be set to **“upi\_intent\_link”**</div></div></td></tr><tr><td><div><div>`upi_intent_link`</div><div>object</div></div></td><td><div><div>**Required.**</div><div>An object that describes payment account information:</div><div>`link` string</div><span>**Required.** The UPI intent that is generated from Payment gateway. The UPI intent only supports the following “`&`” separated attributes- pa, pn, mc, purpose and tr</span><div>Example: `upi://pay?pa=merchant_vpa&pn=Merchant_Name&mc=merchant_category_code&purpose=purpose_code&tr=pg_generated_id`</div></div></td></tr></tbody></table>

</div><div id="bkmrk-order-object"><div id="bkmrk-order-object-1"><div>##### Order Object

</div></div></div><div><table><thead><tr><th><span>Object </span></th><th><span>Description </span></th></tr></thead><tbody><tr><td><div><div>`status`</div><div>string</div></div></td><td><div><div>**Required.**</div><div>Only supported value in the `order_details` message is `pending`.</div><div><div>In an `order_status` message, `status` can be: `pending`, `captured`, or `failed`.</div></div></div></td></tr><tr><td><div><div>`type`</div><div>string</div></div></td><td><div><div>**Optional.**</div><div>Only supported value is `quick_pay`. When this field is passed in we hide the “Review and Pay” button and only show the “Pay Now” button in the order details bubble.</div></div></td></tr><tr><td><div><div>`items`</div><div>object</div></div></td><td><div><div>**Required.**</div><div>An object with the list of items for this order, containing the following fields:</div><div>`retailer_id` string</div><span>**Optional.** Content ID for an item in the order from your catalog.</span><div>`name` string</div><span>**Required.** The item’s name to be displayed to the user. Cannot exceed 60 characters</span><div>`image` object</div><span>**Optional.** Custom image for the item to be displayed to the user. See [item image object](#bkmrk-item-image-object-1) for information</span><div><div>Using this image field will limit the items array to a maximum of 10 items and this cannot be used with `retailer_id` or `catalog_id`.</div></div><div>`amount` amount object with value and offset -- refer total amount field above</div><span>**Required.** The price per item</span><div>`sale_amount` amount object</div><span>**Optional.** The discounted price per item. This should be less than the original amount. If included, this field is used to calculate the subtotal amount</span><div>`quantity` integer</div><span>**Required.** The number of items in this order, this field cannot be decimal, has to be integer.</span><div>`country_of_origin` string</div><span>**Required** if `catalog_id` is not present. The country of origin of the product</span><div>`importer_name` string</div><span>**Required** if `catalog_id` is not present. Name of the importer company</span><div>`importer_adress` string</div><span>**Required** if `catalog_id` is not present. Address of importer company</span></div></td></tr><tr><td><div><div>`subtotal`</div><div>object</div></div></td><td><div><div>**Required.**</div><div>The value **must be equal** to sum of `order.amount.value` * `order.amount.quantity`. Refer to `total_amount` description for explanation of `offset` and `value` fields</div><div>The following fields are part of the `subtotal` object:</div><div>`offset` integer</div><span>**Required.** Must be `100` for `INR`</span><div>`value` integer</div><span>**Required.** Positive integer representing the amount value multiplied by offset. For example, ₹12.34 has value 1234</span></div></td></tr><tr><td><div><div>`tax`</div><div>object</div></div></td><td><div><div>**Required.**</div><div>The tax information for this order which contains the following fields:</div><div>`offset` integer</div><span>**Required.** Must be `100` for `INR`</span><div>`value` integer</div><span>**Required.** Positive integer representing the amount value multiplied by offset. For example, ₹12.34 has value 1234</span><div>`description` string</div><span>**Optional.** Max character limit is 60 characters</span></div></td></tr><tr><td><div><div>`shipping`</div><div>object</div></div></td><td><div><div>**Optional.**</div><div>The shipping cost of the order. The object contains the following fields:</div><div>`offset` integer</div><span>**Required.** Must be `100` for `INR`</span><div>`value` integer</div><span>**Required.** Positive integer representing the amount value multiplied by offset. For example, ₹12.34 has value 1234</span><div>`description` string</div><span>**Optional.** Max character limit is 60 characters</span></div></td></tr><tr><td><div><div>`discount`</div><div>object</div></div></td><td><div><div>**Optional.**</div><div>The discount for the order. The object contains the following fields:</div><div>`offset` integer</div><span>**Required.** Must be `100` for `INR`</span><div>`value` integer</div><span>**Required.** Positive integer representing the amount value multiplied by offset. For example, ₹12.34 has value 1234</span><div>`description` string</div><span>**Optional.** Max character limit is 60 characters</span><div>`discount_program_name` string</div><span>**Optional.** Text used for defining incentivised orders. If order is incentivised, the merchant needs to define this information. Max character limit is 60 characters</span></div></td></tr><tr><td><div><div>`catalog_id`</div><div>object</div></div></td><td><div><div>**Optional.**</div><div>Unique identifier of the Facebook catalog being used by the business.</div><div>If you do not provide this field, you must provide the following fields inside the items object: `country_of_origin`, `importer_name`, and `importer_address`</div></div></td></tr><tr><td><div><div>`expiration`</div><div>object</div></div></td><td><div><div>**Optional.**</div><div>Expiration for that order. Business must define the following fields inside this object:</div><div>`timestamp` string – UTC timestamp in seconds of time when order should expire. Minimum threshold is 300 seconds</div><div>`description` string – Text explanation for expiration. Max character limit is 120 characters</div></div></td></tr></tbody></table>

</div><div id="bkmrk-item-image-object"><div id="bkmrk-item-image-object-1"><div>##### Item Image Object

</div></div></div><div><table><thead><tr><th><span>Object </span></th><th><span>Description </span></th></tr></thead><tbody><tr><td><div><div>`link` string</div></div></td><td><div><div>**Required.** A link to the image that will be shown to the user. Must be an `image/jpeg` or `image/png` and 8-bit, RGB or RGBA. Follows same requirements as image in [media](/books/meta-whatsapp/page/media-developer-documentation)</div></div></td></tr></tbody></table>

</div><div>By the end, the interactive object should look something like this for a merchant upi intent type catalog-based integration:</div><div id="bkmrk-step-3%3A-add-common-m"><div id="bkmrk-step-3%3A-add-common-m-1"><div>#### Step 3: Add Common Message Parameters

</div></div></div><div>Once the interactive object is complete, append the other parameters that make a message: `recipient_type`, `to`, and `type`. Remember to set the `type` to `interactive`.</div><div>These are [parameters common to all message types](/books/meta-whatsapp/page/sending-messages-developer-documentation).</div><div id="bkmrk-step-4%3Amake-a-post-c"><div id="bkmrk-step-4%3Amake-a-post-c-1"><div>#### Step 4:Make a POST Call to Messages Endpoint

</div></div></div><div>Make a POST call to the [`/[PHONE_NUMBER_ID]/messages`](/books/meta-whatsapp/page/sending-messages-developer-documentation) endpoint with the `JSON` object you have assembled. If your message is sent successfully, you get the following response:</div><div id="bkmrk-errors"><div id="bkmrk-errors-1"><div>##### Errors

</div></div></div>###### WhatsApp Payments Terms of Service Acceptance Pending

<div>If you see the following error, accept the WhatsApp Payments terms of service using the link provided in the error message before trying again.</div><div>For all other errors that can be returned and guidance on how to handle them, see [WhatsApp Cloud API, Error Codes](/documentation/business-messaging/whatsapp/support/error-codes).</div><div id="bkmrk-step-5%3A-consumer-pay"><div id="bkmrk-step-5%3A-consumer-pay-1"><div>#### Step 5: Consumer Pays for the Order

</div></div></div><div>Consumers can pay using WhatsApp payment method or using any UPI supported app that is installed on the device.</div><div id="bkmrk-step-6%3A-get-notified"><div id="bkmrk-step-6%3A-get-notified-1"><div>#### Step 6: Get Notified About Transaction Status Updates from payment gateway

</div></div></div><div>Businesses receive updates to the invoice via payment gateway webhooks, when the status of the user-initiated transaction changes. The unique identifier reference-id passed in `order_details` message can be used to map the transaction to the consumer invoice or interactive order details message.</div><div>Please refer to our PG integration guide for the exact payment signals. [Cashfree](/books/meta-whatsapp/page/cashfree-payment-gateway-integration-guide-developer-documentation) and [CCAvenue](/books/meta-whatsapp/page/cashfree-payment-gateway-integration-guide-developer-documentation)</div><div id="bkmrk-step-7%3A-update-order"><div id="bkmrk-step-7%3A-update-order-1"><div>#### Step 7: Update order status

</div></div></div><div>Upon receiving transaction signals from payment gateway through webhook, the business must update the order status to keep the user up to date. Currently we support the following order status values:</div><div>![Image](https://support2.chatarchitect.com/uploads/images/gallery/2026-04/embedded-image-twum7b7q.jpeg)</div><div><table><thead><tr><th><span>Value </span></th><th><span>Description </span></th></tr></thead><tbody><tr><td><div><div>`pending`</div></div></td><td><div><div>User has not successfully paid yet</div></div></td></tr><tr><td><div><div>`processing`</div></div></td><td><div><div>User payment authorized, merchant/partner is fulfilling the order, performing service, etc.</div></div></td></tr><tr><td><div><div>`partially-shipped`</div></div></td><td><div><div>A portion of the products in the order have been shipped by the merchant</div></div></td></tr><tr><td><div><div>`shipped`</div></div></td><td><div><div>All the products in the order have been shipped by the merchant</div></div></td></tr><tr><td><div><div>`completed`</div></div></td><td><div><div>The order is completed and no further action is expected from the user or the partner/merchant</div></div></td></tr><tr><td><div><div>`canceled`</div></div></td><td><div><div>The partner/merchant would like to cancel the `order_details` message for the order/invoice. The status update will fail if there is already a `successful` or `pending` payment for this `order_details` message</div></div></td></tr></tbody></table>

</div><div>Typically businesses update the `order_status` using either the WhatsApp payment status change notifications or their own internal processes. To update `order_status`, the partner sends a `order_status` message to the user.</div><div>The following table describes the returned values:</div><div><table><thead><tr><th><span>Value </span></th><th><span>Description </span></th></tr></thead><tbody><tr><td><div><div>`reference_id`</div></div></td><td><div><div>The ID provided by the partner in the `order_details` message</div></div></td></tr><tr><td><div><div>`status`</div></div></td><td><div><div>The new order `status`</div></div></td></tr><tr><td><div><div>`description`</div></div></td><td><div><div>Optional text for sharing status related information in `order_details`. Could be useful while sending cancellation. Max character limit is 120 characters</div></div></td></tr></tbody></table>

</div><div><div>Merchant should always post this order-status message to the consumer after receiving transaction updates for an order. As the order_details message and order details screen experience is tied to to the order status updates.</div></div><div id="bkmrk-security-considerati"><div id="bkmrk-security-considerati-1"><div>### Security Considerations

</div></div></div><div>Businesses should comply with local security and regulatory requirements in India. They should not rely solely on the status of the transaction provided in the webhook and must use payment lookup API to retrieve the statuses directly from WhatsApp. Businesses must always sanitize/validate the data in the API responses or webhooks to protect against SSRF attacks.</div><div id="bkmrk-checklist-for-integr"><div id="bkmrk-checklist-for-integr-1"><div>### Checklist for Integrated Merchants

</div></div></div><div>Ensure that an `order_status` message is send to consumer informing them about updates to an order after receiving transaction updates for an order.</div><div>Ensure the merchant is verified and WABA contact is marked with a verified check.</div><div>Verify the WABA is mapped to appropriate merchant initiated messaging tier(1k, 10k and 100k per day)</div><div>Merchant should list the customer support information in the profile screen in case the consumer wants to report any issues.</div></div>

# Cashfree Payment Gateway Integration Guide | Developer Documentation

<div id="bkmrk-cashfree-payment-gat">## Cashfree Payment Gateway Integration Guide

<div><span>Updated: Oct 31, 2025</span></div><div id="bkmrk-purpose"><div id="bkmrk-purpose-1"><div>### Purpose

</div></div></div><div>The purpose of this document is to lay down the payment integration with Cashfree that is required for a merchant or Solution Partner that has setup a chatbot using WhatsApp Business APIs and needs to receive payments from WhatsApp users.</div><div>This document covers the set of APIs that need to be integrated and how the integration works in tandem with the WhatsApp Business API integration. For additional details regarding Cashfree payment integration, please refer to the Cashfree documentation.</div><div>Where this fits into the entire flow in terms of integration to the WA P2M product : The following document covers the requests, responses in red in the flow diagram below. ![Image](https://support2.chatarchitect.com/uploads/images/gallery/2026-04/embedded-image-yog0vcut.jpeg)</div><div id="bkmrk-handling-special-cas"><div id="bkmrk-handling-special-cas-1"><div>### Handling Special cases

</div></div></div><div id="bkmrk-order-expiry"><div id="bkmrk-order-expiry-1"><div>#### Order Expiry

</div></div></div>
<span>Cashfree allows setting the expiry time for an order in the Create Order API. Use that to set preferred expiry time.</span><span>Post order expiry, if no webhook was received, do a status check to ensure that the order expired and then cancel the order at WhatsApp to update the user.</span><div id="bkmrk-handling-failed-paym"><div id="bkmrk-handling-failed-paym-1"><div>#### Handling failed payments

</div></div></div>
<span>The Payment message sent to the user via WhatsApp allows for multiple retries upon failure (ie the Pay button is available until successful payment). However Cashfree requires the reference id (“tr” field in the url received in Order Pay response) to be unique for each payment.</span><span>So when a failed payment response is received from Cashfree, update the status of order at WhatsApp to cancelled. Post that a new payment message can be sent to the user to retry the payment.</span><span>In case, there is a delay in cancellation and the user ends up making a successful payment, Cashfree will not send a webhook to the merchant but does an auto-refund, without any additional action required by the merchant. In the case of a customer query in such a scenario (where they claim the transaction was successful but the payment cannot be found at Cashfree), suggest to the user that refund will be processed in a few days.</span><div id="bkmrk-canceling-order-for-"><div id="bkmrk-canceling-order-for--1"><div>#### Canceling Order for successful transaction

</div></div></div><div>There may arise a scenario where Cashfree shared a successful payment signal but the order cannot be fulfilled by the merchant. In such scenario, process refund for the payment via one of the following mechanisms:</div>
<span>Use Refund API.</span><span>Use Cashfree dashboard for merchants.</span></div>

# Billdesk Payment Gateway Integration Guide | Developer Documentation

<div id="bkmrk-billdesk-payment-gat">## Billdesk Payment Gateway Integration Guide

<div><span>Updated: Nov 14, 2025</span></div><div>The purpose of this document is to lay down the payment integration with Billdesk that is required for a merchant, or a Solution Partner, that has implemented a chatbot using WhatsApp Business APIs and needs to accept payments from WhatsApp users.</div><div>This document outlines the necessary APIs that must be integrated and how the integration works in conjunction with the WhatsApp Business API integration. While not a comprehensive guide, it serves as a general overview to assist in understanding the payment gateway integration process. Any specific or unique details related to the payment gateway must be determined by the merchant or Solution Partner.</div><div>In terms of integrating with the WA P2M product, this document covers the requests and responses highlighted in red in the flow diagram.</div><div>![](https://support2.chatarchitect.com/uploads/images/gallery/2026-04/embedded-image-pj5pfhcd.png)</div><div id="bkmrk-billdesk-payment-int"><div id="bkmrk-billdesk-payment-int-1"><div>### Billdesk payment integration

</div></div></div><div id="bkmrk-setup"><div id="bkmrk-setup-1"><div>#### Setup

</div></div></div><div>To authenticate with Billdesk's API, a client must be created and an authentication method must be selected between HMAC and Javascript Object Signing and Encryption (JOSE) with JOSE being the preferred method. These methods are used to encrypt/decrypt the request/response from Billdesk's APIs.</div><div>To simplify the explanation, the following examples will only address the body of final payload that will ultimately be included in the final object required for successful authentication with their API. It is important to consult Billdesk's documentation for guidance on how this final object must be structured.</div><div>You must have the following details before you can proceed:</div>
<span>Client ID and secret key from Billdesk</span><span>Details from the payment configuration you already configured on the WhatsApp Business Account </span>
<span>Merchant category code</span><span>Merchant's VPA</span><span>Merchant Name</span><div id="bkmrk-parse-the-response"><div id="bkmrk-parse-the-response-1"><div>#### Parse the response

</div></div></div><div>Use the value of `wa_txnid` on the response and pass it as the `reference_id` while setting up the `parameters` object to send for the [order details message](/documentation/business-messaging/whatsapp/payments/payments-in/upi-intent#paramobject) using the API.</div><div>Make sure to verify the values in the intent you receive:</div>
<span>The `intent` key has the base64 encoded value of the intent</span><span>Decoding the `intent` should give a value that should be similar to this: `upi://pay?pa=billdesk@hdfcbank&pn=SIDDHIVINKamp;mc=6300&tr=XHD50477676443&tn=Pay&am=2.00&malORS`</span><span>The value of `pa` is the merchant `VPA`. This value must match the VPA on the `payment_configuration` you send in the `parameters` object</span><div id="bkmrk-status-webhook"><div id="bkmrk-status-webhook-1"><div>#### Status webhook

</div></div></div><div>Billdesk will post a transaction object to the return URL (`ru`) you specified in the initiate payment API.</div><div><table><thead><tr><th><span>Key </span></th><th><span>Data type </span></th><th><span>Description </span></th></tr></thead><tbody><tr><td><div><div>objectid (Mandatory)</div></div></td><td><div><div>string</div></div></td><td><div><div>String representing the object's type. This value will be fixed as transaction</div></div></td></tr><tr><td><div><div>transactionid</div></div></td><td><div><div>string</div></div></td><td><div><div>Unique transaction ID generation by BillDesk for the transaction</div></div></td></tr><tr><td><div><div>orderid</div></div></td><td><div><div>string</div></div></td><td><div><div>Unique orderid generated by merchant to for the transaction</div></div></td></tr><tr><td><div><div>mercid</div></div></td><td><div><div>string</div></div></td><td><div><div>Unique identifier as defined by BillDesk for each merchant</div></div></td></tr><tr><td><div><div>transaction_date</div></div></td><td><div><div>timestamp</div></div></td><td><div><div>BillDesk transaction date and time in YYYY-MM DDThh:mm:ssTZD format</div></div></td></tr><tr><td><div><div>amount</div></div></td><td><div><div>string</div></div></td><td><div><div>Transaction amount in two decimals</div></div></td></tr><tr><td><div><div>surcharge</div></div></td><td><div><div>string</div></div></td><td><div><div>Customer surcharge in two decimals applied to the transaction amount, if any</div></div></td></tr><tr><td><div><div>discount</div></div></td><td><div><div>string</div></div></td><td><div><div>Customer discount in two decimals applied to the transaction amount, if any</div></div></td></tr><tr><td><div><div>charge_amount</div></div></td><td><div><div>string</div></div></td><td><div><div>Total charge to the customer</div></div></td></tr><tr><td><div><div>currency</div></div></td><td><div><div>integer</div></div></td><td><div><div>ISO currency of the transaction amount</div></div></td></tr><tr><td><div><div>txn_process_type</div></div></td><td><div><div>string</div></div></td><td><div><div>Indicates transaction processing type.</div><div>Intent for payment_method_type is upi and the method of payment is UPI intent</div></div></td></tr><tr><td><div><div>bankid</div></div></td><td><div><div>string</div></div></td><td><div><div>BillDesk defined unique identifier for bank or acquirer</div></div></td></tr><tr><td><div><div>txn_process_type</div></div></td><td><div><div>string</div></div></td><td><div><div>Indicates transaction processing type.</div><div>Intent for payment_method_type is upi and the method of payment is UPI intent.</div></div></td></tr><tr><td><div><div>ru</div></div></td><td><div><div>string</div></div></td><td><div><div>Merchant return url</div></div></td></tr><tr><td><div><div>additional_info</div></div></td><td><div><div>object</div></div></td><td><div><div>Array of 10 `additional_info` values that can be attached to the transaction. Note: Merchant is advised to not pass customer PII information in additional info fields.</div></div></td></tr><tr><td><div><div>itemcode</div></div></td><td><div><div>string</div></div></td><td><div><div>Itemcode value provided by BillDesk, with a default value of `DIRECT`</div></div></td></tr><tr><td><div><div>bank_ref_no</div></div></td><td><div><div>string</div></div></td><td><div><div>Transaction reference number generated by bank or acquirer</div></div></td></tr><tr><td><div><div>auth_status</div></div></td><td><div><div>string</div></div></td><td><div><div>Represents the authorization status of the transaction with the possible values:</div>
<span>`0300` - transaction is successful</span><span>`0002` - transaction is pending for authorization</span><span>`0399` - transaction failed</span></div></td></tr><tr><td><div><div>settlement_lob</div></div></td><td><div><div>string</div></div></td><td><div><div>Settlement line of business pre-configured by BillDesk for funds settlement to merchant account</div></div></td></tr><tr><td><div><div>customer</div></div></td><td><div><div>object</div></div></td><td><div><div>Customer object</div></div></td></tr><tr><td><div><div>device</div></div></td><td><div><div>object</div></div></td><td><div><div>Device object</div></div></td></tr><tr><td><div><div>transaction_error_code</div></div></td><td><div><div>string</div></div></td><td><div><div>Represents the error code for a transaction with `0399` status</div></div></td></tr><tr><td><div><div>transaction_error_type</div></div></td><td><div><div>string</div></div></td><td><div><div>Represents the standard error category for a transaction with `0399` status</div></div></td></tr><tr><td><div><div>transaction_error_desc</div></div></td><td><div><div>string</div></div></td><td><div><div>Represents the description of the error code for a transaction with `0399` status</div></div></td></tr><tr><td><div><div>authcode</div></div></td><td><div><div>string</div></div></td><td><div><div>Authorization code received from the acquirer for a successfully authorized card transaction</div></div></td></tr><tr><td><div><div>eci</div></div></td><td><div><div>string</div></div></td><td><div><div>eci value for the authentication taken for the card transaction</div></div></td></tr><tr><td><div><div>payment_method_type</div></div></td><td><div><div>string</div></div></td><td><div><div>Represents the method of payment e.g. upi</div></div></td></tr><tr><td><div><div>card</div></div></td><td><div><div>Object</div></div></td><td><div><div>Payment method object (applicable when payment method is card)</div></div></td></tr><tr><td><div><div>customer_refid</div></div></td><td><div><div>string</div></div></td><td><div><div>Unique customer identifier as per merchant</div></div></td></tr><tr><td><div><div>links</div></div></td><td><div><div>object</div></div></td><td><div><div>Associated links with the object</div></div></td></tr></tbody></table>

</div><div id="bkmrk-parsing-the-response"><div id="bkmrk-parsing-the-response-1"><div>#### Parsing the response

</div></div></div><div>Use the `auth_status` retrieved from the response above and transmit the corresponding [status message](https://developers.facebook.com/docs/whatsapp/cloud-api/payments-api/upi#step-7--update-order-status) via the WhatsApp API.</div></div>

# CCAvenue Payment Gateway Integration Guide | Developer Documentation

<div id="bkmrk-ccavenue-payment-gat">## CCAvenue Payment Gateway Integration Guide

<div><span>Updated: Dec 10, 2025</span></div><div>The purpose of this document is to lay down the payment integration with CCAvenue that is required for a merchant (or BSP) that has implemented a chatbot using WhatsApp Business APIs and needs to accept payments from WhatsApp users.</div><div>This document outlines the necessary APIs that must be integrated and how the integration works in conjunction with the WhatsApp Business API integration. While not a comprehensive guide, it serves as a general overview to assist in understanding the payment gateway integration process. Any specific or unique details related to the payment gateway must be determined by the merchant (or BSP).</div><div>In terms of integrating with the WA P2M product, this document covers the requests and responses highlighted in red within the flow diagram.</div><div>![](https://support2.chatarchitect.com/uploads/images/gallery/2026-04/embedded-image-gumgtgmi.png)</div></div>

# Accept Payments via Payment Links | Developer Documentation

<div id="bkmrk-accept-payments-via-">## Accept Payments via Payment Links

<div><span>Updated: Nov 14, 2025</span></div><div><div>This feature is not publicly available yet. Please reach out to whatsappindia-bizpayments-support@meta.com to know more.</div></div><div>Your businesses can enable customers to pay for their orders by bringing in all the payment methods supported on your platform to WhatsApp. Businesses can send customers invoice(`order_details`) messages, then get notified about payment status updates via webhook notifications from Payment Gateway.</div><div id="bkmrk-overview"><div id="bkmrk-overview-1"><div>### Overview

</div></div></div><div>Currently, customers browse business catalogs, add products to cart, and send orders in with our set of commerce messaging solutions, which includes [Single Product Message, Multi Product Message, and Product Detail Page](/books/meta-whatsapp/page/share-products-with-whatsapp-users-developer-documentation).</div><div>With the WhatsApp Messaging API, businesses can send customers a bill to complete the order with one of the supported payment instrument.</div><div id="bkmrk-how-it-works"><div id="bkmrk-how-it-works-1"><div>### How It Works

</div></div></div><div>The business must send an `order_details` message for the consumer to initiate payment. This type of message is a new type of interactive message, which always 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.</div><div>Each `order_details` message contains a unique `reference_id` provided by the business, and that unique number is used throughout the flow to track the order. This `reference_id` is used to generate the payment link from Payment Gateway.</div><div>Once the message is sent, the business waits for a payment or transaction status updates directly from Payment Gateway. Upon receiving payment signal for an order, business should relay this payment signal to consumer client through interactive order status(`order_status`) message.</div><div>Updating user about the payment signal is important as this message updates the order details message and order details view for the consumer reflecting the order confirmation from merchant. This is shown with an example in subsequent sections.</div><div id="bkmrk-purchase-flow-in-app"><div id="bkmrk-purchase-flow-in-app-1"><div>### Purchase Flow in App

</div></div></div><div>In the WhatsApp customer app, the purchase flow has the following steps:</div><div>Customer sends an order with selected products to the business or business identifies the products that the customer has shown interest to purchase.</div><div>After receiving the order or identifying the product, if a business accepts payment methods other than UPI, such as credit cards and payment wallets, etc. then business will send a message to the user to get their preferred payment method for the order.</div><div><div>![Image](https://support2.chatarchitect.com/uploads/images/gallery/2026-04/embedded-image-3r693o6s.jpeg)</div></div><div>When consumers want to pay using other payment method option, the business should generate the payment link by calling Payment Gateway by providing the unique “reference-id” and other information like amount, validity etc, then business can use the generated payment link to construct the order details message and send to the consumer.</div><div><div>![Image](https://support2.chatarchitect.com/uploads/images/gallery/2026-04/embedded-image-7etgfusp.jpeg)![Image](https://support2.chatarchitect.com/uploads/images/gallery/2026-04/embedded-image-citmyjba.jpeg)</div></div><div>When the consumer taps the Pay now/continue button, consumer will be redirected to the payment link within specially designed In-App browser to present with the list of supported payment options such as credit card, debit card, wallet or UPI apps. Consumers can choose any one of the payment option to pay for the order.</div><div><div><div>The following is a sample payment link redirect within In-App Browser accepting various payment methods like credit, debit, wallet and UPI apps.</div></div><div>![Image](https://support2.chatarchitect.com/uploads/images/gallery/2026-04/embedded-image-ropyzsno.jpeg)![Image](https://support2.chatarchitect.com/uploads/images/gallery/2026-04/embedded-image-uolz422q.jpeg)</div></div><div>Once the payment is complete, the business will receive a notification from Payment Gateway and the business needs to send order status updates to the consumer client notifying consumers about the progress on their order, this will update the order details message CTAs, Order details screen and Order status. The order status should contain the matching “reference-id” of order details.</div><div><div>![Image](https://support2.chatarchitect.com/uploads/images/gallery/2026-04/embedded-image-z5do8xtx.jpeg)![Image](https://support2.chatarchitect.com/uploads/images/gallery/2026-04/embedded-image-iyylztqr.jpeg)</div></div><div id="bkmrk-integration-steps"><div id="bkmrk-integration-steps-1"><div>### Integration Steps

</div></div></div><div>The steps outlined below assume that the business is about to send order details message to consumer client.</div><div>The following sequence diagram demonstrates the typical integration flow for WA Payments API: ![Image](https://support2.chatarchitect.com/uploads/images/gallery/2026-04/embedded-image-6xzavkzj.jpeg)</div><div id="bkmrk-step-1%3A-get-payment-"><div id="bkmrk-step-1%3A-get-payment--1"><div>#### Step 1: Get Payment Link from Payment Gateway

</div></div></div><div>Once the consumer has expressed their interest to purchase an item using payment link. Business needs to call payment gateway with necessary information like reference-id, amount and validity to generate the payment link. Following is a sample payment link:</div><div><div>```
https://rzp.io/i/rNiAagU8y
```

</div></div><div>Business needs to use the same reference-id, amount and expiration in invoice(`order_details`) interactive message.</div><div id="bkmrk-step-2%3A-assemble-the"><div id="bkmrk-step-2%3A-assemble-the-1"><div>#### Step 2: Assemble the Interactive Object

</div></div></div><div>To send an `order_details` message, businesses must assemble an [interactive object](/books/meta-whatsapp/page/sending-messages-developer-documentation) of type `order_details` with the following components:</div><div><table><thead><tr><th><span>Object </span></th><th><span>Description </span></th></tr></thead><tbody><tr><td><div><div>`type`</div><div>object</div></div></td><td><div><div>**Required.**</div><div>Must be “order_details”.</div></div></td></tr><tr><td><div><div>`header`</div><div>object</div></div></td><td><div><div>**Optional.**</div><div>Header content displayed on top of a message. If a header is not provided, the API uses an image of the first available product as the header</div></div></td></tr><tr><td><div><div>`body`</div><div>object</div></div></td><td><div><div>**Required.**</div><div>An object with the body of the message. The object contains the following field:</div><div>`text` string</div><span>**Required** if `body` is present. The content of the message. Emojis and markdown are supported. Maximum length is 1024 characters</span></div></td></tr><tr><td><div><div>`footer`</div><div>object</div></div></td><td><div><div>**Optional.**</div><div>An object with the footer of the message. The object contains the following fields:</div><div>`text` string</div><span>**Required** if `footer` is present. The footer content. Emojis, markdown, and links are supported. Maximum length is 60 characters</span></div></td></tr><tr><td><div><div>`action`</div><div>object</div></div></td><td><div><div>**Required.**</div><div>An action object you want the user to perform after reading the message. This action object contains the following fields:</div><div>`name` string</div><span>**Required**. Must be “review\_and\_pay”</span><div>`parameters` object</div><span>See [Parameters Object](#bkmrk-parameters-object-1) for information</span></div></td></tr></tbody></table>

</div><div id="bkmrk-parameters-object"><div id="bkmrk-parameters-object-1"><div>##### Parameters Object

</div></div></div><div><table><thead><tr><th><span>Object </span></th><th><span>Description </span></th></tr></thead><tbody><tr><td><div><div>`reference_id`</div><div>string</div></div></td><td><div><div>**Required.**</div><div>Unique identifier for the order or invoice provided by the business. It is case sensitive and cannot be an empty string and can only contain English letters, numbers, underscores, dashes, or dots, and should not exceed 35 characters.</div><div>The `reference_id` must be unique for each `order_details` message for the same business. If the partner would like to send multiple order_details messages for the same order, invoice, etc. it is recommended to include a sequence number in the `reference_id` (for example, &lt;order-or-invoice-id&gt;-&lt;sequence-number&gt;) to ensure `reference_id` uniqueness.</div></div></td></tr><tr><td><div><div>`type`</div><div>object</div></div></td><td><div><div>**Required.**</div><div>The type of goods being paid for in this order. Current supported options are `digital-goods` and `physical-goods`</div></div></td></tr><tr><td><div><div>`beneficiaries`</div><div>array</div></div></td><td><div><div>**Required for shipped physical-goods.**</div><div>An array of beneficiaries for this order. A beneficiary is an intended recipient for shipping the physical goods in the order. It contains the following fields:</div><div><div>Beneficiary information isn’t shown to users but is needed for legal and compliance reasons.</div></div><div>`name` string</div><span>**Required.** Name of the individual or business receiving the physical goods. Cannot exceed 200 characters</span><div>`address_line1` string</div><span>**Required.** Shipping address (Door/Tower Number, Street Name etc.). Cannot exceed 100 characters</span><div>`address_line2` string</div><span>**Optional.** Shipping address (Landmark, Area, etc.). Cannot exceed 100 characters</span><div>`city` string</div><span>**Required.** Name of the city.</span><div>`state` string</div><span>**Required.** Name of the state.</span><div>`country` string</div><span>**Required.** Must be “India”.</span><div>`postal_code` string</div><span>**Required.** 6-digit zipcode of shipping address.</span></div></td></tr><tr><td><div><div>`payment_type`</div></div></td><td><div><div>**Required.**</div><div>Must be “upi”.</div></div></td></tr><tr><td><div><div>`payment_settings`</div></div></td><td><div><div>**Required.** See [Payment Settings Object](#bkmrk-payment-setting-obje-1) for more details.</div></div></td></tr><tr><td><div><div>`currency`</div></div></td><td><div><div>**Required.**</div><div>The currency for this order. Currently the only supported value is `INR`.</div></div></td></tr><tr><td><div><div>`total_amount`</div><div>object</div></div></td><td><div><div>**Required.**</div><div>The `total_amount` object contains the following fields:</div><div>`offset` integer</div><span>**Required.** Must be `100` for `INR`.</span><div>`value` integer</div><span>**Required.** Positive integer representing the amount value multiplied by offset. For example, ₹12.34 has value 1234.</span><div><div>`total_amount.value` must be equal to `order.subtotal.value` + `order.tax.value` + `order.shipping.value` - `order.discount.value`.</div></div></div></td></tr><tr><td><div><div>`order`</div><div>object</div></div></td><td><div><div>**Required.**</div><div>See [order object](#bkmrk-order-object-1) for more information.</div></div></td></tr></tbody></table>

</div><div id="bkmrk-payment-setting-obje"><div id="bkmrk-payment-setting-obje-1"><div>##### Payment Setting Object

</div></div></div><div><table><thead><tr><th><span>Object </span></th><th><span>Description </span></th></tr></thead><tbody><tr><td><div><div>`type` string</div></div></td><td><div><div>**Required.** Must be `payment_link`.</div></div></td></tr><tr><td><div><div>`payment_link` object</div></div></td><td><div><div>**Required.** Refer [Payment Link Object](#bkmrk-payment-link-object-1) for more information.</div></div></td></tr></tbody></table>

</div><div id="bkmrk-payment-link-object"><div id="bkmrk-payment-link-object-1"><div>##### Payment Link Object

</div></div></div><div><table><thead><tr><th><span>Object </span></th><th><span>Description </span></th></tr></thead><tbody><tr><td><div><div>`uri` string</div></div></td><td><div><div>**Required.** A valid payment link generated through payment gateway.</div><div><div>Generated payment links domains needs to be enabled to accept payments. Please reach out to whatsappindia-bizpayments-support@meta.com to know more.</div></div></div></td></tr><tr><td><div><div>`success_url` string</div></div></td><td><div><div>**Optional.** The flow terminated with success status, when success_url is hit.</div></div></td></tr><tr><td><div><div>`cancel_url` string</div></div></td><td><div><div>**Optional.** The flow ends with failure, when the cancel_url is triggered.</div></div></td></tr></tbody></table>

</div><div id="bkmrk-order-object"><div id="bkmrk-order-object-1"><div>##### Order Object

</div></div></div><div><table><thead><tr><th><span>Object </span></th><th><span>Description </span></th></tr></thead><tbody><tr><td><div><div>`status`</div><div>string</div></div></td><td><div><div>**Required.**</div><div>Only supported value in the `order_details` message is `pending`.</div><div><div>In an `order_status` message, `status` can be: `pending`, `captured`, or `failed`.</div></div></div></td></tr><tr><td><div><div>`type`</div><div>string</div></div></td><td><div><div>**Optional.**</div><div>Only supported value is `quick_pay`. When this field is passed in we hide the “Review and Pay” button and only show the “Pay Now” button in the order details bubble.</div></div></td></tr><tr><td><div><div>`items`</div><div>object</div></div></td><td><div><div>**Required.**</div><div>An object with the list of items for this order, containing the following fields:</div><div>`retailer_id` string</div><span>**Optional.** Content ID for an item in the order from your catalog.</span><div>`name` string</div><span>**Required.** The item’s name to be displayed to the user. Cannot exceed 60 characters</span><div>`image` object</div><span>**Optional.** Custom image for the item to be displayed to the user. See [item image object](#bkmrk-item-image-object-1) for information</span><div><div>Using this image field will limit the items array to a maximum of 10 items and this cannot be used with `retailer_id` or `catalog_id`.</div></div><div>`amount` amount object with value and offset -- refer total amount field above</div><span>**Required.** The price per item</span><div>`sale_amount` amount object</div><span>**Optional.** The discounted price per item. This should be less than the original amount. If included, this field is used to calculate the subtotal amount</span><div>`quantity` integer</div><span>**Required.** The number of items in this order, this field cannot be decimal has to be integer.</span><div>`country_of_origin` string</div><span>**Required** if `catalog_id` is not present. The country of origin of the product</span><div>`importer_name` string</div><span>**Required** if `catalog_id` is not present. Name of the importer company</span><div>`importer_adress` string</div><span>**Required** if `catalog_id` is not present. Address of importer company</span></div></td></tr><tr><td><div><div>`subtotal`</div><div>object</div></div></td><td><div><div>**Required.**</div><div>The value **must be equal** to sum of `order.amount.value` * `order.amount.quantity`. Refer to `total_amount` description for explanation of `offset` and `value` fields</div><div>The following fields are part of the `subtotal` object:</div><div>`offset` integer</div><span>**Required.** Must be `100` for `INR`</span><div>`value` integer</div><span>**Required.** Positive integer representing the amount value multiplied by offset. For example, ₹12.34 has value 1234</span></div></td></tr><tr><td><div><div>`tax`</div><div>object</div></div></td><td><div><div>**Required.**</div><div>The tax information for this order which contains the following fields:</div><div>`offset` integer</div><span>**Required.** Must be `100` for `INR`</span><div>`value` integer</div><span>**Required.** Positive integer representing the amount value multiplied by offset. For example, ₹12.34 has value 1234</span><div>`description` string</div><span>**Optional.** Max character limit is 60 characters</span></div></td></tr><tr><td><div><div>`shipping`</div><div>object</div></div></td><td><div><div>**Optional.**</div><div>The shipping cost of the order. The object contains the following fields:</div><div>`offset` integer</div><span>**Required.** Must be `100` for `INR`</span><div>`value` integer</div><span>**Required.** Positive integer representing the amount value multiplied by offset. For example, ₹12.34 has value 1234</span><div>`description` string</div><span>**Optional.** Max character limit is 60 characters</span></div></td></tr><tr><td><div><div>`discount`</div><div>object</div></div></td><td><div><div>**Optional.**</div><div>The discount for the order. The object contains the following fields:</div><div>`offset` integer</div><span>**Required.** Must be `100` for `INR`</span><div>`value` integer</div><span>**Required.** Positive integer representing the amount value multiplied by offset. For example, ₹12.34 has value 1234</span><div>`description` string</div><span>**Optional.** Max character limit is 60 characters</span><div>`discount_program_name` string</div><span>**Optional.** Text used for defining incentivised orders. If order is incentivised, the merchant needs to define this information. Max character limit is 60 characters</span></div></td></tr><tr><td><div><div>`catalog_id`</div><div>object</div></div></td><td><div><div>**Optional.**</div><div>Unique identifier of the Facebook catalog being used by the business.</div><div>If you do not provide this field, you must provide the following fields inside the items object: `country_of_origin`, `importer_name`, and `importer_address`</div></div></td></tr><tr><td><div><div>`expiration`</div><div>object</div></div></td><td><div><div>**Optional.**</div><div>Expiration for that order. Business must define the following fields inside this object:</div><div>`timestamp` string – UTC timestamp in seconds of time when order should expire. Minimum threshold is 300 seconds</div><div>`description` string – Text explanation for expiration. Max character limit is 120 characters</div></div></td></tr></tbody></table>

</div><div id="bkmrk-item-image-object"><div id="bkmrk-item-image-object-1"><div>##### Item Image Object

</div></div></div><div><table><thead><tr><th><span>Object </span></th><th><span>Description </span></th></tr></thead><tbody><tr><td><div><div>`link` string</div></div></td><td><div><div>**Required.** A link to the image that will be shown to the user. Must be an `image/jpeg` or `image/png` and 8-bit, RGB or RGBA. Follows same requirements as image in [media](/books/meta-whatsapp/page/media-developer-documentation)</div></div></td></tr></tbody></table>

</div><div><div>The `parameters` value is a stringified JSON object.</div></div><div>By the end, the interactive object should look something like this for a catalog-based integration:</div><div><div>The `parameters` value is a stringified JSON object.</div></div><div>For a non-catalog based integration i.e. when catalog-id is not present, an example payload looks as follows:</div><div id="bkmrk-step-3%3A-add-common-m"><div id="bkmrk-step-3%3A-add-common-m-1"><div>#### Step 3: Add Common Message Parameters

</div></div></div><div>Once the interactive object is complete, append the other parameters that make a message: `recipient_type`, `to`, and `type`. Remember to set the `type` to `interactive`.</div><div>These are [parameters common to all message types](/books/meta-whatsapp/page/sending-messages-developer-documentation).</div><div id="bkmrk-step-4%3Amake-a-post-c"><div id="bkmrk-step-4%3Amake-a-post-c-1"><div>#### Step 4:Make a POST Call to Messages Endpoint

</div></div></div><div>Make a POST call to the [`/[PHONE_NUMBER_ID]/messages`](/books/meta-whatsapp/page/sending-messages-developer-documentation) endpoint with the `JSON` object you have assembled. If your message is sent successfully, you get the following response:</div><div id="bkmrk-errors"><div id="bkmrk-errors-1"><div>##### Errors

</div></div></div>###### WhatsApp Payments Terms of Service Acceptance Pending

<div>If you see the following error, accept the WhatsApp Payments terms of service using the link provided in the error message before trying again.</div><div>For all other errors that can be returned and guidance on how to handle them, see [WhatsApp Cloud API, Error Codes](/documentation/business-messaging/whatsapp/support/error-codes).</div><div id="bkmrk-step-5%3A-consumer-pay"><div id="bkmrk-step-5%3A-consumer-pay-1"><div>#### Step 5: Consumer Pays for the Order

</div></div></div><div>Consumers can pay using WhatsApp payment method or using any UPI supported app that is installed on the device.</div><div id="bkmrk-step-6%3A-get-notified"><div id="bkmrk-step-6%3A-get-notified-1"><div>#### Step 6: Get Notified About Transaction Status Updates from payment gateway

</div></div></div><div>Businesses receive updates to the invoice via payment gateway webhooks, when the status of the user-initiated transaction changes. The unique identifier reference-id passed in `order_details` message can be used to map the transaction to the consumer invoice or interactive order details message.</div><div id="bkmrk-step-7%3A-update-order"><div id="bkmrk-step-7%3A-update-order-1"><div>#### Step 7: Update order status

</div></div></div><div>Upon receiving transaction signals from payment gateway through webhook, the business must update the order status to keep the user up to date. Currently we support the following order status values:</div><div>![Image](https://support2.chatarchitect.com/uploads/images/gallery/2026-04/embedded-image-0gwle5f1.jpeg)</div><div><table><thead><tr><th><span>Value </span></th><th><span>Description </span></th></tr></thead><tbody><tr><td><div><div>`pending`</div></div></td><td><div><div>User has not successfully paid yet</div></div></td></tr><tr><td><div><div>`processing`</div></div></td><td><div><div>User payment authorized, merchant/partner is fulfilling the order, performing service, etc.</div></div></td></tr><tr><td><div><div>`partially-shipped`</div></div></td><td><div><div>A portion of the products in the order have been shipped by the merchant</div></div></td></tr><tr><td><div><div>`shipped`</div></div></td><td><div><div>All the products in the order have been shipped by the merchant</div></div></td></tr><tr><td><div><div>`completed`</div></div></td><td><div><div>The order is completed and no further action is expected from the user or the partner/merchant</div></div></td></tr><tr><td><div><div>`canceled`</div></div></td><td><div><div>The partner/merchant would like to cancel the `order_details` message for the order/invoice. The status update will fail if there is already a `successful` or `pending` payment for this `order_details` message</div></div></td></tr></tbody></table>

</div><div>Typically businesses update the `order_status` using either the WhatsApp payment status change notifications or their own internal processes. To update `order_status`, the partner sends an `order_status` message to the user.</div><div>The following table describes the returned values:</div><div><table><thead><tr><th><span>Value </span></th><th><span>Description </span></th></tr></thead><tbody><tr><td><div><div>`reference_id`</div></div></td><td><div><div>The ID provided by the partner in the `order_details` message</div></div></td></tr><tr><td><div><div>`status`</div></div></td><td><div><div>The new order `status`</div></div></td></tr><tr><td><div><div>`description`</div></div></td><td><div><div>Optional text for sharing status related information in `order_details`. Could be useful while sending cancellation. Max character limit is 120 characters</div></div></td></tr></tbody></table>

</div><div><div>Merchant should always post this order-status message to consumer after receiving transaction updates for an order. As the order_details message and order details screen experience is tied to to the order status updates.</div></div><div id="bkmrk-step-8%3A-reconcile-pa"><div id="bkmrk-step-8%3A-reconcile-pa-1"><div>#### Step 8: Reconcile Payments

</div></div></div><div>Businesses should use their bank statements to reconcile the payments using the `reference_id` provided in the `order_details` messages.</div><div id="bkmrk-checklist-for-integr"><div id="bkmrk-checklist-for-integr-1"><div>### Checklist for Integrated Merchants

</div></div></div><div>Ensure that `order_status` message is send to consumer informing them about updates to an order after receiving transaction updates for an order.</div><div>Ensure the merchant is verified and WABA contact is marked with a verified check.</div><div>Verify the WABA is mapped to appropriate merchant initiated messaging tier(1k, 10k and 100k per day)</div><div>Merchant should list the customer support information in the profile screen incase consumer wants to report any issues.</div></div>

# Enhanced Payment Links | Developer Documentation

<div id="bkmrk-enhanced-payment-lin">## Enhanced Payment Links

<div><span>Updated: Dec 12, 2025</span></div><div id="bkmrk-overview"><div id="bkmrk-overview-1"><div>### Overview

</div></div></div><div>Enhanced Payment Links is a feature that transforms existing payment gateway URLs into rich, native payment experiences within WhatsApp.</div><div>It converts existing payment links into an in-app checkout flow - no changes to your payment backend, reconciliation, or callback setup are required. When a supported payment link is sent through a message template, it automatically renders as a structured payment bubble featuring:</div>
<span>**Amount and currency** clearly displayed</span><span>**“Pay Now” CTA** for seamless checkout</span><span>**In-app checkout** via UPI Intent or hosted payment page</span><div>This feature significantly improves payment conversion rates by reducing checkout friction and increasing consumer trust.</div><div>**Superfast Setup**: Merchants can independently create the required [WhatsApp templates](#bkmrk-template-requirement-1) and embed payment links from [supported payment gateways](#bkmrk-supported-payment-ga-1) - no BSP involvement is needed.</div><div><span></span><div>This feature is not publicly available yet. To request access, please reach out to your BSP or Meta representative with your **WABA ID**, **sample payment link**, and **preferred Payment Gateway** (Razorpay, PayU, or Cashfree).</div></div><div id="bkmrk-user-experience"><div id="bkmrk-user-experience-1"><div>### User Experience

</div></div></div><div>On supported WhatsApp versions, the payment link renders as an enhanced bubble:</div><div>![Image](https://support2.chatarchitect.com/uploads/images/gallery/2026-04/embedded-image-qdsjhlas.jpeg)</div>
<span>**Rich Payment Card**: Displays Amount, currency, and CTA button</span><span>**In-App Checkout**: </span>
<span>*UPI*: Direct app-switch to UPI apps (Google Pay, PhonePe, Paytm, etc.)</span><span>*Other methods*: In-app browser for cards, net banking, or wallets</span><span>**Automatic Status Updates**: The payment card automatically updates to reflect the payment status on completion or expiry, and disables the “Pay Now” button to prevent duplicate payments.</span><div id="bkmrk-prerequisites"><div id="bkmrk-prerequisites-1"><div>### Prerequisites

</div></div></div><div><span></span><div>Enhanced Payment Links is an experience that works with both existing BSP APIs and WhatsApp Business Cloud API. Neither BSPs nor merchants need to make any backend, API, reconciliation, or callback changes to enable this feature. Your existing payment gateway integration remains completely unchanged.</div></div><div>To use Enhanced Payment Links:</div><div><table><thead><tr><th><span>Requirement</span></th><th><span>Description</span></th></tr></thead><tbody><tr><td><div>**Allowlisted WABA**</div></td><td><div>Your WABA ID must be enabled for Enhanced Payment Links. Submit a request to your BSP or Meta representative with your WABA ID, preferred payment gateway(s), and sample payment links for validation.</div></td></tr><tr><td><div>**Supported Payment Gateway**</div></td><td><div>An active account with Razorpay, PayU, or Cashfree</div></td></tr><tr><td><div>**Compliant Template**</div></td><td><div>A message template configured with no header and a dynamic URL button (see [Template Requirements](#bkmrk-template-requirement-1))</div></td></tr></tbody></table>

</div><div id="bkmrk-supported-payment-ga"><div id="bkmrk-supported-payment-ga-1"><div>#### Supported Payment Gateways

</div></div></div><div><table><thead><tr><th><span>Payment Gateway</span></th><th><span>Status</span></th></tr></thead><tbody><tr><td><div>Razorpay</div></td><td><div>✅ Supported</div></td></tr><tr><td><div>PayU</div></td><td><div>✅ Supported</div></td></tr><tr><td><div>Cashfree</div></td><td><div>✅ Supported</div></td></tr></tbody></table>

</div><div id="bkmrk-integration-flow"><div id="bkmrk-integration-flow-1"><div>### Integration Flow

</div></div></div><div>The following diagram illustrates the end-to-end flow, from sending an Enhanced Payment Link to payment completion and callbacks:</div><div>![End-to-end EPL flow: Merchant creates payment link via PG, sends template message, consumer pays in-app, PG sends webhook to merchant (unchanged), WhatsApp updates payment card automatically](https://support2.chatarchitect.com/uploads/images/gallery/2026-04/embedded-image-roiqkivy.png)</div><div>**Steps:**</div>
<span>**Generate payment link** - Your server calls the payment gateway API (Razorpay, PayU, or Cashfree) to create a payment link for the transaction.</span><span>**Receive payment link URL** - The payment gateway returns a URL (for example, `https://rzp.io/i/abc123XYZ`).</span><span>**Send template message** - Your server sends a template message via the Cloud API or your BSP, embedding the dynamic portion of the payment link (the suffix) in the button component.</span><span>**Message delivered on WhatsApp** - The consumer receives an enhanced payment bubble with the amount, currency, and a “Pay Now” button for in-app checkout.</span><span>**Consumer completes payment** - The consumer taps “Pay Now” and pays via UPI apps, cards, net banking, or wallets within WhatsApp.</span><span>**Payment gateway sends callback to merchant** - Your existing webhook endpoint receives the payment status callback with the same payload format as before. No changes to your webhook URL, payload handling, or reconciliation logic are needed.</span><span>**WhatsApp updates the payment card** - The payment card automatically reflects the payment status (success, or expiry) and disables the “Pay Now” button to prevent duplicate payments. This happens independently and requires no merchant action.</span><div id="bkmrk-template-requirement"><div id="bkmrk-template-requirement-1"><div>### Template Requirements

</div></div></div><div>Enhanced Payment Link templates must follow these constraints:</div><div><table><thead><tr><th><span>Component</span></th><th><span>Requirement</span></th></tr></thead><tbody><tr><td><div>**Header**</div></td><td><div>None — templates must **not** include a media header (image, video, or document)</div></td></tr><tr><td><div>**Button**</div></td><td><div>Exactly **one** dynamic URL button with a [supported PG link prefix](#bkmrk-dynamic-url-prefix-c-1)</div></td></tr></tbody></table>

</div><div>Merchants can independently create these templates without involving their BSP. Templates can be created using any one of the following methods:</div>
<span>[Template Library](/books/meta-whatsapp/page/template-library-developer-documentation) (recommended)</span><span>[WhatsApp Manager<span>⁠</span>](https://business.facebook.com/wa/manage/message-templates)</span><span>[Business Management API](https://developers.facebook.com/docs/whatsapp/business-management-api/message-templates)</span><span>BSP Dashboard</span><div id="bkmrk-example-template-con"><div id="bkmrk-example-template-con-1"><div>#### Example Template Configuration

</div></div></div><div>Your business can enable customers to pay using their favorite UPI apps or other payment methods accepted by supporting Payment Gateways without leaving WhatsApp.</div><div>```
<span>Body</span><span>:</span><span>"Hi 1, reminder to pay for your insurance renewal #2. Amount: ₹3"</span><span>Button</span><span>:</span><span>-</span><span>Type</span><span> of </span><span>Action</span><span>:</span><span>"Visit website"</span><span>-</span><span>Button</span><span>Text</span><span>:</span><span>"Pay Now"</span><span>-</span><span> URL </span><span>Type</span><span>:</span><span>Dynamic</span><span>-</span><span>Website</span><span> URL</span><span>:</span><span> https</span><span>:</span><span>//pg.io/i/</span>
```

</div>> <div>**Important**: The button URL must be configured as **dynamic** to pass the payment link at send time.</div>

<div id="bkmrk-dynamic-url-prefix-c"><div id="bkmrk-dynamic-url-prefix-c-1"><div>#### Dynamic URL Prefix Configuration

</div></div></div><div>When creating your template, the dynamic URL button requires a **URL prefix** that matches your payment gateway’s domain. Use one of the following prefixes based on your PG:</div><div id="bkmrk-razorpay"><div id="bkmrk-razorpay-1"><div>##### Razorpay

</div></div></div><div><table><thead><tr><th><span>URL Prefix</span></th></tr></thead><tbody><tr><td><div>`https://rzp.io/rzp/`</div></td></tr><tr><td><div>`https://rzp.io/i/`</div></td></tr></tbody></table>

</div><div id="bkmrk-payu"><div id="bkmrk-payu-1"><div>##### PayU

</div></div></div><div><table><thead><tr><th><span>URL Prefix</span></th></tr></thead><tbody><tr><td><div>`https://pmny.in/PAYUMN/`</div></td></tr><tr><td><div>`https://api.payu.in/`</div></td></tr><tr><td><div>`https://u.payu.in/PAYUMN/`</div></td></tr></tbody></table>

</div><div id="bkmrk-cashfree"><div id="bkmrk-cashfree-1"><div>##### Cashfree

</div></div></div><div><table><thead><tr><th><span>URL Prefix</span></th></tr></thead><tbody><tr><td><div>`https://payments.cashfree.com/links`</div></td></tr><tr><td><div>`https://payments.cashfree.com/link/`</div></td></tr><tr><td><div>`https://cfre.in/CSHFRE/`</div></td></tr></tbody></table>

</div>> <div>**Note**: The URL prefix you configure in your template must match the format of payment links generated by your PG. When sending the message, pass only the dynamic portion (e.g., the link ID) in the button parameter.</div>

<div id="bkmrk-payment-link-require"><div id="bkmrk-payment-link-require-1"><div>### Payment Link Requirements

</div></div></div><div><table><thead><tr><th><span>Requirement</span></th><th><span>Details</span></th></tr></thead><tbody><tr><td><div>Environment</div></td><td><div>Must be from production environment (not sandbox/test mode)</div></td></tr><tr><td><div>Status</div></td><td><div>Link must be active and not expired</div></td></tr><tr><td><div>Gateway</div></td><td><div>Must be from a supported PG (see [Supported Payment Gateways](#bkmrk-supported-payment-ga-1))</div></td></tr><tr><td><div>URL Format</div></td><td><div>Must match one of the supported URL prefixes for your PG</div></td></tr></tbody></table>

</div><div><span></span><div>**Using wrapped or redirected payment links?** Enhanced Payment Links requires direct payment gateway URLs that match the [supported URL prefixes](#bkmrk-dynamic-url-prefix-c-1). If your implementation wraps payment gateway links under your own domain (e.g., `yourdomain.com/pay/...`) or redirects to the payment gateway from a hosted page, the enhanced experience will not render automatically. In such cases, you will need to update your workflow to pass the direct payment gateway link in the template button instead of your wrapped or redirected URL.</div></div><div id="bkmrk-generating-payment-l"><div id="bkmrk-generating-payment-l-1"><div>#### Generating Payment Links

</div></div></div><div>Refer to your payment gateway’s documentation:</div>
<span>**Razorpay**: [Create Payment Link (API)<span>⁠</span>](https://l.facebook.com/l.php?u=https%3A%2F%2Frazorpay.com%2Fdocs%2Fapi%2Fpayments%2Fpayment-links%2Fcreate-standard%2F&h=AT6x8UuYubBo7_o0nWKLaGwT5USw8gtg0Sy-AvJyabDE516EqlCpX2z2aD1im_6A7qO-0pi-XEwE6F07SHCfj-ddPOXb5XSFJGdyIv6hYOpJfKphZVLrt5iLPyJu9rcUzfMgpKTH64XOL2LIEUfRmQ)[Dashboard<span>⁠</span>](https://l.facebook.com/l.php?u=https%3A%2F%2Frazorpay.com%2Fdocs%2Fpayments%2Fpayment-links%2Fcreate%2F&h=AT6x8UuYubBo7_o0nWKLaGwT5USw8gtg0Sy-AvJyabDE516EqlCpX2z2aD1im_6A7qO-0pi-XEwE6F07SHCfj-ddPOXb5XSFJGdyIv6hYOpJfKphZVLrt5iLPyJu9rcUzfMgpKTH64XOL2LIEUfRmQ)</span><span>**PayU**: [Payment Links<span>⁠</span>](https://l.facebook.com/l.php?u=https%3A%2F%2Fdocs.payu.in%2Freference%2Fcreate-payment-links&h=AT6x8UuYubBo7_o0nWKLaGwT5USw8gtg0Sy-AvJyabDE516EqlCpX2z2aD1im_6A7qO-0pi-XEwE6F07SHCfj-ddPOXb5XSFJGdyIv6hYOpJfKphZVLrt5iLPyJu9rcUzfMgpKTH64XOL2LIEUfRmQ)</span><span>**Cashfree**: [Payment Links<span>⁠</span>](https://l.facebook.com/l.php?u=https%3A%2F%2Fwww.cashfree.com%2Fdocs%2Fpayments%2Fno-code%2Fpayment-link&h=AT6x8UuYubBo7_o0nWKLaGwT5USw8gtg0Sy-AvJyabDE516EqlCpX2z2aD1im_6A7qO-0pi-XEwE6F07SHCfj-ddPOXb5XSFJGdyIv6hYOpJfKphZVLrt5iLPyJu9rcUzfMgpKTH64XOL2LIEUfRmQ)</span><div id="bkmrk-payment-reconciliati"><div id="bkmrk-payment-reconciliati-1"><div>### Payment Reconciliation and Callbacks

</div></div></div><div>Enhanced Payment Links does not modify your existing payment processing or backend infrastructure. This means:</div><div><table><thead><tr><th><span>Aspect</span></th><th><span>Impact</span></th></tr></thead><tbody><tr><td><div>**Payment callbacks/webhooks**</div></td><td><div>No change. Your existing webhook endpoints and callback flows from your payment gateway continue to work as-is.</div></td></tr><tr><td><div>**Reconciliation**</div></td><td><div>No change. Reconciliation remains the same as configured on your payment gateway (Razorpay, PayU, or Cashfree).</div></td></tr><tr><td><div>**Settlement**</div></td><td><div>No change. Settlement flows and timelines are unaffected.</div></td></tr></tbody></table>

</div><div>No backend integration changes are required to adopt Enhanced Payment Links.</div><div id="bkmrk-reporting"><div id="bkmrk-reporting-1"><div>### Reporting

</div></div></div><div>Reporting for Enhanced Payment Links is split across two sources:</div><div><table><thead><tr><th><span>Metric</span></th><th><span>Source</span></th><th><span>Details</span></th></tr></thead><tbody><tr><td><div>**Link clicks**</div></td><td><div>WhatsApp</div></td><td><div>Click metrics on payment gateway links are available from WhatsApp analytics.</div></td></tr><tr><td><div>**Payment status, success/failure rates, refunds, settlements**</div></td><td><div>Payment gateway</div></td><td><div>All payment-level reporting remains on your payment gateway (Razorpay, PayU, or Cashfree). Use your existing dashboards and reports.</div></td></tr></tbody></table>

</div><div>No additional reporting setup is required. WhatsApp provides visibility into link engagement, while your payment gateway continues to be the source of truth for all payment and transaction metrics.</div><div id="bkmrk-best-practices"><div id="bkmrk-best-practices-1"><div>### Best Practices

</div></div></div><div><table><thead><tr><th><span>Practice</span></th><th><span>Details</span></th></tr></thead><tbody><tr><td><div>**Use production links**</div></td><td><div>Sandbox/test links will not render enhanced bubbles</div></td></tr><tr><td><div>**Set reasonable expiry**</div></td><td><div>24-48 hours balances conversion and security</div></td></tr><tr><td><div>**Include context**</div></td><td><div>Add amount and order details in the message body</div></td></tr><tr><td><div>**One button only**</div></td><td><div>Multiple buttons are not supported</div></td></tr><tr><td><div>**Match URL prefix**</div></td><td><div>Ensure template URL prefix matches your PG’s link format</div></td></tr></tbody></table>

</div><div id="bkmrk-limitations"><div id="bkmrk-limitations-1"><div>### Limitations

</div></div></div>
<span>Only **one payment link** per template message</span><span>**No header** components allowed</span><span>**Single button** required</span><span>Enhanced rendering depends on recipient’s WhatsApp version</span><span>Currently available for **India** only</span><span>**Payment metrics behavior**: Enhanced Payment Links create a UPI intent on every “Pay now” tap. This means: </span>
<span>Total payment attempt counts will be higher than pre-EPL</span><span>Expired intents are reported as failures, which may inflate failure rates (eg: Razorpay webhooks for expired UPI intents: “Payment was unsuccessful as you could not complete it in time”)</span><span>**Recommendation**: Exclude payment expiry errors when calculating your success metrics.</span><div id="bkmrk-troubleshooting"><div id="bkmrk-troubleshooting-1"><div>### Troubleshooting

</div></div></div><div id="bkmrk-payment-link-not-ren"><div id="bkmrk-payment-link-not-ren-1"><div>#### Payment link not rendering as enhanced bubble

</div></div></div><div><table><thead><tr><th><span>Check</span></th><th><span>Action</span></th></tr></thead><tbody><tr><td><div>WABA allowlisted?</div></td><td><div>Confirm with your BSP or Meta representative</div></td></tr><tr><td><div>Supported PG?</div></td><td><div>Must be Razorpay, PayU, or Cashfree</div></td></tr><tr><td><div>URL prefix correct?</div></td><td><div>Template URL prefix must match your PG’s supported formats</div></td></tr><tr><td><div>Link active?</div></td><td><div>Verify link hasn’t expired</div></td></tr><tr><td><div>Template compliant?</div></td><td><div>No header, single dynamic URL button</div></td></tr></tbody></table>

</div>> <div>**Note**: If your template gets miscategorized, you can appeal the assigned category. See the [Template Categorization Guide](/books/meta-whatsapp/page/template-categorization-developer-documentation) for details on the appeal process. To avoid categorization uncertainty altogether, consider using a [**Utility Template**](/books/meta-whatsapp/page/template-library-developer-documentation) from the template library, this ensures correct categorization and provides guidance on template content structure.</div>

<div id="bkmrk-getting-help"><div id="bkmrk-getting-help-1"><div>### Getting Help

</div></div></div>
<span>**Direct API users or Meta Managed Businesses**: Contact your Meta representative</span><span>**BSP partners**: Reach out to your BSP for integration support</span><span>**Payment gateway issues**: Consult your PG’s documentation or support team</span>---

<div>*See also: [Message Templates](https://developers.facebook.com/docs/whatsapp/business-management-api/message-templates), [Cloud API Messages](/books/meta-whatsapp/page/sending-messages-developer-documentation), [Payments Overview](/books/meta-whatsapp/page/payments-api-india-developer-documentation)*</div></div>

# Send order details template message | Developer Documentation

<div id="bkmrk-send-order-details-t">## Send order details template message

<div><span>Updated: Oct 31, 2025</span></div><div id="bkmrk-overview"><div id="bkmrk-overview-1"><div>### Overview

</div></div></div><div>Order details message template is a template with [interactive components](/books/meta-whatsapp/page/templates-developer-documentation) that extends the call-to-action button to support sending order details and provides a richer experience compared to templates with only text components.</div><div>Once your Order details message templates have been created and approved, you can use the approved template to send the template message with order or bill information to prompt them to make a payment.</div><div>Before sending an order details template message, businesses need to create a template with an “open order details” call-to-action button. See [Create Message Templates for Your WhatsApp Business Account<span>⁠</span>](https://www.facebook.com/business/help/2055875911147364?id=2129163877102343) for more information on prerequisites and how to create a template.</div><div id="bkmrk-creating-an-order-de"><div id="bkmrk-creating-an-order-de-1"><div>### Creating an order details template on WhatsApp Manager

</div></div></div><div>To create an order details template, business needs a business portfolio with a WhatsApp Business Account.</div><div>In **WhatsApp Manager** &gt; **Account tools**:</div><span>Click on `create template`</span><span>Select `Utility` category to expand `Order details message` option</span><span>Enter the desired `template name` and supported `locale`</span> <span>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.</span><span>Please fill in template components such as `Header`, `Body` and optional `footer` text and submit.</span><span>Once submitted, templates will be [categorized as per the guidelines](/books/meta-whatsapp/page/template-categorization-developer-documentation) and undergo the [approval process](/books/meta-whatsapp/page/template-review-developer-documentation) refrain from having [marketing content](/books/meta-whatsapp/page/template-categorization-developer-documentation) as part of template components.</span><span>The template will be approved or rejected after the template components are verified by the system. </span><span>If business believe the category determined is not consistent with our template category guidelines, please confirm there are no [common issues](/books/meta-whatsapp/page/template-review-developer-documentation) that leads to rejections and if you are looking for further clarification you may [request a review](/books/meta-whatsapp/page/template-categorization-developer-documentation) of the template via [Business Support<span>⁠</span>](https://business.facebook.com/business-support-home/)</span><span>Once approved template [status](/books/meta-whatsapp/page/templates-developer-documentation) will be changed to `ACTIVE`</span> <span>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](/books/meta-whatsapp/page/template-review-developer-documentation) and take appropriate actions whenever such change occurs.</span><div><div>![Image](https://support2.chatarchitect.com/uploads/images/gallery/2026-04/embedded-image-peo8ghft.jpeg)</div></div><div id="bkmrk-sending-order-detail"><div id="bkmrk-sending-order-detail-1"><div>### Sending order details template message

</div></div></div><div>Order details template message allows the businesses to send invoice(order_details) message as predefined `Open order details` call-to-action button component parameters. It supports businesses to send all payment integration (such as [UPI Intent](/documentation/business-messaging/whatsapp/payments/payments-in/upi-intent#step-2--assemble-the-interactive-object), [Payment Gateway](/books/meta-whatsapp/page/receive-payments-via-payment-gateways-on-whatsapp-developer-documentation) or [Payment Links](/books/meta-whatsapp/page/accept-payments-via-payment-links-developer-documentation)) integration as button parameters.</div><div>To send an order details template message, make a `POST` call to `/PHONE_NUMBER_ID/messages` endpoint and attach a message object with `type=template`. Then, add a template object with a predefined `Open order details` call-to-action button.</div><div>For example following sample describes how to send [UPI Intent](/documentation/business-messaging/whatsapp/payments/payments-in/upi-intent#step-2--assemble-the-interactive-object) in order details template message parameters to prompt the consumer to make a payment.</div><div>The below example shows an example payload with `upi` as the payment type. For other variants of the `payment_settings` block (for example, for the type `payment_gateway` type), refer to this [document](/books/meta-whatsapp/page/receive-payments-via-payment-gateways-on-whatsapp-developer-documentation).</div><div>Once the order details template message is delivered, a successful response will include an object with an identifier prefixed with wamid. Use the ID listed after wamid to track your message status.</div><div id="bkmrk-post-order-details-t"><div id="bkmrk-post-order-details-t-1"><div>### Post order details template message flow

</div></div></div><div>After the order details template message delivery the rest of the payment flow is the same as “Sending invoice in customer session window” and depends on the chosen [payment integration](/books/meta-whatsapp/page/payments-api-india-developer-documentation) order details parameters. For more details refer [UPI Intent](/documentation/business-messaging/whatsapp/payments/payments-in/upi-intent#step-5--consumer-pays-for-the-order), [Payment Gateway](/books/meta-whatsapp/page/receive-payments-via-payment-gateways-on-whatsapp-developer-documentation) and [Payment Links](/books/meta-whatsapp/page/accept-payments-via-payment-links-developer-documentation) post payments flows.</div></div>

# Send order status template message | Developer Documentation

<div id="bkmrk-send-order-status-te">## Send order status template message

<div><span>Updated: Nov 14, 2025</span></div><div id="bkmrk-overview"><div id="bkmrk-overview-1"><div>### Overview

</div></div></div><div>An Order status template is a template with interactive [components](/books/meta-whatsapp/page/template-components-developer-documentation) that extends the call-to-action button to support updating order status through a template. It allows the businesses to update the order status outside of the [customer session window](/books/meta-whatsapp/page/sending-messages-developer-documentation) in use cases such as charging the card for past order and updating about a shipment on order placed in the past.</div><div>Upon receiving the payment signals, the businesses must update the order status to keep the user up to date. Currently we support the following order status values</div><div>![](https://support2.chatarchitect.com/uploads/images/gallery/2026-04/embedded-image-l52f0oty.jpeg)</div><div><table><thead><tr><th><span>Value </span></th><th><span>Description </span></th></tr></thead><tbody><tr><td><div><div>`pending`</div></div></td><td><div><div>User has not successfully paid yet</div></div></td></tr><tr><td><div><div>`processing`</div></div></td><td><div><div>User payment authorized, merchant/partner is fulfilling the order, performing service, etc.</div></div></td></tr><tr><td><div><div>`partially-shipped`</div></div></td><td><div><div>A portion of the products in the order have been shipped by the merchant</div></div></td></tr><tr><td><div><div>`shipped`</div></div></td><td><div><div>All the products in the order have been shipped by the merchant</div></div></td></tr><tr><td><div><div>`completed`</div></div></td><td><div><div>The order is completed and no further action is expected from the user or the partner/merchant</div></div></td></tr><tr><td><div><div>`canceled`</div></div></td><td><div><div>The partner/merchant would like to cancel the `order_details` message for the order/invoice. The status update will fail if there is already a `successful` or `pending` payment for this `order_details` message</div></div></td></tr></tbody></table>

</div><div id="bkmrk-creating-an-order-st"><div id="bkmrk-creating-an-order-st-1"><div>### Creating an order status template

</div></div></div><div>To create an order status template, the business needs a business portfolio with a WhatsApp Business Account, and access to the WhatsApp Manager.</div><div>In **WhatsApp Manager** &gt; **Account tools**:</div><span>Click on `create template`</span><span>Select `Utility` category to expand `Order details message` option</span><span>Enter the desired `template name` and supported `locale`</span> <span>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.</span><span>Please fill in template components such as `Body` and optional `footer` text and submit.</span><span>Once submitted, templates will be [categorized as per the guidelines](/books/meta-whatsapp/page/template-categorization-developer-documentation) and undergo the [approval process](/books/meta-whatsapp/page/template-review-developer-documentation) refrain from having [marketing content](/books/meta-whatsapp/page/template-categorization-developer-documentation) as part of template components.</span><span>The template will be approved or rejected after the template components are verified by the system. </span><span>If business believe the category determined is not consistent with our template category guidelines, please confirm there are no [common issues](/books/meta-whatsapp/page/template-review-developer-documentation) that leads to rejections and if you are looking for further clarification you may [request a review](/books/meta-whatsapp/page/template-categorization-developer-documentation) of the template via [Business Support<span>?</span>](https://business.facebook.com/business-support-home/)</span><span>Once approved template [status](/books/meta-whatsapp/page/templates-developer-documentation) will be changed to `ACTIVE`</span> <span>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](/books/meta-whatsapp/page/template-review-developer-documentation) and take appropriate actions whenever such change occurs.</span><div>![](https://support2.chatarchitect.com/uploads/images/gallery/2026-04/embedded-image-r7peyd1l.gif)</div><div id="bkmrk-sending-order-status"><div id="bkmrk-sending-order-status-1"><div>### Sending order status template message

</div></div></div><div>Order status template message allows the businesses to send update on the status of the order as template component parameters.</div><div>To send an order status template message, make a `POST` call to `/<PHONE_NUMBER_ID>/messages` endpoint and attach a message object with `type=template`. Then, add a [template object](/books/meta-whatsapp/page/sending-messages-developer-documentation) with a `order_status` component and parameters with latest status on order with order `reference-id`.</div><div>For example, the following sample describes how to send `shipped` status on the placed order.</div><div>Upon sending an `order_status` message with an invalid transition, you will receive an error webhook with the error code `2046` and message `New order status was not correctly transitioned`.</div><div id="bkmrk-canceling-an-order"><div id="bkmrk-canceling-an-order-1"><div>### Canceling an order

</div></div></div><div>An order can be canceled by sending an `order_status` message with the status `canceled`. The customer cannot pay for an order that is canceled. The customer receives an `order_status` message and the order details page is updated to show that the order is canceled and the `Continue` button removed. The optional text shown below `Order canceled` on the order details page can be specified using the description field in the `order_status` message.</div><div>An order can be canceled only if the user has not already paid for the order. If the user has paid and the business sends a order_status message with canceled status will receive an error webhook with error code `2047` and message `Could not change order status to 'canceled'`.</div></div>

# Checkout button templates | Developer Documentation

<div id="bkmrk-checkout-button-temp">## Checkout button templates

<div><span>Updated: Dec 12, 2025</span></div><div>Checkout button templates are marketing templates that can showcase one or more products along with corresponding checkout buttons that WhatsApp users can use to make purchases without leaving the WhatsApp client.</div><div>![](https://support2.chatarchitect.com/uploads/images/gallery/2026-04/embedded-image-gyxg9c9a.png)</div><div id="bkmrk-single-products"><div id="bkmrk-single-products-1"><div>### Single products

</div></div></div><div>Checkout button templates can show a single product image or video header, along with message body text, message footer, a single checkout button, and up to 9 quick-reply buttons.</div><div>![](https://support2.chatarchitect.com/uploads/images/gallery/2026-04/embedded-image-u0vhfjld.png)</div><div>WhatsApp users who tap the button will see details of the order:</div><div>![](https://support2.chatarchitect.com/uploads/images/gallery/2026-04/embedded-image-txg1wz1x.png)</div><div>Users can proceed by selecting shipping information provided by you (if you know their information and supplied it in the send message payload)...</div><div>![](https://support2.chatarchitect.com/uploads/images/gallery/2026-04/embedded-image-vmohjguv.png)</div><div>... or can add their own shipping information:</div><div>![](https://support2.chatarchitect.com/uploads/images/gallery/2026-04/embedded-image-8vkvxk71.png)</div><div id="bkmrk-enabling-coupons%2C-re"><div id="bkmrk-enabling-coupons%2C-re-1"><div>### Enabling coupons, realtime inventory, and pricing updates

</div></div></div><div><div>Enabling coupons, realtime inventory and pricing updates is currently in beta and only available to India businesses and WhatsApp users with an India country calling code. Please reach out to whatsappindia-bizpayments-support@meta.com to know more.</div></div><div>To enable coupons, realtime inventory and pricing updates, you can set up a checkout endpoint that can exchange data in real time to update the order on the WhatsApp client. It enables businesses to receive the shipping address and offers coupons based on the order and allows users to apply the coupon. It also enables businesses to validate inventory and serviceability on the order before the user completes the checkout.</div><div>Setting up the checkout endpoint consists of the following steps and it's the same method that [WhatsApp Flows endpoint](https://developers.facebook.com/docs/whatsapp/flows/guides/implementingyourflowendpoint#implementing-endpoint-for-flows) uses to share the data with WhatsApp clients.</div><span>Create a key pair and upload and sign the public key using the [Cloud API](https://developers.facebook.com/docs/whatsapp/cloud-api/reference/whatsapp-business-encryption#set-business-public-key).</span><span>[Setup the endpoint](#bkmrk-set-up-the-endpoint-1)</span><span>[Implement Payload Encryption/Decryption](#bkmrk-implement-encryption-1)</span><span>[Link the checkout endpoint with payment configuration](#bkmrk-link-the-checkout-en-1)</span><span>[Implement checkout endpoint logic](#bkmrk-implement-checkout-e-1)</span><div id="bkmrk-set-up-the-endpoint"><div id="bkmrk-set-up-the-endpoint-1"><div>#### Set up the endpoint

</div></div></div><div>WhatsApp client makes a HTTPS request to exchange the data with the business endpoint. You should make sure the endpoint is configured probably to accept the request and link the endpoint url with the [payment configuration](/books/meta-whatsapp/page/receive-payments-via-payment-gateways-on-whatsapp-developer-documentation):</div><div><div>```
<span><span>https://business.com/checkout</span></span><br></br>
```

</div></div><div>Your server must be enabled to receive and process `POST` requests, use `HTTPS` and have a valid TLS/SSL certificate installed. This certificate does not have to be used in payload encryption/decryption.</div><div id="bkmrk-implement-encryption"><div id="bkmrk-implement-encryption-1"><div>#### Implement Encryption/Decryption

</div></div></div><div>The body of each request contains the encrypted payload and has the following form:</div><div id="bkmrk-sample-endpoint-requ"><div id="bkmrk-sample-endpoint-requ-1"><div>##### Sample endpoint request syntax

</div></div></div><div><div>```
<span><span>{</span></span><br></br><span><span>  encrypted_flow_data: "</span><span><</span><span>ENCRYPTED_FLOW_DATA</span><span>></span><span>",</span></span><br></br><span><span>  encrypted_aes_key: "</span><span><</span><span>ENCRYPTED_AES_KEY</span><span>></span><span>",</span></span><br></br><span><span>  initial_vector: "</span><span><</span><span>INITIAL_VECTOR</span><span>></span><span>"</span></span><br></br><span><span>}</span></span><br></br>
```

</div></div><div><table><thead><tr><th><span>Parameter </span></th><th><span>Description </span></th></tr></thead><tbody><tr><td><div><div>`encrypted_flow_data` string</div></div></td><td><div><div>**Required.** The encrypted request payload.</div></div></td></tr><tr><td><div><div>`encrypted_aes_key` string</div></div></td><td><div><div>**Required.** The encrypted 128-bit AES key.</div></div></td></tr><tr><td><div><div>`initial_vector` string</div></div></td><td><div><div>**Required.** The 128-bit initialization vector.</div></div></td></tr></tbody></table>

</div><div>After processing the decrypted request, create a response and encrypt it before sending it back to the WhatsApp client. Encrypt the payload using the AES key received in the request and send it back as a Base64 string.</div><div>You can refer to examples of how to [decrypt and encrypt](https://developers.facebook.com/docs/whatsapp/flows/guides/implementingyourflowendpoint#request-decryption-and-encryption).</div><div>If a request can not be decrypted, the endpoint should return HTTP 421 response status code (see [Business Endpoint Error Codes](https://developers.facebook.com/docs/whatsapp/flows/reference/error-codes#endpoint_error_codes) for more details).</div><div id="bkmrk-link-the-checkout-en"><div id="bkmrk-link-the-checkout-en-1"><div>#### Link the checkout endpoint with payment configuration

</div></div></div><div><div>The business should have payment gateway based [payment configuration](/books/meta-whatsapp/page/receive-payments-via-payment-gateways-on-whatsapp-developer-documentation) and reach out to whatsappindia-bizpayments-support@meta.com to enable the WhatsApp business account for checkout endpoint linking with with payment configuration.</div></div><div>Prior to linking the checkout endpoint, you should create a [payment configuration](/books/meta-whatsapp/page/receive-payments-via-payment-gateways-on-whatsapp-developer-documentation) and link with the payment gateway account. We advise you to use the linked payment configuration only with checkout button template integration.</div><div>You can achieve the endpoint linking with payment configuration by following [Onboarding API's - Link data endpoint](/books/meta-whatsapp/page/onboarding-apis-developer-documentation)</div><div id="bkmrk-implement-checkout-e"><div id="bkmrk-implement-checkout-e-1"><div>#### Implement checkout endpoint logic

</div></div></div><div>WhatsApp checkout endpoint integration inherits the 'data_exchange' similar to Flows and supports a set of subactions based on the user interaction and passes the relevant information in each of these actions to allow businesses to provide user specific coupons and enable businesses to update the pricing information accordingly.</div><div><table><thead><tr><th><span>Sub Action </span></th><th><span>Method </span></th><th><span>Description </span></th></tr></thead><tbody><tr><td><div><div>`get_coupons`</div></div></td><td><div><div>Request</div></div></td><td><div><div>When users click on a savings offer CTA, WhatsApp passes [order parameters](/books/meta-whatsapp/page/receive-payments-via-payment-gateways-on-whatsapp-developer-documentation) excluding the [payment settings](/books/meta-whatsapp/page/receive-payments-via-payment-gateways-on-whatsapp-developer-documentation). It also passes the `user phone number` as an input parameter.</div><div>Refer [get coupons request](#bkmrk-get-coupons---endpoi-1) example to understand the order and input parameters</div></div></td></tr><tr><td></td><td><div><div>Response</div></div></td><td><div><div>Checkout endpoint expected to pass the list of coupon information, such as code, id and description.</div><div>Refer [get coupons response](#bkmrk-get-coupons---endpoi-4) example to understand the expected response.</div></div></td></tr><tr><td><div><div>`apply_coupon`</div></div></td><td><div><div>Request</div></div></td><td><div><div>When users select or enter a coupon, WhatsApp passes [order parameters](/books/meta-whatsapp/page/receive-payments-via-payment-gateways-on-whatsapp-developer-documentation) excluding the [payment settings](/books/meta-whatsapp/page/receive-payments-via-payment-gateways-on-whatsapp-developer-documentation). It also passes the `user phone number` and information about the coupon to be applied as an input parameter.</div><div>Refer [apply coupon request](#bkmrk-apply-coupon---endpo-1) example to understand the order and input parameters</div></div></td></tr><tr><td></td><td><div><div>Response</div></div></td><td><div><div>Checkout endpoint expected to update the item and order pricing in [order parameters](/books/meta-whatsapp/page/receive-payments-via-payment-gateways-on-whatsapp-developer-documentation) and attach the coupon with the order</div><div>Refer to [apply coupon response](#bkmrk-apply-coupon---endpo-4) example to understand the expected response.</div></div></td></tr><tr><td><div><div>`remove_coupon`</div></div></td><td><div><div>Request</div></div></td><td><div><div>When users try to remove an applied coupon, WhatsApp passes [order parameters](/books/meta-whatsapp/page/receive-payments-via-payment-gateways-on-whatsapp-developer-documentation) excluding the [payment settings](/books/meta-whatsapp/page/receive-payments-via-payment-gateways-on-whatsapp-developer-documentation). It also passes the `user phone number` as an input parameter.</div><div>Refer [remove coupon request](#bkmrk-remove-coupon---endp-1) example to understand the expected response.</div></div></td></tr><tr><td></td><td><div><div>Response</div></div></td><td><div><div>Checkout endpoint expected to update the item and order pricing in [order parameters](/books/meta-whatsapp/page/receive-payments-via-payment-gateways-on-whatsapp-developer-documentation) and remove the coupon attached with the order.</div><div>Refer [remove coupon response](#bkmrk-remove-coupon---endp-4) example to understand the expected response.</div></div></td></tr><tr><td><div><div>`apply_shipping`</div></div></td><td><div><div>Request</div></div></td><td><div><div>When users try to submit a shipping address, WhatsApp passes [order parameters](/books/meta-whatsapp/page/receive-payments-via-payment-gateways-on-whatsapp-developer-documentation) excluding the [payment settings](/books/meta-whatsapp/page/receive-payments-via-payment-gateways-on-whatsapp-developer-documentation). It also passes the `user phone number` and shipping information as an input parameter.</div><div>Refer to the [apply shipping request](#bkmrk-apply-shipping---end-1) example to understand the expected response.</div></div></td></tr><tr><td></td><td><div><div>Response</div></div></td><td><div><div>Checkout endpoint expected to update the item and shipping pricing in [order parameters](/books/meta-whatsapp/page/receive-payments-via-payment-gateways-on-whatsapp-developer-documentation).</div><div>Refer to the [apply shipping response](#bkmrk-apply-shipping---end-4) example to understand the expected response.</div></div></td></tr></tbody></table>

</div><div>We have created a [checkout endpoint example<span>?</span>](https://l.facebook.com/l.php?u=https%3A%2F%2Fgithub.com%2FWhatsApp%2FWhatsApp-Checkout-Button-Template-Endpoint&h=AT5XJ5__rAvqCztGbeHJ8sRlVIHN6gj-TilwOCqgzP-_mvDzrR1DSAGz-ng9SY4wpndfQL7v0S7VGjBK0dCtiNA7oW1JzN8DyrpjA5K37diGYAEyTLPMb0zSmkKEVMl0_h-9J7RIi8kyGJ0NcvITWg) in Node.js that you can clone (remix) on Glitch to create your own endpoint and quickly prototype your checkout logic. Follow the instructions in the [README.md<span>?</span>](https://l.facebook.com/l.php?u=https%3A%2F%2Fgithub.com%2FWhatsApp%2FWhatsApp-Checkout-Button-Template-Endpoint%2Fblob%2Fmain%2FREADME.md&h=AT5XJ5__rAvqCztGbeHJ8sRlVIHN6gj-TilwOCqgzP-_mvDzrR1DSAGz-ng9SY4wpndfQL7v0S7VGjBK0dCtiNA7oW1JzN8DyrpjA5K37diGYAEyTLPMb0zSmkKEVMl0_h-9J7RIi8kyGJ0NcvITWg) file to get started. Using Glitch is entirely optional. You can clone the example code from Glitch and run it in any environment you prefer.</div><div>Upon completing the above steps, when business sends the checkout template with the linked payment configuration, WhatsApp enables the coupons, realtime inventory and pricing updates and allows users to apply coupons and share shipping addresses.</div><div>When enabled the `Apply a savings offer` will appear in the order summary screen</div><div><div>![Image](https://support2.chatarchitect.com/uploads/images/gallery/2026-04/embedded-image-g48eaifd.jpeg)</div></div><div>User can click on `Apply a savings offer` to explore the coupons, at this point WhatsApp makes `get_coupons` request to fetch the list coupons based on the passed order and `user phone number` information.</div><div><div>![Image](https://support2.chatarchitect.com/uploads/images/gallery/2026-04/embedded-image-nocbpcaq.jpeg)</div></div><div>When the user tries to apply a coupon, WhatsApp makes `apply_coupon` and allow businesses to update the order or item pricing based on the selected coupon.</div><div><div>![Image](https://support2.chatarchitect.com/uploads/images/gallery/2026-04/embedded-image-heqyrz6s.jpeg)</div></div><div>Similar to coupons, user can share the shipping address by clicking on `Add shipping address` and select the addresses saved with the businesses or add new address. WhatsApp makes `apply_shipping` request when user tries to submit the address and allow businesses to check inventory and logistics based on the address provided.</div><div><div>![Image](https://support2.chatarchitect.com/uploads/images/gallery/2026-04/embedded-image-v0clfrai.jpeg)![Image](https://support2.chatarchitect.com/uploads/images/gallery/2026-04/embedded-image-j5k8cmhz.jpeg)</div></div><div>Users can then continue to place the order using their preferred payment method set up in the WhatsApp client:</div><div>![](https://support2.chatarchitect.com/uploads/images/gallery/2026-04/embedded-image-1yh6utz2.png)</div><div>Once the order is processed, a [payment webhook](/books/meta-whatsapp/page/receive-payments-via-payment-gateways-on-whatsapp-developer-documentation) is triggered.</div><div id="bkmrk-multiple-products"><div id="bkmrk-multiple-products-1"><div>### Multiple products

</div></div></div><div>You can create a [media card carousel template](/documentation/business-messaging/whatsapp/templates/marketing-templates/media-card-carousel-templates) that showcases up to 10 products in a card carousel, each with their own checkout button. To do this, simply create a media card carousel template as you normally would, but replace one of the buttons with a [checkout button](#bkmrk-checkout-buttons-1), and make sure that it is the first button in the card.</div><div>Checkout buttons in media card carousel templates trigger the same order and payment flow as checkout buttons in templates that showcase a single product.</div><div id="bkmrk-checkout-buttons"><div id="bkmrk-checkout-buttons-1"><div>### Checkout buttons

</div></div></div><div>Each checkout button in a template must correspond to a single product. Checkout buttons, when creating a template, must have the following non-customizable syntax:</div><div>Note that this is simply a button definition. The actual details about the product that maps to this button are included when you [send the template](#bkmrk-send-a-checkout-butt-1) in a template message. For example:</div><div>If you are sending a [media card carousel template](/documentation/business-messaging/whatsapp/templates/marketing-templates/media-card-carousel-templates) (which can have two or more products), each checkout button must be defined in the template, and the item details that map to each button must be included when sending the template.</div><div id="bkmrk-send-a-checkout-butt"><div id="bkmrk-send-a-checkout-butt-1"><div>### Send a checkout button template

</div></div></div><div>Once your checkout button template or carousel template has been approved, you can send it in a template message.</div><div id="bkmrk-post-body-3"><div id="bkmrk-post-body-4"><div>#### Post body

</div></div></div><div>This post body syntax is for a checkout button template. See [Sending Media Card Carousel Templates](/documentation/business-messaging/whatsapp/templates/marketing-templates/media-card-carousel-templates) for media card carousel template post body payload syntax.</div><div id="bkmrk-post-body-parameters-3"><div id="bkmrk-post-body-parameters-4"><div>#### Post body parameters

</div></div></div><div><table><thead><tr><th><span>Placeholder </span></th><th><span>Description </span></th><th><span>Example Value </span></th></tr></thead><tbody><tr><td><div><div>`<DISCOUNT_AMOUNT>`</div><div>*Integer*</div></div></td><td><div><div>**Required if using a discount.**</div><div>Discount amount, multiplied by discount.offset value.</div><div>For example, to represent a discount of ?2, the value would be `200`.</div><div>Discount amount applies to the order subtotal.</div></div></td><td><div><div>`15000`</div></div></td></tr><tr><td><div><div>`<DISCOUNT_DESCRIPTION>`</div><div>*String*</div></div></td><td><div><div>**Optional.**</div><div>Discount description.</div><div>Maximum 60 characters.</div></div></td><td><div><div>`Additional 10% off`</div></div></td></tr><tr><td><div><div>`<EXPIRATION_TIMESTAMP>`</div><div>*String*</div></div></td><td><div><div>**Required if using an order expiration.**</div><div>UTC timestamp indicating when we should disable the **Buy now** button. The timestamp will be used to generate a text string that appears at the bottom of the **Order details** window. For example:</div><div>*This order expires on September 30, 2024 at 12:00 PM.*</div><div>WhatsApp users who view the message after this time will be unable to purchase the item using the checkout button.</div><div>Values must represent a UTC time at least 300 seconds from when the send message request is sent to us.</div></div></td><td><div><div>`1726692927`</div></div></td></tr><tr><td><div><div>`<IMPORTER_ADDRESS_LINE_1>`</div><div>*String*</div></div></td><td><div><div>**Required.**</div><div>Importer address, line 1 (door, tower, number, street, etc.).</div><div>Maximum 100 characters.</div></div></td><td><div><div>`One BKC`</div></div></td></tr><tr><td><div><div>`<IMPORTER_ADDRESS_LINE_2>`</div><div>*String*</div></div></td><td><div><div>**Optional.**</div><div>Importer address, line 2 (landmark, area, etc.).</div><div>Maximum 100 characters.</div></div></td><td><div><div>`Bandra Kurla Complex`</div></div></td></tr><tr><td><div><div>`<IMPORTER_CITY>`</div><div>*String*</div></div></td><td><div><div>**Required.**</div><div>Importer city.</div><div>Maximum 120 characters.</div></div></td><td><div><div>`Mumbai`</div></div></td></tr><tr><td><div><div>`<IMPORTER_NAME>`</div><div>*String*</div></div></td><td><div><div>**Required.**</div><div>Importer name.</div><div>Maximum 200 characters.</div></div></td><td><div><div>`Lucky Shrub Imports and Exports`</div></div></td></tr><tr><td><div><div>`<IMPORTER_POSTAL_CODE>`</div><div>*String*</div></div></td><td><div><div>**Required.**</div><div>Importer 6-digit postal index number.</div><div>Maximum 6 digits.</div></div></td><td><div><div>`400051`</div></div></td></tr><tr><td><div><div>`<IMPORTER_ZONE_CODE>`</div><div>*String*</div></div></td><td><div><div>**Required.**</div><div>Importer two-letter zone code.</div></div></td><td><div><div>`MH`</div></div></td></tr><tr><td><div><div>`<ITEM_COUNTRY_OF_ORIGIN>`</div><div>*String*</div></div></td><td><div><div>**Required.**</div><div>Item's country of origin.</div><div>Maximum 100 characters.</div></div></td><td><div><div>`India`</div></div></td></tr><tr><td><div><div>`<ITEM_NAME>`</div><div>*String*</div></div></td><td><div><div>**Required.**</div><div>Item name.</div><div>Maximum 60 characters.</div></div></td><td><div><div>`Blue Elf Aloe`</div></div></td></tr><tr><td><div><div>`<ITEM_PRICE>`</div><div>*Integer*</div></div></td><td><div><div>**Required.**</div><div>Individual item price (price per item), multiplied by amount.offset value.</div><div>For example, to represent an item price of ?12.99, the value would be `1299`.</div></div></td><td><div><div>`200000`</div></div></td></tr><tr><td><div><div>`<ITEM_QUANTITY>`</div><div>*Integer*</div></div></td><td><div><div>**Required.**</div><div>Number of items in order, if order is placed.</div><div>Maximum 100 integers.</div></div></td><td><div><div>`1`</div></div></td></tr><tr><td><div><div>`<MESSAGE_BODY_TEXT_VARIABLE>`</div><div>*Object*</div></div></td><td><div><div>**Required if template message body text uses variables, otherwise omit.**</div><div>Object describing a message variable. If the template uses multiple variables, you must define an object for each variable.</div><div>Supports `text`, `currency`, and `date_time` types. See [Messages Parameters](/books/meta-whatsapp/page/sending-messages-developer-documentation).</div><div>There is no maximum character limit on this value, but it does count against the message body text limit of 1024 characters.</div></div></td><td></td></tr><tr><td><div><div>`<MESSAGE_HEADER_ASSET_ID>`</div><div>*String*</div></div></td><td><div><div>**Required.**</div></div></td><td><div><div>`1558081531584829`</div></div></td></tr><tr><td><div><div>`<MESSAGE_HEADER_FORMAT>`</div><div>*String*</div></div></td><td><div><div>**Required.**</div><div>Indicates header type and a matching property name.</div><div>Note that the `<MESSAGE_HEADER_FORMAT>` placeholder appears twice in the post body example above, as it serves as a placeholder for the type property's value and its matching property name.</div><div>Value can be `image` or `video`.</div></div></td><td><div><div>`image`</div></div></td></tr><tr><td><div><div>`<PAYMENT_GATEWAY_CONFIGURATION_NAME>`</div><div>*String*</div></div></td><td><div><div>**Required.**</div><div>Configuration name of payment gateway you have [configured](/books/meta-whatsapp/page/onboarding-apis-developer-documentation) on your WhatsApp Business Account.</div></div></td><td><div><div>`prod-razor-pay-config-05`</div></div></td></tr><tr><td><div><div>`<PAYMENT_GATEWAY_NAME>`</div><div>*String*</div></div></td><td><div><div>**Required.**</div><div>Name of payment gateway you have [configured](/books/meta-whatsapp/page/onboarding-apis-developer-documentation) on your WhatsApp Business Account.</div><div>Values can be:</div><span>`razorpay`</span><span>`payu`</span><span>`zaakpay`</span></div></td><td><div><div>`razorpay`</div></div></td></tr><tr><td><div><div>`<PRODUCT_TYPE>`</div><div>*String*</div></div></td><td><div><div>**Required.**</div><div>Product type. Value can be `digital-goods` or `physical-goods`.</div></div></td><td><div><div>`digital-goods`</div></div></td></tr><tr><td><div><div>`<QUICK_REPLY_BUTTON_PAYLOAD>`</div><div>*String*</div></div></td><td><div><div>**Optional.**</div><div>Value to be included in messages webhooks (`messages.button.payload`) when the button is tapped.</div></div></td><td><div><div>`opt-out`</div></div></td></tr><tr><td><div><div>`<REFERENCE_ID>`</div><div>*String*</div></div></td><td><div><div>**Required.**</div><div>Your unique order or invoice reference ID. Case-sensitive. Cannot be empty. Will be preceded by a hash (#) symbol in the checkout flow.</div><div>Value must be unique for each checkout button template message. If sending a carousel template, each checkout button must have a unique reference ID.</div><div>If you need to send multiple messages for the same order/invoice, it is recommended to append a sequence number to the value (for example, -1).</div><div>Values can only contain English letters, numbers, underscores, dashes, or dots.</div><div>Maximum 35 characters.</div></div></td><td><div><div>`abc.123_xyz-1`</div></div></td></tr><tr><td><div><div>`<SALE_PRICE>`</div><div>*Integer*</div></div></td><td><div><div>**Required if using a sale amount.**</div><div>Sale price, multiplied by `sale.offset` value.</div><div>For example, to represent a sale price of ?10, the value would be `1000`.</div></div></td><td><div><div>`150000`</div></div></td></tr><tr><td><div><div>`<SHIPPING_AMOUNT>`</div><div>*Integer*</div></div></td><td><div><div>**Required.**</div><div>Order shipping cost, multiplied by `shipping.offset` value.</div><div>For example, to represent a shipping cost of ?.99, the value would be `99`.</div></div></td><td><div><div>`20000`</div></div></td></tr><tr><td><div><div>`<SHIPPING_INFO_ADDRESS>`</div><div>*String*</div></div></td><td><div><div>**Required if you know the recipient's shipping information.**</div><div>Product recipient's address.</div><div>Maximum 512 characters.</div></div></td><td><div><div>`Bandra Kurla Complex`</div></div></td></tr><tr><td><div><div>`<SHIPPING_INFO_BUILDING_NAME>`</div><div>*String*</div></div></td><td><div><div>**Optional.**</div><div>Product recipient's building name.</div><div>Maximum 128 characters.</div></div></td><td><div><div>`One BKC`</div></div></td></tr><tr><td><div><div>`<SHIPPING_INFO_CITY>`</div><div>*String*</div></div></td><td><div><div>**Required if you know the recipient's shipping information.**</div><div>Full name of product recipient's city.</div><div>Maximum 100 characters.</div></div></td><td><div><div>`Mumbai`</div></div></td></tr><tr><td><div><div>`<SHIPPING_INFO_FLOOR_NUMBER>`</div><div>*String*</div></div></td><td><div><div>**Optional.**</div><div>Product recipient's floor number.</div><div>Maximum 10 characters.</div></div></td><td><div><div>`2`</div></div></td></tr><tr><td><div><div>`<SHIPPING_INFO_HOUSE_NUMBER>`</div><div>*String*</div></div></td><td><div><div>**Optional.**</div><div>Product recipient's house number.</div><div>Maximum 8 characters.</div></div></td><td><div><div>`12`</div></div></td></tr><tr><td><div><div>`<SHIPPING_INFO_INDIA_PIN>`</div><div>*String*</div></div></td><td><div><div>**Required if you know the recipient's shipping information.**</div><div>Product recipient's postal index number.</div><div>Maximum 6 characters.</div></div></td><td><div><div>`400051`</div></div></td></tr><tr><td><div><div>`<SHIPPING_INFO_LANDMARK_AREA>`</div><div>*String*</div></div></td><td><div><div>**Optional.**</div><div>Product recipient's landmark area.</div><div>Maximum 128 characters.</div></div></td><td><div><div>`Near BKC Circle`</div></div></td></tr><tr><td><div><div>`<SHIPPING_INFO_NAME>`</div><div>*String*</div></div></td><td><div><div>**Required if you know the recipient's shipping information.**</div><div>Product recipient's full name.</div><div>Maximum 256 characters.</div></div></td><td><div><div>`Nidhi Tripathi`</div></div></td></tr><tr><td><div><div>`<SHIPPING_INFO_PHONE_NUMBER>`</div><div>*String*</div></div></td><td><div><div>**Required if you know the recipient's shipping information.**</div><div>Product recipient's WhatsApp phone number.</div><div>Maximum 12 characters.</div></div></td><td><div><div>`919000090000`</div></div></td></tr><tr><td><div><div>`<SHIPPING_INFO_STATE>`</div><div>*String*</div></div></td><td><div><div>**Required if you know the recipient's shipping information.**</div><div>Full name of product recipient's state.</div><div>Maximum 100 characters.</div></div></td><td><div><div>`Maharastra`</div></div></td></tr><tr><td><div><div>`<SHIPPING_INFO_TOWER_NUMBER>`</div><div>*String*</div></div></td><td><div><div>**Optional.**</div><div>Product recipient's tower number.</div><div>Maximum 8 characters.</div></div></td><td><div><div>`2`</div></div></td></tr><tr><td><div><div>`<SUBTOTAL_AMOUNT>`</div><div>*Integer*</div></div></td><td><div><div>**Required.**</div><div>Order subtotal. Calculate by multiplying `<ITEM_PRICE>` by `<ITEM_QUANTITY>` by `subtotal.offset`.</div><div>For example, if the template is for placing a single order containing 2 items priced at ?12.99, the value would be `2598`.</div></div></td><td><div><div>`150000`</div></div></td></tr><tr><td><div><div>`<TAX_AMOUNT>`</div><div>*Integer*</div></div></td><td><div><div>**Required.**</div><div>Tax amount, multiplied by `tax.offset`.</div><div>For example, to represent a tax amount of ?5, the value would be `500`.</div></div></td><td><div><div>`10000`</div></div></td></tr><tr><td><div><div>`<TAX_DESCRIPTION>`</div><div>*String*</div></div></td><td><div><div>**Optional.**</div><div>Tax description.</div><div>Maximum 60 characters.</div></div></td><td><div><div>`Sales tax`</div></div></td></tr><tr><td><div><div>`<TEMPLATE_LANGUAGE>`</div><div>*String*</div></div></td><td><div><div>**Required.**</div><div>Template [language and locale code](/books/meta-whatsapp/page/template-library-developer-documentation).</div></div></td><td><div><div>`en_US`</div></div></td></tr><tr><td><div><div>`<TEMPLATE_NAME>`</div><div>*String*</div></div></td><td><div><div>**Required.**</div><div>Template name.</div><div>Maximum 512 characters.</div></div></td><td><div><div>`item_back_in_stock_v1`</div></div></td></tr><tr><td><div><div>`<TOTAL_AMOUNT>`</div><div>*Integer*</div></div></td><td><div><div>**Required.**</div><div>Total amount of order, multiplied by `total_amount.offset` value.</div><div>For example, to represent a total amount of ?18, value be `1800`.</div><div>Must be a sum of:</div><span>`order.subtotal.value`</span><span>`order.shipping.value`</span><span>`order.tax.value`</span><div>Minus:</div><span>`order.discount.value`</span></div></td><td><div><div>`165000`</div></div></td></tr><tr><td><div><div>`<WHATSAPP_USER_PHONE_NUMBER>`</div><div>*String*</div></div></td><td><div><div>**Required.**</div><div>WhatsApp user phone number.</div></div></td><td><div><div>`+16505551234`</div></div></td></tr></tbody></table>

</div><div id="bkmrk-example-request-3"><div id="bkmrk-example-request-4"><div>#### Example request

</div></div></div><div><div>The following sample request and responses are only supported with [Enabling coupons, realtime inventory and pricing updates](#bkmrk-enabling-coupons%2C-re-1) feature and it is currently in beta and only available to India businesses and WhatsApp users with an India country calling code. Please reach out to whatsappindia-bizpayments-support@meta.com to know more.</div></div></div>

# Payments API - Brazil | Developer Documentation

<div id="bkmrk-payments-api---brazi">## Payments API - Brazil

<div><span>Updated: Nov 14, 2025</span></div><div>Payments API enable businesses to accept payments from their customers via WhatsApp. Businesses send `order_details` messages ([Orders API](/books/meta-whatsapp/page/orders-developer-documentation)) to their customers, then get notified about payment status updates via webhook notifications.</div><div>Based on the selected use case, businesses can collect payment from the customers using one of the following integrations:</div>
<span>[Dynamic Pix Codes](/books/meta-whatsapp/page/offsite-pix-payments-developer-documentation)</span><span>[Payment Links](/books/meta-whatsapp/page/payment-links-developer-documentation)</span><span>[Boleto](/books/meta-whatsapp/page/boleto-developer-documentation)</span><span>[One-click offsite card payment](/books/meta-whatsapp/page/one-click-payments-developer-documentation)</span><span>[Order Details Template](/documentation/business-messaging/whatsapp/payments/payments-br/orderdetailstemplate)</span><div id="bkmrk-how-it-works"><div id="bkmrk-how-it-works-1"><div>### How It Works

</div></div></div><div>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.</div><div>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.</div><div>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](/books/meta-whatsapp/page/offsite-pix-payments-developer-documentation), [Payment Links](/books/meta-whatsapp/page/payment-links-developer-documentation), 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.</div><div id="bkmrk-purchase-flow-in-app"><div id="bkmrk-purchase-flow-in-app-1"><div>### Purchase Flow in App

</div></div></div><div>In the WhatsApp customer app, the purchase flow has the following steps:</div>
<span>Buyers communicate with businesses and select a product.</span><span>Businesses send an `order_details` message to the buyer.</span><span>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.</span><span>Businesses send an `order_status` message indicating that the order is now `processing`.</span></div>

# Orders | Developer Documentation

<div id="bkmrk-ordersupdated%3A-mar-2">## Orders

<div><span>Updated: Mar 25, 2026</span></div><div>Payments API introduces two new types of [interactive messages](/books/meta-whatsapp/page/sending-messages-developer-documentation): `order_details` and `order_status`. They are the entrypoint to collect payment in WhatsApp.</div>
<span>`order_details` messages are sent to create an order in the buyer’s WhatsApp client app. This message includes the payment settings used to collect payment and can optionally include an `order` object with itemized products, fees, and discounts. Without the `order` object, you can send a simplified order details message with just the total amount and payment settings. The payment settings will vary depending on the integration type ([Pix](/books/meta-whatsapp/page/offsite-pix-payments-developer-documentation), [payment links](/books/meta-whatsapp/page/payment-links-developer-documentation), [Boleto](/books/meta-whatsapp/page/boleto-developer-documentation), [One Click Payments](/books/meta-whatsapp/page/one-click-payments-developer-documentation)).</span><span>`order_status` messages are sent when businesses update the order status either based on the WhatsApp payment status change notification or based on their internal processes. You can also send a simplified status update without the `order` object.</span><div>![Image](https://support2.chatarchitect.com/uploads/images/gallery/2026-04/embedded-image-pev8y9ir.jpeg)</div><div>When attached to an order details message, orders start in `pending` status. When the merchant has fully fulfilled the order and the buyer should not expect any further updates, it must be marked as `completed`.</div><div id="bkmrk-full-api-reference"><div id="bkmrk-full-api-reference-1"><div>### Full API Reference

</div></div></div><div id="bkmrk-order-details"><div id="bkmrk-order-details-1"><div>#### Order Details

</div></div></div><div>To send an order_details message, businesses must assemble an interactive object of type order_details with the following components:</div><div id="bkmrk-interactive-object"><div id="bkmrk-interactive-object-1"><div>##### Interactive Object

</div></div></div><div><table><thead><tr><th><span>**Field Name**</span></th><th><span>**Optional?**</span></th><th><span>**Type**</span></th><th><span>**Description**</span></th></tr></thead><tbody><tr><td><div><div>type</div></div></td><td><div><div>Required</div></div></td><td><div><div>String</div></div></td><td><div><div>Must be `order_details`.</div></div></td></tr><tr><td><div><div>header</div></div></td><td><div><div>Optional</div></div></td><td><div><div>Object</div></div></td><td><div><div>Thumbnail image for order details message. It has the following fields:</div>
<span>`type`: Must be `image`.</span><span>`image`: See [Image Object](#bkmrk-image-object-1).</span><div><div>If the header is not present, the API finds the first product with an image and uses that for the thumbnail image.</div></div></div></td></tr><tr><td><div><div>body</div></div></td><td><div><div>Required</div></div></td><td><div><div>Object</div></div></td><td><div><div>An object with the body of the message. The object contains the following field:</div>
<span>`text` string: The content of the message. Emojis and markdown are supported. Maximum length is 1024 characters.</span></div></td></tr><tr><td><div><div>footer</div></div></td><td><div><div>Optional</div></div></td><td><div><div>Object</div></div></td><td><div><div>An object with the footer of the message. The object contains the following field:</div>
<span>`text` string: **Required** if footer is present. The footer content. Emojis, markdown, and links are supported. Maximum length is 60 characters.</span></div></td></tr><tr><td><div><div>action</div></div></td><td><div><div>Required</div></div></td><td><div><div>Action Object</div></div></td><td><div><div>See [Action Object](#bkmrk-action-object-1) below.</div></div></td></tr></tbody></table>

</div><div id="bkmrk-image-object"><div id="bkmrk-image-object-1"><div>##### Image Object

</div></div></div><div><table><thead><tr><th><span>Field Name </span></th><th><span>Optional? </span></th><th><span>Type </span></th><th><span>Description </span></th></tr></thead><tbody><tr><td><div><div>link</div></div></td><td><div><div>Required</div></div></td><td><div><div>String</div></div></td><td><div><div>Url of the image.</div></div></td></tr><tr><td><div><div>provider</div></div></td><td><div><div>Optional</div></div></td><td><div><div>String</div></div></td><td><div><div>Name of the url provider.</div></div></td></tr></tbody></table>

</div><div id="bkmrk-action-object"><div id="bkmrk-action-object-1"><div>##### Action Object

</div></div></div><div><table><thead><tr><th><span>Field Name </span></th><th><span>Optional? </span></th><th><span>Type </span></th><th><span>Description </span></th></tr></thead><tbody><tr><td><div><div>name</div></div></td><td><div><div>Required</div></div></td><td><div><div>String</div></div></td><td><div><div>Must be `review_and_pay`.</div></div></td></tr><tr><td><div><div>parameters</div></div></td><td><div><div>Required</div></div></td><td><div><div>Parameters Object</div></div></td><td><div><div>See [Parameters Object](#bkmrk-parameters-object-1).</div></div></td></tr></tbody></table>

</div><div id="bkmrk-parameters-object"><div id="bkmrk-parameters-object-1"><div>##### Parameters Object

</div></div></div><div><table><thead><tr><th><span>**Field Name**</span></th><th><span>**Optional?**</span></th><th><span>**Type**</span></th><th><span>**Description**</span></th></tr></thead><tbody><tr><td><div><div>reference_id</div></div></td><td><div><div>Required</div></div></td><td><div><div>String</div></div></td><td><div><div>Unique identifier for the order or invoice provided by the business. This cannot be an empty string and can only contain English letters, numbers, underscores, dashes, or dots, and should not exceed 60 characters.</div><div>The reference_id must be unique for each order_details message for the same business. If the partner would like to send multiple order_details messages for the same order, invoice, etc. it is recommended to include a sequence number in the reference_id to ensure reference_id uniqueness.</div></div></td></tr><tr><td><div><div>type</div></div></td><td><div><div>Required</div></div></td><td><div><div>String</div></div></td><td><div><div>Must be one of `digital-goods` or `physical-goods`.</div></div></td></tr><tr><td><div><div>payment_type</div></div></td><td><div><div>Required</div></div></td><td><div><div>String</div></div></td><td><div><div>Must be `br`.</div></div></td></tr><tr><td><div><div>payment_settings</div></div></td><td><div><div>Optional</div></div></td><td><div><div>[Payment Settings Object](#bkmrk-payment-settings-1)</div></div></td><td><div><div>List of payment related configuration objects.</div></div></td></tr><tr><td><div><div>currency</div></div></td><td><div><div>Required</div></div></td><td><div><div>String</div></div></td><td><div><div>ISO 4217 currency code for the order. Must be `BRL` (Brazilian Real).</div></div></td></tr><tr><td><div><div>total_amount</div></div></td><td><div><div>Required</div></div></td><td><div><div>Amount Object</div></div></td><td><div><div>See [Amount Object](#bkmrk-amount-object-1).</div><div><span></span><div>`total_amount.value` must be equal to `order.subtotal.value` + `order.tax.value` + `order.shipping.value` - `order.discount.value`</div></div></div></td></tr><tr><td><div><div>order</div></div></td><td><div><div>Optional</div></div></td><td><div><div>Order Object</div></div></td><td><div><div>See [Order Object](#bkmrk-order-object-1).</div></div></td></tr></tbody></table>

</div><div id="bkmrk-payment-settings"><div id="bkmrk-payment-settings-1"><div>##### Payment Settings

</div></div></div><div><table><thead><tr><th><span>Field Name </span></th><th><span>Optional? </span></th><th><span>Type </span></th><th><span>Description </span></th></tr></thead><tbody><tr><td><div><div>`type`</div></div></td><td><div><div>Required</div></div></td><td><div><div>String</div></div></td><td><div><div>One of `pix_dynamic_code`, `payment_link`, `boleto`.</div></div></td></tr><tr><td><div><div>One of the following objects: `pix_dynamic_code`, `payment_link`, `boleto`.</div></div></td><td><div><div>Required</div></div></td><td><div><div>Object</div></div></td><td><div><div>Payment instructions which will be displayed to buyers during the checkout process.</div></div></td></tr></tbody></table>

</div><div id="bkmrk-order-object"><div id="bkmrk-order-object-1"><div>##### Order Object

</div></div></div><div><table><thead><tr><th><span>**Field Name**</span></th><th><span>**Optional?**</span></th><th><span>**Type**</span></th><th><span>**Description**</span></th></tr></thead><tbody><tr><td><div><div>status</div></div></td><td><div><div>Required</div></div></td><td><div><div>String</div></div></td><td><div><div>Status of the order. Only supported value here is `pending`.</div></div></td></tr><tr><td><div><div>catalog_id</div></div></td><td><div><div>Optional</div></div></td><td><div><div>String</div></div></td><td><div><div>Unique identifier of the Facebook catalog being used by the business.</div></div></td></tr><tr><td><div><div>expiration</div></div></td><td><div><div>Optional</div></div></td><td><div><div>Expiration Object</div></div></td><td><div><div>Expiration for that order. The CTA for payment will be disabled after expiry on the user end. See [Expiration Object](#bkmrk-expiration-object-1).</div></div></td></tr><tr><td><div><div>items</div></div></td><td><div><div>Required</div></div></td><td><div><div>List of Item Objects</div></div></td><td><div><div>List must have at least one item. See [Item Object](#bkmrk-item-object-1).</div></div></td></tr><tr><td><div><div>subtotal</div></div></td><td><div><div>Required</div></div></td><td><div><div>Amount Object</div></div></td><td><div><div>See [Amount Object](#bkmrk-amount-object-1).</div><div><span></span><div>The value **must be equal** to sum of (`item.amount.value` or `item.sale_amount.value`) * `item.quantity`.</div></div><div>The following fields are part of the `subtotal` object:</div><div>`offset` string</div>
<span>**Required.** Must be `100` for `BRL`.</span><div>`value` string</div>
<span>**Required.** Positive integer representing the amount value multiplied by offset. For example, S$12.34. has value 1234</span></div></td></tr><tr><td><div><div>tax</div></div></td><td><div><div>Required</div></div></td><td><div><div>Amount With Description Object</div></div></td><td><div><div>The tax information for this order. Even though the object is required, the amount can be zero. When zero is used, the tax line is not rendered in the client. See [Amount With Description Object](#bkmrk-amount-object-%28with--1).</div></div></td></tr><tr><td><div><div>shipping</div></div></td><td><div><div>Optional</div></div></td><td><div><div>Amount With Description Object</div></div></td><td><div><div>See [Amount Object](#bkmrk-amount-object-%28with--1).</div></div></td></tr><tr><td><div><div>discount</div></div></td><td><div><div>Optional</div></div></td><td><div><div>Discount Object</div></div></td><td><div><div>The discount for the order. See [Discount object](#bkmrk-discount-object-1).</div></div></td></tr></tbody></table>

</div><div id="bkmrk-expiration-object"><div id="bkmrk-expiration-object-1"><div>##### Expiration Object

</div></div></div><div><table><thead><tr><th><span>**Field Name**</span></th><th><span>**Optional?**</span></th><th><span>**Type**</span></th><th><span>**Description**</span></th></tr></thead><tbody><tr><td><div><div>timestamp</div></div></td><td><div><div>Required</div></div></td><td><div><div>String</div></div></td><td><div><div>UTC time in seconds. Minimum threshold is 300 seconds.</div></div></td></tr><tr><td><div><div>description</div></div></td><td><div><div>Required</div></div></td><td><div><div>String</div></div></td><td><div><div>Text explanation for when the order will expire. Max character limit is 120 characters.</div></div></td></tr></tbody></table>

</div><div id="bkmrk-item-object"><div id="bkmrk-item-object-1"><div>##### Item Object

</div></div></div><div><table><thead><tr><th><span>**Field Name**</span></th><th><span>**Optional?**</span></th><th><span>**Type**</span></th><th><span>**Description**</span></th></tr></thead><tbody><tr><td><div><div>retailer_id</div></div></td><td><div><div>Required</div></div></td><td><div><div>String</div></div></td><td><div><div>Content ID for an item in the order from your catalog.</div></div></td></tr><tr><td><div><div>name</div></div></td><td><div><div>Required</div></div></td><td><div><div>String</div></div></td><td><div><div>The item’s name to be displayed to the user. Cannot exceed 60 characters.</div></div></td></tr><tr><td><div><div>amount</div></div></td><td><div><div>Required</div></div></td><td><div><div>Amount Object</div></div></td><td><div><div>The price per item. See [Amount Object](#bkmrk-amount-object-1).</div></div></td></tr><tr><td><div><div>quantity</div></div></td><td><div><div>Required</div></div></td><td><div><div>Integer</div></div></td><td><div><div>Number of items in this order.</div></div></td></tr><tr><td><div><div>sale_amount</div></div></td><td><div><div>Optional</div></div></td><td><div><div>Amount Object</div></div></td><td><div><div>The discounted price per item. This should be less than the original amount. If included, this field is used to calculate the subtotal amount. See [Amount Object](#bkmrk-amount-object-1).</div></div></td></tr></tbody></table>

</div><div id="bkmrk-discount-object"><div id="bkmrk-discount-object-1"><div>##### Discount Object

</div></div></div><div><table><thead><tr><th><span>**Field Name**</span></th><th><span>**Optional?**</span></th><th><span>**Type**</span></th><th><span>**Description**</span></th></tr></thead><tbody><tr><td><div><div>value</div></div></td><td><div><div>Required</div></div></td><td><div><div>Integer</div></div></td><td><div><div>Positive integer representing the amount value multiplied by offset. For example, 12.34 BRL has value 1234.</div></div></td></tr><tr><td><div><div>offset</div></div></td><td><div><div>Required</div></div></td><td><div><div>Integer</div></div></td><td><div><div>Must be `100` for `BRL`.</div></div></td></tr><tr><td><div><div>description</div></div></td><td><div><div>Optional</div></div></td><td><div><div>String</div></div></td><td><div><div>Max character limit is 60 characters.</div></div></td></tr><tr><td><div><div>discount_program_name</div></div></td><td><div><div>Optional</div></div></td><td><div><div>String</div></div></td><td><div><div>Text used for defining incentivised orders. If order is incentivised, the merchant needs to define this information. Max character limit is 60 characters.</div></div></td></tr></tbody></table>

</div><div id="bkmrk-amount-object"><div id="bkmrk-amount-object-1"><div>##### Amount Object

</div></div></div><div><table><thead><tr><th><span>**Field Name**</span></th><th><span>**Optional?**</span></th><th><span>**Type**</span></th><th><span>**Description**</span></th></tr></thead><tbody><tr><td><div><div>value</div></div></td><td><div><div>Required</div></div></td><td><div><div>Integer</div></div></td><td><div><div>Positive integer representing the amount value multiplied by offset. For example, 12.34 BRL has value 1234.</div></div></td></tr><tr><td><div><div>offset</div></div></td><td><div><div>Required</div></div></td><td><div><div>Integer</div></div></td><td><div><div>Must be `100` for `BRL`.</div></div></td></tr></tbody></table>

</div><div id="bkmrk-amount-object-%28with-"><div id="bkmrk-amount-object-%28with--1"><div>##### Amount Object (With Description)

</div></div></div><div><table><thead><tr><th><span>**Field Name**</span></th><th><span>**Optional?**</span></th><th><span>**Type**</span></th><th><span>**Description**</span></th></tr></thead><tbody><tr><td><div><div>value</div></div></td><td><div><div>Required</div></div></td><td><div><div>Integer</div></div></td><td><div><div>Positive integer representing the amount value multiplied by offset. For example, 12.34 BRL has value 1234.</div></div></td></tr><tr><td><div><div>offset</div></div></td><td><div><div>Required</div></div></td><td><div><div>Integer</div></div></td><td><div><div>Must be `100` for `BRL`.</div></div></td></tr><tr><td><div><div>description</div></div></td><td><div><div>Optional</div></div></td><td><div><div>String</div></div></td><td><div><div>Max character limit is 60 characters.</div></div></td></tr></tbody></table>

</div><div id="bkmrk-order-status"><div id="bkmrk-order-status-1"><div>#### Order Status

</div></div></div><div>To send an order_status message, businesses must assemble an interactive object of type order_status with the following components:</div><div id="bkmrk-interactive-object-3"><div id="bkmrk-interactive-object-4"><div>##### Interactive Object

</div></div></div><div><table><thead><tr><th><span>**Field Name**</span></th><th><span>**Optional?**</span></th><th><span>**Type**</span></th><th><span>**Description**</span></th></tr></thead><tbody><tr><td><div><div>type</div></div></td><td><div><div>Required</div></div></td><td><div><div>String</div></div></td><td><div><div>Must be `order_status`.</div></div></td></tr><tr><td><div><div>header</div></div></td><td><div><div>Optional</div></div></td><td><div><div>Object</div></div></td><td><div><div>Optional object for the message’s header for the message.</div></div></td></tr><tr><td><div><div>body</div></div></td><td><div><div>Required</div></div></td><td><div><div>Object</div></div></td><td><div><div>An object with the body of the message. The object contains the following field:</div>
<span>`text` string: The content of the message. Emojis and markdown are supported. Maximum length is 1024 characters.</span></div></td></tr><tr><td><div><div>footer</div></div></td><td><div><div>Optional</div></div></td><td><div><div>Object</div></div></td><td><div><div>An object with the footer of the message. The object contains the following field:</div>
<span>`text` string: **Required** if footer is present. The footer content. Emojis, markdown, and links are supported. Maximum length is 60 characters.</span></div></td></tr><tr><td><div><div>action</div></div></td><td><div><div>Required</div></div></td><td><div><div>Action Object</div></div></td><td><div><div>See [Action Object](#bkmrk-action-object-4) below.</div></div></td></tr></tbody></table>

</div><div id="bkmrk-action-object-3"><div id="bkmrk-action-object-4"><div>##### Action Object

</div></div></div><div><table><thead><tr><th><span>Field Name </span></th><th><span>Optional? </span></th><th><span>Type </span></th><th><span>Description </span></th></tr></thead><tbody><tr><td><div><div>name</div></div></td><td><div><div>Required</div></div></td><td><div><div>String</div></div></td><td><div><div>Must be `review_order`.</div></div></td></tr><tr><td><div><div>parameters</div></div></td><td><div><div>Required</div></div></td><td><div><div>Parameters Object</div></div></td><td><div><div>See [Parameters Object](#bkmrk-parameters-object-4).</div></div></td></tr></tbody></table>

</div><div id="bkmrk-parameters-object-3"><div id="bkmrk-parameters-object-4"><div>##### Parameters Object

</div></div></div><div><table><thead><tr><th><span>Field Name </span></th><th><span>Optional? </span></th><th><span>Type </span></th><th><span>Description </span></th></tr></thead><tbody><tr><td><div><div>reference_id</div></div></td><td><div><div>Required</div></div></td><td><div><div>String</div></div></td><td><div><div>The unique ID provided in the `order_details` message.</div></div></td></tr><tr><td><div><div>order</div></div></td><td><div><div>Optional</div></div></td><td><div><div>Order Object</div></div></td><td><div><div>See [Order Object](#bkmrk-order-object-4).</div></div></td></tr><tr><td><div><div>payment</div></div></td><td><div><div>Optional</div></div></td><td><div><div>Payment Object</div></div></td><td><div><div>See [Payment Object](#bkmrk-payment-object-1).</div></div></td></tr></tbody></table>

</div><div id="bkmrk-order-object-3"><div id="bkmrk-order-object-4"><div>##### Order Object

</div></div></div><div><table><thead><tr><th><span>Field Name </span></th><th><span>Optional? </span></th><th><span>Type </span></th><th><span>Description </span></th></tr></thead><tbody><tr><td><div><div>status</div></div></td><td><div><div>Required</div></div></td><td><div><div>String</div></div></td><td><div><div>The new order status. [See supported order status](#bkmrk-supported-order-stat-1).</div></div></td></tr><tr><td><div><div>description</div></div></td><td><div><div>Optional</div></div></td><td><div><div>String</div></div></td><td><div><div>Optional text for sharing status related information in order-details page. Could be useful while sending cancellation. Length should not exceed 120 characters.</div></div></td></tr></tbody></table>

</div><div id="bkmrk-payment-object"><div id="bkmrk-payment-object-1"><div>##### Payment Object

</div></div></div><div><table><thead><tr><th><span>Field Name </span></th><th><span>Optional? </span></th><th><span>Type </span></th><th><span>Description </span></th></tr></thead><tbody><tr><td><div><div>status</div></div></td><td><div><div>Required</div></div></td><td><div><div>String</div></div></td><td><div><div>The new payment status. [See supported payment status](#bkmrk-supported-payment-st-1).</div></div></td></tr><tr><td><div><div>timestamp</div></div></td><td><div><div>Optional</div></div></td><td><div><div>Integer</div></div></td><td><div><div>Optional epoch timestamp in seconds</div></div></td></tr></tbody></table>

</div><div id="bkmrk-supported-order-stat"><div id="bkmrk-supported-order-stat-1"><div>##### Supported Order Status

</div></div></div><div>Currently we support the following order status values:</div><div><table><thead><tr><th><span>Value </span></th><th><span>Description </span></th></tr></thead><tbody><tr><td><div><div>`pending`</div></div></td><td><div><div>Order is pending / not processed yet.</div></div></td></tr><tr><td><div><div>`processing`</div></div></td><td><div><div>Merchant/partner is fulfilling the order, performing service, etc.</div></div></td></tr><tr><td><div><div>`partially-shipped`</div></div></td><td><div><div>Part of the products in order have been shipped by the merchant.</div></div></td></tr><tr><td><div><div>`shipped`</div></div></td><td><div><div>All the products in order have been shipped by the merchant.</div></div></td></tr><tr><td><div><div>`completed`</div></div></td><td><div><div>The order is completed and no further action is expected from the user or the partner/merchant.</div></div></td></tr><tr><td><div><div>`canceled`</div></div></td><td><div><div>The partner/merchant would like to cancel the order_details message for the order/invoice. The status update will fail if there is already a successful or pending payment for this order_details message.</div></div></td></tr></tbody></table>

</div><div id="bkmrk-supported-payment-st"><div id="bkmrk-supported-payment-st-1"><div>##### Supported Payment Status

</div></div></div><div>Currently we support the following payment status values:</div><div><table><thead><tr><th><span>Value </span></th><th><span>Description </span></th></tr></thead><tbody><tr><td><div><div>`pending`</div></div></td><td><div><div>Payment is pending.</div></div></td></tr><tr><td><div><div>`captured`</div></div></td><td><div><div>Payment was successfully captured. Receiving this payment status will update the order bubble to include the “paid” label (with green checkmark).</div></div></td></tr><tr><td><div><div>`failed`</div></div></td><td><div><div>Payment failed.</div></div></td></tr></tbody></table>

</div><div id="bkmrk-errors-and-statuses"><div id="bkmrk-errors-and-statuses-1"><div>### Errors and Statuses

</div></div></div><div>These are the relevant errors for the WhatsApp Payments API:</div><div><table><thead><tr><th><span>Error Code </span></th><th><span>Description </span></th></tr></thead><tbody><tr><td><div><div>`2040 - Message is not supported`</div></div></td><td><div><div>The message you are trying to send cannot be received by this user</div></div></td></tr><tr><td><div><div>`2046 - Order status invalid transition`</div></div></td><td><div><div>The order status cannot be updated from the existing value to the new one</div></div></td></tr><tr><td><div><div>`2047 - Order cancellation failure`</div></div></td><td><div><div>The order could not be cancelled</div></div></td></tr></tbody></table>

</div><div>For a comprehensive list with detailed descriptions of error codes and HTTP status codes, please refer to our [Error Codes](/documentation/business-messaging/whatsapp/support/error-codes) document.</div></div>

# Offsite Pix payments | Developer Documentation

<div id="bkmrk-offsite-pix-payments">## Offsite Pix payments

<div><span>Updated: Nov 14, 2025</span></div><div>Payments API also enables businesses to collect payments from their customers via WhatsApp using dynamic Pix codes.</div><div>When using this integration, WhatsApp only facilitates the communication between merchants and buyers. Merchants are responsible for integrating with a bank or PSP in order to generate dynamic Pix codes, and confirm their payment.</div><div id="bkmrk-before-you-start"><div id="bkmrk-before-you-start-1"><div>### Before you start

</div></div></div>
<span>Familiarize yourself with the [Orders API](/books/meta-whatsapp/page/orders-developer-documentation). Orders are the entrypoint for collecting payments in WhatsApp.</span><span>You will need an existing integration with a bank or PSP to generate dynamic Pix codes and do automatic reconciliation when a payment is made. You must be able to update the order status as soon as a payment is made.</span></div>

# Payment links | Developer Documentation

<div id="bkmrk-payment-linksupdated">## Payment links

<div><span>Updated: Nov 14, 2025</span></div><div>Payments API also enables businesses to collect payments from their customers via WhatsApp using Payment Links.</div><div>When using this integration, WhatsApp only facilitates the communication between merchants and buyers. Merchants are responsible for integrating with a PSP from which they can generate Payment Links, and confirm their payment.</div><div id="bkmrk-before-you-start"><div id="bkmrk-before-you-start-1"><div>### Before You Start

</div></div></div>
<span>Familiarize yourself with the [Orders API](/books/meta-whatsapp/page/orders-developer-documentation). Orders are the entrypoint for collecting payments in WhatsApp.</span><span>You will need an existing integration with a PSP to generate Payment Links and do automatic reconciliation when a payment is made.</span><span>You must update the order status as soon as a payment is made.</span></div>

# Boleto | Developer Documentation

<div id="bkmrk-boletoupdated%3A-nov-1">## Boleto

<div><span>Updated: Nov 14, 2025</span></div><div>Payments API also enables businesses to collect payments from their customers via WhatsApp using Boleto.</div><div>When using this integration, WhatsApp only facilitates the communication between merchants and buyers. Merchants are responsible for integrating with a PSP from which they can generate Boleto codes, and confirm their payment.</div><div id="bkmrk-before-you-start"><div id="bkmrk-before-you-start-1"><div>### Before you start

</div></div></div>
<span>Familiarize yourself with the [Orders API](/books/meta-whatsapp/page/orders-developer-documentation). Orders are the entrypoint for collecting payments in WhatsApp.</span><span>You will need an existing integration with a PSP to generate Boleto codes and do automatic reconciliation when a payment is made.</span><span>You must update the order status as soon as a payment is made.</span></div>

# One-Click Payments | Developer Documentation

<div id="bkmrk-one-click-paymentsup">## One-Click Payments

<div><span>Updated: Nov 14, 2025</span></div><div><span></span><div>This feature is not publicly available yet and is only available for businesses based in Brazil and their Brazilian customers. To enable payments for your businesses, please contact your Solution Partner.</div></div><div>Payments API also enables businesses to collect payments from their customers via WhatsApp using One-Click Payments.</div><div>When using this integration, WhatsApp facilitates communication between merchants and buyers. Merchants are responsible for storing payment credentials and integrating with a payment service provider (PSP) to submit these credentials, completing and confirming their payments.</div><div id="bkmrk-before-you-start"><div id="bkmrk-before-you-start-1"><div>### Before you start

</div></div></div>
<span>Familiarize yourself with the [Orders API](/books/meta-whatsapp/page/orders-developer-documentation). Orders are the entrypoint for collecting payments in WhatsApp.</span><span>You will need an existing integration with a PSP and do automatic reconciliation when a payment is made.</span><span>You must update the order status as soon as a payment is made.</span></div>

# Send order details template message | Developer Documentation

<div id="bkmrk-send-order-details-t">## Send order details template message

<div><span>Updated: Nov 4, 2025</span></div><div id="bkmrk-overview"><div id="bkmrk-overview-1"><div>### Overview

</div></div></div><div>Order details message template is a template with [interactive components](/books/meta-whatsapp/page/templates-developer-documentation) that extends the call-to-action button to support sending order details and provides a richer experience compared to templates with only text components.</div><div>Once your Order details message templates have been created and approved, you can use the approved template to send the template message with order or bill information to prompt customers to make a payment.</div><div>Before sending an order details template message, businesses need to create a template with an “order details” call-to-action button. See [Create Message Templates for Your WhatsApp Business Account<span>⁠</span>](https://www.facebook.com/business/help/2055875911147364?id=2129163877102343) for more information on prerequisites and how to create a template.</div><div id="bkmrk-creating-an-order-de"><div id="bkmrk-creating-an-order-de-1"><div>### Creating an order details template on WhatsApp Manager

</div></div></div><div>To create an order details template, business needs a business portfolio with a WhatsApp Business Account.</div><div>In **WhatsApp Manager** &gt; **Account tools**:</div><span>Click on `create template`</span><span>Select `Utility` or `Marketing` category to see the `Order details` template format option.</span><span>Select `Order details` template format, and click **Next**</span><span>Enter the desired `template name` and supported `locale`</span> <span>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.</span><span>Fill in template components such as `Header`, `Body` and optional `footer` text. </span><span>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.</span><span>Click submit.</span><span>Once submitted, templates will be [categorized as per the guidelines](/books/meta-whatsapp/page/template-categorization-developer-documentation) and undergo the [approval process](/books/meta-whatsapp/page/template-review-developer-documentation).</span><span>The template will be approved or rejected after the template components are verified by the system. </span><span>If business believe the category determined is not consistent with our template category guidelines, please confirm there are no [common issues](/books/meta-whatsapp/page/template-review-developer-documentation) that leads to rejections and if you are looking for further clarification you may [request a review](/books/meta-whatsapp/page/template-categorization-developer-documentation) of the template via [Business Support<span>⁠</span>](https://business.facebook.com/business-support-home/)</span><span>Once approved template [status](/books/meta-whatsapp/page/templates-developer-documentation) will be changed to `ACTIVE`</span> <span>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](/books/meta-whatsapp/page/template-review-developer-documentation) and take appropriate actions whenever such change occurs.</span><div id="bkmrk-sending-order-detail"><div id="bkmrk-sending-order-detail-1"><div>### Sending order details template message

</div></div></div><div>Order details template message allows the businesses to send invoice (order_details) message as predefined `order details` call-to-action button component parameters. It supports businesses to send all payment integration (such as [Dynamic Pix code](/books/meta-whatsapp/page/offsite-pix-payments-developer-documentation), [Payment Links](/books/meta-whatsapp/page/payment-links-developer-documentation), [Boleto](/books/meta-whatsapp/page/boleto-developer-documentation), etc) integration as button parameters.</div><div>To send an order details template message, make a `POST` call to `/PHONE_NUMBER_ID/messages` endpoint and attach a message object with `type=template`. Then, add a template object with a predefined `order details` call-to-action button.</div><div>You can optionally include a **PDF file** as attachment in the `header` component of the template message. To do so, you use `type=document` in the `parameter` object of the `header` component object, as described in our [Components](/books/meta-whatsapp/page/template-components-developer-documentation) document.</div><div>For example following sample describes how to send [Copy Pix code](/books/meta-whatsapp/page/offsite-pix-payments-developer-documentation) in order details template message parameters to prompt the consumer to make a payment.</div><div id="bkmrk-post-order-details-t"><div id="bkmrk-post-order-details-t-1"><div>### Post order details template message flow

</div></div></div><div>After the order details template message delivery the rest of the payment flow is the same as “Sending invoice in customer session window” and depends on the chosen [payment integration](/books/meta-whatsapp/page/payments-api-brazil-developer-documentation) order details parameters.</div></div>

# Receive UPI Payments Through WhatsApp | Developer Documentation

<div id="bkmrk-receive-upi-payments">## Receive UPI Payments Through WhatsApp

<div><span>Updated: Nov 14, 2025</span></div><div><div>This is NOT the recommended UPI Intent integration. [Migrate to dynamic VPA](/documentation/business-messaging/whatsapp/payments/payments-in/upi-intent/dynamic-vpa). With dynamic VPA, you can rotate VPAs on UPI intents without requiring any configuration changes on your end - simplifying integration and ongoing maintenance.</div></div><div>Your business can enable customers to pay for their orders using all the UPI Apps installed on their devices via WhatsApp. Businesses can send customers invoice(`order_details`) messages, then get notified about payment status updates via webhook notifications from Payment Gateway.</div><div id="bkmrk-overview"><div id="bkmrk-overview-1"><div>### Overview

</div></div></div><div>Currently, customers browse business catalogs, add products to cart, and send orders in with our set of commerce messaging solutions, which includes [Single Product Message, Multi Product Message, and Product Detail Page](/books/meta-whatsapp/page/share-products-with-whatsapp-users-developer-documentation).</div><div>With the WhatsApp Payments API, businesses can send customers a bill so the customer can complete their order with all the UPI Apps.</div><div id="bkmrk-how-it-works"><div id="bkmrk-how-it-works-1"><div>### How It Works

</div></div></div><div>The business must send an `order_details` message for the consumer to initiate payment. This type of message is a new type of interactive message, which always 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.</div><div>Each `order_details` message contains a unique `reference_id` provided by the business, and that unique number is used throughout the flow to track the order. This `reference_id` is fetched from UPI intent link(**tr** value from the UPI payment intent) generated for a business order from Payment Gateway.</div><div>Once the message is sent, the business waits for a payment or transaction status updates directly from Payment Gateway. Upon receiving payment signal for an order, Business should relay this payment signal to consumer through interactive order status(`order_status`) message.</div><div>Updating user about the payment signal is important as this message updates the order details message and order details view for the consumer reflecting the order confirmation from merchant. This is shown with an example in subsequent sections.</div><div id="bkmrk-purchase-flow-in-app"><div id="bkmrk-purchase-flow-in-app-1"><div>### Purchase Flow in App

</div></div></div><div>In the WhatsApp customer app, the purchase flow has the following steps:</div><div>Customer sends an order with selected products to the business or Business identifies the products that the customer has shown interest to purchase.</div><div>After receiving the order/identifying the product, if a merchant accepts payment methods other than UPI, such as credit cards and payment wallets, then merchant will send a message to the user to get their preferred payment method for the order.</div><div><div>![Image](https://support2.chatarchitect.com/uploads/images/gallery/2026-04/embedded-image-lc4ocuyi.jpeg)</div></div><div>When consumers want to pay using UPI payment method, then merchants should retrieve the UPI payment intent by calling Payment Gateway. Merchant needs to use UPI intent to construct order details messages and send it to the consumer.</div><div><div>![Image](https://support2.chatarchitect.com/uploads/images/gallery/2026-04/embedded-image-muexyd8v.jpeg)![Image](https://support2.chatarchitect.com/uploads/images/gallery/2026-04/embedded-image-y4cphnux.jpeg)</div></div><div>When the consumer taps the Pay now/continue button, they will be given the option to choose UPI payment Apps - WhatsApp or any other UPI payments apps. Consumers may choose any UPI option to pay for the order.</div><div><div>![Image](https://support2.chatarchitect.com/uploads/images/gallery/2026-04/embedded-image-sel8v6ol.jpeg)![Image](https://support2.chatarchitect.com/uploads/images/gallery/2026-04/embedded-image-x28rwl2j.jpeg)</div></div><div>Consumer pays for the order and the payment method is saved for the future and automatically selected for the next payment transaction. Also, one quick note is the order details screen order-status will continue to show “Order pending” until merchant sends order status interactive message.</div><div><div>![Image](https://support2.chatarchitect.com/uploads/images/gallery/2026-04/embedded-image-e5dlkzmh.jpeg)![Image](https://support2.chatarchitect.com/uploads/images/gallery/2026-04/embedded-image-54brpul3.jpeg)</div></div><div>Once the payment is complete, the business receives a notification from Payment Gateway and the merchant needs to send order status updates to the consumer client notifying consumers about the progress to the order, this will update the order details message CTAs and order details screen - order status description.</div><div><div>![Image](https://support2.chatarchitect.com/uploads/images/gallery/2026-04/embedded-image-hacv0kik.jpeg)![Image](https://support2.chatarchitect.com/uploads/images/gallery/2026-04/embedded-image-h9j7nfh0.jpeg)![Image](https://support2.chatarchitect.com/uploads/images/gallery/2026-04/embedded-image-xozru19q.jpeg)</div></div><div id="bkmrk-before-you-start"><div id="bkmrk-before-you-start-1"><div>### Before You Start

</div></div></div><div>To receive UPI payments on WhatsApp merchants have to set up their VPA on WhatsApp Business Manager using the direct payment methods option.</div><div>Each configuration must have a unique name, merchant categorization code (mcc), purpose code, and VPA handles as shown below. A business can have multiple payment configurations, but for each order merchant must specify a specific configuration to be used for payment. See `payment_configuration` field in `order_details` message.</div><div>`name` for each payment type must be unique. `name` will be used to reference the specific configurations for each payment type. If WA is unable to find a payment configuration name, the user will not be able to make the payment upon receiving the `order_details` message. `mcc` refers to a [merchant categorization code<span>⁠</span>](https://l.facebook.com/l.php?u=https%3A%2F%2Fen.wikipedia.org%2Fwiki%2FMerchant_category_code&h=AT4aQI3vEzVEGQIkERhgg-87uTsex9tz0Ki1bvUichbOLZfPPRAtYgP4iVX05KmasN0FrQzsCKp6gWX4e-Ek41tWevfkDxwdpxZxMPp3giaVL8eyaBcneA0GHvikcZfUIVHZxOqwSRZGnFRuKHdf7A) for the items in the order. `upi_pc` refers to the purpose of the transaction. Some sample codes are below:</div><div><table><thead><tr><th><span>Code </span></th><th><span>Title </span></th></tr></thead><tbody><tr><td><div><div>00</div></div></td><td><div><div>Default</div></div></td></tr><tr><td><div><div>01</div></div></td><td><div><div>SEMI</div></div></td></tr><tr><td><div><div>02</div></div></td><td><div><div>AMC</div></div></td></tr><tr><td><div><div>03</div></div></td><td><div><div>Travel</div></div></td></tr><tr><td><div><div>04</div></div></td><td><div><div>Hospitality</div></div></td></tr><tr><td><div><div>05</div></div></td><td><div><div>Hospital</div></div></td></tr><tr><td><div><div>06</div></div></td><td><div><div>Telecom</div></div></td></tr><tr><td><div><div>07</div></div></td><td><div><div>Insurance</div></div></td></tr><tr><td><div><div>08</div></div></td><td><div><div>Education</div></div></td></tr><tr><td><div><div>09</div></div></td><td><div><div>Gifting</div></div></td></tr><tr><td><div><div>10</div></div></td><td><div><div>Others</div></div></td></tr></tbody></table>

</div><div><div>If merchant/partner is not sure of the MCC and purpose code, then they may contact Payment Gateway to get this information as Payment Gateway sets up these values based on the type of business while generating business VPAs.</div></div><div id="bkmrk-manage-your-payment-"><div id="bkmrk-manage-your-payment--1"><div>### Manage Your Payment Methods (Beta Feature)

</div></div></div><div>Self-service Payment Configuration allows you to add multiple payment configurations to your WhatsApp Manager profile. Each payment configuration will have its own UPI handle(VPA), MCC, and purpose code (for physical goods) so that merchants can accept payments for different categories with different UPI accounts. After setup, merchant can send invoice(`order_details`) messages to users with the corresponding payment configuration to collect payments.</div><div id="bkmrk-pre-requisites"><div id="bkmrk-pre-requisites-1"><div>#### Pre-requisites

</div></div></div><div>Manage Payment Methods feature is in Beta, so please contact Business Engineering team to allow merchants/partners access the page in WhatsApp Business Manager portal.</div><div id="bkmrk-steps-to-link-paymen"><div id="bkmrk-steps-to-link-paymen-1"><div>#### Steps to link Payment Configuration for a Business Service Provider

</div></div></div><div>You can create a payment configuration for a WhatsApp Business Account using the ‘Payment configurations’ page and under ‘India’ in [WhatsApp Business Manager<span>⁠</span>](https://business.facebook.com/wa/manage/home).</div><div>After linking your payment configuration, you must integrate with the Payments APIs below. This will allow you to send an `order_details` message to customers with the payment configuration to receive payments.</div><div id="bkmrk-steps-to-unlink-paym"><div id="bkmrk-steps-to-unlink-paym-1"><div>#### Steps to unlink Payment Configuration

</div></div></div><div>Note: Make sure no new order messages requesting payment from consumer are sent with the payment config your are trying to remove before you perform the unlink action.</div><div id="bkmrk-integration-steps"><div id="bkmrk-integration-steps-1"><div>### Integration Steps

</div></div></div><div>The steps outlined below assume that the business is about to send order details message to consumer client.</div><div>The following sequence diagram demonstrates the typical integration flow for WA Payments API: ![Image](https://support2.chatarchitect.com/uploads/images/gallery/2026-04/embedded-image-u1wpcihs.jpeg)</div><div id="bkmrk-step-1%3A-get-upi-inte"><div id="bkmrk-step-1%3A-get-upi-inte-1"><div>#### Step 1: Get UPI Intent from Payment Gateway

</div></div></div><div>Once the consumer has expressed their interest to purchase an item using UPI payment method. Merchant needs to call payment gateway to create a UPI intent, the following is the sample UPI intent link:</div><div><div>```
<span><span>upi://pay?pa=cfsukoonaa@yesbank&pn=Sukoon&tr=87737</span><span>6394&</span></span><br></br><span><span>  am=10.00&cu=INR&mode=00&purpose=00&mc=5399&tn=87</span><span>7376394</span></span><br></br>
```

</div></div><div>Merchant needs to parse the `tr` value from the above URI and use this as the reference id in invoice(`order_details`) interactive message.</div><div id="bkmrk-step-2%3A-assemble-the"><div id="bkmrk-step-2%3A-assemble-the-1"><div>#### Step 2: Assemble the Interactive Object

</div></div></div><div>To send an `order_details` message, businesses must assemble an [interactive object](/books/meta-whatsapp/page/sending-messages-developer-documentation) of type `order_details` with the following components:</div><div><table><thead><tr><th><span>Object </span></th><th><span>Description </span></th></tr></thead><tbody><tr><td><div><div>`type`</div><div>object</div></div></td><td><div><div>**Required.**</div><div>Must be “order_details”.</div></div></td></tr><tr><td><div><div>`header`</div><div>object</div></div></td><td><div><div>**Optional.**</div><div>Header content displayed on top of a message. If a header is not provided, the API uses an image of the first available product as the header</div></div></td></tr><tr><td><div><div>`body`</div><div>object</div></div></td><td><div><div>**Required.**</div><div>An object with the body of the message. The object contains the following field:</div><div>`text` string</div><span>**Required** if `body` is present. The content of the message. Emojis and markdown are supported. Maximum length is 1024 characters</span></div></td></tr><tr><td><div><div>`footer`</div><div>object</div></div></td><td><div><div>**Optional.**</div><div>An object with the footer of the message. The object contains the following fields:</div><div>`text` string</div><span>**Required** if `footer` is present. The footer content. Emojis, markdown, and links are supported. Maximum length is 60 characters</span></div></td></tr><tr><td><div><div>`action`</div><div>object</div></div></td><td><div><div>**Required.**</div><div>An action object you want the user to perform after reading the message. This action object contains the following fields:</div><div>`name` string</div><span>**Required**. Must be “review\_and\_pay”</span><div>`parameters` object</div><span>See [Parameters Object](#bkmrk-parameters-object-1) for information</span></div></td></tr></tbody></table>

</div><div id="bkmrk-parameters-object"><div id="bkmrk-parameters-object-1"><div>##### Parameters Object

</div></div></div><div><table><thead><tr><th><span>Object </span></th><th><span>Description </span></th></tr></thead><tbody><tr><td><div><div>`reference_id`</div><div>string</div></div></td><td><div><div>**Required.**</div><div>Unique identifier for the order or invoice provided by the business. This cannot be an empty string and can only contain English letters, numbers, underscores, dashes, or dots, and should not exceed 35 characters.</div><div>The `reference_id` must be unique for each `order_details` message for the same business. If the partner would like to send multiple order_details messages for the same order, invoice, etc. it is recommended to include a sequence number in the `reference_id` (for example, &lt;order-or-invoice-id&gt;-&lt;sequence-number&gt;) to ensure `reference_id` uniqueness.</div></div></td></tr><tr><td><div><div>`type`</div><div>object</div></div></td><td><div><div>**Required.**</div><div>The type of goods being paid for in this order. Current supported options are `digital-goods` and `physical-goods`</div></div></td></tr><tr><td><div><div>`beneficiaries`</div><div>array</div></div></td><td><div><div>**Required for shipped physical-goods.**</div><div>An array of beneficiaries for this order. A beneficiary is an intended recipient for shipping the physical goods in the order. It contains the following fields:</div><div><div>Beneficiary information isn’t shown to users but is needed for legal and compliance reasons.</div></div><div>`name` string</div><span>**Required.** Name of the individual or business receiving the physical goods. Cannot exceed 200 characters</span><div>`address_line1` string</div><span>**Required.** Shipping address (Door/Tower Number, Street Name etc.). Cannot exceed 100 characters</span><div>`address_line2` string</div><span>**Optional.** Shipping address (Landmark, Area, etc.). Cannot exceed 100 characters</span><div>`city` string</div><span>**Required.** Name of the city.</span><div>`state` string</div><span>**Required.** Name of the state.</span><div>`country` string</div><span>**Required.** Must be “India”.</span><div>`postal_code` string</div><span>**Required.** 6-digit zipcode of shipping address.</span></div></td></tr><tr><td><div><div>`payment_type`</div></div></td><td><div><div>**Required.**</div><div>Must be “upi”.</div></div></td></tr><tr><td><div><div>`payment_configuration`</div></div></td><td><div><div>**Required.**</div><div>The name of the pre-configured payment configuration to use for this order and must not exceed 60 characters.</div></div></td></tr><tr><td><div><div>`currency`</div></div></td><td><div><div>**Required.**</div><div>The currency for this order. Currently the only supported value is `INR`.</div></div></td></tr><tr><td><div><div>`total_amount`</div><div>object</div></div></td><td><div><div>**Required.**</div><div>The `total_amount` object contains the following fields:</div><div>`offset` integer</div><span>**Required.** Must be `100` for `INR`.</span><div>`value` integer</div><span>**Required.** Positive integer representing the amount value multiplied by offset. For example, ₹12.34 has value 1234.</span><div><div>`total_amount.value` must be equal to `order.subtotal.value` + `order.tax.value` + `order.shipping.value` - `order.discount.value`.</div></div></div></td></tr><tr><td><div><div>`order`</div><div>object</div></div></td><td><div><div>**Required.**</div><div>See [order object](#bkmrk-order-object-1) for more information.</div></div></td></tr></tbody></table>

</div><div id="bkmrk-order-object"><div id="bkmrk-order-object-1"><div>##### Order Object

</div></div></div><div><table><thead><tr><th><span>Object </span></th><th><span>Description </span></th></tr></thead><tbody><tr><td><div><div>`status`</div><div>string</div></div></td><td><div><div>**Required.**</div><div>Only supported value in the `order_details` message is `pending`.</div><div><div>In an `order_status` message, `status` can be: `pending`, `captured`, or `failed`.</div></div></div></td></tr><tr><td><div><div>`type`</div><div>string</div></div></td><td><div><div>**Optional.**</div><div>Only supported value is `quick_pay`. When this field is passed in we hide the “Review and Pay” button and only show the “Pay Now” button in the order details bubble.</div></div></td></tr><tr><td><div><div>`items`</div><div>object</div></div></td><td><div><div>**Required.**</div><div>An object with the list of items for this order, containing the following fields:</div><div>`retailer_id` string</div><span>**Optional.** Content ID for an item in the order from your catalog.</span><div>`name` string</div><span>**Required.** The item’s name to be displayed to the user. Cannot exceed 60 characters</span><div>`image` object</div><span>**Optional.** Custom image for the item to be displayed to the user. See [item image object](#bkmrk-item-image-object-1) for information</span><div><div>Using this image field will limit the items array to a maximum of 10 items and this cannot be used with `retailer_id` or `catalog_id`.</div></div><div>`amount` amount object with value and offset -- refer total amount field above</div><span>**Required.** The price per item</span><div>`sale_amount` amount object</div><span>**Optional.** The discounted price per item. This should be less than the original amount. If included, this field is used to calculate the subtotal amount</span><div>`quantity` integer</div><span>**Required.** The number of items in this order, this field cannot be decimal has to be integer.</span><div>`country_of_origin` string</div><span>**Optional** if `catalog_id` is not present. The country of origin of the product</span><div>`importer_name` string</div><span>**Optional** if `catalog_id` is not present. Name of the importer company</span><div>`importer_adress` string</div><span>**Optional** if `catalog_id` is not present. Address of importer company</span></div></td></tr><tr><td><div><div>`subtotal`</div><div>object</div></div></td><td><div><div>**Required.**</div><div>The value **must be equal** to `order.amount.value` multiplied by `order.amount.quantity`.</div><div>Refer to `total_amount` description for explanation of `offset` and `value` fields</div><div>The following fields are part of the `subtotal` object:</div><div>`offset` integer</div><span>**Required.** Must be `100` for `INR`</span><div>`value` integer</div><span>**Required.** Positive integer representing the amount value multiplied by offset. For example, ₹12.34 has value 1234</span></div></td></tr><tr><td><div><div>`tax`</div><div>object</div></div></td><td><div><div>**Required.**</div><div>The tax information for this order which contains the following fields:</div><div>`offset` integer</div><span>**Required.** Must be `100` for `INR`</span><div>`value` integer</div><span>**Required.** Positive integer representing the amount value multiplied by offset. For example, ₹12.34 has value 1234</span><div>`description` string</div><span>**Optional.** Max character limit is 60 characters</span></div></td></tr><tr><td><div><div>`shipping`</div><div>object</div></div></td><td><div><div>**Optional.**</div><div>The shipping cost of the order. The object contains the following fields:</div><div>`offset` integer</div><span>**Required.** Must be `100` for `INR`</span><div>`value` integer</div><span>**Required.** Positive integer representing the amount value multiplied by offset. For example, ₹12.34 has value 1234</span><div>`description` string</div><span>**Optional.** Max character limit is 60 characters</span></div></td></tr><tr><td><div><div>`discount`</div><div>object</div></div></td><td><div><div>**Optional.**</div><div>The discount for the order. The object contains the following fields:</div><div>`offset` integer</div><span>**Required.** Must be `100` for `INR`</span><div>`value` integer</div><span>**Required.** Positive integer representing the amount value multiplied by offset. For example, ₹12.34 has value 1234</span><div>`description` string</div><span>**Optional.** Max character limit is 60 characters</span><div>`discount_program_name` string</div><span>**Optional.** Text used for defining incentivised orders. If order is incentivised, the merchant needs to define this information. Max character limit is 60 characters</span></div></td></tr><tr><td><div><div>`catalog_id`</div><div>object</div></div></td><td><div><div>**Optional.**</div><div>Unique identifier of the Facebook catalog being used by the business.</div></div></td></tr><tr><td><div><div>`expiration`</div><div>object</div></div></td><td><div><div>**Optional.**</div><div>Expiration for that order. Business must define the following fields inside this object:</div><div>`timestamp` string – UTC timestamp in seconds of time when order should expire. Minimum threshold is 300 seconds</div><div>`description` string – Text explanation for expiration. Max character limit is 120 characters</div></div></td></tr></tbody></table>

</div><div id="bkmrk-item-image-object"><div id="bkmrk-item-image-object-1"><div>##### Item Image Object

</div></div></div><div><table><thead><tr><th><span>Object </span></th><th><span>Description </span></th></tr></thead><tbody><tr><td><div><div>`link` string</div></div></td><td><div><div>**Required.** A link to the image that will be shown to the user. Must be an `image/jpeg` or `image/png` and 8-bit, RGB or RGBA. Follows same requirements as image in [media](/books/meta-whatsapp/page/media-developer-documentation)</div></div></td></tr></tbody></table>

</div><div>By the end, the interactive object should look something like this for a catalog-based integration:</div><div>For a non-catalog based integration i.e. when catalog-id is not present, an example payload looks as follows:</div><div id="bkmrk-step-3%3A-add-common-m"><div id="bkmrk-step-3%3A-add-common-m-1"><div>#### Step 3: Add Common Message Parameters

</div></div></div><div>Once the interactive object is complete, append the other parameters that make a message: `recipient_type`, `to`, and `type`. Remember to set the `type` to `interactive`.</div><div>These are [parameters common to all message types](/books/meta-whatsapp/page/sending-messages-developer-documentation).</div><div id="bkmrk-step-4%3Amake-a-post-c"><div id="bkmrk-step-4%3Amake-a-post-c-1"><div>#### Step 4:Make a POST Call to Messages Endpoint

</div></div></div><div>Make a POST call to the [`/[PHONE_NUMBER_ID]/messages`](/books/meta-whatsapp/page/sending-messages-developer-documentation) endpoint with the `JSON` object you have assembled. If your message is sent successfully, you get the following response:</div><div>For all errors that can be returned and guidance on how to handle them, see [WhatsApp Cloud API, Error Codes](/documentation/business-messaging/whatsapp/support/error-codes).</div><div id="bkmrk-step-5%3A-consumer-pay"><div id="bkmrk-step-5%3A-consumer-pay-1"><div>#### Step 5: Consumer Pays for the Order

</div></div></div><div>Consumers can pay using WhatsApp payment method or using any UPI supported app that is installed on the device.</div><div id="bkmrk-step-6%3A-get-notified"><div id="bkmrk-step-6%3A-get-notified-1"><div>#### Step 6: Get Notified About Transaction Status Updates from payment gateway

</div></div></div><div>Businesses receive updates to the invoice via payment gateway webhooks, when the status of the user-initiated transaction changes. The unique identifier tr(reference-id passed in `order_details` message) can be used to map the transaction to the consumer invoice or interactive order details message.</div><div>Please refer to your PG’s documentation for the exact payment signals. If you are not receiving webhooks from your PG, then work with them to enable it.</div><div id="bkmrk-step-7%3A-update-order"><div id="bkmrk-step-7%3A-update-order-1"><div>#### Step 7: Update order status

</div></div></div><div>Upon receiving transaction signals from payment gateway through webhook, the business must update the order status to keep the user up to date. Currently we support the following order status values:</div><div>![Image](https://support2.chatarchitect.com/uploads/images/gallery/2026-04/embedded-image-tk4tonmb.jpeg)</div><div><table><thead><tr><th><span>Value </span></th><th><span>Description </span></th></tr></thead><tbody><tr><td><div><div>`pending`</div></div></td><td><div><div>User has not successfully paid yet</div></div></td></tr><tr><td><div><div>`processing`</div></div></td><td><div><div>User payment authorized, merchant/partner is fulfilling the order, performing service, etc.</div></div></td></tr><tr><td><div><div>`partially-shipped`</div></div></td><td><div><div>A portion of the products in the order have been shipped by the merchant</div></div></td></tr><tr><td><div><div>`shipped`</div></div></td><td><div><div>All the products in the order have been shipped by the merchant</div></div></td></tr><tr><td><div><div>`completed`</div></div></td><td><div><div>The order is completed and no further action is expected from the user or the partner/merchant</div></div></td></tr><tr><td><div><div>`canceled`</div></div></td><td><div><div>The partner/merchant would like to cancel the `order_details` message for the order/invoice. The status update will fail if there is already a `successful` or `pending` payment for this `order_details` message</div></div></td></tr></tbody></table>

</div><div>Typically businesses update the `order_status` using either the WhatsApp payment status change notifications or their own internal processes. To update `order_status`, the partner sends an `order_status` message to the user.</div><div>The following table describes the returned values:</div><div><table><thead><tr><th><span>Value </span></th><th><span>Description </span></th></tr></thead><tbody><tr><td><div><div>`reference_id`</div></div></td><td><div><div>The ID provided by the partner in the `order_details` message</div></div></td></tr><tr><td><div><div>`status`</div></div></td><td><div><div>The new order `status`</div></div></td></tr><tr><td><div><div>`description`</div></div></td><td><div><div>Optional text for sharing status related information in `order_details`. Could be useful while sending cancellation. Max character limit is 120 characters</div></div></td></tr></tbody></table>

</div><div><div>Merchant should always post this order-status message to consumer after receiving transaction updates for an order. As the order_details message and order details screen experience is tied to to the order status updates.</div></div><div id="bkmrk-step-8%3A-reconcile-pa"><div id="bkmrk-step-8%3A-reconcile-pa-1"><div>#### Step 8: Reconcile Payments

</div></div></div><div>Businesses should use their bank statements to reconcile the payments using the `reference_id` provided in the `order_details` messages.</div><div id="bkmrk-merchant-preferred-u"><div id="bkmrk-merchant-preferred-u-1"><div>### Merchant Preferred UPI Payment Method

</div></div></div><div>Now merchants can specify up to `one` UPI Payment app to showup in checkout flow. Merchant preferred payment app will be shown on top of the list of available UPI apps in - “Choose payment method” screen. To enable this capability we require partners to specify the external app-id in the Order Details or order-invoice message.</div><div>Note: This feature is available on consumer apps on and above version: 2.24.21.0</div><div id="bkmrk-updates-to-order-det"><div id="bkmrk-updates-to-order-det-1"><div>#### Updates to Order Details Payload

</div></div></div><div id="bkmrk-list-of-supported-ap"><div id="bkmrk-list-of-supported-ap-1"><div>#### List of supported apps:

</div></div></div><div><table><thead><tr><th><span>UPI Application </span></th><th><span>Application ID to be passed in Order Details payload </span></th></tr></thead><tbody><tr><td><div><div>Google Pay</div></div></td><td><div><div>gpay</div></div></td></tr><tr><td><div><div>PhonePe</div></div></td><td><div><div>phonepe</div></div></td></tr><tr><td><div><div>PayTm</div></div></td><td><div><div>paytm</div></div></td></tr><tr><td><div><div>Amazon Pay</div></div></td><td><div><div>amazonpay</div></div></td></tr><tr><td><div><div>CRED</div></div></td><td><div><div>cred</div></div></td></tr><tr><td><div><div>Mobikwik</div></div></td><td><div><div>mobikwik</div></div></td></tr></tbody></table>

</div><div id="bkmrk-checklist-for-integr"><div id="bkmrk-checklist-for-integr-1"><div>### Checklist for Integrated Merchants

</div></div></div><div>Ensure that `order_status` message is send to consumer informing them about updates to an order after receiving transaction updates for an order.</div><div>Ensure the merchant is verified and WABA contact is marked with a verified check.</div><div>Verify the WABA is mapped to appropriate merchant initiated messaging tier(1k, 10k and 100k per day)</div><div>Merchant should list the customer support information in the profile screen incase consumer wants to report any issues.</div></div>

# Receive payments via payment gateways on WhatsApp | Developer Documentation

<div id="bkmrk-receive-payments-via">## Receive payments via payment gateways on WhatsApp

<div><span>Updated: Dec 12, 2025</span></div><div>Your business can enable customers to pay for their orders through our partner payment gateways without leaving WhatsApp. Businesses can send customers order_details messages, then get notified about payment status updates via webhook notifications.</div><div id="bkmrk-overview"><div id="bkmrk-overview-1"><div>### Overview

</div></div></div><div>Currently, customers browse business catalogs, add products to cart, and send orders with our set of commerce messaging solutions, which includes [Single Product Message, Multi Product Message, and Product Detail Page](/books/meta-whatsapp/page/share-products-with-whatsapp-users-developer-documentation). Now, with the Payments API, businesses can send customers a *bill*, so the customer can complete their order by paying the business without having to leave WhatsApp.</div><div><div>Our payments solution is currently enabled by BillDesk, Razorpay, PayU and Zaakpay, a third-party payments service provider. You must have a BillDesk, Razorpay, PayU or Zaakpay account in order to receive payments on WhatsApp.</div><div>We expect more payment providers to be added in the future.</div></div><div id="bkmrk-how-it-works"><div id="bkmrk-how-it-works-1"><div>### How it works

</div></div></div><div>First, the business composes and sends an `order_details` message. An `order_details` message is a new type of `interactive` message, which always 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.</div><div>Each `order_details` message contains a unique `reference_id` provided by the business, and that unique ID is used throughout the flow to track the order.</div><div>Once the message is sent, the business waits for a payment status update via webhooks. Businesses get notified when the payment status changes, but they must not solely rely on these webhooks notifications due to security reasons. WhatsApp also provides a payment lookup API that can be used to retrieve the payment statuses directly anytime.</div><div id="bkmrk-purchase-flow-in-app"><div id="bkmrk-purchase-flow-in-app-1"><div>### Purchase flow in app

</div></div></div><div>In the WhatsApp Messenger App, the purchase flow has the following steps:</div><div>Customers send an order with selected products to the business either through simple text messages or using other interactive messages such as [Single Product Message, Multi Product Message, and Product Detail.](/books/meta-whatsapp/page/share-products-with-whatsapp-users-developer-documentation)</div><div>Once the business receives the order, they send an `order_details` message to the user. When the user taps on **Review and Pay**, they will see details about the order and total amount to be paid.</div><div>When the user taps the **Continue** button, they are able to choose to pay natively on WhatsApp or any other UPI app.   
  
Checkout with WhatsApp Pay:</div><div>*\[image removed - too large for import\]*</div><div>  
  
Checkout on other UPI Apps:</div><div>*\[image removed - too large for import\]*</div><div>Once the payment has been confirmed by your payment gateway (PG) or payment service provider, the business can start processing the order.</div><div>Businesses can then send an `order_status` message to the consumer informing them about the status of the order. Each message will result in a message bubble (as shown below) that refers to the original order details message and also updates the status displayed on the order details page.</div><div id="bkmrk-link-your-payment-ac"><div id="bkmrk-link-your-payment-ac-1"><div>### Link your payment account

</div></div></div><div>To receive payments on WhatsApp, you must add a *payment configuration* to the corresponding WhatsApp Business Account. A payment configuration allows you to link a payment gateway account to WhatsApp. Each payment configuration is associated with a *unique name*. As part of the `order_details` message, you can specify the payment configuration to use for a specific checkout. WhatsApp will then generate a checkout flow using the associated payment gateway account.</div><div>*\[image removed - too large for import\]*</div><div>After linking your payment partner account, you must integrate with the Payments APIs below. This will allow you to send an `order_details` message to customers with the payment configuration to receive payments.</div><div id="bkmrk-steps-to-unlink-paym"><div id="bkmrk-steps-to-unlink-paym-1"><div>#### Steps to unlink Payment Configuration

</div></div></div><div>Note: Make sure no new order messages requesting payment from consumer are sent with the payment config your are trying to remove before you perform the unlink action.</div><div id="bkmrk-integration-steps"><div id="bkmrk-integration-steps-1"><div>### Integration Steps

</div></div></div><div>The steps outlined below assume that the business already knows what the user is interested in through earlier chat threads. The Payments API is a standalone API and hence can work with various messages such as [List Messages, Reply Buttons, Single or Multi-Product Messages](/books/meta-whatsapp/page/sending-messages-developer-documentation).</div><div id="bkmrk-sequence-diagram"><div id="bkmrk-sequence-diagram-1"><div>#### Sequence Diagram

</div></div></div><div>The following sequence diagram demonstrates the typical integration flow for Payments API. The steps highlighted in green are the key integration steps.</div><div>*\[image removed - too large for import\]*</div><div id="bkmrk-step-1%3A-send-order-d"><div id="bkmrk-step-1%3A-send-order-d-1"><div>#### Step 1: Send Order Details Interactive Message

</div></div></div><div>To send an `order_details` message, businesses must assemble an interactive object of type `order_details` with the following components:</div><div><table><thead><tr><th><span>Object </span></th><th><span>Description </span></th></tr></thead><tbody><tr><td><div><div>`type`</div><div>object</div></div></td><td><div><div>**Required.**</div><div>Must be “order_details”.</div></div></td></tr><tr><td><div><div>`header`</div><div>object</div></div></td><td><div><div>**Optional.**</div><div>Header content displayed on top of a message. If a header is not provided, the API uses an image of the first available product as the header</div></div></td></tr><tr><td><div><div>`body`</div><div>object</div></div></td><td><div><div>**Required.**</div><div>An object with the body of the message. The object contains the following field:</div><div>`text` string</div><span>**Required** if `body` is present. The content of the message. Emojis and markdown are supported. Maximum length is 1024 characters</span></div></td></tr><tr><td><div><div>`footer`</div><div>object</div></div></td><td><div><div>**Optional.**</div><div>An object with the footer of the message. The object contains the following fields:</div><div>`text` string</div><span>**Required** if `footer` is present. The footer content. Emojis, markdown, and links are supported. Maximum length is 60 characters</span></div></td></tr><tr><td><div><div>`action`</div><div>object</div></div></td><td><div><div>**Required.**</div><div>An action object you want the user to perform after reading the message. This action object contains the following fields:</div><div>`name` string</div><span>**Required**. Must be “review\_and\_pay”</span><div>`parameters` object</div><span>See [Parameters Object](#bkmrk-parameters-object-1) for information</span></div></td></tr></tbody></table>

</div><div id="bkmrk-parameters-object"><div id="bkmrk-parameters-object-1"><div>##### Parameters Object

</div></div></div><div><table><thead><tr><th><span>Object </span></th><th><span>Description </span></th></tr></thead><tbody><tr><td><div><div>`reference_id`</div><div>string</div></div></td><td><div><div>**Required.**</div><div>Unique identifier for the order or invoice provided by the business. It is case sensitive and cannot be an empty string and can only contain English letters, numbers, underscores, dashes, or dots, and should not exceed 35 characters.</div><div>The reference_id must be unique for each order_details message for a given business. If there is a need to send multiple order_details messages for the same order, it is recommended to include a sequence number in the reference_id (for example, “BM345A-12”) to ensure reference_id uniqueness.</div></div></td></tr><tr><td><div><div>`type`</div><div>object</div></div></td><td><div><div>**Required.**</div><div>The type of goods being paid for in this order. Current supported options are `digital-goods` and `physical-goods`.</div></div></td></tr><tr><td><div><div>`beneficiaries`</div><div>array</div></div></td><td><div><div>**Required for shipped physical-goods.**</div><div>An array of beneficiaries for this order. A beneficiary is an intended recipient for shipping the physical goods in the order. It contains the following fields:</div><div>Note: Beneficiary information isn’t shown to users but is needed for legal and compliance reasons.</div><div>`name` string</div><span>**Required.** Name of the individual or business receiving the physical goods. Cannot exceed 200 characters</span><div>`address_line1` string</div><span>**Required.** Shipping address (Door/Tower Number, Street Name etc.). Cannot exceed 100 characters</span><div>`address_line2` string</div><span>**Optional.** Shipping address (Landmark, Area, etc.). Cannot exceed 100 characters</span><div>`city` string</div><span>**Required.** Name of the city.</span><div>`state` string</div><span>**Required.** Name of the state.</span><div>`country` string</div><span>**Required.** Must be “India”.</span><div>`postal_code` string</div><span>**Required.** 6-digit zipcode of shipping address.</span></div></td></tr><tr><td><div><div>`currency`</div></div></td><td><div><div>**Required.**</div><div>The currency for this order. Currently the only supported value is `INR`.</div></div></td></tr><tr><td><div><div>`total_amount`</div><div>object</div></div></td><td><div><div>**Required.**</div><div>The `total_amount` object contains the following fields:</div><div>`offset` integer</div><span>**Required.** Must be `100` for `INR`.</span><div>`value` integer</div><span>**Required.** Positive integer representing the amount value multiplied by offset. For example, ₹12.34 has value 1234.</span><div><div>`total_amount.value` must be equal to `order.subtotal.value` + `order.tax.value` + `order.shipping.value` - `order.discount.value`.</div></div><div><div>UPI transactions are limited to ₹5,00,000. For higher amounts, set `enabled_payment_options` to `["web"]`. See [Restrict Available Payment Options](#bkmrk-restrict-available-p-1).</div></div></div></td></tr><tr><td><div><div>`payment_settings`</div><div>object</div></div></td><td><div><div>**Required.**</div><div>See [Payment Settings object](#bkmrk-payment-settings-obj-1) for more information.</div></div></td></tr><tr><td><div><div>`order`</div><div>object</div></div></td><td><div><div>**Required.**</div><div>See [order object](#bkmrk-order-object-1) for more information.</div></div></td></tr></tbody></table>

</div><div id="bkmrk-payment-settings-obj"><div id="bkmrk-payment-settings-obj-1"><div>##### Payment settings object

</div></div></div><div><table><thead><tr><th><span>Object </span></th><th><span>Description </span></th></tr></thead><tbody><tr><td><div><div>`type`</div><div>string</div></div></td><td><div><div>**Required.**</div><div>Must be set to **“payment\_gateway”**</div></div></td></tr><tr><td><div><div>`payment_gateway`</div><div>object</div></div></td><td><div><div>**Required.**</div><div>An object that describes payment account information:</div><div>`type` string</div><span>**Required.** Unique identifier for an item in the order. You must set this to **“billdesk”** or **“razorpay”** or **“payu”** or **zaakpay**, if you have linked your BillDesk or Razorpay or PayU or Zaakpay payment gateway to accept payments</span><div>`configuration_name` string</div><span>**Required.** The name of the pre-configured payment configuration to use for this order and must not exceed 60 characters. This value must match with a payment configuration set up on the WhatsApp Business Manager.</span><div><div>When `configuration_name` is invalid, the customer will be unable to pay for their order. We strongly advise businesses to conduct extensive testing of this setup during the integration phase.</div></div><div>`billdesk/razorpay/payu/zaakpay` object</div><span>**Optional.** For merchants/partners that want to use additional\_info1/7(for BillDesk), notes and receipt(for Razorpay) and UDF fields(for PayU) and extra1/2(for Zaakpay), they can now pass these values in Order Details message and we would use these to create transaction/order at respective PGs.</span><div>Please refer [Payment Gateway specific UDF object](#bkmrk-billdesk%2C-razorpay%2C--1) for more information.</div></div></td></tr></tbody></table>

</div><div id="bkmrk-billdesk%2C-razorpay%2C-"><div id="bkmrk-billdesk%2C-razorpay%2C--1"><div>##### BillDesk, RazorPay, PayU and Zaakpay fields

</div></div></div><div>We now have support for partners and merchants to pass `notes`, `receipt` and `udf` fields in Order Details message and receive this data back in payment signals. Here we will take a look at merchants can pass additional_info for BillDesk, notes and receipt fields for Razorpay, udf for PayU, extra for Zaakpay PGs.</div><div><table><thead><tr><th><span>Object </span></th><th><span>Description </span></th></tr></thead><tbody><tr><td><div><div>`notes`</div><div>object</div></div></td><td><div><div>**Optional.**</div><span>Only supported for Razorpay payment gateway</span><div>The object can be key value pairs with maximum 15 keys and each value limits to 256 characters.</div></div></td></tr><tr><td><div><div>`receipt`</div><div>String</div></div></td><td><div><div>**Optional.**</div><span>Only supported for Razorpay payment gateway</span><div>Receipt number that corresponds to this order, set for your internal reference. Maximum length of 40 characters supported with minimum length greater than 0 characters.</div></div></td></tr><tr><td><div><div>`udf1-4`</div><div>String</div></div></td><td><div><div>**Optional.**</div><span>Only supported for PayU payment gateway</span><div>User-defined fields (udf) are used to store any information corresponding to a particular order. Each UDF field has a maximum character limit of 255.</div></div></td></tr><tr><td><div><div>`extra1-2`</div><div>String</div></div></td><td><div><div>**Optional.**</div><span>Only supported for Zaakpay payment gateway</span><div>User-defined fields (extra) are used to store any information corresponding to a particular order. Each extra field has a maximum character limit of 180.</div></div></td></tr><tr><td><div><div>`additional_info1-7`</div><div>String</div></div></td><td><div><div>**Optional.**</div><span>Only supported for BillDesk payment gateway</span><div>User-defined fields (extra) are used to store any information corresponding to a particular order. Each extra field has a maximum character limit of 120.</div></div></td></tr></tbody></table>

</div><div id="bkmrk-order-object"><div id="bkmrk-order-object-1"><div>##### Order object

</div></div></div><div><table><thead><tr><th><span>Object </span></th><th><span>Description </span></th></tr></thead><tbody><tr><td><div><div>`status`</div><div>string</div></div></td><td><div><div>**Required.**</div><div>Only supported value in the `order_details` message is `pending`.</div><div><div>In an `order_status` message, `status` can be: `pending`, `captured`, or `failed`.</div></div></div></td></tr><tr><td><div><div>`type` string</div></div></td><td><div><div>**Optional.**</div><div>Only supported value is `quick_pay`. When this field is passed in we hide the “Review and Pay” button and only show the “Pay Now” button in the order details bubble.</div></div></td></tr><tr><td><div><div>`items`</div><div>object</div></div></td><td><div><div>**Required.**</div><div>An object with the list of items for this order, containing the following fields:</div><div>`retailer_id` string</div><span>**Optional.** Content ID for an item in the order from your catalog.</span><div>`name` string</div><span>**Required.** The item’s name to be displayed to the user. Cannot exceed 60 characters</span><div>`image` object</div><span>**Optional.** Custom image for the item to be displayed to the user. See [item image object](#bkmrk-item-image-object-1) for information</span><div><div>Using this image field will limit the items array to a maximum of 10 items and this cannot be used with `retailer_id` or `catalog_id`.</div></div><div>`amount` amount object with value and offset -- refer total amount field above</div><span>**Required.** The price per item</span><div>`sale_amount` amount object</div><span>**Optional.** The discounted price per item. This should be less than the original amount. If included, this field is used to calculate the subtotal amount.</span><div>`quantity` integer</div><span>**Required.** The number of items in this order, this field cannot be decimal has to be integer.</span><div>`country_of_origin` string</div><span>**Required** if `catalog_id` is not present. The country of origin of the product</span><div>`importer_name` string</div><span>**Required** if `catalog_id` is not present. Name of the importer company</span><div>`importer_adress` string</div><span>**Required** if `catalog_id` is not present. Address of importer company</span></div></td></tr><tr><td><div><div>`subtotal`</div><div>object</div></div></td><td><div><div>**Required.**</div><div>The value **must be equal** to sum of `order.amount.value` * `order.amount.quantity`. Refer to `total_amount` description for explanation of `offset` and `value` fields</div><div>The following fields are part of the `subtotal` object:</div><div>`offset` integer</div><span>**Required.** Must be `100` for `INR`</span><div>`value` integer</div><span>**Required.** Positive integer representing the amount value multiplied by offset. For example, ₹12.34 has value 1234</span></div></td></tr><tr><td><div><div>`tax`</div><div>object</div></div></td><td><div><div>**Required.**</div><div>The tax information for this order which contains the following fields:</div><div>`offset` integer</div><span>**Required.** Must be `100` for `INR`</span><div>`value` integer</div><span>**Required.** Positive integer representing the amount value multiplied by offset. For example, ₹12.34 has value 1234</span><div>`description` string</div><span>**Optional.** Max character limit is 60 characters</span></div></td></tr><tr><td><div><div>`shipping`</div><div>object</div></div></td><td><div><div>**Optional.**</div><div>The shipping cost of the order. The object contains the following fields:</div><div>`offset` integer</div><span>**Required.** Must be `100` for `INR`</span><div>`value` integer</div><span>**Required.** Positive integer representing the amount value multiplied by offset. For example, ₹12.34 has value 1234</span><div>`description` string</div><span>**Optional.** Max character limit is 60 characters</span></div></td></tr><tr><td><div><div>`discount`</div><div>object</div></div></td><td><div><div>**Optional.**</div><div>The discount for the order. The object contains the following fields:</div><div>`offset` integer</div><span>**Required.** Must be `100` for `INR`</span><div>`value` integer</div><span>**Required.** Positive integer representing the amount value multiplied by offset. For example, ₹12.34 has value 1234</span><div>`description` string</div><span>**Optional.** Max character limit is 60 characters</span><div>`discount_program_name` string</div><span>**Optional.** Text used for defining incentivised orders. If order is incentivised, the merchant needs to define this information. Max character limit is 60 characters</span></div></td></tr><tr><td><div><div>`catalog_id`</div><div>object</div></div></td><td><div><div>**Optional.**</div><div>Unique identifier of the Facebook catalog being used by the business.</div><div>If you do not provide this field, you must provide the following fields inside the items object: `country_of_origin`, `importer_name`, and `importer_address`</div></div></td></tr><tr><td><div><div>`expiration`</div><div>object</div></div></td><td><div><div>**Optional.**</div><div>Expiration for that order. Business must define the following fields inside this object:</div><div>`timestamp` string – UTC timestamp in seconds of time when order should expire. Minimum threshold is 300 seconds</div><div>`description` string – Text explanation for expiration. Max character limit is 120 characters</div></div></td></tr></tbody></table>

</div><div id="bkmrk-item-image-object"><div id="bkmrk-item-image-object-1"><div>##### Item Image Object

</div></div></div><div><table><thead><tr><th><span>Object </span></th><th><span>Description </span></th></tr></thead><tbody><tr><td><div><div>`link` string</div></div></td><td><div><div>**Required.** A link to the image that will be shown to the user. Must be an `image/jpeg` or `image/png` and 8-bit, RGB or RGBA. Follows same requirements as image in [media](/books/meta-whatsapp/page/media-developer-documentation)</div></div></td></tr></tbody></table>

</div><div><div>The `parameters` value is a stringified JSON object.</div></div><div>By the end, the interactive object should look something like this for a BillDesk catalog-based integration:</div><div><div>The `parameters` value is a stringified JSON object.</div></div><div>By the end, the interactive object should look something like this for a RazorPay catalog-based integration:</div><div><div>The `parameters` value is a stringified JSON object.</div></div><div>For a PayU non-catalog based integration i.e. when catalog-id is not present, an example payload looks as follows:</div><div>For a Zaakpay non-catalog based integration i.e. when catalog-id is not present, an example payload looks as follows:</div><div id="bkmrk-step-2%3A-add-common-m"><div id="bkmrk-step-2%3A-add-common-m-1"><div>#### Step 2: Add Common Message Parameters

</div></div></div><div>Once the interactive object is complete, append the other parameters that make a message: `recipient_type`, `to`, and `type`. Remember to set the `type` to `interactive`.</div><div>These are [parameters common to all message types](/books/meta-whatsapp/page/sending-messages-developer-documentation).</div><div id="bkmrk-step-3%3Amake-a-post-c"><div id="bkmrk-step-3%3Amake-a-post-c-1"><div>#### Step 3:Make a POST Call to Messages Endpoint

</div></div></div><div>Make a POST call to the [`/[PHONE_NUMBER_ID]/messages`](/books/meta-whatsapp/page/sending-messages-developer-documentation) endpoint with the `JSON` object you have assembled. If your message is sent successfully, you get the following response:</div><div>For all errors that can be returned and guidance on how to handle them, see [WhatsApp Cloud API, Error Codes](/documentation/business-messaging/whatsapp/support/error-codes).</div><div id="bkmrk-product-experience"><div id="bkmrk-product-experience-1"><div>##### Product Experience

</div></div></div><div>The customer receives an `order_details` message similar to the one below (left). When they click on “Review and Pay”, it opens up the order details screen as shown below (middle). Customer can then pay for their order using “Continue” button that opens up a bottom sheet with the payment options (right).</div><div><div><div><div>*\[image removed - too large for import\]*</div></div><div><div>*\[image removed - too large for import\]*</div></div><div><div>*\[image removed - too large for import\]*</div></div></div></div><div id="bkmrk-step-4%3A-receive-webh"><div id="bkmrk-step-4%3A-receive-webh-1"><div>#### Step 4: Receive Webhook about Transaction Status

</div></div></div><div>Businesses receive updates via [messages webhooks](/books/meta-whatsapp/page/messages-webhook-reference-developer-documentation) when the status of the user-initiated transaction changes in a status of type “payment”. It contains the following fields:</div><div><table><thead><tr><th><span>Object </span></th><th><span>Description </span></th></tr></thead><tbody><tr><td><div><div>`id`</div><div>string</div></div></td><td><div><div>**Required.**</div><div>Webhook ID for the notification.</div></div></td></tr><tr><td><div><div>`recipient_id `</div><div>string</div></div></td><td><div><div>**Required.**</div><div>WhatsApp ID of the customer.</div></div></td></tr><tr><td><div><div>`type`</div><div>string</div></div></td><td><div><div>**Required.**</div><div>For payment status update webhooks, type is “payment”.</div></div></td></tr><tr><td><div><div>`status`</div><div>string</div></div></td><td><div><div>**Required.**</div><div>`captured`/`pending`: `captured` - when the payment is successfully completed, `pending` when the user attempted but yet to receive success transactions signal</div></div></td></tr><tr><td><div><div>`payment`</div><div>object</div></div></td><td><div><div>**Required.**</div><div>Contains the following field:   
`reference_id` string</div><div>Unique reference ID for the order sent in `order_details` message.   
`amount` object</div><div>Has value and offset fields corresponding to total amount that user has paid.   
`currency `string</div><div>currency is always INR.   
`transaction `object Transaction attempt for this payment. Transaction object contains the following fields:</div><div>`id` string **Required.** The alpha-numeric payment gateway order ID.</div><div>`pg_transaction_id` string **Optional.** The alpha-numeric payment gateway payment ID.</div><div>`type` string **Required.** The payment type for this transactions. Only, `billdesk` or `razorpay` or `payu` or `zaakpay` are supported.</div><div>`status` string **Required.** The status of the transaction. Can be one of `pending` or `success` or `failed`.</div><div>`created_timestamp` integer **Required.** Time when transaction was created in epoch seconds.</div><div>`updated_timestamp` integer **Required.** Time when transaction was last updated in epoch seconds.</div><span>`method` object (**Optional.** the payment method information might not be available for failed payments)</span><div>`type` string **Required.** The describes the type of payment method used by consumer to pay for the order. Can be one of `upi` or `card` or `wallet` or `netbanking`.</div><span>`error` object (**Optional.** the payment error details might not be available for all payments attempts)</span><span>`code` string **Required.** The describes the payment failure reason that is generated by payment gateway and Meta returns this to partners.</span><div>`reason` string **Required.** The describes the payment failure reason in plain text that is generated by payment gateway and Meta returns this to partners.   
`additional_info1-7` string **Optional.**</div><div>Only sent for billdesk payment gateway when the value is sent in order details message. Each of the keys additional_info1-4 has string values in them.   
`notes `object **Optional.**</div><div>Only sent for razorpay payment gateway when the value is sent in order details message. This contains key-value pair as passed in the Order Details message.   
`receipt` string **Optional.**</div><div>Only sent for razorpay payment gateway when the value is sent in order details message.   
`udf1-4` string **Optional.**</div><span>Only sent for payu payment gateway when the value is sent in order details message. Each of the keys udf1-4 has string values in them.</span><div>  
`extra1-2` string **Optional.**</div><span>Only sent for zaakpay payment gateway when the value is sent in order details message. Each of the keys extra1-2 has string values in them.   
`refunds` array **Optional.**</span><div>The list of refunds for this order. Each refund object contains the following fields:</div><span>`id` string **Required.** The alpha-numeric ID of the refund.</span><span>`amount` object **Required.** The total amount of the refund.</span><span>`speed_processed` string **Required.** Speed by which refund was processed. Can be one of `instant` or `normal`.</span><span>`status` string **Required.** The status of the refund. Can be one of `pending`, `success` or `failed`.</span><span>`created_timestamp` integer **Required.** Time when refund was created in epoch seconds.</span><span>`updated_timestamp` integer **Required.** Time when refund was last updated in epoch seconds.</span></div></td></tr><tr><td><div><div>`timestamp`</div><div>string</div></div></td><td><div><div>**Required.**</div><div>Timestamp for the webhook.</div></div></td></tr></tbody></table>

</div><div>Here is an example status webhook of type `payment`:</div><div>For more information about other statuses, see [Messages Webhooks](/books/meta-whatsapp/page/messages-webhook-reference-developer-documentation).</div><div id="bkmrk-step-5%3A-confirm-paym"><div id="bkmrk-step-5%3A-confirm-paym-1"><div>#### Step 5: Confirm Payment

</div></div></div><div>After receiving the payment status webhook, or at any time, the business can look up the status of the payment for the order. To do that, businesses must make a GET call to the payments endpoint as shown here:</div><div><div>```
<span><span>GET </span><span><</span><span>PHONE_NUMBER_ID</span><span>></span><span>/payments/</span><span><</span><span>PAYMENT_CONFIGURATION</span><span>></span><span>/</span><span><</span><span>REFERENCE_ID</span><span>></span></span><br></br>
```

</div></div><div>where `payment_configuration` and `reference_id` are same as that sent in the `order_details` message.</div><div>Businesses should expect a response in the same HTTP session (not in a webhook notification) that contains the following fields:</div><div><table><thead><tr><th><span>Field </span></th><th><span>Description </span></th></tr></thead><tbody><tr><td><div><div>`reference_id`</div><div>string</div></div></td><td><div><div>**Required.**</div><div>The ID sent by the business in the `order_details` message</div></div></td></tr><tr><td><div><div>`status`</div><div>string</div></div></td><td><div><div>**Required.**</div><div>Status of the payment for the order. Can be one of `pending` or `captured`  
</div><div>Refer the table below for what these statuses mean.</div></div></td></tr><tr><td><div><div>`currency`</div><div>string</div></div></td><td><div><div>**Required.**</div><div>The currency for this payment. Currently the only supported value is `INR`.</div></div></td></tr><tr><td><div><div>`amount`</div><div>object</div></div></td><td><div><div>**Required.**</div><div>The amount for this payment. It contains the following fields:</div><div>`offset` integer</div><span>**Required.** Must be 100.</span><div>`value` integer</div><span>**Required.** Positive integer representing the amount value multiplied by offset. For example, ₹12.34 has value 1234.</span></div></td></tr><tr><td><div><div>`transactions`</div><div>array</div></div></td><td><div><div>**Optional.**</div><div>The list of transactions for this payment. This field is only present when at least one payment attempt has been made. If the payment status is `pending` and no payment attempt has occurred, this field will not be returned. Each transaction object contains the following fields:</div><div>`id` string</div><span>**Required.** The alpha-numeric payment gateway order ID.</span><div>`pg_transaction_id` string</div><span>**Required.** The alpha-numeric payment gateway payment ID.</span><div>`type` string</div><span>**Required.** The payment type for this transactions. Only, `billdesk` or `razorpay` or `payu` or `zaakpay` are supported.</span><div>`status` string</div><span>**Required.** The status of the transaction. Can be one of `pending` or `success` or `failed`.</span><div><div>At most one transaction can have a `success` status.</div></div><div>`created_timestamp` integer</div><span>**Required.** Time when transaction was created in epoch seconds.</span><div>`updated_timestamp` integer</div><span>**Required.** Time when transaction was last updated in epoch seconds.</span><div>`method` object</div><div>**Optional.** the payment method information might not be available for failed payments</div><span>`type` string **Required.** The describes the type of payment method used by consumer to pay for the order. Can be one of `upi` or `card` or `wallet` or `netbanking`.</span><div>`error` object</div><div>**Optional.** the payment error details might not be available for all payments attempts</div><span>`code` string **Required.** The describes the payment failure reason that is generated by payment gateway and Meta returns this to partners.</span><span>`reason` string **Required.** The describes the payment failure reason in plain text that is generated by payment gateway and Meta returns this to partners.</span><div>`refunds` array</div><div>**Optional.** The list of refunds for this order. Each refund object contains the following fields:</div><span>`id` string **Required.** The alpha-numeric ID of the refund.</span><span>`amount` object **Required.** The total amount of the refund.</span><span>`speed_processed` string **Required.** Speed by which refund was processed. Can be one of `instant` or `normal`.</span><span>`status` string **Required.** The status of the refund. Can be one of `pending`, `success` or `failed`.</span><span>`created_timestamp` integer **Required.** Time when refund was created in epoch seconds.</span><span>`updated_timestamp` integer **Required.** Time when refund was last updated in epoch seconds.</span></div></td></tr><tr><td><div><div>`additional_info1-7`</div><div>string</div></div></td><td><div><div>**Optional.**</div><div>Supported for only BillDesk PG, this contains string values sent as part of Order Details message.</div></div></td></tr><tr><td><div><div>`receipt`</div><div>string</div></div></td><td><div><div>**Optional.**</div><div>Supported for only Razorpay PG, this contains the receipt-value sent as part of Order Details message.</div></div></td></tr><tr><td><div><div>`notes`</div><div>object</div></div></td><td><div><div>**Optional.**</div><div>Supported for only Razorpay PG, this contains the key-value pairs sent as part of Order Details message.</div></div></td></tr><tr><td><div><div>`udf1-4`</div><div>string</div></div></td><td><div><div>**Optional.**</div><div>Supported for only PayU PG, this contains string values sent as part of Order Details message.</div></div></td></tr><tr><td><div><div>`extra1-2`</div><div>string</div></div></td><td><div><div>**Optional.**</div><div>Supported for only Zaakpay PG, this contains string values sent as part of Order Details message.</div></div></td></tr></tbody></table>

</div><div id="bkmrk-payment-status"><div id="bkmrk-payment-status-1"><div>##### Payment Status

</div></div></div><div><table><thead><tr><th><span>Status </span></th><th><span>Description </span></th></tr></thead><tbody><tr><td><div><div>`pending`</div></div></td><td><div><div>The order has been created but payment has not yet been captured. This status covers two scenarios:</div><span>**No payment attempt yet:** The `transactions` array will not be present in the response.</span><span>**Payment attempted but failed:** The `transactions` array will contain one or more entries with `status` set to `failed`.</span></div></td></tr><tr><td><div><div>`captured`</div></div></td><td><div><div>The payment was successfully captured. The `transactions` array will contain an entry with `status` set to `success`.</div></div></td></tr></tbody></table>

</div><div>An example successful response looks like this:</div><div>Shown here is an example for a generic error:</div><div id="bkmrk-response-by-payment-"><div id="bkmrk-response-by-payment--1"><div>##### Response by Payment Stage

</div></div></div><div>The response payload varies depending on the payment stage. Below are examples for each stage.</div><div>**No payment attempted** — The user has not yet attempted payment. Only order-level fields are returned; the `transactions` array is not present.</div><div>**Payment successful** — The user completed payment and the payment gateway confirmed capture. The `transactions` array contains the successful transaction with payment method details.</div><div>**Payment failed** — The user attempted payment but it failed. The overall payment status remains `pending` (the order is still awaiting successful payment), but the `transactions` array contains the failed attempt with error details.</div><div id="bkmrk-step-6%3A-update-order"><div id="bkmrk-step-6%3A-update-order-1"><div>#### Step 6: Update Order Status

</div></div></div><div><div>Businesses *must* send updates to their order using the `order_status` message instead of text messages since the latest status of an order displayed on the order details page is only based on `order_status` messages.</div></div><div>To notify the customer with updates to an order, you can send an `interactive` message of type `order_status` as shown below.</div><div>The following table describes the fields in the `order_status` interactive message:</div><div><table><thead><tr><th><span>Object </span></th><th><span>Description </span></th></tr></thead><tbody><tr><td><div><div>`type`</div><div>string</div></div></td><td><div><div>**Required.** Must be “order_status”</div></div></td></tr><tr><td><div><div>`body`</div><div>object</div></div></td><td><div><div>**Required.**</div><div>An object with the body of the message. The object contains the following field:</div><div>`text` string</div><span>**Required** if `body` is present. The content of the message. Emojis and markdown are supported. Maximum length is 1024 characters.</span></div></td></tr><tr><td><div><div>`footer`</div><div>object</div></div></td><td><div><div>**Optional.**</div><div>An object with the footer of the message. The object contains the following field:</div><div>`text` string</div><span>**Required** if `footer` is present. The footer content. Emojis, markdown, and links are supported. Maximum length is 60 characters.</span></div></td></tr><tr><td><div><div>`action`</div><div>object</div></div></td><td><div><div>**Required.**</div><div>An action object you want the user to perform after reading the message. This action object contains the following fields:</div><div>`name` string</div><span>**Required**. Must be “review\_order”.</span><div>`parameters` object</div><span>See [Parameters Object](#bkmrk-parameters-object-4) for information.</span></div></td></tr></tbody></table>

</div><div id="bkmrk-parameters-object-3"><div id="bkmrk-parameters-object-4"><div>##### Parameters object

</div></div></div><div>The `parameters` object contains the following fields:</div><div><table><thead><tr><th><span>Value </span></th><th><span>Description </span></th></tr></thead><tbody><tr><td><div><div>`reference_id`</div><div>string</div></div></td><td><div><div>**Required.**</div><div>The ID sent by the business in the `order_details` message.</div></div></td></tr><tr><td><div><div>`order`</div><div>object</div></div></td><td><div><div>**Required.** This object contains the following fields:</div><div>`status` string</div><span>**Required.** The new order `status`. Must be one of `processing`, `partially_shipped`, `shipped`, `completed`, `canceled`.</span><div>`description` string</div><span>**Optional.** Text for sharing status related information in `order_details`. Could be useful while sending cancellation. Max character limit is 120 characters.</span></div></td></tr></tbody></table>

</div><div>`order_status` message introduces two new errors that are summarized below.</div><div><table><thead><tr><th><span>Error Code </span></th><th><span>Description </span></th></tr></thead><tbody><tr><td><div><div>`2046` - Invalid status transition</div></div></td><td><div><div>The order status transition is not allowed.</div></div></td></tr><tr><td><div><div>`2047` - Cannot cancel order</div></div></td><td><div><div>Cannot cancel the order since the user has already paid for it.</div></div></td></tr></tbody></table>

</div><div id="bkmrk-product-experience-3"><div id="bkmrk-product-experience-4"><div>##### Product Experience

</div></div></div><div>Customers receive each `order_status` update as a separate message in their chat thread, that references their original `order_details` message as shown below (left). The order details page always displays the latest valid status communicated to the customer using the `order_status` message as shown below (right).</div><div><div><div><div><div>*\[image removed - too large for import\]*</div></div></div><div><div><div>*\[image removed - too large for import\]*</div></div></div></div></div><div id="bkmrk-supported-order-stat"><div id="bkmrk-supported-order-stat-1"><div>##### Supported Order Status and Transitions

</div></div></div><div>Currently we support the following order status values:</div><div><table><thead><tr><th><span>Value </span></th><th><span>Description </span></th></tr></thead><tbody><tr><td><div><div>`pending`</div></div></td><td><div><div>User has not successfully paid yet</div></div></td></tr><tr><td><div><div>`processing`</div></div></td><td><div><div>User payment authorized, merchant/partner is fulfilling the order, performing service, etc.</div></div></td></tr><tr><td><div><div>`partially-shipped`</div></div></td><td><div><div>A portion of the products in the order have been shipped by the merchant</div></div></td></tr><tr><td><div><div>`shipped`</div></div></td><td><div><div>All the products in the order have been shipped by the merchant</div></div></td></tr><tr><td><div><div>`completed`</div></div></td><td><div><div>The order is completed and no further action is expected from the user or the partner/merchant</div></div></td></tr><tr><td><div><div>`canceled`</div></div></td><td><div><div>The partner/merchant would like to cancel the `order_details` message for the order/invoice. The status update will fail if there is already a `successful` or `pending` payment for this `order_details` message</div></div></td></tr></tbody></table>

</div><div>Order status transitions are restricted for consistency of consumer experience. Allowed status transitions are summarized below:</div><span>Initial status of an order is always `pending`, which is sent in `order_details` message.</span><span>`canceled` and `completed` are terminal status and cannot be updated to any other status.</span><span>`pending` can transition to any of the other statuses including `processing`, `shipped`, `partially-shipped`.</span><span>`processing`, `shipped` and `partially-shipped` are equivalent statuses and can transition between one another or to one of the terminal statuses.</span><div>*\[image removed - too large for import\]*</div><div>Upon sending an `order_status` message with an invalid transition, you will receive an error webhook with the error code `2046` and message “New order status was not correctly transitioned.”</div><div id="bkmrk-canceling-an-order"><div id="bkmrk-canceling-an-order-1"><div>##### Canceling an Order

</div></div></div><div>An order can be `canceled` by sending an `order_status` message with the status `canceled`. The customer cannot pay for an order that is canceled. The customer receives an `order_status` message and order details page is updated to show that the order is canceled and the “Continue” button removed. The *optional* text shown below “Order canceled” on the order details page can be specified using the `description` field in the `order_status` message.</div><div>An order can be canceled only if the user has not already paid for the order. If the user has paid and you send an `order_status` message with `canceled` status, you will receive an error webhook with error code `2047` and message “Could not change order status to ‘canceled’”.</div><div id="bkmrk-step-7%3A-reconcile-pa"><div id="bkmrk-step-7%3A-reconcile-pa-1"><div>#### Step 7: Reconcile Payments

</div></div></div><div>WhatsApp does not support payment reconciliations. Businesses should use their payment gateway account to reconcile the payments using the `reference_id` provided in the `order_details` messages and the `id` of the transactions returned as part of the payment lookup query.</div><div id="bkmrk-merchant-preferred-u"><div id="bkmrk-merchant-preferred-u-1"><div>### Merchant Preferred UPI Payment Method

</div></div></div><div>Now merchants can specify up to one UPI Payment app to showup in checkout flow. Merchant preferred payment app will be shown on top of the list of available UPI apps in the “Choose payment method” screen. To enable this capability we require partners to specify the external app-id in the Order Details or order-invoice message.</div><div>Note: This feature is available on consumer apps on and above version: 2.24.21.0</div><div id="bkmrk-updates-to-order-det"><div id="bkmrk-updates-to-order-det-1"><div>#### Updates to Order Details Payload

</div></div></div><div id="bkmrk-list-of-supported-ap"><div id="bkmrk-list-of-supported-ap-1"><div>#### List of supported apps:

</div></div></div><div><table><thead><tr><th><span>UPI Application </span></th><th><span>Application ID to be passed in Order Details payload </span></th></tr></thead><tbody><tr><td><div><div>Google Pay</div></div></td><td><div><div>gpay</div></div></td></tr><tr><td><div><div>PhonePe</div></div></td><td><div><div>phonepe</div></div></td></tr><tr><td><div><div>PayTm</div></div></td><td><div><div>paytm</div></div></td></tr><tr><td><div><div>BHIM</div></div></td><td><div><div>bhim</div></div></td></tr><tr><td><div><div>Amazon Pay</div></div></td><td><div><div>amazonpay</div></div></td></tr><tr><td><div><div>CRED</div></div></td><td><div><div>cred</div></div></td></tr><tr><td><div><div>Mobikwik</div></div></td><td><div><div>mobikwik</div></div></td></tr></tbody></table>

</div><div id="bkmrk-restrict-available-p"><div id="bkmrk-restrict-available-p-1"><div>### Restrict Available Payment Options

</div></div></div><div>Merchants can specify which payment options to show in checkout flow between UPI and Web options. This will allow merchants to enable only UPI or credit card(any PG available option) to accept payments for invoices.</div><div><div>UPI transactions are limited to ₹5,00,000. For higher amounts, set `enabled_payment_options` to `["web"]` to use your payment gateway’s web checkout. Payments with UPI enabled above this limit will fail.</div></div><div>Note: This feature is available on consumer apps on and above version: 2.24.22.4</div><div id="bkmrk-updates-to-order-det-3"><div id="bkmrk-updates-to-order-det-4"><div>#### Updates to Order Details Payload

</div></div></div><div id="bkmrk-list-of-payment-opti"><div id="bkmrk-list-of-payment-opti-1"><div>#### List of payment options

</div></div></div><div><table><thead><tr><th><span>Enabled Option </span></th><th><span>Experience in checkout flow </span></th></tr></thead><tbody><tr><td><div><div>upi</div></div></td><td><div><div>Only UPI apps are show in checkout flow</div></div></td></tr><tr><td><div><div>web</div></div></td><td><div><div>Payment gateway webpage is loaded and merchant payment gateway account configured payment options will be shown in the checkout flow.</div></div></td></tr></tbody></table>

</div><div><div>Some Payment Gateways allow customization of payment options that are shown in payment link or web based checkout flow. Please contact Payment Gateway to restricting payment options in payment link or web page.</div></div><div id="bkmrk-third-party-validati"><div id="bkmrk-third-party-validati-1"><div>### Third Party Validation with Razorpay and PayU Payment Gateways

</div></div></div><div>We now support TPV for RazorPay and PayU merchants, this allows merchants to specify the consumer accounts from which orders needs to be paid. Since, the consumer bank account information is sensitive, please work with Payment Gateways to procure public encryption key and pass the encryption information as part of Order details message.</div><div>To use this feature which is in alpha testing, please reach out to Meta payments team - whatsappindia-bizpayments-support@meta.com</div><div id="bkmrk-updates-to-order-det-6"><div id="bkmrk-updates-to-order-det-7"><div>#### Updates to Order Details Payload to support TPV for Razorpay merchants

</div></div></div><div>The raw value before encryption should look something like the following:</div><div id="bkmrk-updates-to-order-det-9"><div id="bkmrk-updates-to-order-det-10"><div>#### Updates to Order Details Payload to support TPV for PayU merchants

</div></div></div><div>The raw value before encryption should look like the following:</div><div><div>Note please closely work with Meta and Payment Gateway teams(RazorPay or PayU) to unlock this feature as we are still in alpha testing phase.</div></div><div id="bkmrk-security-considerati"><div id="bkmrk-security-considerati-1"><div>### Security Considerations

</div></div></div><div>Businesses should comply with local security and regulatory requirements in India. They should not rely solely on the status of the transaction provided in the webhook and must use payment lookup API to retrieve the statuses directly from WhatsApp. Businesses must always sanitize/validate the data in the API responses or webhooks to protect against SSRF attacks.</div><div id="bkmrk-checklist-for-integr"><div id="bkmrk-checklist-for-integr-1"><div>### Checklist for Integrated Merchants

</div></div></div><div>Ensure that `order_status` message is send to consumer informing them about updates to an order after receiving transaction updates for an order.</div><div>Ensure the merchant is verified and WABA contact is marked with a verified check.</div><div>Verify the WABA is mapped to appropriate merchant initiated messaging tier(1k, 10k and 100k per day)</div><div>Merchant should list the customer support information in the profile screen incase consumer wants to report any issues.</div><div>Migrate to “payment_settings” in place of “payment_type” and “payment_configuration”. This is the recommended way, and gives access to features likes “notes” and “udf” fields. For an example, [view the payloads above](#bkmrk-step-1%3A-send-order-d-1).</div></div>