Onboarding APIs | Developer Documentation

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.

Onboarding APIs allows you to programatically perform certain operations:

Businesses receive updates via WhatsApp webhooks when the status of the payment configuration changes.

To receive webhook, Businesses must subscribe to “payment_configuration_update” event for their respective application.

Webhook contains the following fields:

Field	Description
configuration_name string	Required. The name of the payment configuration to be used in the Order Details message.
provider_name string	Required. Provider name of the payment configuration. Must be one of [“razorpay”, “payu”, “zaakpay”].
provider_mid string	Required. Payment gateway account merchant ID.
status string	Required. Status of the payment configuration. Must be one of [“Active”, “Needs_Connecting”, “Needs_Testing”].
created_timestamp integer	Required. Time when payment configuration was created.
updated_timestamp integer	Required. Time when payment configuration was last updated.

If you see the following error, accept the WhatsApp Payments terms of service using the link provided in the error message before trying again.

For all other errors that can be returned and guidance on how to handle them, see WhatsApp Cloud API, Error Codes.