API для адаптации новых пользователей | Документация для разработчиков

API для регистрации новых пользователей

Обновлено: 14 ноября 2025 г

Для приема платежей через WhatsApp необходимо настроить платежи, привязанные к соответствующему бизнес-аккаунту WhatsApp. Каждая настройка платежа имеет уникальное имя. В сообщении order_details вы можете указать настройку платежа, которая будет использоваться для конкретного оформления заказа.

API для подключения позволяют программно выполнять определенные операции:

Привяжите все параметры оплаты к бизнес-аккаунту WhatsApp.Получите специальные настройки оплаты, привязанные к бизнес-аккаунту WhatsApp.Создайте конфигурацию платежа.Сгенерируйте ссылку OAuth для платежного шлюза, чтобы связать конфигурацию платежа с платежным шлюзом.Удалите настройки оплаты.

Получить все настройки оплаты

Получите список настроек платежей, связанных с бизнес-аккаунтом WhatsApp.

Синтаксис запроса

ПОЛУЧАТЬ /<WHATSAPP_BUSINESS_ACCOUNT_ID> /payment_configurations

Образец запроса

curl 'https://graph.facebook.com/v16.0/102290129340398/payment_configurations' \ -H 'Авторизация: Bearer EAAJB...'

Пример ответа

{ "data": [ { "payment_configurations": [ { "configuration_name": "test-payment-configuration", "merchant_category_code": { "code": "0000", "description": "Test MCC Code" }, "purpose_code": { "code": "00", "description": "Test Purpose Code" }, "status": "Active", "provider_mid": "test-payment-gateway-mid", "provider_name": "RazorPay", "created_timestamp": 1720203204, "updated_timestamp": 1721088316 }, .... ] } ] }

Поле	Описание
`configuration_name` нить	Необходимый. Название конфигурации платежа, которое будет использоваться в сообщении «Подробности заказа».
`merchant_category_code` объект	Необходимый. Код категории продавца: строка `кода` Обязательно. Будет действительный код MCC. строка `описания` Обязательно. Описание кода MCC.
`purpose_code` объект	Необходимый. Код назначения: строка `кода` Обязательно. Будет указан допустимый код назначения. строка `описания` Обязательно. Описание кода назначения.
`статус` нить	Необходимый. Статус конфигурации платежа. Должен быть одним из [“Активный”, “Требуется_подключение”, “Требуется_тестирование”].
`provider_mid` нить	Необязательный. Идентификационный номер продавца (MID) платежного шлюза.
`имя_провайдера` нить	Необязательный. Название платежного шлюза. Должно быть одним из следующих: [“razorpay”, “payu”, “zaakpay”].
`merchant_vpa` нить	Необязательный. Идентификатор UPI продавца.
`созданная_временная_метка` целое число	Необязательный. Время создания настроек платежа.
`обновленная_временная_метка` целое число	Необязательный. Время последнего обновления настроек оплаты.

Получите конкретные настройки оплаты

Получите специальные настройки оплаты, привязанные к бизнес-аккаунту WhatsApp.

Синтаксис запроса

ПОЛУЧАТЬ /<WHATSAPP_BUSINESS_ACCOUNT_ID> /payment_configuration/<CONFIGURATION_NAME>

Образец запроса

curl 'https://graph.facebook.com/v16.0/102290129340398/payment_configuration/test-payment-configuration' \ -H 'Авторизация: Bearer EAAJB...'

Пример ответа

{ "data": [ { "configuration_name": "test-payment-configuration", "merchant_category_code": { "code": "0000", "description": "Test MCC Code" }, "purpose_code": { "code": "00", "description": "Test Purpose Code" }, "status": "Active", "provider_mid": "test-payment-gateway-mid", "provider_name": "RazorPay", "created_timestamp": 1720203204, "updated_timestamp": 1721088316 } ] }

