⌘K

Consultar Recorrência

Consulta uma recorrência de Pix Automático pelo idRec, retornando seus dados completos e, quando aplicável, os dados do QR Code em dadosQR.

Sem o parâmetro txid, o campo dadosQR retorna o QR Code simples de recorrência (Jornada 2). Com ?txid={txid da cob/cobv}, retorna o QR Code composto (Jornadas 3 e 4).

GET/rec/{idRec}

Consulta os detalhes de uma recorrência pelo seu identificador idRec. Requer o escopo rec.read.

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

Headers

Header	Valor	Descricao
`Content-Type`	application/json	Tipo do conteúdo da requisição
`Authorization`	Bearer {access_token}	Token de acesso obtido via OAuth2 (escopo rec.read)

Parametros de Rota

Nome	Tipo	Descricao
`idRec`	string	Identificador da recorrência (29 caracteres, formato RAxxxxxxxxyyyyMMddkkkkkkkkkkk)

Parametros de Query

Nome	Tipo	Obrigatorio	Descricao
`txid`	string	Opcional	txid da cobrança (cob ou cobv) vinculada. Usado apenas nas Jornadas 3 e 4 para gerar o QR Code composto; omita na Jornada 2

Exemplo de Response

{
  "idRec": "RN1234567820260801abcdefghijk",
  "status": "APROVADA",
  "vinculo": {
    "contrato": "63100862",
    "devedor": {
      "cpf": "45164632481",
      "nome": "Fulano de Tal"
    },
    "objeto": "Serviço de streaming de música"
  },
  "calendario": {
    "dataInicial": "2026-08-01",
    "dataFinal": "2027-08-01",
    "periodicidade": "MENSAL"
  },
  "valor": {
    "valorRec": "35.00"
  },
  "politicaRetentativa": "NAO_PERMITE",
  "loc": {
    "criacao": "2026-07-19T10: 30: 00.000Z",
    "id": 108,
    "location": "pix.example.com/qr/v2/rec/2353c790eefb11eaadc10242ac120002",
    "idRec": "RN1234567820260801abcdefghijk"
  },
  "pagador": {
    "codMun": "2673833",
    "cpf": "45164632481",
    "ispbParticipante": "81102623"
  },
  "recebedor": {
    "cnpj": "01602606000113",
    "nome": "Empresa de Serviços SA"
  },
  "atualizacao": [
    {
      "data": "2026-07-19T10: 30: 00.000Z",
      "nome": "CRIADA"
    },
    {
      "data": "2026-07-19T11: 05: 00.000Z",
      "nome": "APROVADA"
    }
  ],
  "dadosQR": {
    "jornada": "JORNADA_2",
    "pixCopiaECola": "00020126180014br.gov.bcb.pix5204000053039865802BR5913Fulano de Tal6008BRASILIA62070503***80800014br.gov.bcb.pix2558pix.example.com/qr/v2/rec/2353c790eefb11eaadc10242ac120002630462C9"
  }
}

Exemplos de Codigo

curl -X GET "https://api.pix.basspago.com.br/rec/RN1234567820260801abcdefghijk?txid=33beb661beda44a8928fef47dbeb2dc5" \
  --cert ./client.crt \
  --key ./client.key \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer {access_token}"

Erros

Código	Descrição
`403`	Requisição de participante autenticado que viola alguma regra de autorização (escopo rec.read ausente).
`404`	Recorrência não encontrada para o idRec informado.
`503`	Serviço indisponível no momento. Tente novamente mais tarde.