Skip to content

Commit 4f3bdba

Browse files
bcb-thiagobcb-thiago
committed
versão 1.2.0
1 parent 4409ea8 commit 4f3bdba

6 files changed

Lines changed: 196 additions & 10 deletions

File tree

‎CHANGELOG.md‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,11 @@
22

33
Mudanças relevantes na API do DICT serão documentadas aqui.
44

5+
## [1.2.0] - 2021-04-01
6+
### Adicionado
7+
- Alteração de nome de cliente na Entry
8+
- Consulta de existência de chaves (CheckKeys)
9+
510
## [1.1.0] - 2020-12-02
611
### Removido
712
- Tipo de infração AML_CTF

‎openapi/examples/entries/UpdateEntryRequest.xml‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,5 +9,10 @@
99
<AccountType>CACC</AccountType>
1010
<OpeningDate>2010-01-10T03:00:00Z</OpeningDate>
1111
</Account>
12+
<Owner>
13+
<Type>NATURAL_PERSON</Type>
14+
<TaxIdNumber>11122233300</TaxIdNumber>
15+
<Name>João Silva</Name>
16+
</Owner>
1217
<Reason>USER_REQUESTED</Reason>
1318
</UpdateEntryRequest>

‎openapi/examples/keys/CheckKeysRequest.xml‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
<?xml version="1.0" encoding="UTF-8" ?>
2+
<CheckKeysRequest>
3+
<Keys>
4+
<Key>mail@mail.com</Key>
5+
<Key>mail2@mail.com</Key>
6+
<Key>+5561999999999</Key>
7+
<Key>+5561888888888</Key>
8+
</Keys>
9+
</CheckKeysRequest>

‎openapi/examples/keys/CheckKeysResponse.xml‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
<?xml version="1.0" encoding="UTF-8" ?>
2+
<CheckKeysResponse>
3+
<Signature></Signature>
4+
<ResponseTime>2020-01-10T10:00:00Z</ResponseTime>
5+
<CorrelationId>a9f13566e19f5ca51329479a5bae60c5</CorrelationId>
6+
<Keys>
7+
<Key hasEntry="true">mail@mail.com</Key>
8+
<Key hasEntry="false">mail2@mail.com</Key>
9+
<Key hasEntry="true">+5561999999999</Key>
10+
<Key hasEntry="false">+5561888888888</Key>
11+
</Keys>
12+
</CheckKeysResponse>

‎openapi/openapi.yaml‎

