---
title: "initiate a new operation"
method: POST
path: "/baas/v1/open/itp/sweeping-accounts/payment-initiation"
---

# initiate a new operation

`POST /baas/v1/open/itp/sweeping-accounts/payment-initiation`

Initiate a sweeping account transaction.

## Request body

- object
  - `brandId` string, required — Identificador único da brand. Exemplo: "6894f1db86d49fedbec6cd13"
  - `redirectUrl` string, required — URL de redirecionamento autorizada pela aplicação. Exemplo: `"http://localhost:8080/callback"`
  - `data` object, required — Objeto contendo os dados do consentimento
    - `loggedUser` object — Usuário (pessoa natural) que encontra-se logado na instituição Iniciadora de Pagamento.
      - `document` object, required — Documento de identificação do usuário logado
        - `identification` string, required — Número do documento de identificação oficial do usuário.
        - `rel` string, required — Tipo do documento de identificação oficial do usuário. Ex.: "CPF"
    - `creditors` object[], required — Lista de recebedores (creditors) para as transferências inteligentes
      - `name` string, required — Nome completo (pessoa natural) ou razão social/fantasia (pessoa jurídica). Exemplo: "João Silva"
      - `cpfCnpj` string, required — CPF (11 dígitos) ou CNPJ (14 dígitos) sem formatação. Exemplo: "12345678909" ou "12345678000190"
      - `personType` 'PESSOA_NATURAL' | 'PESSOA_JURIDICA', required — Tipo de pessoa. Exemplo: "PESSOA_NATURAL"
    - `recurringConfiguration` object, required — Configuração de recorrência para transferências inteligentes
      - `sweeping` object, required — Configuração específica de sweeping accounts
        - `totalAllowedAmount` string — Valor máximo total permitido para todas as transações (formato: "XXXXX.XX"). Exemplo: "10000.00"
        - `transactionLimit` string — Valor máximo por transação (formato: "XXXXX.XX"). Exemplo: "150.00"
        - `periodicLimit` object, required — Limites periódicos . **Ao menos um período deve ser configurado**
          - `day` object — Restrição: Ao menos um dos campos (quantityLimit ou transactionLimit) deve ser preenchido quando o objeto day for informado.
            - `quantityLimit` string — Quantidade máxima de transações permitidas durante um dia. Exemplo: 5
            - `transactionLimit` string — Valor máximo a ser transacionado diariamente (formato: "XXXXX.XX"). Exemplo: "300.00"
          - `week` object — Restrição: Ao menos um dos campos (quantityLimit ou transactionLimit) deve ser preenchido quando o objeto week for informado.
            - `quantityLimit` string — Quantidade máxima de transações permitidas durante uma semana. Exemplo: 5
            - `transactionLimit` string — Valor máximo a ser transacionado semanalmente (formato: "XXXXX.XX"). Exemplo: "100.00"
          - `month` object — Restrição: Ao menos um dos campos (quantityLimit ou transactionLimit) deve ser preenchido quando o objeto month for informado.
            - `quantityLimit` string — Quantidade máxima de transações permitidas durante um mês. Exemplo: 5
            - `transactionLimit` string — Valor máximo a ser transacionado mensalmente (formato: "XXXXX.XX"). Exemplo: "300.00"
          - `year` object — Restrição: Ao menos um dos campos (quantityLimit ou transactionLimit) deve ser preenchido quando o objeto year for informado.
            - `quantityLimit` string — Quantidade máxima de transações permitidas durante um ano. Exemplo: 5
            - `transactionLimit` string — Valor máximo a ser transacionado por um ano (formato: "XXXXX.XX"). Exemplo: "10000.00"
        - `startDateTime` string, required — Data e hora de início do consentimento (RFC-3339 UTC). Exemplo: `"2025-11-19T16:00:00Z"`
    - `businessEntity` object — Usuário (pessoa jurídica) que encontra-se logado na instituição Iniciadora de Pagamento. [Restrição] Preenchimento obrigatório se usuário logado na instituição Iniciadora de Pagamento for um CNPJ (pessoa jurídica).
      - `document` object, required
        - `identification` string — Número do documento de identificação oficial do titular pessoa jurídica.
        - `rel` string — Tipo do documento de identificação oficial do titular pessoa jurídica.
    - `expirationDateTime` string — Data e hora em que o consentimento deve deixar de ser válido. Uma string com data e hora conforme especificação RFC-3339, sempre com a utilização de timezone UTC (UTC time format).

## Response `200`

- object
  - `brandId` string, required — Identificador único da brand (ecoado da requisição). Exemplo: `"6894f1db86d49fedbec6cd13"`
  - `redirectUrl` string — URL de redirecionamento autorizada pela aplicação (ecoada da requisição). Exemplo: `"http://localhost:8080/callback"`
  - `data` object — Objeto contendo os dados do consentimento (ecoado da requisição)
  - `journeySessionId` string — Identificador único da sessão de jornada criada. Exemplo: `"69283c458c0c9010a509fc9f"`
  - `applicationId` string — Identificador único da aplicação. Exemplo: `"68a482d2b3ee755e8bbdec8a"`
  - `paymentInitiationApi` string — Tipo da API de payment initiation utilizada. Valor fixo: `"SWEEPING_ACCOUNTS_V1"`
  - `tokenId` string — Identificador único do token opaco criado para a sessão. Exemplo: `"69283c4528f44e10a5b1310a"`
  - `createdAt` string — Data e hora de criação do registro no formato ISO 8601. Exemplo: `"2025-11-27T11:55:49.308Z"`
  - `updatedAt` string — Data e hora da última atualização do registro no formato ISO 8601. Exemplo: `"2025-11-27T11:55:55.217Z"`
  - `authorizationUrl` string — URL para redirecionamento do usuário à detentora de conta para autorização do consentimento. Exemplo: `"https://apicorp.celcoin.com.br/orgs/bricks/auth?client_id=..."`
  - `ofConsentId` string — Identificador único do consentimento criado na detentora de conta (Open Finance). Exemplo: `"69283c4a8c0c9010a509fca3"`
  - `id` string — Identificador único do payment initiation gerado pelo sistema. Exemplo: `"69283c458c0c9010a509fca0"`

---

[API](https://skmtc.net/celcoin/apis/api-para-transa-es.md) · [All operations](https://skmtc.net/celcoin/apis/api-para-transa-es/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/celcoin/api-para-transa-es/revisions/85dd6188a37b/schema)