Receive Payments via Payment Gateways on WhatsApp

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.

Overview

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

Before You Start

It is recommended you install the latest version of the WhatsApp Business Platform On-Premises client. This feature is supported only on WhatsApp On-Premise API client versions >= v2.47.1.

To use RazorPay receipt and notes fields or UDF fields for PayU use the latest client version >= v2.51.2

How It Works

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.

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.

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.

Purchase Flow in App

In the WhatsApp Messenger App, the purchase flow has the following steps:

1. 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.
2. 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.
3. 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
   

   Checkout on other UPI Apps
   

4. Once the payment has been confirmed by your payment gateway (PG) or payment service provider, the business can start processing the order.
5. 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.

Link Your Payment Account

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.

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.

Steps to unlink Payment Configuration

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.

Integration Steps

The steps outlined below assume that the business already knows what the user is interested in through earlier conversations. 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.

Sequence Diagram

The following sequence diagram demonstrates the typical integration flow for Payments API. The steps higlighted in green are the key integration steps.

Step 1: Send Order Details Interactive Message

To send an order_details message, businesses must assemble an interactive object of type order_details with the following components:

Parameters Object

Payment Settings Object

RazorPay Notes and PayU UDF fields (Supported API client version >= v2.51.2)

We now have support for partners and merchants to pass notes, receipt and udf fileds in Order Details message and receive this data back in payment signals. Here we will take a look at merchants can pass notes, receipt fields for Razorpay and UDF for PayU PGs.

Order Object

By the end, the interactive object should look something like this for razor payment gateway with notes and receipts fields:

{
  "recipient_type": "individual",
  "to": "[recipient-whatsapp-id]",
  "type": "interactive",
  "interactive": {
    "type": "order_details",
    "header": {
      "type": "image",
      "image": {
        "link": "http(s)://the-url",
        "provider": {
          "name": "provider-name"
        }
      }
    },
    "body": {
      "text": "your-text-body-content"
    },
    "footer": {
      "text": "your-text-footer-content"
    },
    "action": {
      "name": "review_and_pay",
      "parameters": {
        "reference_id": "reference-id-value",
        "type": "digital-goods",
        "currency": "INR",
        "total_amount": {
          "value": 21000,
          "offset": 100
        },
        "payment_settings": [
          {
            "type": "payment_gateway",
            "payment_gateway": {
              "type": "razorpay",
              "configuration_name": "payment-config-id",
              "razorpay": {
                "receipt": "receipt-value",
                "notes": {
                  "key1": "value1"
                }
              }
            }
          }
        ],
        "order": {
          "status": "pending",
          "catalog_id": "the-catalog_id",
          "expiration": {
            "timestamp": "utc_timestamp_in_seconds",
            "description": "expiration-explanation"
          },
          "items": [
            {
              "retailer_id": "1234567",
              "name": "Product name, for example bread",
              "amount": {
                "value": 10000,
                "offset": 100
              },
              "quantity": 5,
              "sale_amount": {
                "value": 10000,
                "offset": 100
              }
            }
          ],
          "subtotal": {
            "value": 10000,
            "offset": 100
          },
          "shipping": {
            "value": 10000,
            "offset": 100,
            "description": "optional_text"
          },
          "discount": {
            "value": 10000,
            "offset": 100,
            "description": "optional_text",
            "discount_program_name": "optional_text"
          },
          "tax": {
            "value": 10000,
            "offset": 100,
            "description": "optional_text"
          }
        }
      }
    }
  }
}

For PayU payment gateway the order details message with UDF field support looks like the following:

{
  "recipient_type": "individual",
  "to": "[recipient-whatsapp-id]",
  "type": "interactive",
  "interactive": {
    "type": "order_details",
    "header": {
      "type": "image",
      "image": {
        "link": "http(s)://the-url",
        "provider": {
          "name": "provider-name"
        }
      }
    },
    "body": {
      "text": "your-text-body-content"
    },
    "footer": {
      "text": "your-text-footer-content"
    },
    "action": {
      "name": "review_and_pay",
      "parameters": {
        "reference_id": "reference-id-value",
        "type": "digital-goods",
        "currency": "INR",
        "total_amount": {
          "value": 21000,
          "offset": 100
        },
        "payment_settings": [
          {
            "type": "payment_gateway",
            "payment_gateway": {
              "type": "payu",
              "configuration_name": "payment-config-id",
              "payu": {
                "udf1": "value1",
                "udf2": "value2",
                "udf3": "value3",
                "udf4": "value4"
              }
            }
          }
        ],
        "order": {
          "status": "pending",
          "catalog_id": "the-catalog_id",
          "expiration": {
            "timestamp": "utc_timestamp_in_seconds",
            "description": "expiration-explanation"
          },
          "items": [
            {
              "retailer_id": "1234567",
              "name": "Product name, for example bread",
              "amount": {
                "value": 10000,
                "offset": 100
              },
              "quantity": 5,
              "sale_amount": {
                "value": 10000,
                "offset": 100
              }
            }
          ],
          "subtotal": {
            "value": 10000,
            "offset": 100
          },
          "shipping": {
            "value": 10000,
            "offset": 100,
            "description": "optional_text"
          },
          "discount": {
            "value": 10000,
            "offset": 100,
            "description": "optional_text",
            "discount_program_name": "optional_text"
          },
          "tax": {
            "value": 10000,
            "offset": 100,
            "description": "optional_text"
          }
        }
      }
    }
  }
}

Add Common Message Parameters

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.

{ 
  "recipient_type": "individual",
  "to" : "whatsapp-id", // WhatsApp ID of the recipient
  "type": "interactive",
  "interactive":{
    // The interactive object  
   }
}

These are parameters common to all message types.

Make a POST Call to /messages

