5.10. URs removidas e rejeitadas¶

🔗 Endpoint¶

Método	URL	Retorno
	`/public/api/v1.1/cartao/contratos/{idContrato}/urs-removidas`	URs que saíram do contrato
	`/public/api/v1.1/cartao/contratos/{idContrato}/urs-rejeitadas`	URs recusadas pela registradora ou pela plataforma

🧾 Descrição¶

Duas visões de auditoria sobre as URs que já estiveram ou tentaram entrar em um contrato:

URs removidas — URs que estavam vinculadas ao contrato e foram retiradas dele por solicitação do cliente, com as datas de solicitação (dataRemocao) e de confirmação pela registradora (dataConfirmacaoRemocao). A remoção é solicitada em 5.8. Remover URs do contrato.
URs rejeitadas — URs cuja tentativa de vínculo foi recusada pela registradora ou pela plataforma VeFlow, com o motivoRejeicao.

URs canceladas, removidas ou rejeitadas permanecem listadas para rastreabilidade — elas nunca são apagadas do histórico do contrato. Nenhuma das duas listas compõe os totais do contrato, que refletem apenas as URs efetivamente vinculadas (ver 5.3. Detalhes do contrato).

Ambas as rotas são paginadas.

📤 Requisição¶

🔑 Parâmetros de rota¶

Parâmetro	Tipo	Obrigatório	Descrição
idContrato	string	Sim	GUID do contrato, devolvido em 5.1. Criar contratos.

🔎 Query params (paginação e ordenação)¶

Parâmetro	Tipo	Obrigatório	Default	Descrição
indicePagina	integer	Não	`1`	Página desejada do resultado.
tamanhoDaPagina	integer	Não	`20`	Quantidade de registros por página. Máximo de 200.
ordem	string	Não	`dataRemocao` / `dataRejeicao`	Campo de ordenação: `dataPrevistaLiquidacao`, `valorGarantido`, `dataRemocao` (removidas) ou `dataRejeicao` (rejeitadas).
direcaoOrdem	string	Não	`desc`	Direção da ordenação: `asc` ou `desc`.

🧪 Exemplo de cURL — URs removidas¶

curl -X GET "https://api.veflow.com/public/api/v1.1/cartao/contratos/5174568D-9FFE-4C10-9FC2-B0F4E7F8D1B6/urs-removidas?indicePagina=1&tamanhoDaPagina=20&ordem=dataRemocao&direcaoOrdem=desc" \
  -H "Authorization: Bearer {seu_token}" \
  -H "GrupoEconomico: {seu_grupo_economico}"

📥 Response — URs removidas¶

✅ 200 OK¶

{
  "registros": [
    {
      "idUr": "29E8F0CE-3391-4A65-8091-2331802CEABE",
      "credenciadora": {
        "cnpj": "11223344000155",
        "nome": "CREDENCIADORA EXEMPLO S.A."
      },
      "arranjo": {
        "sigla": "MCC",
        "nome": "Mastercard Crédito"
      },
      "dataPrevistaLiquidacao": "2025-09-18",
      "valorGarantido": 1500.00,
      "dataRemocao": "2025-09-10",
      "dataConfirmacaoRemocao": "2025-09-11"
    }
  ],
  "paginacao": {
    "paginaAtual": 1,
    "paginaTotal": 1,
    "paginaQuantidadeRegistro": 20,
    "quantidadeRegistros": 1,
    "temPaginaAnterior": false,
    "temProximaPagina": false
  },
  "mensagem": null
}

🔹 registros¶

Campo	Tipo	Descrição
idUr	string	GUID da UR que foi removida do contrato.
credenciadora.cnpj	string	CNPJ da credenciadora responsável pela UR.
credenciadora.nome	string	Nome da credenciadora.
arranjo.sigla	string	Sigla do arranjo de pagamento (ex.: `MCC`, `VCC`).
arranjo.nome	string	Nome completo do arranjo (ex.: Mastercard Crédito).
dataPrevistaLiquidacao	string	Data prevista de liquidação da UR (`YYYY-MM-DD`).
valorGarantido	number	Valor que a UR mantinha comprometido no contrato antes da remoção.
dataRemocao	string	Data em que a remoção foi solicitada na plataforma (`YYYY-MM-DD`).
dataConfirmacaoRemocao	string	Data em que a registradora confirmou a remoção (`YYYY-MM-DD`). Retorna `null` enquanto não confirmada.

🧪 Exemplo de cURL — URs rejeitadas¶

curl -X GET "https://api.veflow.com/public/api/v1.1/cartao/contratos/5174568D-9FFE-4C10-9FC2-B0F4E7F8D1B6/urs-rejeitadas?indicePagina=1&tamanhoDaPagina=20&ordem=dataRejeicao&direcaoOrdem=desc" \
  -H "Authorization: Bearer {seu_token}" \
  -H "GrupoEconomico: {seu_grupo_economico}"

