Criar QR Code com TxID

Cria uma cobranca Pix com QR Code dinamico utilizando um txid definido pelo cliente.

O txid deve ser unico, conter entre 26 e 35 caracteres alfanumericos (padrao [a-zA-Z0-9]) e nao pode ser reutilizado. Caso um txid ja existente seja enviado, a API retornara erro.

PUT/cob/{txid}

Cria uma cobranca Pix imediata com um txid definido pelo cliente. O txid informado sera utilizado como identificador unico da cobranca.

Base URL: https://api.pix.basspago.com.br

Headers

Header	Valor	Descricao
`Content-Type`	application/json	Tipo do conteudo da requisicao
`Authorization`	Bearer {access_token}	Token de acesso obtido via OAuth2

Parametros de Rota

Nome	Tipo	Descricao
`txid`	string	Identificador da transacao definido pelo cliente (26-35 caracteres alfanumericos, padrao [a-zA-Z0-9])

Parametros do Body

Nome	Tipo	Obrigatorio	Descricao
`calendario.expiracao`	integer	Obrigatorio	Tempo de expiracao da cobranca em segundos
`devedor.cpf`	string	Opcional	CPF do devedor (usar cpf OU cnpj, nao ambos)
`devedor.cnpj`	string	Opcional	CNPJ do devedor (usar cpf OU cnpj, nao ambos)
`devedor.nome`	string	Opcional	Nome do devedor
`valor.original`	string	Obrigatorio	Valor da cobranca em BRL (ex: "10.00")
`chave`	string	Obrigatorio	Chave Pix cadastrada na conta
`solicitacaoPagador`	string	Opcional	Descricao do pagamento visivel para o pagador (max 140 caracteres)
`infoAdicionais`	array	Opcional	Informacoes adicionais em formato [{nome, valor}]

Exemplo de Request

{
  "calendario": {
    "expiracao": 3600
  },
  "devedor": {
    "cpf": "12345678909",
    "nome": "Fulano de Tal"
  },
  "valor": {
    "original": "10.00"
  },
  "chave": "sua-chave-pix@example.com",
  "solicitacaoPagador": "Pagamento do pedido #12345",
  "infoAdicionais": [
    {
      "nome": "Pedido",
      "valor": "12345"
    }
  ]
}

Exemplo de Response

{
  "calendario": {
    "criacao": "2025-01-15T10: 30: 00.000Z",
    "expiracao": 3600
  },
  "txid": "abcdefghijklmnopqrstuvwxyz12",
  "revisao": 0,
  "loc": {
    "id": 1234,
    "location": "pix.example.com/qr/v2/abc123def456",
    "tipoCob": "cob"
  },
  "location": "pix.example.com/qr/v2/abc123def456",
  "status": "ATIVA",
  "devedor": {
    "cpf": "12345678909",
    "nome": "Fulano de Tal"
  },
  "valor": {
    "original": "10.00"
  },
  "chave": "sua-chave-pix@example.com",
  "solicitacaoPagador": "Pagamento do pedido #12345",
  "infoAdicionais": [
    {
      "nome": "Pedido",
      "valor": "12345"
    }
  ],
  "pixCopiaECola": "00020126580014br.gov.bcb.pix..."
}

Exemplos de Codigo

curl -X PUT https://api.pix.basspago.com.br/cob/abcdefghijklmnopqrstuvwxyz12 \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer {access_token}" \
  -d '{
    "calendario": {
      "expiracao": 3600
    },
    "devedor": {
      "cpf": "12345678909",
      "nome": "Fulano de Tal"
    },
    "valor": {
      "original": "10.00"
    },
    "chave": "sua-chave-pix@example.com",
    "solicitacaoPagador": "Pagamento do pedido #12345"
  }'