You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
| GET | Retorna recursos já existentes, ex.: consulta de cobrança. |
354
+
| POST | Cria um novo recurso, ex.: criação de cobrança. |
355
+
| PUT | Atualiza um recurso existente, ex.: realizar devolução. |
356
+
| DELETE | Exclui um recurso, ex.: exclui um webhook. |
357
+
| PATCH | Revisa um recurso, ex.: revisa uma cobrança. |
358
+
359
+
Cada envio de requisição irá retornar um código de Status HTTP, indicando se ela foi realizada com sucesso ou não.
360
+
361
+
## Credenciais e autenticação
362
+
363
+
Abaixo, você aprende como solicitar credenciais Sandbox e, em seguida, credenciais Produção.
364
+
365
+
### Solicitação de credenciais Sandbox
366
+
367
+
Para obter acesso ao ambiente Sandbox, solicite à Cielo, por meio do e‑mail **apipix.suporte@cielo.com.br**, as seguintes credenciais:
368
+
369
+
- Client ID e Client Secret (utilizados para autenticação via OAuth2).
370
+
- Chave Pix transacional (tipo: aleatória).
371
+
372
+
No ambiente Sandbox, após gerar o QR Code, envie-o por e-mail apipix.suporte@cielo.com.br para que a Cielo efetue o pagamento. Configure um tempo de expiração maior para o QR Code.
373
+
374
+
### Solicitação de credenciais Produção
375
+
376
+
Para transacionar em nome dos clientes da Cielo, os parceiros devem ter as seguintes chaves do cliente:
377
+
378
+
- Client ID
379
+
- Client Secret
380
+
- Chave Pix
381
+
382
+
<asidestyle="background-color: #d4edda; padding: 15px; border-left: 5pxsolid#28a745; color: #155724;margin-top: 20px; margin-bottom: 20px;"> Cada estabelecimento comercial precisa ter credenciais próprias.</aside>
383
+
384
+
Siga o passo-a-passo abaixo para gerar credenciais de Produção:
385
+
386
+
**1.** No site da Cielo, acesse o portal [Minha Conta](https://minhaconta2.cielo.com.br/minha-conta/home) e clique em **Meu Cadastro**.
387
+
388
+
**2.** Na aba **Autorizações**, clique em **Pix**.
Após essa etapa, o cliente poderá copiar o Cliente ID, Client Secret e Chave Transacional para realizar onboarding no portal parceiro.
425
+
426
+
<asidestyle="background-color: #f8d7da; padding: 15px; border-left: 5pxsolid#dc3545; color: #721c24;margin-top: 20px; margin-bottom: 20px;"> As credenciais precisam ser copiadas/baixadas dentro de 3 minutos. Caso contrário, será necessário gerar uma nova credencial. </aside>
Para garantir a conformidade e a proteção das informações, devem ser adotadas as seguintes medidas:
433
+
434
+
### Criptografia da conexão
435
+
436
+
- Toda conexão com a API deve ser criptografada utilizando TLS versão 1.2 ou superior, permitindo apenas cipher suites que ofereçam forward secrecy.
437
+
- A API Pix exige autenticação mútua por certificados. Isso significa que tanto o cliente quanto o servidor apresentam seus certificados, que são validados pelo outro lado. Durante a requisição, o cliente envia seu certificado para validação pela Cielo. A Cielo, por sua vez, também apresenta seu certificado para validação pelo cliente. A autenticação só é concluída mediante validação bem-sucedida dos dois certificados.
438
+
439
+
### Autenticação via OAuth 2.0 com mTLS
440
+
441
+
A Cielo utiliza seu próprio Resource Server, que implementa o OAuth 2.0 (RFC 6749) com TLS mútuo (mTLS – RFC 8705), conforme regulamentações do Banco Central. Assim, o processo de comunicação e autenticação deve seguir os seguintes critérios:
442
+
443
+
- Os certificados digitais dos clientes podem ser emitidos por ACs externas ou pela própria Cielo, que atua como autoridade certificadora. Certificados autoassinados não são aceitos.
444
+
- Cliente e servidor devem implementar TLS mútuo na comunicação com a API Pix.
445
+
- A Cielo utiliza Client Certificate-Bound Access Tokens, vinculando o certificado do cliente ao access token emitido, conforme seção 3 da RFC 8705.
446
+
- O Resource Server da Cielo valida se o thumbprint do certificado associado ao access token corresponde ao certificado utilizado na autenticação TLS (proof-of-possession).
447
+
- O fluxo OAuth utilizado é o Client Credentials Flow.
448
+
449
+
### Confidencialidade e integridade
450
+
451
+
- O processo de cadastro dos clientes para acesso à API ocorre em ambiente autenticado da Cielo com duplo fator de autenticação conforme determinado pelo Bacen. Além disso, utilizamos um canal seguro para envio das credenciais, o que garante rastreabilidade completa de todas as ações realizadas.
452
+
- A API assegura a confidencialidade e a integridade dos dados dos usuários e de suas transações, tanto em trânsito quanto em repouso.
453
+
- A Cielo mantém logs de auditoria de acesso à API por, no mínimo, 1 ano.
454
+
- O client_id utilizado na autenticação é vinculado ao CNPJ ou CPF do estabelecimento recebedor, e somente permite acesso aos recursos relacionados às contas transacionais de titularidade desse mesmo CNPJ ou CPF.
455
+
- A API da Cielo é projetada para atender com alta disponibilidade.
456
+
457
+
458
+
321
459
## Entidades de negócio
322
460
323
461
A API Pix está estruturada em torno de algumas entidades de negócio, que agrupam conjuntos de atributos, conforme definido abaixo:
@@ -445,75 +583,6 @@ No processo de adesão, o Client_ID disponibilizado pelo PSP deve possuir um con
445
583
446
584
Dessa forma, é possível, por exemplo, que determinadas funcionalidades estejam acessíveis apenas por usuários que cumpram requisitos adicionais de segurança estipulados por cada PSP.
447
585
448
-
# CREDENCIAIS E AUTENTICAÇÃO
449
-
450
-
Para utilizar a API PIX, as requisições devem ser executadas utilizando as respectivas credenciais dos ambientes de Homologação e Produção.
451
-
452
-
## Ambientes
453
-
454
-
-**Produção:** Ambiente transacional integrado ao ambiente da Cielo. As operações realizadas nesse ambiente são reais e não podem ser desfeitas.
455
-
-**Homologação:** Ambiente destinado à realização de testes. As operações são executadas em ambiente real, porém não produtivo.
456
-
457
-
## Homologação
458
-
459
-
Para obter acesso ao ambiente Sandbox, solicite à Cielo, por meio do e‑mail **apipix.suporte@cielo.com.br**, as seguintes credenciais:
460
-
461
-
- Client ID e Client Secret (utilizados para autenticação via OAuth2);
462
-
- Chave Pix transacional (tipo: aleatória).
463
-
464
-
<asidestyle="background-color: #d4edda; padding: 15px; border-left: 5pxsolid#28a745; color: #155724;margin-top: 20px; margin-bottom: 20px;"> No ambiente Sandbox, após gerar o QR Code, envie-o por e-mail apipix.suporte@cielo.com.br para que a Cielo efetue o pagamento. Lembre-se de configurar um tempo de expiração maior para o QR Code. </aside>
465
-
466
-
## Produção
467
-
468
-
**Produção:** Para os parceiros acessarem os dados dos clientes da Cielo, os clientes precisam informar as “chaves” ao parceiro.
469
-
470
-
**E como funciona o fluxo de criação das credenciais em produção?**
471
-
472
-
**Importante:** Para cada estabelecimento comercial devem ser geradas novas credenciais.
473
-
474
-
**1º:** No site da Cielo, o cliente Cielo acessa o portal [Minha Conta](https://minhaconta2.cielo.com.br/minha-conta/home) e clica em Meu Cadastro.
475
-
476
-
**2º:** Na aba Autorizações clique em Pix.
477
-
478
-
**3º:** Para criar as credenciais, selecione a opção Novo acesso.
0 commit comments