📥 Response — URs rejeitadas¶

✅ 200 OK¶

{
  "registros": [
    {
      "idUr": "7D121577-3C5A-494D-B052-291D9E100D0D",
      "credenciadora": {
        "cnpj": "10293847560102",
        "nome": "CREDENCIADORA EXEMPLO II S.A."
      },
      "arranjo": {
        "sigla": "VCC",
        "nome": "Visa Crédito"
      },
      "dataPrevistaLiquidacao": "2025-09-25",
      "valorGarantido": 820.45,
      "motivoRejeicao": 1,
      "dataRejeicao": "2025-09-05"
    }
  ],
  "paginacao": {
    "paginaAtual": 1,
    "paginaTotal": 1,
    "paginaQuantidadeRegistro": 20,
    "quantidadeRegistros": 1,
    "temPaginaAnterior": false,
    "temProximaPagina": false
  },
  "mensagem": null
}

🔹 registros¶

Campo	Tipo	Descrição
idUr	string	GUID da UR cuja tentativa de vínculo foi rejeitada.
credenciadora.cnpj	string	CNPJ da credenciadora responsável pela UR.
credenciadora.nome	string	Nome da credenciadora.
arranjo.sigla	string	Sigla do arranjo de pagamento (ex.: `MCC`, `VCC`).
arranjo.nome	string	Nome completo do arranjo (ex.: Visa Crédito).
dataPrevistaLiquidacao	string	Data prevista de liquidação da UR (`YYYY-MM-DD`).
valorGarantido	number	Valor que se pretendia comprometer no contrato com aquela UR.
motivoRejeicao	integer	Motivo da rejeição (ver tabela abaixo).
dataRejeicao	string	Data em que a rejeição foi registrada na plataforma (`YYYY-MM-DD`).

🔢 Motivos de rejeição¶

Código	Descrição	Quando ocorre
1	Falha ao vincular ao contrato	A registradora recusou o vínculo da UR ao contrato no regime de interoperabilidade.
2	Não performado corretamente	A UR não se confirmou como performada na conciliação, então não pôde compor o contrato.

📄 Envelope de paginação¶

🔹 paginacao¶

Campo	Tipo	Descrição
paginaAtual	integer	Página atual do retorno.
paginaTotal	integer	Total de páginas disponíveis.
paginaQuantidadeRegistro	integer	Quantidade máxima de registros por página.
quantidadeRegistros	integer	Total de registros encontrados.
temPaginaAnterior	boolean	Indica se há página anterior.
temProximaPagina	boolean	Indica se há próxima página.

🔹 mensagem¶

Campo	Tipo	Descrição
mensagem	string/null	Mensagem informativa opcional. Em caso de sucesso vem `null`.

Quando o contrato existe e não há URs removidas (ou rejeitadas), a resposta é 200 OK com registros vazio e quantidadeRegistros = 0.

❌ Erros¶

🔸 400 Bad Request¶

{
  "tipo": "https://tools.ietf.org/html/rfc9110#section-15.5.1",
  "titulo": "Atenção",
  "status": 400,
  "erros": [
    "Parâmetro 'indicePagina' deve ser maior ou igual a 1.",
    "Parâmetro 'tamanhoDaPagina' deve estar entre 1 e 200.",
    "Parâmetro 'ordem' inválido."
  ]
}

🔸 404 Not Found¶

{
  "tipo": "https://tools.ietf.org/html/rfc9110#section-15.5.5",
  "titulo": "Atenção",
  "status": 404,
  "erros": [
    "Contrato não encontrado."
  ]
}

🕒 Observações¶

As duas listas são imutáveis e cumulativas: URs canceladas, removidas ou rejeitadas permanecem listadas indefinidamente para rastreabilidade, inclusive após o contrato ser cancelado ou liquidado.
Uma mesma UR pode aparecer nas duas visões ao longo do tempo — por exemplo, rejeitada em uma tentativa de vínculo e, depois de vinculada com sucesso, removida do contrato.
O valorGarantido é o vocabulário da fase de contrato. Contratos de garantia (tipoContrato = 2) não têm deságio e, portanto, não trazem valores de nominal, desconto nem aquisição nestas listas.
Uma UR removida libera o valor que mantinha comprometido; o saldo volta a ficar livre e pode ser reutilizado em outros contratos.
O evento que originou cada registro chega em tempo real por webhook — ver 3.2. Atualizações do contrato e 3.3. Atualizações da UR.
Headers obrigatórios e convenções gerais: 1.1. Primeiros Passos.