Pix

Info

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

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

---

Оплата

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

1. Покупатель выбирает Pix в качестве способа оплаты.
2. Торговец отправляет запрос оплаты в PaySage.io.
3. PaySage.io присылает в ответе QR код и хэш транзакции.
4. Торговец отображает покупателю QR код и хэш транзакции.
5. Покупатель сканирует QR код в своем банковском приложении и совершает оплату.
6. В качестве альтернативного варианта, покупатель копирует хэш транзакции и использует его для оплаты в своем банковском приложении.
7. PaySage.io высылает торговцу автоматическое уведомление.
8. Торговец возвращает PaySage.io ответ на автоматическое уведомление.

Запрос

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

Параметр	Тип данных	Описание
request	object
expired_at	string	Время в формате ISO-8601, до которого можно осуществить оплату по QR коду или хэшу. Формат: YYYY-MM-DDThh:mm:ssTZD, где YYYY – год (например, 2019), MM – месяц (например, 02), DD – день (например, 09), hh – часы (например, 18), mm – минуты (например, 20), ss – секунды (например, 45), TZD – часовой пояс (+hh:mm или –hh:mm относительно UTC).
customer	object	Секция информации о покупателе.
first_name *обязательный	string	Имя покупателя.
last_name *обязательный	string	Фамилия покупателя.
taxpayer_id *обязательный	string	Номер налогоплательщика (CFP или CNPJ).
email *обязательный	string	Адрес электронной почты покупателя.
method	object	Секция информации о платежном методе.
type *обязательный	string	pix

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

{
    "request":{
        "amount":100,
        "currency":"BRL",
        "description":"description",
        "test": false,
        "expired_at": "2023-11-01T15:00:00+01:00",
        "return_url":"https://merchant.ltd/return",
        "customer":{
            "first_name":"John",
            "last_name":"Doe",
            "email": "example@example.com",
            "taxpayer_id": "390.533.447-05"
        },
        "method":{
            "type": "pix"
        }
    }
}

Ответ

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

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

Пример успешного ответа

{
    "transaction": {
        "uid": "36b89d1b-2eef-4202-b99f-0f5842b2665a",
        "type": "payment",
        "status": "pending",
        "amount": 100,
        "currency": "BRL",
        "description": "description",
        "created_at": "2023-10-23T11:49:18Z",
        "updated_at": "2023-10-23T11:49:20Z",
        "method_type": "pix",
        "receipt_url": "https://backoffice.paysage.io/customer/transactions/36b89d1b-2eef-4202-b99f-0f5842b2665a/2cbb1fe89ed4f965a88d753c2ebf92d315058880b38c8ec2004255fbe099f140?language=en",
        "payment": {
            "status": "pending",
            "gateway_id": 3333,
            "message": "Transaction was initialized"
        },
        "pix": {
            "qr_code": "PHN2ZyBoZWlnaHQ9IjUxMSIPSI3IiB4PS...",
            "hash": "00020101021126860014br.gov.bcb.pix013601898bcc-516d-2480-6bd1-49ad4b4ba3880224018b5c5e-32a9-a1b1-b67a-52040000530398654031.05802BR5921PSP - Cash Out6002BR61080000000062070503***6304E6CA"
        },
        "customer": {
            "first_name": "John",
            "last_name": "Doe",
            "email": "example@example.com",
            "taxpayer_id": "390.533.447-05",
            "ip": null
        },
        "manually_corrected_at": null,
        "message": "Transaction was initialized",
        "test": false,
        "language": "en",
        "billing_address": {
            "first_name": "John",
            "last_name": "Doe",
            "email": "example@example.com",
            "taxpayer_id": "390.533.447-05"
        },
        "additional_data": {
            "payment_method": {
                "type": "alternative"
            }
        },
        "gateway": {
            "iframe": false
        }
    }
}

Выплата

Запрос

Отправьте запрос выплаты

Параметр	Тип данных	Описание
method	object	Секция платежного метода.
type *обязательный	string	pix
account_number *обязательный	string	Идентификатор счета, на который будет совершена выплата.

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

{
    "request":{
        "amount":100,
        "currency":"BRL",
        "description":"description",
        "test": true,
        "return_url":"https://your-success.url",
        "method":{
            "type": "pix",
            "account_number": "33281283609809"
        }
    }
}

Ответ

Пример успешного ответа

{
    "transaction": {
        "uid": "73139810-53fd-4a66-90d0-44bd42d7aae7",
        "type": "payout",
        "status": "pending",
        "amount": 100,
        "currency": "BRL",
        "description": "description",
        "created_at": "2023-10-23T13:36:57Z",
        "updated_at": "2023-10-23T13:36:59Z",
        "manually_corrected_at": null,
        "method_type": "pix",
        "receipt_url": "https://backoffice.paysage.io/customer/transactions/73139810-53fd-4a66-90d0-44bd42d7aae7/3901a763d93ae4d7345e636a7887498e399d03e6050e0e54601cfb8f2dc4706f",
        "payout": {
            "status": "pending",
            "gateway_id": 3333,
            "ref_id": "018b5cc0-c6b1-fa0b-1c88-41836d5219bc",
            "message": "Transaction was initialized"
        },
        "pix": {
            "type": "pix",
            "account_number": "33281283609809"
        },
        "customer": {
            "email": null,
            "ip": null
        },
        "message": "Transaction was initialized",
        "test": true,
        "additional_data": {
            "payment_method": {
                "type": "alternative"
            }
        }              
    }
}

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

Запрос

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