Autorização - Jornada 1
Envio de notificação para o cliente pagador aderir ao Pix Automático
Caso de uso: A Jornada 1 foi pensada para casos de uso fora do ambiente Pix, como um envio de solicitação de adesão ao cliente pelo WhatsApp, por exemplo.
Caso o cliente em fluxo de WhatsAPP demonstre interesse em aderir a Jornada de Pix Automático, será enviado para ele através da Jornada 1 de Autorização, uma notificação diretamente no seu aplicativo bancário para adesão ao Pix Automático.
Este envio de notificação por parte do cliente recebedor diretamente ao banco do cliente pagador é a jornada 1 de autorização.
Neste fluxo, não há leitura de Qr Code Pix por parte do cliente pagador.
A empresa recebedora enviará os dados para o cliente pagador a partir das suas informações de CPF, Banco, Agência e Conta.
Neste fluxo, é possível que a oferta de Pix Automático seja por valor fixo (igual em todas as cobranças futuras por Pix Automático) ou por valor variável. Importante que no caso de cobranças com valor variável, o cliente pagador sempre irá definir um valor máximo (teto) para que os agendamentos sejam realizados.
Se no momento do consentimento de uma conta de luz o usuário pagador determine, por exemplo, que o valor máximo que ele deseja pagar através de Pix Automático é de R$ 200,00, em qualquer mês que a empresa recebedora tentar enviar uma ordem de valor máximo acima de R$ 200,00, essa cobrança de Pix Automático será rejeitada pelo banco do cliente pagador, que deverá pagar sua fatura de outra forma, manualmente.
Nos casos onde o valor enviado de uma cobrança é superior ao valor máximo definido pelo cliente, somente o agendamento daquela cobrança específica não ocorrerá, porém o consentimento de Pix Automático continuará ativo para todas as cobranças futuras, até que o cliente pagador cancele o consentimento em si.
Para adesões de Pix Automático através da Jornada 1, não existe fluxo de pagamento realizado na hora, somente a adesão para cobranças futuras.
Passos para Integrar
- Cliente final solicita a criação de uma recorrência.
- Realizar autenticação na API - [API Reference]
- Solicita a criação de recorrência da Jornada 1 - [Reference]
- Encaminha webhook com a confirmação do recebimento da solicitação.
- Encaminha webhook com a resposta da solicitação (Confirmação ou Negação)
Fluxo de integração - Jornada 1 - Autorização da Recorrência
Solicita a criação da recorrência da jornada 1
JSON de Exemplo
{
"recurrencyId": "RRxxxxxxxxyyyyMMddkkkkkkkkkkk",
"recurrency": { //Os campos recurrencyId e recurrency são mutuamente excludentes
"interval": {
"start": "2025-07-01T09:00:00Z",
"end": "2026-07-01T09:00:00Z",
"frequencyType": 1
},
"amount": 100.75,
"creditParty": {
"bank": "0000000",
"taxId": "12345678000190",
"name": "Empresa de Exemplo Ltda."
},
"debitParty": {
"personType": "LEGAL_PERSON",
"taxId": "98765432000121",
"bank": "0000000",
"account": "123456"
},
"debtor": {
"personType": "NATURAL_PERSON",
"taxId": "11122233344",
"name": "João da Silva"
},
"contract": {
"number": "CONTRATO-2025/001",
"description": "Serviços de consultoria anual"
},
"allowsNewAttemptsAfterExpiration": true,
"maxValueFloor": 200.00,
"allowAutoSendingPaymentInstructions": false
}
}
cURL da chamada
curl --location 'https://sandbox.openfinance.celcoin.dev/baas/v2/recurrencies/journey1' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {{Token}}' \
--data '{
"recurrencyId": "RRxxxxxxxxyyyyMMddkkkkkkkkkkk",
"recurrency": { //Os campos recurrencyId e recurrency são mutuamente excludentes
"interval": {
"start": "2025-07-01T09:00:00Z",
"end": "2026-07-01T09:00:00Z",
"frequencyType": 1
},
"amount": 100.75,
"creditParty": {
"bank": "0000000",
"taxId": "12345678000190",
"name": "Empresa de Exemplo Ltda."
},
"debitParty": {
"personType": "LEGAL_PERSON",
"taxId": "98765432000121",
"bank": "0000000",
"account": "123456"
},
"debtor": {
"personType": "NATURAL_PERSON",
"taxId": "11122233344",
"name": "João da Silva"
},
"contract": {
"number": "CONTRATO-2025/001",
"description": "Serviços de consultoria anual"
},
"allowsNewAttemptsAfterExpiration": true,
"maxValueFloor": 200.00,
"allowAutoSendingPaymentInstructions": false
}
}'
Exemplo de retorno
Sucesso 200
{
"recurrencyId": "RR1234567820250606093015000",
"interval": {
"start": "2025-07-01T10:00:00Z",
"end": "2026-06-30T10:00:00Z",
"frequencyType": 2
},
"status": 3,
"journeys": [
{
"status": 1,
"type": 10,
"createDate": "2025-06-05T14:30:00Z"
}
],
"amount": 250.50,
"creditParty": {
"bank": "12345678",
"taxId": "00000000000100",
"name": "Recebedor Fictício Ltda."
},
"debitParty": {
"ispb": "12345678",
"personType": "NATURAL_PERSON",
"taxId": "99988877766",
"bank": "12345678",
"account": "78902"
},
"debtor": {
"personType": "LEGAL_PERSON",
"taxId": "11223344000155",
"name": "Empresa Paga Tudo S.A."
},
"contract": {
"number": "CONTRATO-ABCD-2025",
"description": "Contrato de licenciamento de software"
},
"allowsNewAttemptsAfterExpiration": false,
"maxValueFloor": 500.00,
"createDate": "2025-06-06T09:07:33Z",
"allowAutoSendingPaymentInstructions": true
}
Error 400
{
"version": "1.0.0",
"status": "ERROR",
"error": {
"errorCode": "",
"message": ""
}
}
Exemplo de webhook disparado quando o pagador recebe a solicitação de recorrência.
Evento: pix-automatic-recurrency-awaiting-debtor
{
"entity": "pix-automatic-recurrency-awaiting-debtor",
"context": "PIX",
"cliente": {
"nome": "Cliente Fictício Ltda.",
"clienteId": 12345,
"localId": 678,
"usuarioId": 91011
},
"body": {
"recurrencyId": "RR9876543220250606180000123",
"interval": {
"start": "2025-08-01T08:00:00Z",
"end": "2026-07-31T08:00:00Z",
"frequencyType": 3
},
"status": 1,
"journeys": [
{
"status": 0,
"type": 5,
"createDate": "2025-06-06T17:00:00Z"
}
],
"amount": 500.25,
"creditParty": {
"bank": "Banco Teste S.A.",
"taxId": "33445566000177",
"name": "Credor Modelo S.A."
},
"debitParty": {
"ispb": "98765432",
"personType": "LEGAL_PERSON",
"taxId": "22334455000188",
"bank": "Banco Prova Ltda.",
"account": "54321-0",
"stateCode": "SP"
},
"debtor": {
"personType": "NATURAL_PERSON",
"taxId": "77766655544",
"name": "Maria Testadora"
},
"contract": {
"number": "CONTRATO-PJ-XPTO-2025",
"description": "Contrato de prestação de serviços mensais"
},
"allowsNewAttemptsAfterExpiration": true,
"maxValueFloor": 1000.00,
"createDate": "2025-06-06T17:55:00Z",
"allowAutoSendingPaymentInstructions": false
}
}
Webhook de completed (disparado quando pagador aceita ou recusa a recorrência)
Evento: pix-automatic-recurrency-completed
{
"entity": "pix-automatic-recurrency-completed",
"context": "PIX",
"cliente": {
"nome": "Cliente VIP Ltda.",
"clienteId": 9876,
"localId": 543,
"usuarioId": 2109
},
"body": {
"recurrencyId": "RR9988776620250606211530000",
"deniedReason": null,
"interval": {
"start": "2024-01-01T00:00:00Z",
"end": "2024-12-31T23:59:59Z",
"frequencyType": 1
},
"status": 4,
"journeys": [
{
"status": 4,
"type": 30,
"createDate": "2024-12-31T17:00:00Z"
}
],
"amount": 75.00,
"creditParty": {
"bank": "10203040",
"taxId": "11223344000100",
"name": "Loja Conveniente Ltda."
},
"debitParty": {
"ispb": "10203040",
"personType": "NATURAL_PERSON",
"taxId": "00011122233",
"bank": "10203040",
"account": "98765-4",
"stateCode": "RJ"
},
"debtor": {
"personType": "NATURAL_PERSON",
"taxId": "44455566677",
"name": "Carlos Nogueira"
},
"contract": {
"number": "CONTRATO-FIN-2024-001",
"description": "Pagamento mensal de assinatura"
},
"allowsNewAttemptsAfterExpiration": false,
"maxValueFloor": 150.00,
"createDate": "2024-01-01T07:55:00Z",
"updateDate": "2024-12-31T17:05:00Z",
"allowAutoSendingPaymentInstructions": true
}
}
Nenhum fluxo de Pix Automático garante ao Recebedor a certeza de recebimento. Em todos os cenários, mesmo que após a adesão, é permitido que o cliente pagador cancele seu consentimento do Pix Automático, que cancele um agendamento ou que o pagamento não seja realizado na data por falta de saldo em conta.
Esta documentação ainda está sujeita a atualizações. Quando tivermos a versão final publicada, este aviso será removido de todas as páginas.
Updated about 7 hours ago