# 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>