v1

latestOpenAPI 3.0.12026-07-245303882.5 MB

Criar um QR Code dinâmico

Essa API possibilita que seja criado um QR Code para cobranças dinâmicas imediatas e com valores pré-definidos. Com este endpoint, em uma chamada é realizado, automaticamente, o fluxo completo para criação de um QR Code:

endereçamento do QR Code (location);
criação da cobrança vinculada àquele QR Code (COB).

post/pix/v1/brcode/dynamic

Request body

clientRequestIdstring

Identificador único da transação fornecida pelo cliente. Este valor não pode ser repetido

keystring required

Chave Pix do recebedor

amountstring

Valor original desta cobrança.

payerNamestring

Nome do pagador. Se o campo payerName está preenchido, então deve existir ou um payerCPF ou um payerCNPJ preenchido.

payerCPFstring

CPF do pagador (apenas números). Não é permitido que o campo payerCPF e campo payerCNPJ estejam preenchidos ao mesmo tempo.

payerCNPJstring

CNPJ do pagador (apenas números). Não é permitido que o campo payerCPF e campo payerCNPJ estejam preenchidos ao mesmo tempo.

payerQuestionstring

Uma mensagem a ser mostrada ao pagador no momento do pagamento, com no máximo 140 caracteres.

expirationinteger

Tempo para expiração do QR Code, em segundos. Caso não informado, será preenchido com o valor default (86400 segundos = 24 horas)

Response

200

versionstring

statusinteger

Example response

{
  "version": "1.0.9",
  "status": 200,
  "body": {
    "clientRequestId": "456456456",
    "pactualId": "3641c1eb-18cf-4960-b5f7-e62a7941f4ca",
    "transactionId": "9193296",
    "createTimestamp": "2022-03-22T18:59:28.0944527+00:00",
    "lastUpdateTimestamp": "2022-03-22T18:59:28.0944527+00:00",
    "entity": "PixImmediateCollection",
    "status": "ACTIVE",
    "transactionIdentification": "kk6g232xel65a0daee4dd13kk9193296",
    "body": {
      "key": "testepix@celcoin.com.br",
      "revision": "0",
      "location": "api-h.developer.btgpactual.com/v1/p/v2/3641c1eb18cf4960b5f7e62a7941f4ca",
      "amount": {
        "original": 25.25
      },
      "calendar": {
        "expiration": 86400,
        "dueDate": "2022-03-23T18:59:28.1220525+00:00"
      },
      "debtor": {
        "cpf": "12312312312",
        "name": "valdir"
      },
      "dynamicBRCodeData": {
        "merchantAccountInformation": {
          "url": "api-h.developer.btgpactual.com/v1/p/v2/3641c1eb18cf4960b5f7e62a7941f4ca"
        },
        "transactionCurrency": 986,
        "countryCode": "BR",
        "merchantName": "Celcoin",
        "merchantCity": "Sao Paulo",
        "transactionIdentification": "***",
        "transactionAmount": "25.25",
        "emvqrcps": "00020101021226930014br.gov.bcb.pix2571api-h.developer.btgpactual.com/v1/p/v2/3641c1eb18cf4960b5f7e62a7941f4ca5204000053039865802BR5923VALDIR DE SOUSA BESERRA6009Sao Paulo61080955000062070503***6304539D"
      }
    }
  }
}