Consulta de Limites da Conta

O endpoint de consulta de limites permite consultar os limites configurados para uma conta, retornando a lista de limites aplicáveis e seus respectivos dados de consumo.

A cada requisição, o serviço consulta o consumo atualizado dos baldes de limite e retorna a lista combinada de limites da conta.

A consulta pode ser refinada por meio dos filtros opcionais category e limitType.

Endpoint: GET /accounts/{account}/limits

Passos para Integrar

Realizar autenticação na API - [API Reference]
Realiza a consulta de limites da conta - [API Reference]

Parâmetros da requisição

Parâmetro	Tipo	Descrição	Obrigatório
account	Rota	Identificador da conta cujos limites serão consultados.	Sim
limitType	query string	Filtra a lista de limites retornada pela categoria informada.	Não
category	query string	Filtra a lista de limites retornada pelo tipo de limite informado.	Não

Regras gerais:

A conta informada deve existir e ser válida para a consulta.
O serviço consulta o consumo dos baldes de limite no momento da requisição.
Os filtros category e limitType são opcionais e restringem os resultados retornados.
A consulta não altera os limites configurados nem realiza qualquer transição de estado.
Contas inexistentes ou inválidas retornam erro.
Contas existentes que não possuam nenhum balde de limite configurado (LimitsCount <= 0) também retornam erro.

cURL da Chamada

curl --request GET \
  --url 'https://sandbox.openfinance.celcoin.dev/baas/v2/accounts/30023646094074/limits' \
  --header 'Authorization: Bearer <access_token>' \
  --header 'Accept: application/json'

cURL da Chamada - Filtrando por category e/ou limitType

curl --request GET \
  --url 'https://sandbox.openfinance.celcoin.dev/baas/v2/accounts/30023646094074/limits?category=PIX&limitType=DAILY' \
  --header 'Authorization: Bearer <access_token>' \
  --header 'Accept: application/json'

Exemplo de retorno

👍
Sucesso 200

{
  "status": "SUCCESS",
  "version": "1.0.0",
  "body": {
    "account": "30023646094074",
    "limits": [
      {
        "limitType": "PixPJ",
        "name": "Pix - Pessoa Jurídica",
        "description": "Limite diário para transações Pix de pessoas jurídicas",
        "category": "pix",
        "period": {
          "type": "DAILY",
          "label": "Diário",
          "startTime": "2026-08-18T00:00:00Z",
          "endTime": "2026-08-19T00:00:00Z"
        },
        "value": 5000.00,
        "consumedValue": 1200.50,
        "remainingValue": 3799.50
      }
    ]
  }
}

Exemplo completo de uma conta que possui todos os limites cadastrados:

