Payment Docs
Платежи по странамЛатинская Америка

Бразилия

Оплата через PIX, картой и boleto в BRL

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

Этот способ оплаты доступен не всем мерчантам. Уточните доступность у вашего менеджера.

Обзор

ВалютаКод страныСпособы оплаты
BRLBRPIX (QR-код) · Карта · Boleto

В Бразилии доступны три варианта интеграции. Они требуют разные данные плательщика; какой из них включён для вашего аккаунта, определяется настройками терминала.

Не уверены, какой вариант у вас? Уточните у менеджера.

Это схема host-to-host: вы получаете QR-ссылку PIX напрямую из API и отображаете её в собственном интерфейсе.

Создайте заказ

Создайте обычный заказ в BRL и сохраните его id.

Создание платежа

Запросите QR-ссылку

POST /v1/orders/{orderId}/h2h/pix
curl -X POST "https://api.1capital.capital/v1/orders/{orderId}/h2h/pix" \
  -H "Content-Type: application/json" \
  -H "X-Api-Token: YOUR_API_TOKEN"

QR-ссылка генерируется на стороне провайдера. Установите таймаут запроса от 30 секунд.

Ответ:

{
  "qrLink": "https://pix.com.br/..."
}

Покажите QR-код

Отобразите qrLink в виде QR-кода или откройте его как ссылку на мобильных устройствах. Плательщик подтверждает перевод в приложении своего банка.

Дождитесь результата

Статус заказа меняется на COMPLETED, когда перевод подтверждён. Вы получаете webhook или можете опрашивать заказ по ID.

Статус заказа и webhook-уведомления

Плательщик перенаправляется на paymentLink и вводит данные карты на платёжной странице. Результат обычно известен сразу; финальный статус приходит webhook-уведомлением.

Документ, email и полный адрес плательщика передаются в объекте customer. Банк проверяет карточный платёж по данным плательщика и без адреса отклоняет его — даже для цифровых товаров. Заказ с недостающими полями, с документом, не прошедшим проверку контрольных цифр, или со штатом не в виде двухбуквенного кода отклоняется с 400.

Передавайте настоящий адрес плательщика: шаблонный или чужой адрес ухудшает антифрод-проверку. Телефон необязателен, но его тоже стоит передавать — некоторые проверки рисков отклоняют плательщика без телефона.

Поля объекта customer

ПолеТипОбязательноеОписание
documentstring✅ ДаCPF (11 цифр) или CNPJ (14 цифр) плательщика, с пунктуацией или без
emailstring✅ ДаEmail плательщика
postcodestring✅ ДаCEP: 8 цифр, с дефисом или без
streetstring✅ ДаУлица
addressNumberstring✅ ДаНомер дома
neighborhoodstring✅ ДаРайон (bairro)
citystring✅ ДаГород
statestring✅ ДаШтат двухбуквенным кодом (SP). Полное название (São Paulo) не принимается
addressComplementstring❌ НетКвартира, офис, этаж
phonestring❌ НетТелефон с кодом города (DDD): 10–11 цифр, допускается код страны 55. Рекомендуется
documentTypestring❌ НетCPF или CNPJ. Если передан, должен соответствовать document
firstNamestring❌ НетИмя. Без имени используется имя с карты
lastNamestring❌ НетФамилия
ipstring❌ НетIP-адрес плательщика. Рекомендуется: он участвует в антифрод-проверках

Пример запроса

{
  "purpose": "Payment for order #1234",
  "amount": "150",
  "currency": "BRL",
  "externalId": "external_id",
  "externalUserId": "external_user_id",
  "successUrl": "https://example.com/success",
  "failUrl": "https://example.com/fail",
  "callbackUrl": "https://example.com/webhooks/payments",
  "isFeeOnUser": false,
  "customer": {
    "firstName": "Ana",
    "lastName": "Souza",
    "email": "ana.souza@example.com",
    "document": "12345678909",
    "phone": "11999998888",
    "postcode": "01310-100",
    "street": "Av. Paulista",
    "addressNumber": "1578",
    "addressComplement": "Apto 12",
    "neighborhood": "Bela Vista",
    "city": "São Paulo",
    "state": "SP"
  }
}

