PIX 2

In order to enroll in PIX digital wallet in Brazil, a request to the Settlix API must contain the following parameters:

Parameter	Type	Required	Description
pos_id	UUID	✅	Merchant's identifier (POS_ID)
mode	MODE	✅	direct
method	METHOD	✅	Payment method (credit)
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.
properties.instrument_type	String	✅	instrument type (pix)
properties.document_id	String	✅	payer’s document number (CPF)

The value of the payway parameter must be pix.

Request example:

{
  "pos_id": "<POS_ID>",
  "mode": "direct",
  "method": "credit",
  "amount": 1.1,
  "currency": "BRL",
  "customer_lname": "Doe",
  "customer_fname": "John",
  "customer_phone": "+5511987654321",
  "customer_email": "joaosilva@hotmail.com",
  "customer_birthday": "2000-06-06",
  "properties": {
    "instrument_type": "pix",
    "document_id": "143.597.426-00"
  },
  "order_id": "1234567890",
  "payway": "pix",
  "order_3ds_bypass": "supported",
  "description": "test Credit",
  "server_url": "http://callback-stub:9000/consume",
  "result_url": "https://example.com/result"
}