{
    "body": {
        "account": "41083163",
        "limits": [
            {
                "limitType": "PixPJ",
                "name": "Pix - Pessoa Jurídica",
                "description": "Limite diário para transações Pix de pessoas jurídicas",
                "category": "PIX",
                "period": {
                    "type": "DAILY",
                    "label": "Diário (00h às 23h59)",
                    "startTime": "00:00",
                    "endTime": "23:59"
                },
                "value": 100000,
                "consumedValue": 0,
                "remainingValue": 100000
            },
            {
                "limitType": "Billpayments",
                "name": "Pagamento de Boletos",
                "description": "Limite diário para pagamento de boletos",
                "category": "PAYMENTS",
                "period": {
                    "type": "DAILY",
                    "label": "Diário (00h às 23h59)",
                    "startTime": "00:00",
                    "endTime": "23:59"
                },
                "value": 100000,
                "consumedValue": 0,
                "remainingValue": 100000
            },
            {
                "limitType": "PixPFPJ",
                "name": "Pix - Pessoa Física para Pessoa Jurídica",
                "description": "Limite diário para transações Pix entre pessoas físicas e jurídicas",
                "category": "PIX",
                "period": {
                    "type": "DAILY",
                    "label": "Diário (00h às 23h59)",
                    "startTime": "00:00",
                    "endTime": "23:59"
                },
                "value": 100000,
                "consumedValue": 0,
                "remainingValue": 100000
            },
            {
                "limitType": "TedPJ",
                "name": "TED - Pessoa Jurídica",
                "description": "limite diário para transferências TED de pessoas jurídicas",
                "category": "TED",
                "period": {
                    "type": "DAILY",
                    "label": "Diário (00h às 23h59)",
                    "startTime": "00:00",
                    "endTime": "23:59"
                },
                "value": 100000,
                "consumedValue": 0,
                "remainingValue": 100000
            },
            {
                "limitType": "TedPF",
                "name": "TED - Pessoa Física",
                "description": "Limite diário para transferências TED de pessoas físicas",
                "category": "TED",
                "period": {
                    "type": "DAILY",
                    "label": "Diário (00h às 23h59)",
                    "startTime": "00:00",
                    "endTime": "23:59"
                },
                "value": 100000,
                "consumedValue": 0,
                "remainingValue": 100000
            },
            {
                "limitType": "PixPF",
                "name": "Pix - Pessoa Física",
                "description": "Limite para transações Pix de pessoas físicas com janelas diurna e noturna",
                "category": "PIX",
                "period": {
                    "type": "DIURNAL",
                    "label": "Diurno (06h às 20h)",
                    "startTime": "06:00",
                    "endTime": "19:59"
                },
                "value": 100000,
                "consumedValue": 0,
                "remainingValue": 100000
            },
            {
                "limitType": "Favorites",
                "name": "Favorecidos",
                "description": "Limite diário para transferências a favorecidos cadastrados",
                "category": "TRANSFER",
                "period": {
                    "type": "DAILY",
                    "label": "Diário (00h às 23h59)",
                    "startTime": "00:00",
                    "endTime": "23:59"
                },
                "value": 100000,
                "consumedValue": 0,
                "remainingValue": 100000
            }
        ]
    },
    "status": "SUCCESS",
    "version": "1.0.0"
}

Estrutura da resposta:

Campo	Descrição
`status`	Status do processamento da requisição. No exemplo, `SUCCESS` indica sucesso.
`version`	Versão do contrato da resposta.
`body`	Objeto que contém os dados retornados pela consulta.
`body.account`	Número da conta consultada.
`body.limits`	Lista de limites configurados para a conta, incluindo informações do período e do consumo.

Campos do objeto limit - Cada item do array limits representa um limite configurado para a conta:

Campo	Descrição
`limitType`	Identificador do tipo de limite como `PixPJ, PixPF, PixPFPJ, Billpayments, TedPJ, TedPF ou Favorites.`
`name`	Nome descritivo do limite. Ex. `Pix - Pessoa Jurídica`
`description`	Descrição da finalidade ou regra do limite.
`category`	Categoria à qual o limite pertence, como pix.
`period`	Objeto com as informações da janela de consumo do limite.
`value`	Valor total configurado para o limite no período.
`consumedValue`	Valor já consumido do limite no período consultado.
`remainingValue`	Valor restante disponível para utilização no período.

Campos do objeto period:

Campo	Descrição
type	Tipo de período do limite, como DAILY.
label	Descrição da janela de utilização do limite. Ex.: Diário (00h às 23h59) ou Diurno (6h às 20h)
startTime	Data e hora de início da janela de consumo (date-time)
endTime	Data e hora de término da janela de consumo (date-time)

Importante:
Os dados de consumo refletem o estado observado no instante da consulta. Como se trata de uma leitura pontual, alterações decorrentes de outras transações ou solicitações podem fazer com que uma consulta posterior apresente valores diferentes.

❗
Error 400

{
  "status": "ERROR",
  "version": "1.0.0",
  "error": {
    "errorCode": "CBE091",
    "message": "É necessário informar o campo: account."
  }
}

Tabela de errorCode

Code	Message
CBE091	É necessário informar o campo: account.
CBE078	Nenhuma conta foi encontrada.
CBE690	Não foram encontrados limites cadastrados para a conta informada.
CBE239	Não foi possivel recuperar os dados do cliente para busca do JWT.
CIE999	Ocorreu um erro interno durante a chamada da api.

Updated about 1 hour ago

Did this page help you?