Criar QR Code Estático

Através desse endpoint é possível criar um QR Code para pagamento do tipo Estático.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Descrição

O QR Code de cobrança estática contém informações fixas, como o valor a ser pago e os dados do recebedor. QR Codes estáticos são QRCodes que não expiram, podem ser pagos várias vezes.

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.

Também é possível informar a url para notificação de pagamento através do campo urlNotification.

Corpo da Requisição

CampoTipoObrigatórioDescrição
keyIdentifierStringNãoIdentificador da chave PIX
keyValueStringNãoValor da chave para a criação do QrCode
descriptionStringNãoDescrição do QR Code
valueDoubleSimValor do QR Code
urlNotificationStringNãoUrl para envio de webhook em caso de pagamento
{
  "keyIdentifier": "05d93d08-20d4-4303-b466-616886f8f470",
  "keyValue":"05d93d08-20d4-4303-b466-616886f8f470",
  "description": "Uma descrição",
  "value": 125.00,
  "urlNotification":"www.webhook.com"
}

Resposta de Sucesso

CampoTipoDescrição
copyAndPasteStringCopia e cola do QR Code gerado
identifierStringIdentificador do QR Code
keyStringValor da chave utilizada para emissão do QR Code
typeDoubleTipo da chave utilizada
{
    "copyAndPaste": "00020101021126670014br.gov.bcb.pix0136756a966c-48cc-4901-948f-e2bde0b48acc0205Teste520400005303986540512.335802BR5921Mateus de Morais Lima6011Joao Pessoa61085807641062240520220320241428184569296304060C",
    "identifier": "03da45ac-86f7-4fc3-a813-84c0a0cbe447",
    "key": "756a966c-48cc-4901-948f-e2bde0b48acc",
    "type": "RANDOM"
}

Response em Caso de Erro

Em caso de erro durante o processamento da requisição, o endpoint retorna uma resposta com status HTTP 500 (Internal Server Error) e o seguinte corpo:

CampoTipoDescrição
pathStringCaminho do erro
errorStringTipo de erro
messageStringMensagem de erro
errorsArrayLista de erros adicionais
timestampStringCarimbo de data/hora do erro
statusNumberCódigo de status HTTP do erro
Body Params
string
Defaults to 05d93d08-20d4-4303-b466-616886f8f470

Identificador da chave PIX

string
Defaults to 05d93d08-20d4-4303-b466-616886f8f470

Valor da chave para a criação do QrCode

string
Defaults to Uma descrição

Descrição do QR Code

double
required
Defaults to 125

Valor do QR Code

string
Defaults to www.webhook.com

Url para envio de webhook em caso de pagamento

Headers
string
required

Identificador da conta para qual se deseja criar o QR Code

Responses

Language
Credentials
OAuth2
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json