Essa API irá retornar todos os convênios disponíveis para o uso do débito automático.

Recomendamos que esses convênios sejam armazenados do lado da sua aplicação, dessa forma, com os dados em memória fica mais fácil apresentá-los ao seus usuários.

Criamos um artigo que explica como realizar essa requisição.

Com essa API é possível listar os convênios de acordo com os segmentos disponíveis, sendo eles:

Não definido (será retornado todos convênios disponíveis); 1: Prefeituras; 2: Saneamento; 3: Energia Elétrica e Gás; 4: Telecomunicações; 6: Carnês e Assemelhados ou Demais

[
  {
    "utilityId": 14717,
    "name": "PREFEITURA MUNICIPAL DE CURITIBA",
    "shortName": "PREF. CURITIBA IPTU",
    "utilityCode": "8161319",
    "subscriptionRoleIdentification": "SEM REGRA",
    "utilityInputs": [
      {
        "utilityInputId": 1053,
        "placeHolder": "Código Identificador",
        "minLength": 8,
        "maxLength": 20,
        "dataType": "string",
        "description": "Código Identificador"
      }
    ],
    "segment": {
      "id": 1,
      "name": "Prefeituras"
    }
  }
]