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
Copy file name to clipboardExpand all lines: _i18n/pt/_posts/pix/2022-04-22-apipix.md
+10-65Lines changed: 10 additions & 65 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -142,7 +142,8 @@ O foco da API está na automação do fluxo do usuário recebedor, permitindo qu
142
142
143
143
- Gere cobranças de forma programática;
144
144
- Acompanhe e confirme, via integração, o pagamento dessas cobranças dentro do próprio arranjo Pix.
145
-
145
+
<br/>
146
+
<br/>
146
147
Abaixo, você confere os possíveis caminhos de integração dos sistemas do usuário recebedor com a API Pix do PSP, neste caso a Cielo.
147
148
148
149

@@ -181,67 +182,11 @@ Importante: todos os clientes habilitados para o Pix Cielo, assim como os novos
181
182
182
183
Caso o cliente Cielo opte pela **Gestão de Livre Movimentação**, a funcionalidade de transferência automática será desativada.
183
184
184
-
**A API Pix contempla as funcionalidades necessárias para viabilizar:**
185
-
186
-
O recebimento de cobranças em casos de negócio focados em pagamentos imediatos, a exemplo de pontos de venda em lojas físicas e de soluções para comércio eletrônico;
187
-
188
-
# Estamos disponibilizando as APIs
189
-
190
-
-**1. API Cobrança:** Disponível para a geração de QR Code pelo usuário recebedor, para ser utilizado uma única vez, iniciando o pagamento instantâneo.
191
-
Nesse momento vamos disponibilizar o QR Code dinâmico com pagamento imediato.
192
-
Prazo para expirar o qrcode (60min).
193
-
194
-
-**2. API Conciliação:** Disponível para geração de relatórios (Opcional para o cliente).
195
-
196
-
-**3. API Devolução:** Disponível para efetuar a devolução das transações.
197
-
Sempre individual, identificando a transação a ser devolvida.
198
-
Representa uma solicitação de devolução de um Pix realizado, cujos fundos já se encontrem disponíveis na conta transacional do usuário recebedor.
199
-
200
-
**A API Cielo-Pix-v1 funciona da seguinte forma:** O software de automação/Front-end utilizado pelo usuário recebedor (EC) acessará a API Cielo-Pix-v1 e, com os dados recebidos como resposta da API, apresentará um QR Code Dinâmico em algum dispositivo para que o usuário pagador faça a leitura do QR Code por meio de seu dispositivo móvel para efetivar o pagamento.
A API Pix é o componente do arranjo que visa possibilitar que o usuário pagador ou recebedor, no contexto P2B64 ou B2B65, possa automatizar a interação com seu prestador de serviços de pagamento (PSP), a fim de realizar ou receber transações no âmbito do arranjo Pix.
207
-
208
-
Nesse contexto, a presente versão da API Pix busca automatizar a interação do usuário recebedor com seu prestador de serviços de pagamento (PSP), a fim de gerar cobranças e confirmar o recebimento do pagamento dessas cobranças por meio do Pix.
209
-
210
-
Na **figura acima**, pode-se visualizar possíveis caminhos de integração dos sistemas do usuário recebedor com a API
211
-
Pix do PSP.
212
-
213
-
O usuário recebedor poderá, via API Pix:
214
-
215
-
-**i.** Gerar cobranças que poderão ser pagas via QR Code pelos seus clientes;
216
-
-**ii.** Alterar dados da cobrança;
217
-
-**iii.** Verificar a liquidação da cobrança por meio de Pix recebidos;
218
-
-**iv.** Realizar a conciliação dos pagamentos de maneira facilitada;
219
-
-**v.** Suportar o processo de devolução de valores, que pode ser acionado em função, por exemplo, da devolução de uma compra.
220
-
221
-
A seguir são detalhados os aspectos gerais que dizem respeito à API Pix.
222
-
223
-
# Conceitos gerais
224
-
225
-
Para os fins deste documento, as expressões e os termos relacionados são assim definidos:
226
-
227
-
-**I - client_ID:** componente de acesso a API Pix que identifica um elemento de software cliente do usuário. Para acessar a API, é necessário utilizar, por exemplo, o Client_ID e um segredo, ambos fornecidos pelo PSP do usuário no processo de cadastramento. Pode existir mais de um elemento software cliente na infraestrutura do usuário e, portanto, para um usuário pode existir mais de um client_ID.
228
-
-**II - Escopos:** definem as autorizações associadas a cada um dos serviços da API. Por sua vez, os Client_IDs possuem acesso a um ou mais escopos, o que definirá quais serviços podem ser acessados por cada Client_ID;
229
-
-**III – Payload JSON:** conteúdo recuperado a partir da chamada à URL, lida a partir do QR Code dinâmico e que representa uma cobrança;
230
-
-**IV - PSP Pagador:** participante do Pix no qual o usuário pagador possui uma conta transacional;
231
-
-**V – PSP Recebedor:** participante do Pix no qual o usuário recebedor possui uma conta transacional que será usada para recebimentos de Pix. O PSP Recebedor que quiser disponibilizar a seus clientes uma solução de integração automatizada com o arranjo Pix deve fazê-lo por meio da API Pix, seguindo as especificações de negócio e técnicas definidas pelo Banco Central do Brasil neste documento e nos outros documentos trazidos na seção 2.
232
-
-**VI - transactionId (txid):** identificador da transação, na perspectiva do usuário recebedor. Esse número é gerado pelo usuário recebedor e repassado ao PSP recebedor na chamada da API Pix, no momento da criação da cobrança, a fim de identificar unicamente aquela cobrança66. Assim, o txid é utilizado pelo usuário recebedor, em seus processos de conciliação de pagamentos recebidos por meio de Pix. No caso das cobranças criadas por meio da API Pix, o PSP recebedor deve garantir que o txid seja único para um dado usuário recebedor (CPF/CNPJ).
233
-
-**VII - usuário pagador:** aquele que efetua o pagamento de uma cobrança por meio do Pix e tem a sua conta transacional debitada.
234
-
-**VIII - usuário recebedor:** pessoa natural ou jurídica que deseja receber cobranças – para pagamentos imediatos ou com vencimento – por meio do Pix e se vale da API Pix para automação dos seus processos de geração dessas cobranças e para conciliação de pagamentos recebidos por meio do Pix.
235
-
-**IX – facilitador de serviço de saque (FSS):** participante do Pix que se classifique como provedor de conta transacional e seja autorizado a funcionar pelo Banco Central do Brasil em caráter facultativo, venha a prestar o serviço de saque, diretamente, ou por meio de agente de saque, mediante estabelecimento de relação contratual para essa finalidade.
236
-
-**X – Chave:** O campo chave, obrigatório, determina a chave Pix registrada junto ao Banco Central que será utilizada para a cobrança, identificando o usuário recebedor, bem como os dados da conta transacional à qual a cobrança deve estar atrelada.
237
-
238
-
# Funcionalidades da API Pix
239
-
240
-
## Definições das entidades
185
+
## Entidades de negócio
241
186
242
187
A API Pix está estruturada em torno de algumas entidades de negócio, que agrupam conjuntos de atributos, conforme definido abaixo:
243
188
244
-
**I - Cobrança (/cob):** representa cada uma das cobranças geradas por meio da API Pix, a fim de permitir que o usuário pagador efetue um pagamento identificado para o usuário recebedor. A cobrança é caracterizada por um conjunto de informações que são utilizadas para que o usuário pagador execute um pagamento por meio do Pix, geralmente, em função de acordo comercial entre o usuário pagador e o usuário recebedor, sem se confundir com o pagamento Pix em si. O modelo de cobrança utilizado é para pagamento imediato.
189
+
**Cobrança (/cob):** representa cada uma das cobranças geradas por meio da API Pix, a fim de permitir que o usuário pagador efetue um pagamento identificado para o usuário recebedor. A cobrança é caracterizada por um conjunto de informações que são utilizadas para que o usuário pagador execute um pagamento por meio do Pix, geralmente, em função de acordo comercial entre o usuário pagador e o usuário recebedor, sem se confundir com o pagamento Pix em si. O modelo de cobrança utilizado é para pagamento imediato.
245
190
246
191
Estados da cobrança:
247
192
@@ -250,9 +195,9 @@ Estados da cobrança:
250
195
- c) **REMOVIDO_PELO_USUARIO_RECEBEDOR:** indica que o usuário recebedor solicitou a remoção da cobrança; e
251
196
- d) **REMOVIDO_PELO_PSP:** indica que o PSP Recebedor solicitou a remoção da cobrança.
252
197
253
-
**II - Pix (/pix):** representa um pagamento recebido por meio do arranjo de pagamentos Pix.
198
+
**Pix (/pix):** representa um pagamento recebido por meio do arranjo de pagamentos Pix.
254
199
255
-
**III - Devolução (devolução):** representa uma solicitação de devolução de um Pix realizado, cujos fundos já se encontrem disponíveis na conta transacional do usuário recebedor.
200
+
**Devolução (devolução):** representa uma solicitação de devolução de um Pix realizado, cujos fundos já se encontrem disponíveis na conta transacional do usuário recebedor.
256
201
257
202
Estados da devolução:
258
203
@@ -262,10 +207,10 @@ Estados da devolução:
262
207
263
208
## Cardinalidade entre as entidades
264
209
265
-
-I - Uma **Cobrança** pode estar associada a um ou mais **Pix** (mesmo txid);
266
-
-II - Um **Pix** pode estar associado a uma única **Cobrança**. O **Pix**, no entanto, pode existir independentemente da existência de uma **Cobrança**;
267
-
-III - Um **Pix** pode ter uma ou mais **Devoluções** associadas a ele. Uma **Devolução** está sempre associada a um **Pix**.
268
-
-IV – Uma **Cobrança** somente pode estar associada a um **PayloadLocation** e, num determinado momento, o PayloadLocation só pode estar associado a uma cobrança.
210
+
- Uma **Cobrança** pode estar associada a um ou mais **Pix** (mesmo txid);
211
+
- Um **Pix** pode estar associado a uma única **Cobrança**. O **Pix**, no entanto, pode existir independentemente da existência de uma **Cobrança**;
212
+
- Um **Pix** pode ter uma ou mais **Devoluções** associadas a ele. Uma **Devolução** está sempre associada a um **Pix**.
213
+
- Uma **Cobrança** somente pode estar associada a um **PayloadLocation** e, num determinado momento, o PayloadLocation só pode estar associado a uma cobrança.
0 commit comments