Generate Static QR Code

This endpoint generates a static Pix payment QR Code. To do so, a call must be sent to the API, as specified below:

Making Request

The call must be made using the POST method.

URL

  /v1/pix/qrcodes/static

HTTP Request Body

{
    "external_reference": "Test2"
}

Description of attributes

ATTRIBUTES	DESCRIPTION	TYPE
external_reference (Optional)	Value provided by the partner to identify the generated QR Code.	STRING 255 character limit

Success

After the call, a JSON with status 201 - Created is returned if the procedure has succeeded.

HTTP 201 Response Body - Example

{
    "qrcode": {
        "reference_code": "ZENDRYTESTPIXQRCODE6",
        "external_reference": "Test2",
        "content": "00000000000000000000br.gov.bcb.pix012345678900-1234-1234-1234-12345678901234567890123456789000.012345BR5925Zendry Solucoes em Paga6009SAO PAULO62230519ZENDRYPIXQRCODETESTE00000"
    }
}

Description of Attributes

PARAMETER	DESCRIPTION	TYPE
qrcode (Required)	Data object of the registered QR Code.	OBJECT
qrcode.external_reference (Optional)	Value provided by the partner to identify the generated QR Code.	STRING 255 character limit
qrcode.reference_code (Required)	Unique identifier of the QR Code.	STRING 100 character limit
qrcode.content (Required)	Content of the QR Code (Pix Copy and Paste code).	STRING 255 character limit

Errors

In case of errors, a JSON with the error attribute specifying the reason why the operation was invalidated will be returned.

HTTP 400 Response Body - Example

  {
    "error": "generator_document not_a_number | generator_document required | generator_name required"
  }

HTTP 403 Response Body - Example

  {
    "error": "Generator not allowed"
  }

HTTP 500 Response Body - Example

  {
    "error": "Operation failed! Please try again or contact our support team"
  }