Consulta de Solicitação de Alteração de Limite

O endpoint de Consulta de Solicitação de Alteração de Limite permite consultar o status e os dados de uma solicitação de alteração de limite previamente criada, seja de aumento ou de redução.

A consulta é realizada de forma síncrona, retornando as informações da solicitação, incluindo o tipo de operação, o valor anterior, o valor solicitado, a data de efetivação prevista e o status atual do processamento.

Endpoint: GET /accounts/{account}/limits/requests.

Passos para Integrar

1. Realizar autenticação na API - [API Reference]
2. Realizar consulta de solicitação de alteração de limite - [API Reference]

Parâmetros da requisição

Regras de negócio

• A consulta deve ser realizada para uma conta informada no parâmetro de rota account.
• É obrigatório informar clientRequestId ou limitId na query string.
• Quando ambos os identificadores forem enviados, a consulta utilizará limitId.
• A consulta retorna os dados da solicitação de alteração de limite previamente criada.
• O status armazenado no documento da solicitação é retornado no campo status raiz da resposta.

cURL da Chamada - para consultar uma solicitação pelo limitId:

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

cURL da Chamada - para consultar uma solicitação pelo limitId:

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

Exemplo de retorno

{
  "status": "SCHEDULED",
  "version": "1.0.0",
  "body": {
    "limitId": "LMR-20260804-98765",
    "account": "30023646094074",
    "limitType": "PixPJ",
    "clientRequestId": "REQ-12345",
    "name": "Pix - Pessoa Jurídica",
    "period": { "type": "DAILY", "label": "Diário" },
    "operationType": "DECREASE",
    "previousValue": 10000.0,
    "requestedValue": 3000.0,
    "effectiveDate": "2026-08-05T15:30:00Z",
    "reason": ""
  }
}

Status da solicitação

O campo status da resposta representa o estado atual da solicitação de alteração de limite.

Dados retornados

A resposta apresenta o status atual da solicitação e os dados associados à alteração de limite, incluindo:

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

Tabela de errorCode