> ## Documentation Index > Fetch the complete documentation index at: https://docs.lerian.studio/llms.txt > Use this file to discover all available pages before exploring further. # Retrieve recurrence (Pix Automático) > Retrieves a recurrence by its idRec. Pix API GET /rec/{idRec}. Projects the stored Rec fields verbatim, including recebedor.convenio. An unknown idRec returns 404 (canonical Problem envelope). ## OpenAPI ````yaml /pt/openapi/v3-current/spi-brcode.yaml get /api/v1/brcode/rec/{idRec} openapi: 3.1.0 info: contact: email: contact@lerian.studio name: Lerian Studio url: https://lerian.studio description: BR Code service for QR code generation and decoding (EMV QRCPS-MPM). license: name: Lerian Studio General License title: Lerian SPI — BR Code API version: 1.0.0 servers: - url: https://api.example.com description: >- Replace the example host with the URL provided during environment onboarding. security: [] tags: - description: EMV BR Code payload generation, decoding, validation, info, and lookup. name: BRCode - description: >- Pix charges (Cob/CobV/LoteCobV): create, retrieve by TxID, list, cancel, reconcile, and resolve public payloads. name: Charges - description: >- Flow (mandatory order): create cob/cobv → generate QR/payload. A dynamic BR Code payload references a charge, so the cob/cobv charge MUST be created first; the payload links to it by txid/locator. name: charge paths: /api/v1/brcode/rec/{idRec}: get: tags: - Rec summary: Retrieve recurrence (Pix Automático) description: >- Retrieves a recurrence by its idRec. Pix API GET /rec/{idRec}. Projects the stored Rec fields verbatim, including recebedor.convenio. An unknown idRec returns 404 (canonical Problem envelope). operationId: getRec parameters: - description: Identificador da recorrência [a-zA-Z0-9]{29}. in: path name: idRec required: true schema: description: Identificador da recorrência [a-zA-Z0-9]{29}. pattern: ^[a-zA-Z0-9]{29}$ type: string - description: >- txid de uma cobrança a compor com a recorrência (JORNADA_3/4). NÃO SERVIDO nesta superfície: informar txid resulta em 422. explode: false in: query name: txid schema: description: >- txid de uma cobrança a compor com a recorrência (JORNADA_3/4). NÃO SERVIDO nesta superfície: informar txid resulta em 422. pattern: ^[a-zA-Z0-9]{26,35}$ type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/RecCompleta' description: OK '404': content: application/problem+json: schema: $ref: '#/components/schemas/Detail' description: Not Found '409': content: application/problem+json: schema: $ref: '#/components/schemas/Detail' description: Conflict '422': content: application/problem+json: schema: $ref: '#/components/schemas/Detail' description: Unprocessable Entity '500': content: application/problem+json: schema: $ref: '#/components/schemas/Detail' description: Internal Server Error default: content: application/problem+json: schema: $ref: '#/components/schemas/Detail' description: Error security: - BearerAuth: [] components: schemas: RecCompleta: additionalProperties: false properties: atestacaoTitularidade: $ref: '#/components/schemas/RecAtestacaoTitularidadeRegistradaDTO' ativacao: $ref: '#/components/schemas/RecAtivacaoDTO' atualizacao: items: $ref: '#/components/schemas/RecAtualizacaoDTO' type: array calendario: $ref: '#/components/schemas/RecCalendarioDTO' dadosQR: $ref: '#/components/schemas/RecDadosQRDTO' description: >- QR Composto da recorrência (Pix Automático). Ausente em duas situações: enquanto a recorrência não tem locrec vinculada, e enquanto a instituição não tiver registrado, para o CNPJ do recebedor desta recorrência, um único perfil de recebedor, de onde sai a cidade obrigatória do BR Code (tag 60). Uma recorrência tem conta e CNPJ, não chave Pix, e nada no fluxo de recorrência cria esse registro: sem ele, ou com mais de um perfil para o mesmo CNPJ, o QR é OMITIDO em vez de sair com uma cidade inventada. Registrar um perfil de recebedor com o CNPJ correspondente é o que passa a servir o QR. encerramento: $ref: '#/components/schemas/RecEncerramentoDTO' idRec: description: Identificador da recorrência. pattern: ^[a-zA-Z0-9]{29}$ type: string loc: $ref: '#/components/schemas/PayloadLocationRecCompleta' pagador: $ref: '#/components/schemas/RecPagadorDTO' description: >- Dados do usuário pagador informados pelo PSP pagador na confirmação da recorrência. politicaRetentativa: enum: - NAO_PERMITE - PERMITE_3R_7D type: string recebedor: $ref: '#/components/schemas/RecRecebedorDTO' solicitacao: items: $ref: '#/components/schemas/SolicRecCompleta' type: array status: enum: - CRIADA - APROVADA - REJEITADA - EXPIRADA - CANCELADA type: string valor: $ref: '#/components/schemas/RecValorDTO' vinculo: $ref: '#/components/schemas/RecVinculoDTO' required: - idRec - vinculo - calendario - recebedor - politicaRetentativa - status - atualizacao type: object Detail: additionalProperties: false properties: code: description: >- Stable, machine-readable domain error code scoped to the emitting service (format: -NNNN). type: string correlationId: description: Request-scoped correlation identifier echoing X-Request-ID. examples: - req-7a3f9c2e type: string detail: description: >- A human-readable explanation specific to this occurrence of the problem. examples: - Property foo is required but is missing. type: string errors: description: Optional list of individual error details items: $ref: '#/components/schemas/ErrorDetail' type: - array - 'null' instance: description: >- A URI reference that identifies the specific occurrence of the problem. examples: - https://example.com/error-log/abc123 format: uri type: string status: description: HTTP status code examples: - 400 format: int64 type: integer title: description: >- A short, human-readable summary of the problem type. This value should not change between occurrences of the error. examples: - Bad Request type: string type: default: about:blank description: A URI reference to human-readable documentation for the error. examples: - https://example.com/errors/example format: uri type: string upstream: $ref: '#/components/schemas/Upstream' description: >- RFC 9457 extension member: the error a proxied third-party provider reported. Absent unless the emitting service explicitly surfaced one. required: - correlationId type: object RecAtestacaoTitularidadeRegistradaDTO: additionalProperties: false properties: agencia: type: string atestadaEm: description: Instante da atestação (RFC 3339). type: string atestadaPor: description: Ator autenticado que fez a atestação. type: string conta: type: string tipoConta: type: string required: - conta - tipoConta - atestadaPor - atestadaEm type: object RecAtivacaoDTO: additionalProperties: false properties: dadosJornada: $ref: '#/components/schemas/RecDadosJornadaDTO' description: Dados da jornada (hoje apenas txid, obrigatório na JORNADA_3). tipoJornada: description: Jornada de ativação da recorrência. enum: - JORNADA_1 - JORNADA_2 - JORNADA_3 - JORNADA_4 - AGUARDANDO_DEFINICAO type: string required: - tipoJornada type: object RecAtualizacaoDTO: additionalProperties: false properties: data: description: Instante da atualização (RFC 3339). type: string status: description: Status da recorrência no instante. enum: - CRIADA - APROVADA - REJEITADA - EXPIRADA - CANCELADA type: string required: - status - data type: object RecCalendarioDTO: additionalProperties: false properties: dataFinal: description: >- Data final (apenas vigência fixa; ausente para indeterminada) (YYYY-MM-DD). Não pode ser anterior a dataInicial. type: string dataInicial: description: >- Data estimada do primeiro pagamento (YYYY-MM-DD). Não pode ser anterior à data de criação da recorrência. examples: - '2027-01-15' type: string periodicidade: description: Cadência da recorrência. enum: - SEMANAL - MENSAL - TRIMESTRAL - SEMESTRAL - ANUAL examples: - MENSAL type: string required: - dataInicial - periodicidade type: object RecDadosQRDTO: additionalProperties: false properties: jornada: description: >- Jornada do QR Composto construído. Nesta superfície sempre JORNADA_2, o QR só de recorrência. JORNADA_3/4 (composição com cobrança imediata ou com vencimento, via txid na consulta) não são servidas aqui: a consulta com txid é recusada. enum: - JORNADA_2 examples: - JORNADA_2 type: string pixCopiaECola: description: Pix Copia e Cola (BR Code) do QR Composto da recorrência. maxLength: 512 type: string required: - jornada - pixCopiaECola type: object RecEncerramentoDTO: additionalProperties: false properties: cancelamento: $ref: '#/components/schemas/RecCancelamentoDTO' rejeicao: $ref: '#/components/schemas/RecRejeicaoDTO' type: object PayloadLocationRecCompleta: additionalProperties: false properties: criacao: description: Data de criação da location (RFC 3339). type: string id: description: Id da location de recorrência (gerado pelo servidor). format: int64 type: integer idRec: description: Recorrência vinculada (ausente quando desvinculada). pattern: ^[a-zA-Z0-9]{29}$ type: string location: description: Localização do payload de recorrência (URI). maxLength: 77 type: string tipo: description: 'Tipo fixo: rec.' enum: - rec examples: - rec type: string required: - id - location - tipo - criacao type: object RecPagadorDTO: additionalProperties: false properties: cnpj: description: >- CNPJ do usuário pagador, informado pelo PSP pagador na confirmação da recorrência. Exclusivo com cpf. examples: - '28333333150443' pattern: ^[0-9A-Z]{14}$ type: string codMun: description: >- Código IBGE (7 dígitos) do município do usuário pagador, informado pelo PSP pagador na confirmação da recorrência. Determina os feriados locais que deslocam a data prevista para liquidação das cobranças. Ausente: assume-se que não há feriados estaduais/municipais. examples: - '3550308' pattern: ^\d{7}$ type: string cpf: description: >- CPF do usuário pagador, informado pelo PSP pagador na confirmação da recorrência. Exclusivo com cnpj. examples: - '23933333316' pattern: ^\d{11}$ type: string ispbParticipante: description: >- ISPB do participante do usuário pagador, informado pelo PSP pagador na confirmação da recorrência. examples: - '81102623' pattern: ^[0-9A-Z]{8}$ type: string type: object RecRecebedorDTO: additionalProperties: false properties: agencia: description: Agência do recebedor. examples: - '0001' maxLength: 4 type: string cnpj: description: CNPJ do usuário recebedor (identidade exigida pelo RecPayload). examples: - 12ABC34501DE35 pattern: ^[0-9A-Z]{14}$ type: string conta: description: Conta do recebedor. examples: - '1234567890' maxLength: 20 type: string convenio: description: Convênio entre usuário e participante recebedor. maxLength: 60 type: string ispbParticipante: description: ISPB do participante do usuário recebedor (definido pelo servidor). pattern: ^[0-9A-Z]{8}$ type: string nome: description: Nome do usuário recebedor (identidade exigida pelo RecPayload). examples: - Empresa Recebedora LTDA maxLength: 140 type: string tipoConta: description: Tipo de conta do recebedor. enum: - CORRENTE - POUPANCA - PAGAMENTO examples: - CORRENTE type: string required: - conta - tipoConta - cnpj - nome type: object SolicRecCompleta: additionalProperties: false properties: atualizacao: items: $ref: '#/components/schemas/SolicRecAtualizacaoDTO' type: array calendario: $ref: '#/components/schemas/SolicRecCalendarioDTO' destinatario: $ref: '#/components/schemas/SolicRecDestinatarioDTO' idRec: pattern: ^[a-zA-Z0-9]{29}$ type: string idSolicRec: description: Identificador da solicitação. pattern: ^[a-zA-Z0-9]{29}$ type: string recPayload: $ref: '#/components/schemas/RecPayloadDTO' status: enum: - CRIADA - ENVIADA - RECEBIDA - REJEITADA - ACEITA - EXPIRADA - CANCELADA type: string required: - idSolicRec - idRec - calendario - destinatario - status - atualizacao type: object RecValorDTO: additionalProperties: false properties: valorMinimoRecebedor: description: Piso do recebedor (mutuamente exclusivo com valorRec). pattern: ^\d{1,10}\.\d{2}$ type: string valorRec: description: Valor fixo da recorrência. examples: - '99.90' pattern: ^\d{1,10}\.\d{2}$ type: string type: object RecVinculoDTO: additionalProperties: false properties: contrato: description: Identificador do contrato/pedido. examples: - contrato-12345 maxLength: 35 type: string devedor: $ref: '#/components/schemas/RecDevedorDTO' description: Devedor da recorrência (PF/PJ). objeto: description: Descrição livre do objeto da recorrência. maxLength: 35 type: string required: - contrato - devedor type: object ErrorDetail: additionalProperties: false properties: location: description: >- Where the error occurred, e.g. 'body.items[3].tags' or 'path.thing-id' type: string message: description: Error message text type: string value: description: The value at the given location type: object Upstream: additionalProperties: false properties: code: description: The upstream provider's own error code, verbatim. examples: - E4001 type: string message: description: >- The upstream provider's own error message, verbatim (bounded, never its raw response body). examples: - account not found at provider type: string type: object RecDadosJornadaDTO: additionalProperties: false properties: txid: description: >- txid da cobrança imediata paga no momento da autorização. Obrigatório na JORNADA_3; removido nas jornadas 1, 2 e 4. pattern: ^[a-zA-Z0-9]{26,35}$ type: string required: - txid type: object RecCancelamentoDTO: additionalProperties: false properties: codigo: description: Código do cancelamento no catálogo de mensagens. enum: - ACCL - CPCL - DCSD - ERSL - FRUD - PCFD - SLCR - SLDB maxLength: 4 type: string descricao: description: Descrição do cancelamento. maxLength: 400 type: string solicitante: description: Quem solicitou o cancelamento. enum: - PSP_PAGADOR - USUARIO_PAGADOR - PSP_RECEBEDOR - USUARIO_RECEBEDOR type: string required: - solicitante - codigo - descricao type: object RecRejeicaoDTO: additionalProperties: false properties: codigo: description: Código da rejeição no catálogo de mensagens. enum: - AP13 - AP14 maxLength: 4 type: string descricao: description: Descrição da causa da rejeição. maxLength: 400 type: string required: - codigo - descricao type: object SolicRecAtualizacaoDTO: additionalProperties: false properties: data: description: Instante da atualização (RFC 3339). type: string status: description: Status da solicitação no instante. enum: - CRIADA - ENVIADA - RECEBIDA - REJEITADA - ACEITA - EXPIRADA - CANCELADA type: string required: - status - data type: object SolicRecCalendarioDTO: additionalProperties: false properties: dataExpiracaoSolicitacao: description: Data de expiração da solicitação enviada ao pagador (RFC 3339). examples: - '2023-12-20T12:17:11Z' format: date-time pattern: ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(\.\d+)?(Z|[+-]\d{2}:\d{2})$ type: string required: - dataExpiracaoSolicitacao type: object SolicRecDestinatarioDTO: additionalProperties: false properties: agencia: description: Agência do destinatário. examples: - '2569' maxLength: 4 type: string cnpj: description: CNPJ do destinatário (PJ). Mutuamente exclusivo com cpf. pattern: ^[0-9A-Z]{14}$ type: string conta: description: Conta do destinatário. examples: - '550689' maxLength: 20 type: string cpf: description: CPF do destinatário (PF). Mutuamente exclusivo com cnpj. examples: - '15231470190' pattern: ^\d{11}$ type: string ispbParticipante: description: ISPB do participante destinatário. examples: - '91193552' pattern: ^[0-9A-Z]{8}$ type: string required: - conta - ispbParticipante type: object RecPayloadDTO: additionalProperties: false properties: atualizacao: items: $ref: '#/components/schemas/RecAtualizacaoDTO' type: array calendario: $ref: '#/components/schemas/RecCalendarioDTO' idRec: description: Identificador da recorrência. pattern: ^[a-zA-Z0-9]{29}$ type: string politicaRetentativa: enum: - NAO_PERMITE - PERMITE_3R_7D type: string recebedor: $ref: '#/components/schemas/RecPayloadRecebedorDTO' valor: $ref: '#/components/schemas/RecValorDTO' vinculo: $ref: '#/components/schemas/RecVinculoDTO' required: - idRec - vinculo - calendario - recebedor - politicaRetentativa - atualizacao type: object RecDevedorDTO: additionalProperties: false properties: cnpj: description: CNPJ do devedor (PJ). Mutuamente exclusivo com cpf. examples: - 12ABC34501DE35 pattern: ^[0-9A-Z]{14}$ type: string cpf: description: CPF do devedor (PF). Mutuamente exclusivo com cnpj. examples: - '12345678901' pattern: ^\d{11}$ type: string nome: description: Nome do devedor. examples: - Fulano de Tal maxLength: 140 type: string type: object RecPayloadRecebedorDTO: additionalProperties: false properties: cnpj: pattern: ^[0-9A-Z]{14}$ type: string ispbParticipante: pattern: ^[0-9A-Z]{8}$ type: string nome: maxLength: 140 type: string required: - cnpj - nome - ispbParticipante type: object securitySchemes: BearerAuth: bearerFormat: JWT description: JWT bearer token issued by the identity provider. scheme: bearer type: http ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.