Revise recurrence (Pix Automático)

Partially revises a recurrence (Rec) by its idRec: changes calendario.dataInicial (only while status == CRIADA) and/or the status (CANCELADA cancels the mandate). Pix API PATCH /rec/. Rejects any change when the recurrence is EXPIRADA/CANCELADA/REJEITADA (422). Changes to rec.loc are not accepted on this endpoint. An unknown idRec returns 404 (canonical Problem envelope).

PATCH /api/v1/brcode/rec/{idRec}

Revise recurrence (Pix Automático)

cURL

curl --request PATCH \
  --url https://spi.sandbox.lerian.net/api/v1/brcode/rec/{idRec} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "calendario": {
    "dataInicial": "2025-08-01"
  },
  "status": "CANCELADA"
}
'

200

{
  "calendario": {
    "dataInicial": "2025-07-15",
    "periodicidade": "MENSAL",
    "dataFinal": "<string>"
  },
  "idRec": "<string>",
  "politicaRetentativa": "NAO_PERMITE",
  "recebedor": {
    "conta": "1234567890",
    "tipoConta": "CORRENTE",
    "agencia": "0001",
    "convenio": "<string>"
  },
  "status": "CRIADA",
  "vinculo": {
    "contrato": "contrato-12345",
    "devedor": {
      "cnpj": "12ABC34501DE35",
      "cpf": "12345678901",
      "nome": "Fulano de Tal"
    },
    "objeto": "<string>"
  },
  "atualizacao": [
    {
      "data": "<string>",
      "status": "CRIADA"
    }
  ],
  "solicitacao": [
    {
      "calendario": {
        "dataExpiracaoSolicitacao": "2023-12-20T12:17:11Z"
      },
      "destinatario": {
        "conta": "550689",
        "ispbParticipante": "91193552",
        "agencia": "2569",
        "cnpj": "<string>",
        "cpf": "15231470190"
      },
      "idRec": "<string>",
      "idSolicRec": "<string>",
      "status": "CRIADA"
    }
  ],
  "valor": {
    "valorMinimoRecebedor": "<string>",
    "valorRec": "99.90"
  }
}

Autorizaciones

Authorization · string · header · requerido

JWT bearer token issued by the identity provider.

Encabezados

Idempotency-Key · string

Idempotency key, max 255 characters.

Parámetros de ruta

idRec · string · requerido

Identificador da recorrência [a-zA-Z0-9]{29}.

Pattern: ^[a-zA-Z0-9]{29}$

Cuerpo

application/json

calendario · object

Patch do calendário (apenas dataInicial).

Show child attributes

status · enum<string>

Novo status da recorrência (CANCELADA cancela o mandato — único destino de status aceito no PATCH, RecRevisada.status v2.9).

Opciones disponibles: CANCELADA

Respuesta

200

application/json

OK

calendario · object · requerido

Show child attributes

idRec · string · requerido

Identificador da recorrência.

Pattern: ^[a-zA-Z0-9]{29}$

politicaRetentativa · enum<string> · requerido

Opciones disponibles: NAO_PERMITE, PERMITE_3R_7D

recebedor · object · requerido

Show child attributes

status · enum<string> · requerido

Opciones disponibles: CRIADA, APROVADA, REJEITADA, EXPIRADA, CANCELADA

vinculo · object · requerido

Show child attributes

atualizacao · object[] | null

Show child attributes

solicitacao · object[] | null

Show child attributes

valor · object

Show child attributes