Get the JWS-signed recurrence payload by location access token

​

Endpoint (location) que serve o payload da recorrência, lido pelo PSP do pagador quando o pagador faz a leitura do QR Code composto.

O corpo é uma serialização compacta JWS (RFC 7515) cujo payload é o RecPayload da API Pix — é esse o schema declarado abaixo, como na norma. O consumidor deve verificar a assinatura contra o JWK Set publicado antes de usar o conteúdo. É a única leitura de recorrência sem escopo de conta.

Path Parameters
  • recUrlAccessToken
    Type: string
    required
Responses
  • application/jose
  • 400

    Requisição inválida

  • 403

    Acesso negado — credencial sem o escopo exigido pela operação ou certificado rejeitado. Respondido no gateway de exposição (Bacen: AcessoNegado)

  • 404

    Recurso não encontrado para esta conta

  • 503

    Serviço temporariamente indisponível (Bacen: ServicoIndisponivel)

Request Example for get/rec/{recUrlAccessToken}
curl 'http://localhost:8080/rec/{recUrlAccessToken}' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

{
  "idRec": "string",
  "vinculo": {
    "contrato": "string",
    "devedor": {
      "cpf": "string",
      "cnpj": "string",
      "nome": "string"
    },
    "objeto": "string"
  },
  "calendario": {
    "dataInicial": "2026-09-16",
    "dataFinal": "2026-09-16",
    "periodicidade": "SEMANAL"
  },
  "valor": {
    "valorRec": "string",
    "valorMinimoRecebedor": "string"
  },
  "recebedor": {
    "cnpj": "string",
    "nome": "string",
    "ispbParticipante": "string"
  },
  "politicaRetentativa": "NAO_PERMITE",
  "atualizacao": [
    {
      "status": "string",
      "statusAnterior": "string",
      "origem": "USER",
      "motivo": "string",
      "data": "2026-09-16T19:14:18.843Z"
    }
  ]
}

Operação realizada com sucesso