Плательщик перенаправляется на paymentLink. Платёжная страница показывает boleto: его номер (linha digitável) с кнопкой копирования, ссылку на PDF и PIX того же boleto как более быстрый способ.

Boleto регистрируется в банке на имя плательщика, поэтому в объекте customer обязательны полные данные плательщика: действительный документ, контакты и полный адрес. Заказ с недостающими или некорректными полями отклоняется с 400.

Передавайте CPF или CNPJ самого плательщика. Документ проверяется по контрольным цифрам, а boleto регистрируется на того, кому этот документ принадлежит.

Поля объекта customer

ПолеТипОбязательноеОписание
firstNamestring✅ ДаИмя
lastNamestring✅ ДаФамилия
documentstring✅ ДаCPF (11 цифр) или CNPJ (14 цифр) плательщика, с пунктуацией или без
emailstring✅ ДаEmail плательщика
phonestring✅ ДаТелефон с кодом региона (DDD): 10–11 цифр, код страны 55 допускается
postcodestring✅ ДаCEP: 8 цифр, с дефисом или без
streetstring✅ ДаУлица
addressNumberstring✅ ДаНомер дома
neighborhoodstring✅ ДаРайон (bairro)
citystring✅ ДаГород
statestring✅ ДаШтат: двухбуквенный код (SP) или полное название (São Paulo)
addressComplementstring❌ НетКвартира, офис, этаж
documentTypestring❌ НетCPF или CNPJ. Если передан, должен соответствовать document

Пример запроса

{
  "purpose": "Payment for order #1234",
  "amount": "150",
  "currency": "BRL",
  "externalId": "external_id",
  "externalUserId": "external_user_id",
  "successUrl": "https://example.com/success",
  "failUrl": "https://example.com/fail",
  "callbackUrl": "https://example.com/webhooks/payments",
  "isFeeOnUser": false,
  "customer": {
    "firstName": "Maria",
    "lastName": "Santos",
    "document": "12345678909",
    "email": "maria.santos@example.com",
    "phone": "11999998888",
    "postcode": "01310-100",
    "street": "Av. Paulista",
    "addressNumber": "1578",
    "addressComplement": "Apto 12",
    "neighborhood": "Bela Vista",
    "city": "São Paulo",
    "state": "SP"
  }
}

Срок оплаты и подтверждение

  • Срок оплаты boleto — 3 календарных дня после выпуска, по времени Бразилиа. Заказ остаётся в PENDING до конца дня срока оплаты, затем переходит в EXPIRED.
  • Оплаченный boleto банк подтверждает примерно за один рабочий день. Оплата по PIX этого boleto подтверждается за секунды.
  • Банки принимают boleto ещё некоторое время после срока оплаты. Когда такая оплата подтверждается, истёкший заказ переходит в COMPLETED, и вы получаете webhook-уведомление.

Ответ

В ответе возвращается стандартный объект заказа. Заказ создаётся со статусом CREATED; перенаправьте плательщика на paymentLink, чтобы он завершил оплату.

Поля объекта заказа

Статусы заказа

СтатусФинальныйОписание
CREATEDНетЗаказ создан, платёжная ссылка ещё не открыта
PENDINGНетОжидает оплаты
COMPLETEDДаПлатёж успешно завершён, средства получены
FAILEDУсловноОшибка оплаты
CANCELEDУсловноЗаказ отменён системой
EXPIREDУсловноСрок действия заказа истёк до оплаты
BLOCKEDУсловноТранзакция заблокирована банком
REFUNDДаПлатёж возвращён плательщику (например, завершён ваш возврат). Устанавливается после COMPLETED
CHARGEBACKДаПлатёж оспорен плательщиком и отменён банком. Устанавливается после COMPLETED

FAILED, CANCELED, EXPIRED и BLOCKED не являются строго финальными. Если банк позже подтверждает платёж из-за ошибки на своей стороне, заказ переходит в COMPLETED, и webhook-уведомление об этом отправляется автоматически. Будьте готовы получить COMPLETED по заказу, который вы уже отметили как неуспешный.

Смотрите также

На этой странице