Criação de QR Code Imediato

Descrição:

Através desse endpoint é possível criar um QR Code para pagamento do tipo dinâmico imediato. QR Codes imediatos possuem informações variáveis, como o valor a ser pago, a descrição da transação e dados do pagador. Este tipo de cobrança possui uma data de expiração geralmente curta, e é ideal para pagamentos que devem ser efetuados em um curto período de tempo.

Durante a requisição, é possível informar o identificador da chave ou o valor da chave para o qual o QR Code deve ser gerado, porém se ambas as informações não forem passadas, o sistema irá pegar a qualquer chave ativa disponível para a conta. É obrigatório o uso do accountIdentifier no header para identificar a conta emissora.

Corpo da Requisição:

{
  "reusable": false,
  "keyIdentifier": "030fb86b-6c4e-4b0b-9c2a-1dedf1061f35",
  "keyValue": "030fb86b-6c4e-4b0b-9c2a-1dedf1061f35",
  "additionalInformation": [
    {
      "name": "name_c0a438849f48",
      "value": "value_c7480c0a491b"
    }
  ],
  "personPayer": {
    "documentNumber": "documentNumber_bd9cb3d9b736",
    "name": "name_c9cc936ecac4",
    "tradingName": "tradingName_6d6efcdc2f7d"
  },
  "description": "description_3026c2806b86",
  "value": 0.00,
  "expirationDate": "2024-05-19",
  "expiration": 0,
  "transactionIdentifier": "transactionIdentifier_600087a7f5ae",
  "urlNotification": "urlNotification_f548baf3211c",
  "splits":[
    {
      "accountIdentifier":"030fb86b-6c4e-4b0b-9c2a-1dedf1061f35",
      "percentualValue":0.5,
      "tax":0.5
    },
    {
      "accountIdentifier":"030fb86b-6c4e-4b0b-9c2a-1dedf1061f35",
      "percentualValue":0.5,
      "tax":0.5
    }
  ]
}

Tabela de Campos da Requisição:

Campo	Tipo	Obrigatório	Descrição
reusable	Boolean	Não	Indica se o QR Code é reutilizável.
keyIdentifier	String	Não	Identificador da chave. Mutuamente excludente com `keyValue`.
keyValue	String	Não	Valor da chave. Mutuamente excludente com `keyIdentifier`.
additionalInformation	Array	Não	Informações adicionais.
└── name	String	Sim	Nome da informação adicional.
└── value	String	Sim	Valor da informação adicional.
personPayer	Object	Não	Dados do pagador.
└── documentNumber	String	Sim	Número do documento do pagador.
└── name	String	Sim	Nome do pagador.
└── tradingName	String	Não	Nome comercial do pagador.
description	String	Não	Descrição da transação.
value	Number	Sim	Valor da transação.
expirationDate	String	Sim*	Data de expiração do QR Code. Mutuamente excludente com `expiration`.
expiration	Number	Sim*	Tempo de expiração em segundos. Mutuamente excludente com `expirationDate`.
transactionIdentifier	String	Não	Caso não seja informado, será gerado automaticamente.
urlNotification	String	Não	URL para notificação de pagamento.
splits	Array	Não	Informações sobre a divisão de valores.
└── accountIdentifier	String	Sim	Identificador da conta.
└── percentualValue	Number	Sim	Percentual do valor.
└── tax	Number	Não	Valor da taxa.

* Pelo menos um dos campos expirationDate ou expiration deve ser informado.

Corpo da Resposta:

{
  "identifier": "708e7150-26df-414e-91bd-f94b0c1c5c84",
  "description": "description_cc3bcc7fd528",
  "copyAndPaste": "copyAndPaste_e73a9dd967b5",
  "value": 0.00,
  "expirationDate": "2024-05-19",
  "key": "key_4fcc41634a3e",
  "keyType": "CPF"
}

Tabela de Campos da Resposta:

Campo	Tipo	Descrição
identifier	String	Identificador do QR Code
description	String	Descrição da transação
copyAndPaste	String	Copia e cola do QR Code gerado
value	Number	Valor da transação
expirationDate	String	Data de expiração do QR Code
key	String	Chave utilizada para gerar o QR Code
keyType	String	Tipo da chave (CPF, CNPJ, EMAIL, RANDOM, CELLPHONE)

Corpo da Resposta em Caso de Erro:

{
  "path": "/pix/qrcode/immediate",
  "error": "Internal Server Error",
  "message": "Erro ao processar requisição",
  "errors": [],
  "timestamp": "2024-03-21T14:33:22.528431",
  "status": 500
}

Tabela de Campos da Resposta em Caso de Erro:

Campo	Tipo	Descrição
path	String	Caminho do endpoint onde ocorreu o erro
error	String	Tipo de erro
message	String	Mensagem descritiva do erro
errors	Array	Lista de erros detalhados
timestamp	String	Data e hora do erro
status	Number	Código de status HTTP