v1

latestOpenAPI 3.0.12026-07-245303882.5 MB

Atualizar QR Code dinâmico

Essa API possibilita que seja atualizado um QR Code para cobranças dinâmicas, ou seja que cobra de forma imediata e com valores pré-definidos.

put/pix/v1/brcode/dynamic/{transactionId}

Path parameters

transactionIdinteger required

ID da transação representante do BRCode dinâmico.

Request body

clientRequestIdstring

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

keystring required

chave pix

amountstring

Valor original desta cobrança.

merchantobject required

payerCPFstring

cpf do pagador, este campo não deve conter nenhum caracter especial.

payerCNPJstring

Cnpj do pagador, este campo não pode ser preenchido com nenhum caracter especial.

payerQuestionstring

Uma questão a ser mostrada ao pagador no momento do pagamento.

payerNamestring

Nome do pagador

expirationstring

A expiração do qrcode em segundos. Esse campo será preenchido com default (86400), caso não preenchido.

Response

200

versionstring

statusinteger

Example response

{
  "version": "1.0.9",
  "status": 201,
  "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": "teste@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": "74881162080",
        "name": "valdir"
      },
      "dynamicBRCodeData": {
        "merchantAccountInformation": {
          "url": "api-h.developer.btgpactual.com/v1/p/v2/3641c1eb18cf4960b5f7e62a7941f4ca"
        },
        "transactionCurrency": 986,
        "countryCode": "BR",
        "merchantName": "VALDIR DE SOUSA BESERRA",
        "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"
      }
    }
  }
}