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