Skip to main content
POST
/
pix
/
create_pix_qrcode
Gerar QR Code Dinâmico
curl --request POST \
  --url https://production.api.noodle.cx/external/pix/create_pix_qrcode \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "receiver_conciliation_id": "<string>",
  "amount": 123,
  "occurrence_type": "<string>",
  "payer_document_number": "<string>",
  "payer_name": "<string>",
  "payer_person_type": "<string>",
  "payer_request": "<string>",
  "pix_key": "<string>",
  "qr_code_type": "<string>",
  "additional_data": [
    {
      "key_name": "<string>",
      "value": "<string>"
    }
  ],
  "expiration_seconds": 864000
}
'
{
  "amount": 123,
  "receiver_conciliation_id": "<string>",
  "pix_key": "<string>",
  "qr_code_key": "<string>",
  "base_64": "<string>",
  "image": "<string>"
}

Authorizations

​
Authorization
string
header
required

Body

application/json

Representa os dados necessários para criar um pagamento dinâmico via Pix.

Atributos:

  • receiver_conciliation_id (str): ID de conciliação do recebedor.
  • amount (float): Valor do pagamento.
  • occurrence_type (str): Tipo de ocorrência do pagamento.
  • payer_document_number (str): CPF ou CNPJ do pagador.
  • payer_name (str): Nome do pagador.
  • payer_person_type (str): Tipo de pessoa do pagador (física ou jurídica).
  • payer_request (str): Solicitação ou mensagem do pagador.
  • pix_key (str): Chave Pix do recebedor.
  • qr_code_type (str): Tipo de QR Code (estático ou dinâmico).
  • additional_data (list[AdditionalPixData]): Lista de dados adicionais para o pagamento.
​
receiver_conciliation_id
string
required

ID de conciliação do recebedor.

​
amount
number
required

Valor do pagamento.

​
occurrence_type
string
required

Tipo de ocorrência do pagamento.

​
payer_document_number
string
required

CPF ou CNPJ do pagador.

​
payer_name
string
required

Nome do pagador.

​
payer_person_type
string
required

Tipo de pessoa do pagador (física ou jurídica).

​
payer_request
string
required

Solicitação ou mensagem do pagador.

​
pix_key
string
required

Chave Pix do recebedor.

​
qr_code_type
string
required

Tipo de QR Code (estático ou dinâmico).

​
additional_data
AdditionalPixData · object[]
required

Lista de dados adicionais para o pagamento.

​
expiration_seconds
integer
default:864000

indica qual o tempo de validade do QR Code em segundos, padrão 1 dia.

Response

Successful Response

Representa os dados de um pagamento dinâmico via Pix.

Atributos:

  • amount (float): Valor do pagamento.
  • receiver_conciliation_id (str): ID de conciliação do recebedor.
  • pix_key (str): Chave Pix do recebedor.
  • qr_code_key (str): Chave do QR Code gerado.
  • base_64 (str): Representação em Base64 do QR Code.
  • image (str): URL ou caminho da imagem do QR Code.
​
amount
number
required

Valor do pagamento.

​
receiver_conciliation_id
string
required

ID de conciliação do recebedor.

​
pix_key
string
required

Chave Pix do recebedor.

​
qr_code_key
string
required

Chave do QR Code gerado.

​
base_64
string
required

Representação em Base64 do QR Code.

​
image
string
required

URL ou caminho da imagem do QR Code.