Documentação
Status PageSuporte
  1. cel_banking - BaaS & Core
  2. Open Finance as a Service
  3. Transferências Inteligentes - Sweeping Accounts

Sweeping Accounts - Consultas

Visão Geral

Os endpoints de consulta permitem listar e detalhar payment initiations de Sweeping Accounts. São úteis para acompanhar o status do consentimento, visualizar pagamentos realizados e auditar a jornada do usuário.

Listar Payment Initiations

GET /open-keys/itp/api/v2/sweeping-accounts/v2/payment-initiation

Retorna todas as payment initiations associadas a um CPF.

Autenticação: Bearer Token (application_token)

Request

GET /open-keys/itp/api/v2/sweeping-accounts/v2/payment-initiation?cpf=12345678909
Authorization: Bearer {{application_token}}

Query Parameters

ParâmetroTipoObrigatórioDescrição
cpfstring✅CPF do usuário (somente números, 11 dígitos)
statusstring❌Filtrar por status: PENDING, AUTHORISED, CONSUMED, REVOKED, EXPIRED
pageinteger❌Número da página (paginação)
pageSizeinteger❌Itens por página (padrão: 10)

Response

{
  "data": [
    {
      "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "status": "AUTHORISED",
      "brandId": "66f4d9e296f18bc4606e13ec",
      "brandName": "Banco Exemplo",
      "createdAt": "2026-02-12T10:00:00Z",
      "authorisedAt": "2026-02-12T10:05:00Z",
      "totalAllowedAmount": "10000.00",
      "totalUsedAmount": "0.01",
      "recurringConfiguration": {
        "sweeping": {
          "transactionLimit": "150.00",
          "startDateTime": "2026-02-12T00:00:00Z"
        }
      }
    }
  ],
  "meta": {
    "totalRecords": 1,
    "totalPages": 1,
    "currentPage": 1
  }
}
CampoTipoDescrição
data[].idstringID da payment initiation
data[].statusstringStatus atual do consentimento
data[].brandNamestringNome da instituição detentora
data[].totalAllowedAmountstringTeto total autorizado
data[].totalUsedAmountstringTotal já utilizado

Códigos de Retorno

HTTPDescrição
200 OKLista retornada com sucesso
400 Bad RequestCPF ausente ou inválido
401 UnauthorizedToken inválido ou expirado

Detalhar Payment Initiation

GET /open-keys/itp/api/v2/sweeping-accounts/v2/payment-initiation/:paymentInitiationId

Retorna os detalhes completos de uma payment initiation específica, incluindo dados do consentimento, histórico de pagamentos e informações da sessão.

Autenticação: Bearer Token (application_token)

Path Parameters

ParâmetroTipoObrigatórioDescrição
paymentInitiationIdstring✅ID da payment initiation

Request

GET {{base_url}}/open-keys/itp/api/v2/sweeping-accounts/v2/payment-initiation/{{payment_initiation_id}}
Authorization: Bearer {{application_token}}

Response

{
  "data": {
    "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "status": "AUTHORISED",
    "brandId": "66f4d9e296f18bc4606e13ec",
    "brandName": "Banco Exemplo",
    "createdAt": "2026-02-12T10:00:00Z",
    "authorisedAt": "2026-02-12T10:05:00Z",
    "consent": {
      "consentId": "urn:celcoin:a1b2c3d4-e5f6...",
      "status": "AUTHORISED",
      "expiresAt": "2028-02-12T00:00:00Z"
    },
    "recurringConfiguration": {
      "sweeping": {
        "totalAllowedAmount": "10000.00",
        "transactionLimit": "150.00",
        "periodicLimits": {
          "day": { "quantityLimit": 5, "transactionLimit": "25.00" },
          "week": { "quantityLimit": 5, "transactionLimit": "100.00" },
          "month": { "quantityLimit": 5, "transactionLimit": "300.00" },
          "year": { "quantityLimit": 5, "transactionLimit": "10000.00" }
        },
        "startDateTime": "2026-02-12T00:00:00Z"
      }
    },
    "creditors": [
      {
        "name": "João Silva",
        "cpfCnpj": "12345678909",
        "personType": "PESSOA_NATURAL"
      }
    ],
    "payments": [
      {
        "paymentId": "pmt-abc123def456",
        "endToEndId": "E13935893202602180000AbCdEfGhIjK",
        "amount": "0.01",
        "currency": "BRL",
        "status": "ACSC",
        "date": "2026-02-18",
        "createdAt": "2026-02-18T10:00:00Z"
      }
    ],
    "journeySession": {
      "authorisationFlow": "HYBRID_FLOW",
      "authorisedBy": "12345678909"
    }
  }
}
CampoTipoDescrição
data.consent.consentIdstringURN do consentimento na detentora
data.consent.expiresAtstringData de expiração do consentimento
data.payments[]arrayLista de pagamentos realizados dentro deste consentimento
data.payments[].statusstringStatus do pagamento. Ver Máquina de Estados
data.journeySessionobjectInformações sobre o fluxo de autorização utilizado

Códigos de Retorno

HTTPDescrição
200 OKDetalhes retornados com sucesso
401 UnauthorizedToken inválido ou expirado
404 Not FoundPayment initiation não encontrada

Pontos de Atenção

⚠️

Versão da API (v2): Os endpoints de consulta e cancelamento utilizam a rota /v2/. Chamadas à versão /v1/ retornam 404 Not Found. Certifique-se de utilizar sempre a versão correta.

⚠️

Filtro por CPF obrigatório na listagem: O endpoint de listagem exige o parâmetro cpf. Não é possível listar todas as payment initiations sem este filtro.

⚠️

totalUsedAmount: Este campo acumula o total de pagamentos com status de sucesso (ACSC). Utilize-o para calcular o saldo restante disponível dentro do consentimento (totalAllowedAmount - totalUsedAmount).


Updated about 1 month ago

Did this page help you?