VersellAPI

Atualizar QR Code

Atualiza uma cobranca Pix existente, permitindo alterar valor, expiracao ou descricao.

PATCH/cob/{txid}

Atualiza os dados de uma cobranca Pix existente. Somente os campos enviados serao alterados.

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

Headers

HeaderValorDescricao
Content-Typeapplication/jsonTipo do conteudo da requisicao
AuthorizationBearer {access_token}Token de acesso obtido via OAuth2

Parametros de Rota

NomeTipoDescricao
txidstringIdentificador unico da transacao (txid) da cobranca a ser atualizada

Parametros do Body

NomeTipoObrigatorioDescricao
calendario.expiracaointegerOpcionalNovo tempo de expiracao em segundos
devedor.cpfstringOpcionalCPF do devedor (11 digitos). Mutuamente exclusivo com cnpj.
devedor.cnpjstringOpcionalCNPJ do devedor (14 digitos). Mutuamente exclusivo com cpf.
devedor.nomestringOpcionalNome do devedor
valor.originalstringOpcionalNovo valor da cobranca em BRL (ex: "25.50")
statusstringOpcionalNovo status da cobranca (ex: "REMOVIDA_PELO_USUARIO_RECEBEDOR")
loc.idintegerOpcionalID do location (payload) a ser vinculado a cobranca
solicitacaoPagadorstringOpcionalNova descricao do pagamento

Exemplo de Request

{
  "calendario": {
    "expiracao": 7200
  },
  "valor": {
    "original": "25.50"
  },
  "solicitacaoPagador": "Pagamento atualizado - Pedido #12345"
}

Exemplo de Response

{
  "calendario": {
    "criacao": "2025-01-15T10: 30: 00.000Z",
    "expiracao": 7200
  },
  "txid": "fc9a43e0b7e14b5a8c3d2f1e0a9b8c7d",
  "revisao": 1,
  "loc": {
    "id": 1234,
    "location": "pix.example.com/qr/v2/abc123def456",
    "tipoCob": "cob"
  },
  "location": "pix.example.com/qr/v2/abc123def456",
  "status": "ATIVA",
  "valor": {
    "original": "25.50"
  },
  "chave": "sua-chave-pix@example.com",
  "solicitacaoPagador": "Pagamento atualizado - Pedido #12345"
}

Exemplos de Codigo

curl -X PATCH https://api.pix.basspago.com.br/cob/{txid} \
  --cert ./client.crt \
  --key ./client.key \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer {access_token}" \
  -d '{
    "calendario": {
      "expiracao": 7200
    },
    "valor": {
      "original": "25.50"
    },
    "solicitacaoPagador": "Pagamento atualizado - Pedido #12345"
  }'