⌘K

Revisar Recorrência

Revisa uma recorrência de Pix Automático existente. O principal uso é o cancelamento da recorrência, mas também é possível revisar dados como o nome do devedor, a location e a data inicial.

No cancelamento, a recorrência registra o solicitante (PSP_PAGADOR, USUARIO_PAGADOR, PSP_RECEBEDOR ou USUARIO_RECEBEDOR) e um código de motivo, como SLCR (solicitado pelo recebedor) ou FRUD (fraude), entre outros.

PATCH/rec/{idRec}

Revisa parcialmente uma recorrência pelo idRec. Requer o escopo rec.write. Retorna 200 com a recorrência atualizada.

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.write)

Parametros de Rota

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

Parametros do Body

Nome	Tipo	Obrigatorio	Descricao
`status`	string	Opcional	Único valor aceito: "CANCELADA". Cancela a recorrência
`vinculo.devedor.nome`	string	Opcional	Novo nome do devedor
`loc`	int64	Opcional	Identificador de uma nova location de recorrência (locrec)
`calendario.dataInicial`	string (YYYY-MM-DD)	Opcional	Nova data prevista do primeiro pagamento
`ativacao.dadosJornada.txid`	string	Opcional	Novo txid da cobrança vinculada à ativação da recorrência

Exemplo de Request

{
  "status": "CANCELADA"
}

Exemplo de Response

{
  "idRec": "RN1234567820260801abcdefghijk",
  "status": "CANCELADA",
  "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",
  "recebedor": {
    "cnpj": "01602606000113",
    "nome": "Empresa de Serviços SA"
  },
  "encerramento": {
    "solicitante": "USUARIO_RECEBEDOR",
    "codigo": "SLCR",
    "data": "2026-07-20T09: 15: 00.000Z"
  },
  "atualizacao": [
    {
      "data": "2026-07-19T10: 30: 00.000Z",
      "nome": "CRIADA"
    },
    {
      "data": "2026-07-19T11: 05: 00.000Z",
      "nome": "APROVADA"
    },
    {
      "data": "2026-07-20T09: 15: 00.000Z",
      "nome": "CANCELADA"
    }
  ]
}

Exemplos de Codigo

curl -X PATCH https://api.pix.basspago.com.br/rec/RN1234567820260801abcdefghijk \
  --cert ./client.crt \
  --key ./client.key \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer {access_token}" \
  -d '{
    "status": "CANCELADA"
  }'