Autorização - Jornada 3
Envio de Qr Code para o cliente pagador com pagamento imediato e adesão obrigatória.
Caso de uso: A Jornada 3 foi pensada para casos de uso onde tanto o fluxo de pagamento, quanto a adesão ao Pix Automático para as jornadas futuras, é obrigatório. Um exemplo de uso da Jornada 3 poderia ser um plano de assinatura de serviço de streaming, onde o cliente precisa fazer um primeiro pagamento a vista e obrigatoriamente aderir ao Pix Automático para as próximas cobranças.
Neste fluxo, o cliente recebedor envia um Qr Code Pix Automático para que o cliente pagador realize o pagamento e a adesão ao Pix Automático.
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 3, não existe a opção de não aderir ao Pix Automático. Caso o cliente pagador tente realizar o pagamento e não aderir ao Pix Automático, nem o pagamento imediato será concluído com sucesso.
A Jornada 3 consiste por meio da criação de um QR Code composto com uma location do tipo COBR.
Esse QR Code possui tanto os dados da cobrança imediata quanto da recorrência. Existem duas formas de criar esse location::
- Cenário 1: Criando o location em separado e depois associando esse location a um QR Code.
- Cenário 2 :Criar o QR Code e o location simultaneamente.
O aceite é vinculado necessariamente ao pagamento da cobrança imediata. Quando o processo completa disparamos o webhook de completed para o recebedor.
Cenário 1: Criando o location separado e depois associando esse location a um QR Code.
Passos para Integrar
- Autenticar na API: Obtenha o token de autenticação. - [API Reference]
- Criar o Location: Registre o novo location - [Reference]
- Criar e Vincular location a um QR Code do tipo Immediate - [API Reference]
- Quando o pagamento for efetuado você receberá 2 webhooks
- Webhook de Cash in (evento: )
- Webhook de Confirmação de recorrência (evento: )
Fluxo de integração - Jornada 3 - Autorização da Recorrência - Cenário 1
Solicita a criação do location
JSON de Exemplo
{
"clientRequestId": "a016bc8bd89a4f62be995fa0ebb91d77",
"type": "COBR",
"merchant": {
"postalCode": "01201005",
"city": "Barueri",
"merchantCategoryCode": 0,
"name": "Celcoin"
}
}
cURL da chamada
curl --location --request POST 'https://sandbox.openfinance.celcoin.dev/pix/v1/location' \
--header 'accept: application/json' \
--header 'Content-Type: application/json-patch+json' \
--header 'Authorization: Bearer {access_token}' \
--data-raw '{
"clientRequestId": "a016bc8bd89a4f62be995fa0ebb91d77",
"type": "COBR",
"merchant": {
"postalCode": "01201005",
"city": "Barueri",
"merchantCategoryCode": 0,
"name": "Celcoin"
}
}'
Exemplo de retorno
Sucesso 200
{
"locationId": 12345,
"status": "ACTIVE",
"clientRequestId": "dc8de35155df4cf6a86c6cf960b797cb",
"url": "qrcode-h.teste.com.brv1/location/cob/dc8de35155df4cf6a86c6cf960b797cb",
"emv": "00020101021226930014br.gov.bcb.pix2571qrcode- h.teste.com.brv1/location/cob/dc8de35155df4cf6a86c6cf960b797cb5204000053039865802BR5907Celcoin6007Barueri623605322b39d30a0dc84ed9bb9d0d79261af1076404D1B6",
"type": "COBR",
"merchant": {
"postalCode": "01201005",
"city": "Barueri",
"merchantCategoryCode": 0,
"name": "Celcoin"
},
"recurrencyUrl": "qrcode-h.teste.com.brv1/location/cob/dc8de35155df4cf6a86c6cf960b797cb"
}
Error 400
{
"version": "1.0.0",
"status": "ERROR",
"error": {
"errorCode": "",
"message": ""
}
}
Associar o location tipo COBR a um novo QR Code
JSON de Exemplo
{
"clientRequestId": "9b26edb7cf254db09f5449c94bf13abc",
"payerQuestion": "Não pagável após vencimento.",
"key": "ab7e4702-fb05-4809-94c9-a7bfbe9aece3",
"locationId": 775645,
"debtor": {
"name": "Fulano de Tal",
"cpf": "11122233366",
"cnpj": "1112223300100"
},
"amount": {
"original": 0,
"changeType": 0,
"withdrawal": {
"vldnAmount": 10,
"agentMode": "AGTEC",
"withdrawalServiceProvider": "13935893",
"changeType": 0
},
"change": {
"vldnAmount": 10,
"vlcpAmount": 15.55,
"agentMode": "AGTEC",
"withdrawalServiceProvider": "13935893",
"changeType": 0
}
},
"calendar": {
"expiration": 86400
},
"additionalInformation": [
{
"value": "Assinatura de serviço",
"key": "Produto 1"
}
],
"recurrency: {
// Se recurrencyId for informado, os demais não podem estar presentes
"recurrencyId": "id da recorrência, seguindo o formato: RRxxxxxxxxyyyyMMddkkkkkkkkkkk",
"interval": {
"start": "datetime",
"end": "datetime",
"frequencyType": "integer (enum FrequencyType)"
},
"amount": "decimal | null",
"creditParty": {
"bank": "string",
"taxId": "string",
"name": "string"
},
"debitParty": {
"ispb": string,
"personType": string,
"taxId": string,
"bank": string | null,
"account": string,
"stateCode": string
},
"debtor": {
"personType": string,
"taxId": string,
"name": string
},
"contract": {
"number": "string",
"description": "string | null"
},
"allowsNewAttemptsAfterExpiration": boolean
"maxValueFloor": decimal | null,
"allowAutoSendingPaymentInstructions": bool
}
}
cURL da chamada
curl --location --request POST 'https://sandbox.openfinance.celcoin.dev/pix/v1/collection/immediate' \
--header 'accept: application/json' \
--header 'Content-Type: application/json-patch+json' \
--header 'Authorization: Bearer {access_token}' \
--data-raw '{
"clientRequestId": "9b26edb7cf254db09f5449c94bf13abc",
"payerQuestion": "Não pagável após vencimento.",
"key": "ab7e4702-fb05-4809-94c9-a7bfbe9aece3",
"locationId": 775645,
"debtor": {
"name": "Fulano de Tal",
"cpf": "11122233366",
"cnpj": "1112223300100"
},
"amount": {
"original": 0,
"changeType": 0,
"withdrawal": {
"vldnAmount": 10,
"agentMode": "AGTEC",
"withdrawalServiceProvider": "13935893",
"changeType": 0
},
"change": {
"vldnAmount": 10,
"vlcpAmount": 15.55,
"agentMode": "AGTEC",
"withdrawalServiceProvider": "13935893",
"changeType": 0
}
},
"calendar": {
"expiration": 86400
},
"additionalInformation": [
{
"value": "Assinatura de serviço",
"key": "Produto 1"
}
],
"recurrency: {
// Se recurrencyId for informado, os demais não podem estar presentes
"recurrencyId": "id da recorrência, seguindo o formato: RRxxxxxxxxyyyyMMddkkkkkkkkkkk",
"interval": {
"start": "datetime",
"end": "datetime",
"frequencyType": "integer (enum FrequencyType)"
},
"amount": "decimal | null",
"creditParty": {
"bank": "string",
"taxId": "string",
"name": "string"
},
"debitParty": {
"ispb": string,
"personType": string,
"taxId": string,
"bank": string | null,
"account": string,
"stateCode": string
},
"debtor": {
"personType": string,
"taxId": string,
"name": string
},
"contract": {
"number": "string",
"description": "string | null"
},
"allowsNewAttemptsAfterExpiration": boolean
"maxValueFloor": decimal | null,
"allowAutoSendingPaymentInstructions": bool
}
}'
Exemplo de retorno
Sucesso 200
{
"revision": 9267254,
"transactionId": 9267254,
"clientRequestId": "9b26edb7cf254db09f5449c94bf13abc",
"status": "ACTIVE",
"lastUpdate": "2021-04-29",
"payerQuestion": "Esta cobrança é referente a...",
"additionalInformation": [
{
"value": "Assinatura de serviço",
"key": "Produto 1"
}],
"debtor": {
"name": "Fulano de Tal",
"cpf": "11122233366",
"cnpj": "1112223300100"},
"amount": {
"original": 0,
"changeType": 0,
"withdrawal": {
"vldnAmount": 10,
"agentMode": "AGTEC",
"withdrawalServiceProvider": "13935893",
"changeType": 0
},
"change": {
"vldnAmount": 10,
"vlcpAmount": 15.55,
"agentMode": "AGTEC",
"withdrawalServiceProvider": "13935893",
"changeType": 0 }
},
"location": {
"merchant": {
"postalCode": "01201005",
"city": "Barueri",
"merchantCategoryCode": 0,
"name": "Celcoin Pagamentos"
},
"url": "string",
"emv": "string",
"type": "string",
"locationId": "string",
"recurrencyUrl": "qrcode-h.teste.com.brv1/location/cob/dc8de35155df4cf6a86c6cf960b797cb"
"id": "string" },
"key": "5d000ece-b3f0-47b3-8bdd-c183e8875862",
"calendar": {
"expiration": 86400 },
"createAt": "2021-04-29",
"transactionIdentification": "kk6g232xel65a0daee4dd13kk479195205",
"recurrency": {
"recurrencyId": "id da recorrência, seguindo o formato: RRxxxxxxxxyyyyMMddkkkkkkkkkkk",
"interval": {
"start": "datetime",
"end": "datetime",
"frequencyType": "integer (enum FrequencyType)"},
"status": integer (enum RecurrencyStatus),
"journeys": [
{
"status": integer (enum JourneyStatus),
"type": integer (enum Journey),
"createDate": datetime,
}],
"amount": "decimal | null",
"creditParty": {
"bank": "string",
"taxId": "string",
"name": "string"
},
"debitParty": {
"ispb": string,
"personType": string,
"taxId": string,
"bank": string | null,
"account": string,
"stateCode": string
},
"debtor": {
"personType": string,
"taxId": string,
"name": string },
"contract": {
"number": "string",
"description": "string | null"},
"allowsNewAttemptsAfterExpiration": boolean
"maxValueFloor": decimal | null,
"createDate": datetime,
"allowAutoSendingPaymentInstructions": bool
}
}
Error 400
{
"version": "1.0.0",
"status": "ERROR",
"error": {
"errorCode": "",
"message": ""
}
}
Cenário 2 - Criar o QR Code e o location simultaneamente.
Passos para Integrar
- Autenticar na API: Obtenha o token de autenticação. - [API Reference]
- Realiza a criação de um Location + QR Code Simultaneamente - [API Reference]
- Quando o pagamento for efetuado você receberá 2 webhooks
-
- Webhook de Cash in (evento: )
- Webhook de Confirmação de recorrência (evento: )
-
Fluxo de integração - Jornada 3 - Autorização da Recorrência - Cenário 2
Solicita a criação do location + Qr Code
JSON de Exemplo
{
"location": {
"clientRequestId": "a016bc8bd89a4f62be995fa0ebb91d77",
"type": "COBR",
"merchant": {
"postalCode": "01201005",
"city": "Barueri",
"merchantCategoryCode": 0,
"name": "Celcoin"
}
},
"clientRequestId": "9b26edb7cf254db09f5449c94bf13abc",
"payerQuestion": "Não pagável após vencimento.",
"key": "ab7e4702-fb05-4809-94c9-a7bfbe9aece3",
"debtor": {
"name": "Fulano de Tal",
"cpf": "11122233366",
"cnpj": "1112223300100"
},
"amount": {
"original": 0,
"changeType": 0,
"withdrawal": {
"vldnAmount": 10,
"agentMode": "AGTEC",
"withdrawalServiceProvider": "13935893",
"changeType": 0
},
"change": {
"vldnAmount": 10,
"vlcpAmount": 15.55,
"agentMode": "AGTEC",
"withdrawalServiceProvider": "13935893",
"changeType": 0
}
},
"calendar": {
"expiration": 86400
},
"additionalInformation": [
{
"value": "Assinatura de serviço",
"key": "Produto 1"
}
],
"recurrency: {
// Se recurrencyId for informado, os demais não podem estar presentes
"recurrencyId": "id da recorrência, seguindo o formato: RRxxxxxxxxyyyyMMddkkkkkkkkkkk",
"interval": {
"start": "datetime",
"end": "datetime",
"frequencyType": "integer (enum FrequencyType)"
},
"amount": "decimal | null",
"creditParty": {
"bank": "string",
"taxId": "string",
"name": "string"
},
"debitParty": {
"ispb": string,
"personType": string,
"taxId": string,
"bank": string | null,
"account": string,
"stateCode": string
},
"debtor": {
"personType": string,
"taxId": string,
"name": string
},
"contract": {
"number": "string",
"description": "string | null"
},
"allowsNewAttemptsAfterExpiration": boolean
"maxValueFloor": decimal | null,
"allowAutoSendingPaymentInstructions": bool
}
}
cURL da chamada
curl --location --request POST 'https://sandbox.openfinance.celcoin.dev/pix/v1/collection/immediate' \
--header 'accept: application/json' \
--header 'Content-Type: application/json-patch+json' \
--header 'Authorization: Bearer {access_token}' \
--data-raw '{
"location": {
"clientRequestId": "a016bc8bd89a4f62be995fa0ebb91d77",
"type": "COBR",
"merchant": {
"postalCode": "01201005",
"city": "Barueri",
"merchantCategoryCode": 0,
"name": "Celcoin"
}
},
"clientRequestId": "9b26edb7cf254db09f5449c94bf13abc",
"payerQuestion": "Não pagável após vencimento.",
"key": "ab7e4702-fb05-4809-94c9-a7bfbe9aece3",
"debtor": {
"name": "Fulano de Tal",
"cpf": "11122233366",
"cnpj": "1112223300100"
},
"amount": {
"original": 0,
"changeType": 0,
"withdrawal": {
"vldnAmount": 10,
"agentMode": "AGTEC",
"withdrawalServiceProvider": "13935893",
"changeType": 0
},
"change": {
"vldnAmount": 10,
"vlcpAmount": 15.55,
"agentMode": "AGTEC",
"withdrawalServiceProvider": "13935893",
"changeType": 0
}
},
"calendar": {
"expiration": 86400
},
"additionalInformation": [
{
"value": "Assinatura de serviço",
"key": "Produto 1"
}
],
"recurrency: {
// Se recurrencyId for informado, os demais não podem estar presentes
"recurrencyId": "id da recorrência, seguindo o formato: RRxxxxxxxxyyyyMMddkkkkkkkkkkk",
"interval": {
"start": "datetime",
"end": "datetime",
"frequencyType": "integer (enum FrequencyType)"
},
"amount": "decimal | null",
"creditParty": {
"bank": "string",
"taxId": "string",
"name": "string"
},
"debitParty": {
"ispb": string,
"personType": string,
"taxId": string,
"bank": string | null,
"account": string,
"stateCode": string
},
"debtor": {
"personType": string,
"taxId": string,
"name": string
},
"contract": {
"number": "string",
"description": "string | null"
},
"allowsNewAttemptsAfterExpiration": boolean
"maxValueFloor": decimal | null,
"allowAutoSendingPaymentInstructions": bool
}
}'
Exemplo de retorno
Sucesso 200
{
"revision": 9267254,
"transactionId": 9267254,
"clientRequestId": "9b26edb7cf254db09f5449c94bf13abc",
"status": "ACTIVE",
"lastUpdate": "2021-04-29",
"payerQuestion": "Esta cobrança é referente a...",
"additionalInformation": [
{
"value": "Assinatura de serviço",
"key": "Produto 1"
}],
"debtor": {
"name": "Fulano de Tal",
"cpf": "11122233366",
"cnpj": "1112223300100"},
"amount": {
"original": 0,
"changeType": 0,
"withdrawal": {
"vldnAmount": 10,
"agentMode": "AGTEC",
"withdrawalServiceProvider": "13935893",
"changeType": 0
},
"change": {
"vldnAmount": 10,
"vlcpAmount": 15.55,
"agentMode": "AGTEC",
"withdrawalServiceProvider": "13935893",
"changeType": 0 }
},
"location": {
"merchant": {
"postalCode": "01201005",
"city": "Barueri",
"merchantCategoryCode": 0,
"name": "Celcoin Pagamentos"
},
"url": "string",
"emv": "string",
"type": "string",
"locationId": "string",
"recurrencyUrl": "qrcode-h.teste.com.brv1/location/cob/dc8de35155df4cf6a86c6cf960b797cb"
"id": "string" },
"key": "5d000ece-b3f0-47b3-8bdd-c183e8875862",
"calendar": {
"expiration": 86400 },
"createAt": "2021-04-29",
"transactionIdentification": "kk6g232xel65a0daee4dd13kk479195205",
"recurrency": {
"recurrencyId": "id da recorrência, seguindo o formato: RRxxxxxxxxyyyyMMddkkkkkkkkkkk",
"interval": {
"start": "datetime",
"end": "datetime",
"frequencyType": "integer (enum FrequencyType)"},
"status": integer (enum RecurrencyStatus),
"journeys": [
{
"status": integer (enum JourneyStatus),
"type": integer (enum Journey),
"createDate": datetime,
}],
"amount": "decimal | null",
"creditParty": {
"bank": "string",
"taxId": "string",
"name": "string"
},
"debitParty": {
"ispb": string,
"personType": string,
"taxId": string,
"bank": string | null,
"account": string,
"stateCode": string
},
"debtor": {
"personType": string,
"taxId": string,
"name": string },
"contract": {
"number": "string",
"description": "string | null"},
"allowsNewAttemptsAfterExpiration": boolean
"maxValueFloor": decimal | null,
"createDate": datetime,
"allowAutoSendingPaymentInstructions": bool
}
}
Error 400
{
"version": "1.0.0",
"status": "ERROR",
"error": {
"errorCode": "",
"message": ""
}
}
Webhook de adesão completa - Pix-automatic-recurrency-completed
{
"entity": "pix-automatic-recurrency-completed"
"context": "PIX",
"cliente": {
"nome": "",
"clienteId": 1,
"localId": 1,
"usuarioId": 2
},
"body": {
"recurrencyId": "id da recorrência, seguindo o formato: RRxxxxxxxxyyyyMMddkkkkkkkkkkk",
"deniedReason": string | null, (smart enum AutomaticPixError),
"interval": {
"start": "datetime",
"end": "datetime",
"frequencyType": "integer (enum FrequencyType)"
},
"status": integer (enum RecurrencyStatus),
"journeys": [
{
"status": integer (enum JourneyStatus),
"type": integer (enum Journey)
"createDate": datetime,
}
],
"amount": "decimal | null",
"creditParty": {
"bank": "string",
"taxId": "string",
"name": "string"
},
"debitParty": {
"ispb": string,
"personType": string,
"taxId": string,
"bank": string | null,
"account": string,
"stateCode": string
},
"debtor": {
"personType": string,
"taxId": string,
"name": string
},
"contract": {
"number": "string",
"description": string | null
},
"allowsNewAttemptsAfterExpiration": boolean
"maxValueFloor": decimal | null,
"createDate": datetime,
"updateDate": datetime,
"allowAutoSendingPaymentInstructions": bool
}
}
Importante
Para estes casos da Jornada 3, a Celcoin sempre retornará o status de CONFIRMED, dado que a adesão é obrigatória. Caso o cliente não realize a adesão, nem o pagamento será recebido e o QR Code seguirá o fluxo normal de expiração de um Qr Code Pix.
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 4 hours ago