Платежи Pix вне сайта | Документация для разработчиков

Платежи Offsite Pix

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

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

При использовании этой интеграции WhatsApp лишь обеспечивает связь между продавцами и покупателями. Продавцы несут ответственность за интеграцию с банком или платежной системой для генерации динамических Pix-кодов и подтверждения платежей.

Прежде чем начать

Ознакомьтесь с API заказов . Заказы — это точка входа для сбора платежей в WhatsApp.Для генерации динамических кодов Pix и автоматической сверки платежей вам потребуется существующая интеграция с банком или платежной системой. Вы должны иметь возможность обновлять статус заказа сразу после совершения платежа.

Этапы интеграции

Следующая диаграмма последовательности демонстрирует типичную интеграцию с Pix.

1. Отправьте сообщение с подробной информацией о заказе

Полное руководство по интеграции находится на странице API заказов .

Если функция Pix доступна для этого заказа, вам потребуется указать значение pix_dynamic_code в payment_settings .

Конечная точка

POST /{ PHONE_NUMBER_ID }/ messages

Пример полезной нагрузки

{ "recipient_type": "individual", "to": "<PHONE_NUMBER> ", "type": "interactive", "interactive": { "type": "order_details", "body": { "text": "Содержание вашего сообщения" }, "action": { "name": "review_and_pay", "parameters": { "reference_id": "unique-reference-id", "type": "digital-goods", "payment_type": "br", "payment_settings": [ { "type": "pix_dynamic_code", "pix_dynamic_code": { "code": "00020101021226700014br.gov.bcb.pix2548pix.example.com...", "merchant_name": "Имя владельца счета", "key": "39580525000189", "key_type": "CNPJ" } } ], "currency": "BRL", "total_amount": { "value": 50000, "смещение": 100 }, "заказ": { "статус": "ожидание", "налог": { "значение": 0, "смещение": 100, "описание": "необязательный текст" }, "товары": [ { "идентификатор продавца": "1234567", "название": "Торт", "количество": { "значение": 50000, "смещение": 100 }, "количество": 1 } ], "итого": { "значение": 50000, "смещение": 100 } } } } } }

Объект параметров

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

Настройки оплаты

Название поля	Необязательный?	Тип	Описание
`тип`	Необходимый	Нить	Должно быть `pix_dynamic_code` .
`pix_dynamic_code`	Необходимый	Динамический пиксельный объект	Динамический объект Pix Code, который будет использоваться для отображения этой опции покупателям в процессе оформления заказа.

Динамический объект кода Pix

Название поля	Необязательный?	Тип	Описание
`код`	Необходимый	Нить	Динамический код Pix, который будет скопирован покупателем.
`merchant_name`	Необходимый	Нить	Имя владельца аккаунта. Отображается в приложении для покупателя в информационных целях.
`ключ`	Необходимый	Нить	Условные обозначения. Отображаются в приложении для покупателя в информационных целях.
`key_type`	Необходимый	Нить	Тип ключа Pix. Один из вариантов: `CPF` , `CNPJ` , `EMAIL` , `PHONE` или `EVP` .

2. Отправить уведомление о статусе заказа

После подтверждения платежа необходимо отправить обновление статуса заказа. Следуйте инструкциям по интеграции на странице API заказов .