Receive WhatsApp Payments via Payment Links
Last updated
Last updated
The Payments API feature is available only for Indian businesses using the 360dialog WhatsApp Business API with phone numbers only from India. Review WhatsApp Business Compliance for India.
This feature is now available to all Indian businesses. If the account is in high or medium tiers, admins or finance editors users will have direct access to the Payment Gateway page and can manage payment settings in Meta Business Manager. If you have any trouble using this feature, please reach out to our Support Team.
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.
Businesses can enable customers to pay for their orders using all the UPI Apps installed on their devices via WhatsApp. Businesses can send customers invoices (order_details
) messages, then get notified about payment status updates via webhook notifications from Payment Gateway.
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.
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.
Once the message is sent, the business waits for a payment or transaction status updates directly from Payment Gateway. Upon receiving a payment signal for an order, business should relay this payment signal to the consumer client through interactive order status(order_status
) message.
Please note that neither 360dialog nor WhatsApp supports payment reconciliations.
You must reconcile the payment with the business payment service provider using the respective order reference_id.
In the WhatsApp customer app, the purchase flow has the following steps:
Customer sends an order with selected products to the business or business identifies the products that the customer has shown interest to purchase.
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.
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.
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.
The following is a sample payment link redirect within In-App Browser accepting various payment methods like credit, debit, wallet and UPI apps.
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.
The steps outlined below assume that the business is about to send order details message to consumer client.
The following sequence diagram demonstrates the typical integration flow for WA Payments API:
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:
Business needs to use the same reference-id, amount and expiration in invoice(order_details
) interactive message.
To send an order_details
message, businesses must assemble an interactive object of type order_details
with the following components:
Order Object
By the end, the interactive object should look something like this for a catalog-based integration:
For a non-catalog based integration i.e. when catalog-id is not present, an example payload looks as follows:
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
.
Make a POST call to the /messages
endpoint with the JSON
object you have assembled. If your message is sent successfully, you get the following response:
Consumers can pay using WhatsApp payment method or using any UPI supported app that is installed on the device.
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.
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:
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.
The following table describes the returned values:
Please note that neither 360dialog nor WhatsApp supports payment reconciliations. Businesses should use their bank statements to reconcile the payments using the reference_id
provided in the order_details
messages.
Object | Description |
---|---|
Object | Description |
---|---|
Object | Description |
---|---|
Object | Description |
---|---|
Object | Description |
---|---|
Value | Description |
---|---|
Value | Description |
---|---|