Поле	Описание
`configuration_name` нить	Необходимый. Название конфигурации платежа, которое будет использоваться в сообщении «Подробности заказа».
`merchant_category_code` объект	Необходимый. Код категории продавца: строка `кода` Обязательно. Будет действительный код MCC. строка `описания` Обязательно. Описание кода MCC.
`purpose_code` объект	Необходимый. Код назначения: строка `кода` Обязательно. Будет указан допустимый код назначения. строка `описания` Обязательно. Описание кода назначения.
`статус` нить	Необходимый. Статус конфигурации платежа. Должен быть одним из [“Активный”, “Требуется_подключение”, “Требуется_тестирование”].
`provider_mid` нить	Необязательный. Идентификационный номер продавца (MID) платежного шлюза.
`имя_провайдера` нить	Необязательный. Название платежного шлюза. Должно быть одним из следующих: [“razorpay”, “payu”, “zaakpay”].
`merchant_vpa` нить	Необязательный. Идентификатор UPI продавца.
`созданная_временная_метка` целое число	Необязательный. Время создания настроек платежа.
`обновленная_временная_метка` целое число	Необязательный. Время последнего обновления настроек оплаты.

Создайте конфигурацию платежей

Создайте конфигурацию платежа.

Синтаксис запроса

ПОЧТА /<WHATSAPP_BUSINESS_ACCOUNT_ID> /payment_configuration

Образец запроса

Конфигурация типа платежного шлюза

curl -X POST \ 'https://graph.facebook.com/v15.0/102290129340398/payment_configuration' \ -H 'Authorization: Bearer EAAJB...' \ -H 'Content-Type: application/json' \ -d '{ "configuration_name": "test-payment-configuration", "purpose_code": "00", "merchant_category_code": "0000", "provider_name": "razorpay", "redirect_url": "https://test-redirect-url.com" }'

Конфигурация типа UPI Vpa

curl -X POST \ 'https://graph.facebook.com/v15.0/102290129340398/payment_configuration' \ -H 'Авторизация: Bearer EAAJB...' \ -H 'Тип содержимого: application/json' \ -d '{ "configuration_name": "test-payment-configuration", "purpose_code": "00", "merchant_category_code": "0000", "provider_name": "upi_vpa", "merchant_vpa": "test-upi-merchant-vpa@test" }'

Поле	Описание
`configuration_name` нить	Необходимый. Название конфигурации платежа, которое будет использоваться в сообщении «Подробности заказа».
`merchant_category_code` нить	Необязательный. Код категории продавца.
`purpose_code` объект	Необязательный. Код назначения.
`имя_провайдера` нить	Необходимый. Название поставщика в конфигурации платежей. Должно быть одним из следующих: [“upi_vpa”, “razorpay”, “payu”, “zaakpay”].
`merchant_vpa` нить	Необязательный. Идентификатор UPI продавца.
`redirect_url` URI	Необязательный. URL-адрес, на который продавец будет перенаправлен после успешной привязки настроек оплаты.

Пример ответа

Конфигурация типа платежного шлюза

{ "oauth_url": "https://www.facebook.com/payment/onboarding/init/", "expiration": 1721687287, "success": true }

Конфигурация типа UPI Vpa

{ "success": true }

Поле	Описание
`oauth_url` нить	Необязательный. URL-адрес OAuth, используемый для привязки конфигурации платежа к платежному шлюзу
`срок действия` целое число	Необязательный. Срок действия URL-адреса OAuth.
`успех` логический	Необходимый. Логический флаг, указывающий на успешность или неуспешность создания конфигурации платежа.

Связать или обновить конечную точку данных

В следующем разделе объясняется, как связать, обновить и удалить конечные точки данных, чтобы включить купоны, адрес доставки и информацию о наличии товаров в режиме реального времени, предоставляемые шаблонами кнопок оформления заказа .

Синтаксис запроса

ПОЧТА /<WHATSAPP_BUSINESS_ACCOUNT_ID> /payment_configuration/<CONFIGURATION_NAME>

Образец запроса

Конфигурация типа платежного шлюза

curl -X POST \ 'https://graph.facebook.com/v15.0/102290129340398/payment_configuration/test-payment-configuration' \ -H 'Authorization: Bearer EAAJB...' \ -H 'Content-Type: application/json' \ -d '{ "data_endpoint_url": "https://test-data-endpoint-url.com" }'

Поле	Описание
`data-endpoint-url` URI	Необязательный. URL-адрес конечной точки, на которую клиент WhatsApp отправляет защищенный HTTPS-запрос для обмена данными в рамках «Шаблоны кнопок оформления заказа» .

Восстановить конфигурацию платежа по ссылке OAuth

Сгенерировать заново ссылку OAuth в конфигурации платежного шлюза.