Make a POST call to the /messages endpoint with the JSON object you have assembled in steps 1 and 2. If your message is sent successfully, you get the following response.

{
  "messages": [{
    "id": "{message-id}"
  }]
}

For all errors that can be returned and guidance on how to handle them, see WhatsApp On-Premises API, Errors.

Product Experience

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).

Step 2: Receive Webhook about Transaction Status

Businesses receive updates via WhatsApp webhooks when the status of the user-initiated transaction changes in a status of type "payment". It contains the following fields:

Here is an example status webhook of type payment:

POST /
{
  "statuses": [
    {
      "id": "gBGGFlB5YjhvAgnhuF1qIUvCo7A",
      "from": "16315555555",
      "type": "payment",
      "status": "new-transaction-status",
      "payment": {
        "reference_id": "reference-id-value",
        "amount": {
          "value": 21000,
          "offset": 100
        },
        "currency": "INR",
        "receipt": "receipt-value",
        "notes": {
          "key1": "value1",
          "key2": "value2"
        },
        "udf1": "udf1-value",
        "udf2": "udf2-value",
        "udf3": "udf3-value",
        "udf4": "udf4-value"
      },
      "timestamp": "1610561171"
    }
  ]
}

For more information about other statuses, see Components, Statuses Object.

Step 3: Confirm Payment

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:

  GET /v1/payments/{payment_configuration}/{reference_id}

where payment_configuration and reference_id are same as that sent in the order_details message.

Businesses should expect a response in the same HTTP session (not in a webhook notification) that contains the following fields:

Payment Status

An example successful response looks like this:

{
  "payments": [
    {
      "reference_id": "BM4321",
      "status": "success",
      "currency": "INR",
      "total_amount": {
        "value": 21000,
        "offset": 100
      },
      "transactions": [
        {
          "id": "1243A434",
          "type": "razorpay/payu",
          "status": "success",
          "created_timestamp": 1664030516,
          "updated_timestamp": 1664040212
        }
      ],
      "receipt": "receipt-value",
      "notes": {
        "key1": "value1",
        "key2": "value2"
      },
      "udf1": "udf1-value",
      "udf2": "udf2-value",
      "udf3": "udf3-value",
      "udf4": "udf4-value"
    }
  ]
}

In the case of any errors, response is similar to an error response for /v1/messages endpoint. For all errors that can be returned and guidance on how to handle them, see WhatsApp On-Premises API, Errors. Show here is an example for a generic error:

{
  "errors": [{
    "code": 500,
    "title": "Generic error",
    "details": "System error. Please try again."
  }]
}

Step 4: Update Order Status

To notify the customer with updates to an order, you can send an interactive message of type order_status as shown below.

{
  "recipient_type": "individual",
  "to": "whatsapp-id",
  "type": "interactive",
  "interactive": {
    "type": "order_status",
    "body": {
      "text": "your-text-body-content"
    },
    "action": {
      "name": "review_order",
      "parameters": {
        "reference_id": "reference-id-value",
        "order": {
          "status": "processing",
          "description": "optional-text"
        }
      }
    }
  }
}

The following table describes the fields in the order_status interactive message:

The parameters object contains the following fields:

order_status message introduces two new errors that are summarized below.

For all other errors that can be returned and guidance on how to handle them, see WhatsApp On-Premises API, Errors.

Product Experience

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).

Supported Order Status and Transitions

Currently we support the following order status values:

Order status transitions are restricted for consistency of consumer experience. Allowed status transitions are summarized below:

• Initial status of an order is always pending, which is sent in order_details message.
• canceled and completed are terminal status and cannot be updated to any other status.
• pending can transition to any of the other statuses including processing, shipped, partially-shipped.
• processing, shipped and partially-shipped are equivalent statuses and can transition between one another or to one of the terminal statuses.

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."

Canceling an Order

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.

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'".

Step 5: Reconcile Payments

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.

Older Send Order Details Message Structure

To send an order_details message, businesses must assemble an interactive object of type order_details with the following components:

Parameters Object

Order Object

By the end, the interactive object should look something like this:

{
  "recipient_type": "individual",
  "to": "[recipient-whatsapp-id]",
  "type": "interactive",
  "interactive": {
    "type": "order_details",
    "header": {
      "type": "image",
      "image": {
        "link": "http(s)://the-url",
        "provider": {
          "name": "provider-name"
        }
      }
    },
    "body": {
      "text": "your-text-body-content"
    },
    "footer": {
      "text": "your-text-footer-content"
    },
    "action": {
      "name": "review_and_pay",
      "parameters": {
        "reference_id": "reference-id-value",
        "type": "digital-goods",
        "payment_type": "payment_gateway:razorpay/payu",
        "payment_configuration": "unique-payment-config-id",
        "currency": "INR",
        "total_amount": {
          "value": 21000,
          "offset": 100
        },
        "order": {
          "status": "pending",
          "catalog_id": "the-catalog_id",
          "expiration": {
            "timestamp": "utc_timestamp_in_seconds",
            "description": "expiration-explanation"
          },
          "items": [{
            "retailer_id": "1234567",
            "name": "Product name, for example bread",
            "amount": {
              "value": 10000,
              "offset": 100
            },
            "quantity": 5,
            "sale_amount": {
              "value": 10000,
              "offset": 100
            }
          }],
          "subtotal": {
            "value": 10000,
            "offset": 100
          },
          "shipping": {
            "value": 10000,
            "offset": 100,
            "description": "optional_text"
          },
          "discount": {
            "value": 10000,
            "offset": 100,
            "description": "optional_text",
            "discount_program_name": "optional_text"
          },
          "tax": {
            "value": 10000,
            "offset": 100,
            "description": "optional_text"
          },
        }
      }
    }
  }
}

Security Considerations

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.