Revise recurrence (Pix Automático)

curl --request PATCH \
  --url https://api.example.com/api/v1/brcode/rec/{idRec} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-Idempotency: <x-idempotency>' \
  --data '
{
  "ativacao": {},
  "calendario": {
    "dataInicial": "2027-02-01"
  },
  "loc": 2,
  "status": "CANCELADA",
  "vinculo": {
    "devedor": {
      "nome": "<string>"
    }
  }
}
'

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.example.com/api/v1/brcode/rec/{idRec}"

	payload := strings.NewReader("{\n  \"ativacao\": {},\n  \"calendario\": {\n    \"dataInicial\": \"2027-02-01\"\n  },\n  \"loc\": 2,\n  \"status\": \"CANCELADA\",\n  \"vinculo\": {\n    \"devedor\": {\n      \"nome\": \"<string>\"\n    }\n  }\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("X-Idempotency", "<x-idempotency>")
	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

const options = {
  method: 'PATCH',
  headers: {
    'X-Idempotency': '<x-idempotency>',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    ativacao: {},
    calendario: {dataInicial: '2027-02-01'},
    loc: 2,
    status: 'CANCELADA',
    vinculo: {devedor: {nome: '<string>'}}
  })
};

fetch('https://api.example.com/api/v1/brcode/rec/{idRec}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.example.com/api/v1/brcode/rec/{idRec}"

payload = {
    "ativacao": {},
    "calendario": { "dataInicial": "2027-02-01" },
    "loc": 2,
    "status": "CANCELADA",
    "vinculo": { "devedor": { "nome": "<string>" } }
}
headers = {
    "X-Idempotency": "<x-idempotency>",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

{
  "atualizacao": [
    {
      "data": "<string>",
      "status": "CRIADA"
    }
  ],
  "calendario": {
    "dataInicial": "2027-01-15",
    "periodicidade": "MENSAL",
    "dataFinal": "<string>"
  },
  "idRec": "<string>",
  "politicaRetentativa": "NAO_PERMITE",
  "recebedor": {
    "cnpj": "12ABC34501DE35",
    "conta": "1234567890",
    "nome": "Empresa Recebedora LTDA",
    "tipoConta": "CORRENTE",
    "agencia": "0001",
    "convenio": "<string>",
    "ispbParticipante": "<string>"
  },
  "status": "CRIADA",
  "vinculo": {
    "contrato": "contrato-12345",
    "devedor": {
      "cnpj": "12ABC34501DE35",
      "cpf": "12345678901",
      "nome": "Fulano de Tal"
    },
    "objeto": "<string>"
  },
  "atestacaoTitularidade": {
    "atestadaEm": "<string>",
    "atestadaPor": "<string>",
    "conta": "<string>",
    "tipoConta": "<string>",
    "agencia": "<string>"
  },
  "ativacao": {
    "tipoJornada": "JORNADA_1",
    "dadosJornada": {
      "txid": "<string>"
    }
  },
  "encerramento": {
    "cancelamento": {
      "codigo": "ACCL",
      "descricao": "<string>",
      "solicitante": "PSP_PAGADOR"
    },
    "rejeicao": {
      "codigo": "AP13",
      "descricao": "<string>"
    }
  },
  "loc": {
    "criacao": "<string>",
    "id": 123,
    "location": "<string>",
    "tipo": "rec",
    "idRec": "<string>"
  },
  "solicitacao": [
    {
      "atualizacao": [
        {
          "data": "<string>",
          "status": "CRIADA"
        }
      ],
      "calendario": {
        "dataExpiracaoSolicitacao": "2023-12-20T12:17:11Z"
      },
      "destinatario": {
        "conta": "550689",
        "ispbParticipante": "91193552",
        "agencia": "2569",
        "cnpj": "<string>",
        "cpf": "15231470190"
      },
      "idRec": "<string>",
      "idSolicRec": "<string>",
      "status": "CRIADA",
      "recPayload": {
        "atualizacao": [
          {
            "data": "<string>",
            "status": "CRIADA"
          }
        ],
        "calendario": {
          "dataInicial": "2027-01-15",
          "periodicidade": "MENSAL",
          "dataFinal": "<string>"
        },
        "idRec": "<string>",
        "politicaRetentativa": "NAO_PERMITE",
        "recebedor": {
          "cnpj": "<string>",
          "ispbParticipante": "<string>",
          "nome": "<string>"
        },
        "vinculo": {
          "contrato": "contrato-12345",
          "devedor": {
            "cnpj": "12ABC34501DE35",
            "cpf": "12345678901",
            "nome": "Fulano de Tal"
          },
          "objeto": "<string>"
        },
        "valor": {
          "valorMinimoRecebedor": "<string>",
          "valorRec": "99.90"
        }
      }
    }
  ],
  "valor": {
    "valorMinimoRecebedor": "<string>",
    "valorRec": "99.90"
  }
}

{
  "correlationId": "req-7a3f9c2e",
  "code": "<string>",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

{
  "correlationId": "req-7a3f9c2e",
  "code": "<string>",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

{
  "correlationId": "req-7a3f9c2e",
  "code": "<string>",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

{
  "correlationId": "req-7a3f9c2e",
  "code": "<string>",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

{
  "correlationId": "req-7a3f9c2e",
  "code": "<string>",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

Revise recurrence (Pix Automático)

Partially revises a recurrence (Rec) by its idRec: changes calendario.dataInicial and ativacao.dadosJornada.txid (only while status == CRIADA), vinculo.devedor.nome and loc (links a locrec; both can change after confirmation too), and/or the status (CANCELADA cancels the mandate). Pix API PATCH /rec/. Rejects any change when the recurrence is EXPIRADA/CANCELADA/REJEITADA (422). An unknown idRec returns 404 (canonical Problem envelope).

PATCH

api

brcode

rec

{idRec}

Revise recurrence (Pix Automático)

curl --request PATCH \
  --url https://api.example.com/api/v1/brcode/rec/{idRec} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-Idempotency: <x-idempotency>' \
  --data '
{
  "ativacao": {},
  "calendario": {
    "dataInicial": "2027-02-01"
  },
  "loc": 2,
  "status": "CANCELADA",
  "vinculo": {
    "devedor": {
      "nome": "<string>"
    }
  }
}
'

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.example.com/api/v1/brcode/rec/{idRec}"

	payload := strings.NewReader("{\n  \"ativacao\": {},\n  \"calendario\": {\n    \"dataInicial\": \"2027-02-01\"\n  },\n  \"loc\": 2,\n  \"status\": \"CANCELADA\",\n  \"vinculo\": {\n    \"devedor\": {\n      \"nome\": \"<string>\"\n    }\n  }\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("X-Idempotency", "<x-idempotency>")
	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

const options = {
  method: 'PATCH',
  headers: {
    'X-Idempotency': '<x-idempotency>',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    ativacao: {},
    calendario: {dataInicial: '2027-02-01'},
    loc: 2,
    status: 'CANCELADA',
    vinculo: {devedor: {nome: '<string>'}}
  })
};

fetch('https://api.example.com/api/v1/brcode/rec/{idRec}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.example.com/api/v1/brcode/rec/{idRec}"

payload = {
    "ativacao": {},
    "calendario": { "dataInicial": "2027-02-01" },
    "loc": 2,
    "status": "CANCELADA",
    "vinculo": { "devedor": { "nome": "<string>" } }
}
headers = {
    "X-Idempotency": "<x-idempotency>",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

{
  "atualizacao": [
    {
      "data": "<string>",
      "status": "CRIADA"
    }
  ],
  "calendario": {
    "dataInicial": "2027-01-15",
    "periodicidade": "MENSAL",
    "dataFinal": "<string>"
  },
  "idRec": "<string>",
  "politicaRetentativa": "NAO_PERMITE",
  "recebedor": {
    "cnpj": "12ABC34501DE35",
    "conta": "1234567890",
    "nome": "Empresa Recebedora LTDA",
    "tipoConta": "CORRENTE",
    "agencia": "0001",
    "convenio": "<string>",
    "ispbParticipante": "<string>"
  },
  "status": "CRIADA",
  "vinculo": {
    "contrato": "contrato-12345",
    "devedor": {
      "cnpj": "12ABC34501DE35",
      "cpf": "12345678901",
      "nome": "Fulano de Tal"
    },
    "objeto": "<string>"
  },
  "atestacaoTitularidade": {
    "atestadaEm": "<string>",
    "atestadaPor": "<string>",
    "conta": "<string>",
    "tipoConta": "<string>",
    "agencia": "<string>"
  },
  "ativacao": {
    "tipoJornada": "JORNADA_1",
    "dadosJornada": {
      "txid": "<string>"
    }
  },
  "encerramento": {
    "cancelamento": {
      "codigo": "ACCL",
      "descricao": "<string>",
      "solicitante": "PSP_PAGADOR"
    },
    "rejeicao": {
      "codigo": "AP13",
      "descricao": "<string>"
    }
  },
  "loc": {
    "criacao": "<string>",
    "id": 123,
    "location": "<string>",
    "tipo": "rec",
    "idRec": "<string>"
  },
  "solicitacao": [
    {
      "atualizacao": [
        {
          "data": "<string>",
          "status": "CRIADA"
        }
      ],
      "calendario": {
        "dataExpiracaoSolicitacao": "2023-12-20T12:17:11Z"
      },
      "destinatario": {
        "conta": "550689",
        "ispbParticipante": "91193552",
        "agencia": "2569",
        "cnpj": "<string>",
        "cpf": "15231470190"
      },
      "idRec": "<string>",
      "idSolicRec": "<string>",
      "status": "CRIADA",
      "recPayload": {
        "atualizacao": [
          {
            "data": "<string>",
            "status": "CRIADA"
          }
        ],
        "calendario": {
          "dataInicial": "2027-01-15",
          "periodicidade": "MENSAL",
          "dataFinal": "<string>"
        },
        "idRec": "<string>",
        "politicaRetentativa": "NAO_PERMITE",
        "recebedor": {
          "cnpj": "<string>",
          "ispbParticipante": "<string>",
          "nome": "<string>"
        },
        "vinculo": {
          "contrato": "contrato-12345",
          "devedor": {
            "cnpj": "12ABC34501DE35",
            "cpf": "12345678901",
            "nome": "Fulano de Tal"
          },
          "objeto": "<string>"
        },
        "valor": {
          "valorMinimoRecebedor": "<string>",
          "valorRec": "99.90"
        }
      }
    }
  ],
  "valor": {
    "valorMinimoRecebedor": "<string>",
    "valorRec": "99.90"
  }
}

{
  "correlationId": "req-7a3f9c2e",
  "code": "<string>",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

{
  "correlationId": "req-7a3f9c2e",
  "code": "<string>",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

{
  "correlationId": "req-7a3f9c2e",
  "code": "<string>",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

{
  "correlationId": "req-7a3f9c2e",
  "code": "<string>",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

{
  "correlationId": "req-7a3f9c2e",
  "code": "<string>",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

Autorizaciones

Authorization

string

header

requerido

JWT bearer token issued by the identity provider.

Encabezados

X-Idempotency

string

requerido

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

ativacao

object

Patch da ativação (apenas dadosJornada.txid, somente enquanto status == CRIADA).

Show child attributes

calendario

object

Patch do calendário (apenas dataInicial).

Show child attributes

cancelamento

object

Detalhe do cancelamento (registrado em encerramento.cancelamento).

Show child attributes

loc

integer<int64>

Id da location (locrec) a vincular. Alterável inclusive após a confirmação.

Rango requerido: x >= 1

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

vinculo

object

Patch do vínculo (apenas devedor.nome).

Show child attributes

Respuesta

atualizacao

object[]

requerido

Show child attributes

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

atestacaoTitularidade

object

Show child attributes

ativacao

object

Show child attributes

encerramento

object

Show child attributes

loc

object

Show child attributes

solicitacao

object[]

Show child attributes

valor

object

Show child attributes