Sign in

v1

latestOpenAPI 3.0.12026-07-245303882.5 MB

Listar convênios

Com essa API é possível listar todos os convênios de concessionárias e tributos que estão disponíveis para pagamento na base da Celcoin. Além de ser possível saber à quais localidades eles pertencem.

get/v5/transactions/institutions

Query parameters

Type'NACIONAL' | 'ESTADUAL'

Para quando você quiser filtrar a busca todos os convênios que têm abrangência nacional ou estadual.

UFstring[]

Para quando você quiser filtrar a busca com todos convênios que têm abrangência em estados específicos. Para filtrar use o UF. Por exemplo: se quiser saber todos os convênios de São Paulo, você deve filtrar pela UF "SP".

Response

200

OR

Example response

{
  "convenants": [
    {
      "timeLimit": "12:00",
      "mask": "99______________9999____________________________",
      "nomeconvenant": "EXEMPLO 1",
      "type": "ESTADUAL",
      "UF": [
        "SP"
      ]
    }
  ]
}