Direct Pix

Merchants now have the capability to display PIX transaction data directly within their cashier page. Users can simply fill out their request in the website´s cashier form, press enter, and the QR code required to complete their PIX transaction will appear within the website´s cashier interface, without any redirection. This streamlined process optimizes the user flow and eliminates the need to redirect users to another domain.

Params (before JWT-encoding)

Parameter	Type	Description
name	(required, string)	The 'name' parameter represents the user's name. If left blank, the deposit form will display the field as editable, allowing the user to input their name.
email	(required, string)	The 'email' parameter represents the user's email address. If left blank or if the provided email address is invalid, the corresponding field in the deposit form can be manually edited by the user.
cpf	(required, string)	The 'CPF' parameter represents the user's CPF (Brazilian tax number). If left blank or if the provided CPF is invalid, the corresponding field in the deposit form can be manually edited by the user.
amount	(number, string)	The 'amount' parameter represents the value of the deposit and cannot be modified by the user.
currency	(required, string)	The 'currency' parameter specifies the currency used for the deposit, with BRL (Brazilian Real) being the default currency in ISO 4217 format.
reference	(required, string)	The 'reference' parameter represents the Reference ID, which is a unique string generated by the merchant.
merchant_user	(required, string)	The 'merchant_user' parameter identifies the user within your system, which can be either an ID or a username
country	(required, string)	The 'country' parameter specifies the user's country configured on the merchant cashier, adhering to ISO 3166 format. Only 'BR' (Brazil) is accepted.
buyer_ip	(required, string)	The 'buyer_ip' parameter represents the user's IP address.
phone	(optional, string)	The 'phone' parameter represents the user's phone number. It should follow the suggested format: (51)9999-999, where (51) is the area code. The maximum length is 45 characters.
brand	(optional, string)	The 'brand' parameter is defined by the merchant and represents the brand of the platform.

{
  "iat": 1712175617,
  "exp": 1712175677,
  "data": {
    "name": "",
    "email": "",
    "cpf": "",
    "amount": 0,
    "currency": "BRL",
    "reference": "",
    "merchant_user": "",
    "country": "BR",
    "buyer_ip": "",
    "phone": "",
    "brand": ""
  }
}

Example Response (after JWT-decode)

{
  "iat": 1712252131,
  "exp": 1712252191,
  "code": 201,
  "data": {
    "id": "102139",
    "currency": "BRL",
    "amount": 10,
    "reference": "teste",
    "qrCodeText": "00020101021226900014br.gov.bcb.pix2568qrcodepix.bb.com.br-pix-v2-txId_C55153TS1712252136116v1Ds87r89IC2Un_5204000053039865802BR5916SAFEPAG NACIONAL6012PORTO ALEGRE62070503***63044F3A",
    "qrCodeImage": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAfQAAAH0AQAAAADjreInAAADW0lEQVR4Xu2VTa7cMAyDA+T+d+0BDKTDH9l53hRuNx2BmtSxKH7MRni9nn+qX9eunFX4XTmr8LtyVuF35azC78pZhd+Vswq/K2cVflfOKvyunFX4XTmr8LtyVv8LPy7WXdd7sOEJ4R5S+Cpn+D48+zJxPhDy4aAiynHlDN+Lr9nyUCSJQNyYOZ3h+/E2vChlruDwnXlZH40ZoKLoUfiO/EqRAA9UUgj2rJzhW/FeEzB/+K2FCt+GX4X5/d6XC3e0c3leFX4TvpQHdXk34NHNrVhot/+szJzwPfjHqzFqcbA2EtH70dhP+E68mAu7AVI5E1u7xUQvWfg2PGQe+lc3JS8EsUwJ34v3hCquXh/+OPAuTYcrfA++JphhOeaCoMVsIiWowlv9dh4ODoY2Bs2NXDVK1M3+8I140Te5cjOUKYVI8Ch8J54GqPNknMwzWVM94VvxMNAliiEXbwrxJ5jMafhG/PCewI4Hd0dxa+TRSCnhW/HqSQL2eGinVv7PxPBdeMEY8YSjfMrDw59iiwnfhB80D+A3DGXhW1lSHRS+F28XhmYATKW2p5QKCN+EpwOUXHigUdGVDxWuWvhOPCYiuSCkvCkKpkNf0S98J16Th3sBUs0lhUK5pjV8J55D+kzCSoVvEAOxEmgK34gXAQuG/hPBVgf8TH7B4dvwNAua7eRMaZkQN33hu/AQV9AiXiB+tC08fBcewoCLTqMENCMkg1PCd+Jh1+XmQTuTmIEQv/Wp8K14Dbg1ZasFMs1Qh4dvyV/cDTHzxkQg08RPmQrfhf8M7cULnY8xH4XxOxUYvgevxcALuzGEDgTh8MI4jS5/M3wP3vYqEPUmWUPn4RK+Ec/VqCm2xHuyCPVaIB3h+/BUBDsKVq+QDW4ROQPCd+FLVgASmKJIuPXyuCp8D75wjp1SpRA/Uwzfia/6eB7hiGPmdEOXwikr/At+vpf3YmAgcvZsFfpTCd+JZ18+x9T+6M8GpNqf8O14+nwKdsGJpUGslaLDt+PBYkyLDnAF2Df78O14Ntwf99QQo396hW/GO2XtBozsBoLUi5/+8G34+p/BS8Nj5TDzJc+PhO/B/22F35WzCr8rZxV+V84q/K6cVfhdOavwu3JW4XflrMLvylmF35WzCr8rZ/X1/G8e1n3EcMHUcgAAAABJRU5ErkJggg=="
  }
}