Синтаксис запроса

ПОЧТА /<WHATSAPP_BUSINESS_ACCOUNT_ID> /generate_payment_configuration_oauth_link

Образец запроса

curl -X POST \ 'https://graph.facebook.com/v15.0/102290129340398/generate_payment_configuration_oauth_link' \ -H 'Авторизация: Bearer EAAJB...' \ -H 'Тип содержимого: application/json' \ -d '{ "configuration_name": "test-payment-configuration", "redirect_url": "https://test-redirect-url.com" }'

Поле	Описание
`configuration_name` нить	Необходимый. Название конфигурации платежа, которое будет использоваться в сообщении «Подробности заказа».
`redirect_url` URI	Необязательный. URL-адрес, на который продавец будет перенаправлен после успешной привязки настроек оплаты.

Пример ответа

{ "oauth_url": "https://www.facebook.com/payment/onboarding/init/", "expiration": 1721687287 }

Поле	Описание
`oauth_url` нить	Необязательный. URL-адрес OAuth, используемый для привязки конфигурации платежа к платежному шлюзу
`срок действия` целое число	Необязательный. Срок действия URL-адреса OAuth.

Удаление настроек платежа

Удалите настройки оплаты.

Синтаксис запроса

УДАЛИТЬ /<WHATSAPP_BUSINESS_ACCOUNT_ID> /payment_configuration

Поле	Описание
`configuration_name` нить	Необходимый. Название конфигурации платежа, которое будет использоваться в сообщении «Подробности заказа».

Образец запроса

curl -X DELETE \ 'https://graph.facebook.com/v15.0/102290129340398/payment_configuration' \ -H 'Authorization: Bearer EAAJB...' \ -H 'Content-Type: application/json' \ -d '{ "configuration_name": "test-payment-configuration" }'

Пример ответа

{ "success": true }

Поле	Описание
`успех` логический	Необходимый. Логический флаг, указывающий, было ли удаление настроек платежа успешным или нет.

Веб-перехватчик настройки платежей

Компании получают уведомления об изменениях в настройках платежной системы через веб-хуки WhatsApp.

Для получения веб-хуков компаниям необходимо подписаться на событие «payment_configuration_update» для своего приложения.

Веб-перехватчик содержит следующие поля:

Поле	Описание
`configuration_name` нить	Необходимый. Название конфигурации платежа, которое будет использоваться в сообщении «Подробности заказа».
`имя_провайдера` нить	Необходимый. Название поставщика платежных настроек. Должно быть одним из следующих: [“razorpay”, “payu”, “zaakpay”].
`provider_mid` нить	Необходимый. Идентификатор продавца в платежном шлюзе.
`статус` нить	Необходимый. Статус конфигурации платежа. Должен быть одним из [“Активный”, “Требуется_подключение”, “Требуется_тестирование”].
`созданная_временная_метка` целое число	Необходимый. Время создания настроек платежа.
`обновленная_временная_метка` целое число	Необходимый. Время последнего обновления настроек оплаты.

Пример веб-перехватчика для настройки платежей

{ "entry": [ { "id": "0", "time": 1725499886, "changes": [ { "field": "payment_configuration_update", "value": { "configuration_name": "test-payment-configuration", "provider_name": "razorpay", "provider_mid": "test-provider-mid", "status": "Needs Testing", "created_timestamp": 123457678, "updated_timestamp": 123457678 } } ] } ], "object": "whatsapp_business_account" }

Ошибки

Условия использования платежной системы WhatsApp находятся на рассмотрении

Если вы видите следующую ошибку, примите условия использования WhatsApp Payments, используя ссылку, указанную в сообщении об ошибке, прежде чем повторять попытку.

{ "error": { "message": "(#131005) Доступ запрещен", "type": "OAuthException", "code": 131005, "error_data": { "messaging_product": "whatsapp", "details": "Ожидается принятие условий обслуживания WhatsApp Payments для этого бизнес-аккаунта WhatsApp. Пожалуйста, используйте следующую ссылку, чтобы принять условия обслуживания перед использованием бизнес-API: https://fb.me/12345" } } }

Со всеми остальными ошибками, которые могут быть возвращены, и рекомендациями по их обработке см. WhatsApp Cloud API, Коды ошибок .