Jornada Otimizada - Sweeping Accounts

Esta página mostra como criar um consentimento de Transferências Inteligentes - Sweeping Accounts com a Jornada Otimizada, para obter também o consentimento de saldo e limite da conta pagadora. O conceito, a consulta do saldo, a revogação e os casos de erro estão em Jornada Otimizada (Saldo e Limite).

📘

Antes de começar

Confira se a marca escolhida pelo usuário tem optimized-journey-sweeping em ApiFamilyType na listagem de marcas.


Criar o consentimento com a Jornada Otimizada

Use a mesma chamada de Sweeping Accounts - Criação de Payment Initiation, acrescentando "isOptimizedJourney": true no objeto raiz do corpo.

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

curl --location '{{base_url}}/baas/v1/open/itp/sweeping-accounts/payment-initiation' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {{application_token}}' \
--data '{
    "brandId": "{{brand_id}}",
    "redirectUrl": "https://seu-dominio.com/callback",
    "device": {
        "platform": "BROWSER",
        "osVersion": "1.00",
        "os": "OTHER"
    },
    "isOptimizedJourney": true,
    "data": {
        "startDateTime": "2026-12-01T14:00:00Z",
        "creditors": [
            {
                "name": "Marco Antonio de Brito",
                "cpfCnpj": "12345678909",
                "personType": "PESSOA_NATURAL"
            }
        ],
        "loggedUser": {
            "document": {
                "identification": "12345678909",
                "rel": "CPF"
            }
        },
        "recurringConfiguration": {
            "sweeping": {
                "startDateTime": "2026-12-01T14:00:00Z",
                "totalAllowedAmount": "1000.00"
            }
        }
    }
}'

Campos

CampoTipoObrigatórioDescrição
brandIdstringSimMarca da detentora, obtida na listagem de marcas
redirectUrlstringSimURL de retorno cadastrada para a aplicação
isOptimizedJourneybooleanNão (padrão false)Com true, cria também o consentimento de saldo e limite
deviceobjectNãoDados do dispositivo em que o usuário inicia a jornada
device.platformstringSim, se device for enviadoPlataforma de onde a jornada parte. Ex.: BROWSER para navegador web
device.osstringSim, se device for enviadoSistema operacional do dispositivo. Ex.: OTHER quando não identificado
device.osVersionstringSim, se device for enviadoVersão do sistema operacional. Ex.: "1.00"
data.loggedUser.documentobjectSimCPF do usuário logado (identification, rel)
data.creditors[]arraySimAo menos um recebedor, com cpfCnpj igual ao do usuário logado
data.recurringConfiguration.sweeping.startDateTimestringSimInício da vigência, em RFC-3339 e UTC, no futuro
data.recurringConfiguration.sweeping.totalAllowedAmountstringNãoTeto total do consentimento. Ex.: "1000.00"
data.recurringConfiguration.sweeping.transactionLimitstringNãoValor máximo por transação
data.recurringConfiguration.sweeping.periodicLimitsobjectNãoLimites por day, week, month e year. Em cada período informado, envie ao menos quantityLimit ou transactionLimit
data.recurringConfiguration.expirationDateTimestringNãoFim da vigência. O padrão é 1 ano
🚧

Transferência entre contas do mesmo titular

No Sweeping, creditors[].cpfCnpj precisa ser igual a loggedUser.document.identification.

Resposta

A resposta mantém o formato atual: id, ofConsentId, authorizationUrl e status (AWAITING_AUTHORISATION). Redirecione o usuário para a authorizationUrl.


Escopos enviados à detentora

A Celcoin monta o PAR com os escopos dos dois consentimentos:

openid consent:{consentId} consents resources accounts recurring-consent:{recurringConsentId} recurring-payments

Consulta, callback e consentimento de dados

Em Sweeping Accounts - Consultas e no callback, a resposta traz:

  • ofConsent.journey, com isLinked: true e linkId igual ao URN do consentimento de dados;
  • o objeto ofDataConsent, com o URN, o status e a validade do consentimento de saldo e limite. Os campos estão descritos na página da Jornada Otimizada.

Antes de cada Execução de Pagamento Pix, consulte o saldo com o consentimento de dados.


Regras específicas do Sweeping

  • Aprovação conjunta. O consentimento recorrente e o compartilhamento são aprovados ou rejeitados juntos na detentora.
  • Consumo. Quando o consentimento recorrente chega a CONSUMED (por exemplo, ao atingir o totalAllowedAmount), o consentimento de dados é revogado automaticamente.
  • Revogação. O cancelamento do consentimento de Sweeping revoga também o consentimento de dados. Revogar só o compartilhamento (DELETE /baas/v1/open/dat/consents/{consent_id}) mantém o Sweeping ativo.
  • Validade. As normas vigentes não permitem alterar o prazo do consentimento de Sweeping.
  • Webhooks. Cada consentimento tem o próprio webhook. Veja Sweeping Accounts - Webhooks.

Requisitos de experiência (Transferências Inteligentes)

EtapaRequisitoO que a tela precisa ter
SolicitaçãoREQ.PG-02501Opção de compartilhar saldo e limite, opcional
SolicitaçãoREQ.PG-02502Opção desmarcada por padrão
SolicitaçãoREQ.PG-02503Usuário avança sem ser obrigado a aceitar
SolicitaçãoREQ.PG-02504Aviso de que saldo e limite serão compartilhados
SolicitaçãoREQ.PG-02505Escopo dos dados compartilhados visível
SolicitaçãoREQ.PG-02506Nada que desvie o foco (links, botões, imagens)
Confirmação (detentora)REQ.PG-05802, REQ.PG-05803Aviso de compartilhamento e escopo dos dados
EfetivaçãoREQ.PG-07804Informar que saldo e limite estão sendo compartilhados
EfetivaçãoREQ.PG-07805Informar que o compartilhamento pode ser cancelado na área de gestão
ErroREQ.PG-10704Autorização criada, mas o compartilhamento falhou
ErroREQ.PG-11003Falha ao cancelar o compartilhamento

Fonte: Guia de Experiência do Usuário v.26.00.00 do Open Finance Brasil.


Did this page help you?