Pix

Info

Платежный метод Pix поддерживает транзакции только в бразильских реалах (BRL).

Для данного альтернативного способа оплаты поддерживаются следующие транзакции:

Оплата

Описание процесса оплаты

Покупатель выбирает Pix в качестве способа оплаты.
Торговец отправляет запрос оплаты в bePaid.
bePaid присылает в ответе QR код и хэш транзакции.
Торговец отображает покупателю QR код и хэш транзакции.
Покупатель сканирует QR код в своем банковском приложении и совершает оплату.
В качестве альтернативного варианта, покупатель копирует хэш транзакции и использует его для оплаты в своем банковском приложении.
bePaid высылает торговцу автоматическое уведомление.
Торговец возвращает bePaid ответ на автоматическое уведомление.

Запрос

Отправьте запрос оплаты со следующими дополнительными параметрами:

Параметр	Тип данных	Описание
request	object
customer	object	Секция информации о покупателе.
first_name *обязательный	string	Имя покупателя.
last_name *обязательный	string	Фамилия покупателя.
taxpayer_id *обязательный	string	Номер налогоплательщика (CFP или CNPJ).
method	object	Секция информации о платежном методе.
type *обязательный	string	`pix`

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

{
  "request": {
    "amount": 100,
    "currency": "BRL",
    "description": "description",
    "test": false,
    "customer": {
      "first_name": "John",
      "last_name": "Doe",
      "taxpayer_id": "770.576.826-70"
    },
    "method": {
      "type": "pix"
    }
  }
}

Ответ

Ответ будет дополнительно содержать секцию pix с параметрами qr_code и hash.

Параметр	Тип данных	Описание
pix	object
qr_code	string	QR код оплаты в формате Base64.
hash	string	Код для совершения оплаты в банковском приложении.

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

{
  "transaction": {
    "uid": "0bc44cfb-3432-4033-a94a-ea537cfbf4dd",
    "type": "payment",
    "status": "pending",
    "amount": 100,
    "currency": "BRL",
    "description": "description",
    "created_at": "2024-02-28T12:36:59Z",
    "updated_at": "2024-02-28T12:36:59Z",
    "method_type": "pix",
    "receipt_url": "https://merchant.bepaid.by/customer/transactions/0bc44cfb-3432-4033-a94a-ea537cfbf4dd/b192284e4aee0bd3deb369c21ff946b4296e34d7a013ec3ae78c317180375571",
    "payment": {
      "status": "pending",
      "gateway_id": 3773,
      "ref_id": "1b9f2399-fccd-441e-a220-48fa041d45b1",
      "message": "Pix gerado com sucesso",
      "bank_code": "0"
    },
    "pix": {
      "qr_code": "qrcode",
      "hash": "qrcodestring"
    },
    "customer": {
      "first_name": "John",
      "last_name": "Doe",
      "taxpayer_id": "770.576.826-70",
      "email": null,
      "ip": null
    },
    "manually_corrected_at": null,
    "message": "Pix gerado com sucesso",
    "test": false,
    "billing_address": {
      "first_name": "John",
      "last_name": "Doe",
      "taxpayer_id": "770.576.826-70"
    },
    "additional_data": {
      "payment_method": {
        "type": "alternative"
      }
    },
    "gateway": {
      "iframe": false
    }
  }
}

Возврат средств

Запрос

Отправьте стандартный запрос возврата средств. Сумма возврата не должна превышать сумму родительской транзакции.