PIX 2

To enable the PIX payment method, you need to use direct integration. When creating a payment, send a request with the following parameters:

Parameter	Type	Required	Description
pos_id	UUID	✅	Merchant's identifier (POS_ID)
mode	MODE	✅	direct
method	METHOD	✅	Payment method (purchase)
amount	Number	✅	Transaction amount. Must be a positive number. The number of decimal digits must be less than or equal to 2 (e.g., 100.00, 250, 50.50)
currency	CURRENCY	✅	Transaction currency (ISO_4217)
order_3ds_bypass	String	✅	3-D Secure flow option
order_id	String	✅	Unique identifier of order
description	String	✅	Payment description
payway	String	✅	pix
server_url	URL		Webhook notification will be sent to this URL
result_url	URL		Customer will be redirected to this URL after payment.
customer_fname	String	✅	payer’s first name
customer_lname	String	✅	payer’s last name
customer_email	String	✅	payer’s email address
customer_phone	String	✅	payer’s phone number
properties.instrument_type	String	✅	payer’s document type
properties.document_id	String	✅	payer’s document ID

Request example:

{
  "pos_id": "<POS_ID>",
  "mode": "direct",
  "amount": 5.50,
  "method": "purchase",
  "currency": "BRL",
  "payway": "pix",
  "order_3ds_bypass": "supported",
  "customer_lname": "Doe",
  "customer_fname": "John",
  "customer_phone": "+5511987654321",
  "customer_email": "joaosilva@hotmail.com",
  "description": "Test description",
  "order_id": "<ORDER_ID>",
  "properties": {
    "instrument_type": "pix",
    "document_id": "50284414727"
  },
  "server_url": "https://callback.blackhole.com/callback",
  "result_url": "https://example.com/result"
}