Lines changed: 106 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
openapi: 3.0.0
22
info:
33
title: DICT API
4-
version: '1.1.0'
4+
version: '1.2.0'
55
license:
66
name: Apache 2.0
77
url: http://www.apache.org/licenses/LICENSE-2.0
@@ -230,6 +230,9 @@ info:
230230
- Existe uma reivindicação com status diferente de concluída ou cancelada para a chave
231231
do vínculo. Enquanto estiver nessa situação, o vínculo não pode ser excluído.
232232
233+
- `EntryTaxIdNumberByDifferentOwner`
234+
- CPF ou CNPJ do vínculo diferente do CPF ou CNPJ do dono da chave.
235+
233236
**Reivindicações**
234237
235238
- `ClaimInvalid`
@@ -289,28 +292,44 @@ servers:
289292
description: Homologação
290293
- url: https://dict.pi.rsfn.net.br:16422/api/v1/
291294
description: Produção
295+
292296
tags:
293297
- name: Directory
294298
x-displayName: Diretório
295299
description: |-
296300
O diretório de identificadores de contas transacionais é um conjunto de vínculos.
297301
Um vínculo é uma associação entre uma chave de endereçamento, uma conta transacional e seu dono.
298-
O dono pode ser uma pessoa física ou uma pessoa jurídica. A chave de endereçamento é usada para identificar um vínculo.
299-
302+
O dono pode ser uma pessoa física ou uma pessoa jurídica. A chave de endereçamento é usada para identificar unicamente um vínculo.
303+
304+
Exemplo de vínculo:
305+
306+
| Chave | Conta | Dono |
307+
|-----------------|---------------------------------------|-----------------------------------|
308+
| +5510998765432 | Banco Fictício/Ag.7263-4/Cc.748627-1 | José João da Silva |
309+
310+
- name: Key
311+
x-displayName: Chave
312+
description: |-
313+
Uma chave transacional é uma sequência de caracteres que identifica um vínculo de forma única no diretório de identificadores.
314+
A existência de uma determinada chave no diretório implica diretamente na existência de um vínculo.
315+
300316
Os tipos de chave suportadas atualmente são as seguintes:
301-
317+
302318
| Tipo | Exp. regular | Exemplo | Comentário |
303319
|---------------|------------------------------------------------------------------------------------------------------------|--------------------------------------|---------------------------------------------------------------------------|
304320
| CPF | ^\[0-9\]{11}$ | 12345678901 | |
305321
| CNPJ | ^\[0-9\]{14}$ | 12345678901234 | |
306322
| PHONE | ^\\+\[1-9\]\[0-9\]\d{1,14}$ | +5510998765432 | |
307-
| EMAIL | [e-mails válidos W3C HTML5](https://html.spec.whatwg.org/multipage/input.html#valid-e-mail-address) | pix@bcb.gov.br | E-mail deve possuir no máximo 77 caracteres e deve ser em minúsculo |
323+
| EMAIL | [e-mails válidos W3C HTML5](https://html.spec.whatwg.org/multipage/input.html#valid-e-mail-address) | pix@bcb.gov.br | E-mail deve possuir no máximo 77 caracteres e deve ser em minúsculo |
308324
| EVP | [0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12} | 123e4567-e89b-12d3-a456-426655440000 | Endereço Virtual de Pagamento é um tipo de chave é gerado pelo DICT |
309325
310326
311327
Novos tipos de chave poderão vir a ser adicionados no futuro. Logo, é importante que a implementação de clientes
312328
seja flexível, permitindo a adição de novos tipos de chave.
313329
330+
Apesar da existência de uma chave estar sempre relacionada a um vínculo, é possível a realização de consultas de existência
331+
de chaves.
332+
314333
- name: Claim
315334
x-displayName: Reivindicação
316335
description: |-
@@ -633,9 +652,9 @@ paths:
633652
description: |-
634653
Atualiza um vínculo.
635654
636-
A ser utilizado no cenário de atualização da informação da conta de um cliente, permanecendo este no mesmo PSP.
637-
Somente pode ser atualizada a informação de conta do vínculo. Outras atualizações do vínculo devem ser feitas
638-
por exclusão/inclusão do vínculo, portabilidade ou reivindicação de posse, a depender da situação.
655+
A ser utilizado no cenário de atualização da informação da conta ou de nome de um cliente, permanecendo este no mesmo PSP.
656+
Somente podem ser atualizadas as informações de conta do vínculo ou nome do cliente. Outras atualizações do vínculo devem
657+
ser feitas por exclusão/inclusão do vínculo, portabilidade ou reivindicação de posse, a depender da situação.
639658
640659
operationId: updateEntry
641660
requestBody:
@@ -707,6 +726,50 @@ paths:
707726
'503':
708727
$ref: "#/components/responses/ServiceUnavailable"
709728

729+
########################################################################################################################
730+
## KEYS
731+
########################################################################################################################
732+
733+
'/keys/check':
734+
735+
post:
736+
summary: Verificar existência de chaves
737+
operationId: checkKeys
738+
description: Consulta a existência de um conjunto de chaves no diretório de identificadores.
739+
tags:
740+
- Key
741+
requestBody:
742+
content:
743+
application/xml:
744+
schema:
745+
$ref: '#/components/schemas/CheckKeysRequest'
746+
examples:
747+
example:
748+
value:
749+
$ref: './examples/keys/CheckKeysRequest.xml'
750+
responses:
751+
'200':
752+
description: OK
753+
content:
754+
application/xml:
755+
schema:
756+
$ref: '#/components/schemas/CheckKeysResponse'
757+
examples:
758+
example:
759+
value:
760+
$ref: './examples/keys/CheckKeysResponse.xml'
761+
'403':
762+
$ref: "#/components/responses/Forbidden"
763+
'404':
764+
$ref: "#/components/responses/NotFound"
765+
'503':
766+
$ref: "#/components/responses/ServiceUnavailable"
767+
servers:
768+
- url: https://dict-np-h.pi.rsfn.net.br:16532/api-np/v1/
769+
description: Homologação
770+
- url: https://dict-np.pi.rsfn.net.br:16432/api-np/v1/
771+
description: Produção
772+
710773
#######################################################################################################################
711774
## CLAIMS
712775
########################################################################################################################
@@ -821,14 +884,30 @@ paths:
821884
name: Limit
822885
in: query
823886
required: false
887+
# - description: Cursor de deslocamento em consultas. Permite o escape linear de registros.
888+
# schema:
889+
# type: integer
890+
# default: 0
891+
# name: Offset
892+
# in: query
893+
# required: false
894+
- description: Indica inclusão de reivindicações de participantes indiretos no resultado da consulta.
895+
schema:
896+
type: boolean
897+
default: false
898+
name: IncludeIndirectParticipants
899+
in: query
900+
required: false
824901
summary: Listar Reivindicações
825902
description: |-
826903
Obtém uma lista de reivindicações, ordenada de forma crescente pelo campo `LastModified`, de acordo com os filtros passados.
827904
828905
Observações:
829906
- Ao percorrer a lista em intervalos de tempo fechados, recomendável para que não se pule nenhum elemento, alguns elementos retornados poderão se repetir.
830907
- O comportamento dos filtros `isDonor` e `isClaimer`, quando os valores passados são iguais, é disjuntivo: são retornadas reinvidicações em que
831-
o participante é doador OU reivindicador.
908+
o participante é doador OU reivindicador.
909+
- A atualização de informações de reinvindicações para listagens é _assíncrona_ em relação às operações de inclusão e atualização de registros, sendo assim,
910+
é possível haver um retardo de _5 segundos_ até que os dados incluídos ou alterados constem na consulta.
832911
833912
operationId: listClaims
834913
tags:
@@ -1344,6 +1423,10 @@ paths:
13441423
| [Confirmar Reivindicação](#operation/confirmClaim) | remove (PSP doador) |
13451424
| [Concluir Reivindicação](#operation/completeClaim) | adiciona (PSP reivindicador)|
13461425
1426+
Observação:
1427+
- A atualização de informações de eventos de CIDs para listagens é _assíncrona_ em relação às operações de inclusão e atualização de registros, sendo assim,
1428+
é possível haver um retardo de _5 segundos_ até que os dados incluídos ou alterados constem na consulta.
1429+
13471430
operationId: listCidSetEvents
13481431
tags:
13491432
- Reconciliation
@@ -1495,11 +1578,22 @@ paths:
14951578
name: Limit
14961579
in: query
14971580
required: false
1581+
# - description: Cursor de deslocamento em consultas. Permite o escape linear de registros.
1582+
# schema:
1583+
# type: integer
1584+
# default: 0
1585+
# name: Offset
1586+
# in: query
1587+
# required: false
14981588
summary: Listar Relatos de Infração
14991589
description: |-
15001590
Obtém lista de relatos de infração em que o participante é parte.
15011591
1502-
Lista de relatos é ordenada de forma crescente pelo campo `LastModified` .
1592+
Lista de relatos é ordenada de forma crescente pelo campo `LastModified`.
1593+
1594+
Observação:
1595+
- A atualização de informações de relatos de infração para listagens é _assíncrona_ em relação às operações de inclusão
1596+
e atualização de registros, sendo assim, é possível haver um retardo de _5 segundos_ até que os dados incluídos ou alterados constem na consulta.
15031597
operationId: listInfractionReport
15041598
tags:
15051599
- InfractionReport
@@ -1661,6 +1755,8 @@ paths:
16611755
Fecha o relato de infração. Se o relato foi criado pelo participante debitado, o
16621756
creditado deve realizar o fechamento e vice-versa.
16631757
1758+
Para fechamento, o status deve ser `ACKNOWLEDGED`.
1759+
16641760
### Idempotência
16651761
A operação é idempotente. Caso o relato já tenha sido fechado com os mesmos parâmetros,
16661762
será retornada resposta equivalente à primeira requisição.

‎openapi/schemas.yaml‎

Lines changed: 59 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -52,6 +52,19 @@
5252
- EMAIL
5353
- EVP
5454
example: CPF
55+
ExtendedKey:
56+
allOf:
57+
- $ref: '#/Key'
58+
- type: string
59+
- description: Chave de endereçamento.
60+
xml:
61+
name: Key
62+
properties:
63+
hasEntry:
64+
type: boolean
65+
description: Existe vínculo cadastrado para a chave de endereçamento.
66+
xml:
67+
attribute: true
5568
NaturalPerson:
5669
type: object
5770
properties:
@@ -522,6 +535,17 @@
522535
- CreditedParticipant
523536
- CreationTime
524537
- LastModified
538+
Owner:
539+
type: object
540+
description: Dono da chave vinculada á uma conta transacional no Brasil.
541+
oneOf:
542+
- $ref: '#/NaturalPerson'
543+
- $ref: '#/LegalPerson'
544+
discriminator:
545+
propertyName: Type
546+
mapping:
547+
NATURAL_PERSON: '#/NaturalPerson'
548+
LEGAL_PERSON: '#/LegalPerson'
525549

526550
#### SYNC REQ-RESP #####
527551

@@ -963,6 +987,8 @@
963987
$ref: "#/Key"
964988
Account:
965989
$ref: '#/BrazilianAccount'
990+
Owner:
991+
$ref: '#/Owner'
966992
Reason:
967993
allOf:
968994
- $ref: '#/EntryOperationReason'
@@ -1073,6 +1099,39 @@
10731099
- Entry
10741100
- Statistics
10751101

1102+
##### KEY REQ-RESP #####
1103+
1104+
CheckKeysRequest:
1105+
type: object
1106+
properties:
1107+
Keys:
1108+
type: array
1109+
description: Chaves de endereçamento
1110+
items:
1111+
$ref: '#/Key'
1112+
required:
1113+
- Keys
1114+
CheckKeysResponse:
1115+
type: object
1116+
properties:
1117+
Signature:
1118+
type: object
1119+
xml:
1120+
prefix: ds
1121+
namespace: 'http://www.w3.org/2000/09/xmldsig#'
1122+
ResponseTime:
1123+
type: string
1124+
format: date-time
1125+
CorrelationId:
1126+
$ref: '#/CorrelationId'
1127+
Keys:
1128+
type: array
1129+
description: Chaves de endereçamento
1130+
items:
1131+
$ref: '#/ExtendedKey'
1132+
required:
1133+
- Keys
1134+
10761135
##### INFRACTION-REPORT REQ-RESP ####
10771136

10781137
CreateInfractionReportRequest:

0 commit comments

Comments
 (0)