|
1
|
openapi: 3.0.1
|
|
2
|
info:
|
|
3
|
title: Cobranças API
|
|
4
|
description: >-
|
|
5
|
API para gerenciar os serviços de cobranças de cliente do Banco do Brasil
|
|
6
|
S.A.
|
|
7
|
contact:
|
|
8
|
name: Banco do Brasil S.A. - BB for Developers
|
|
9
|
url: https://developers.bb.com.br
|
|
10
|
version: '2.13'
|
|
11
|
externalDocs:
|
|
12
|
url: https://apoio.developers.bb.com.br/referency/post/5f4f8342b71fb5001268c9ac
|
|
13
|
servers:
|
|
14
|
- url: https://api.sandbox.bb.com.br/cobrancas/v2
|
|
15
|
description: Servidor de Homologação
|
|
16
|
- url: https://api.hm.bb.com.br/cobrancas/v2
|
|
17
|
description: Servidor de Homologação2
|
|
18
|
- url: https://api.bb.com.br/cobrancas/v2
|
|
19
|
description: Servidor de Produção
|
|
20
|
security:
|
|
21
|
- OAuth2:
|
|
22
|
- cobrancas.boletos-info
|
|
23
|
paths:
|
|
24
|
/boletos:
|
|
25
|
get:
|
|
26
|
summary: Lista Boletos
|
|
27
|
description: >-
|
|
28
|
Listar títulos de cobrança - Em Ser, Baixados, Liquidados e Com Protesto
|
|
29
|
por Beneficiário.
|
|
30
|
parameters:
|
|
31
|
- name: gw-dev-app-key
|
|
32
|
in: query
|
|
33
|
description: >-
|
|
34
|
É a chave de acesso do aplicativo do desenvolvedor utilizada em
|
|
35
|
produção, obtida no Portal do Desenvolvedor. Essa chave será usada
|
|
36
|
para identificação do aplicativo.
|
|
37
|
|
|
38
|
|
|
39
|
Para os testes em ambiente de homologação, trocar por gw-app-key.
|
|
40
|
|
|
41
|
|
|
42
|
Ex: 0021239456d80136bebf005056891bed.
|
|
43
|
|
|
44
|
CAMPO OBRIGATÓRIO.
|
|
45
|
required: true
|
|
46
|
schema:
|
|
47
|
type: string
|
|
48
|
- name: Authorization
|
|
49
|
in: header
|
|
50
|
description: |-
|
|
51
|
É um "token" de acesso fornecido pelo OAuth 2.0.
|
|
52
|
Ex: Bearer [ACCESS_TOKEN]
|
|
53
|
required: true
|
|
54
|
schema:
|
|
55
|
type: string
|
|
56
|
- name: indicadorSituacao
|
|
57
|
in: query
|
|
58
|
description: |-
|
|
59
|
Situação do boleto. Campo obrigatoriamente MAIÚSCULO.
|
|
60
|
Domínios:
|
|
61
|
A - Em ser
|
|
62
|
B - Baixados/Protestados/Liquidados
|
|
63
|
required: true
|
|
64
|
schema:
|
|
65
|
type: string
|
|
66
|
- name: contaCaucao
|
|
67
|
in: query
|
|
68
|
description: |-
|
|
69
|
Número da conta caução.
|
|
70
|
|
|
71
|
Domínio:
|
|
72
|
1 - Compõe Garantia;
|
|
73
|
2 - Não Compõe Garantia;
|
|
74
|
4 - Não Compõe Garantia (vencimento superior a 180 dias);
|
|
75
|
5 - Não Compõe Garantia (Vedado);
|
|
76
|
6 - Em análise;
|
|
77
|
7 - Em análise;
|
|
78
|
8 - Não Compõe Garantia.
|
|
79
|
schema:
|
|
80
|
type: integer
|
|
81
|
format: int32
|
|
82
|
- name: agenciaBeneficiario
|
|
83
|
in: query
|
|
84
|
description: >-
|
|
85
|
Número da agência do beneficiário, sem o dígito verificador. Ex:
|
|
86
|
452. CAMPO OBRIGATÓRIO.
|
|
87
|
required: true
|
|
88
|
schema:
|
|
89
|
type: integer
|
|
90
|
format: int32
|
|
91
|
- name: contaBeneficiario
|
|
92
|
in: query
|
|
93
|
description: >-
|
|
94
|
Número da conta do beneficiário, sem o dígito verificador. Ex:
|
|
95
|
123873. CAMPO OBRIGATÓRIO.
|
|
96
|
required: true
|
|
97
|
schema:
|
|
98
|
type: integer
|
|
99
|
format: int64
|
|
100
|
- name: carteiraConvenio
|
|
101
|
in: query
|
|
102
|
description: 'Número da carteira do convênio de cobrança. Ex: 17'
|
|
103
|
schema:
|
|
104
|
type: integer
|
|
105
|
format: int32
|
|
106
|
- name: variacaoCarteiraConvenio
|
|
107
|
in: query
|
|
108
|
description: 'Número da variação da carteira do convênio de cobrança. Ex: 35'
|
|
109
|
schema:
|
|
110
|
type: integer
|
|
111
|
format: int32
|
|
112
|
- name: modalidadeCobranca
|
|
113
|
in: query
|
|
114
|
description: >-
|
|
115
|
Código para identificar a característica dos boletos dentro das
|
|
116
|
modalidades de cobrança existentes no BB.
|
|
117
|
|
|
118
|
Domínio:
|
|
119
|
|
|
120
|
1 - SIMPLES COM REGISTRO
|
|
121
|
|
|
122
|
2 - SIMPLES SEM REGISTRO
|
|
123
|
|
|
124
|
4 - VINCULADA
|
|
125
|
|
|
126
|
6 - DESCONTADA
|
|
127
|
|
|
128
|
8 - FINANCIADA VENDOR
|
|
129
|
schema:
|
|
130
|
type: integer
|
|
131
|
format: int32
|
|
132
|
- name: cnpjPagador
|
|
133
|
in: query
|
|
134
|
description: |-
|
|
135
|
CNPJ do pagador
|
|
136
|
Ex: 123456789012
|
|
137
|
schema:
|
|
138
|
type: integer
|
|
139
|
format: int64
|
|
140
|
- name: digitoCNPJPagador
|
|
141
|
in: query
|
|
142
|
description: |-
|
|
143
|
Dígito verificador do CNPJ do pagador
|
|
144
|
Ex: 12
|
|
145
|
schema:
|
|
146
|
type: integer
|
|
147
|
format: int32
|
|
148
|
- name: cpfPagador
|
|
149
|
in: query
|
|
150
|
description: 'CPF do pagador sem o dígito. Ex: 711285901'
|
|
151
|
schema:
|
|
152
|
type: integer
|
|
153
|
format: int64
|
|
154
|
- name: digitoCPFPagador
|
|
155
|
in: query
|
|
156
|
description: 'Dígito verificador do CPF do pagador. Ex: 82'
|
|
157
|
schema:
|
|
158
|
type: integer
|
|
159
|
format: int32
|
|
160
|
- name: dataInicioVencimento
|
|
161
|
in: query
|
|
162
|
description: >-
|
|
163
|
Data inicial de vencimento do boleto que delimita o período da
|
|
164
|
consulta. Campo não obrigatório. Se informado Data Início, deixando
|
|
165
|
em branco a Data Fim, o sistema deve assumir a data atual como Data
|
|
166
|
Fim. Ex: 22.04.2020
|
|
167
|
schema:
|
|
168
|
type: string
|
|
169
|
- name: dataFimVencimento
|
|
170
|
in: query
|
|
171
|
description: >-
|
|
172
|
Data final de vencimento do boleto que delimita o período da
|
|
173
|
consulta - deverá ser maior que a data de início. Campo não
|
|
174
|
obrigatório. Se informado, deverá ser preenchido
|
|
175
|
dataInicioVencimento. Ex: 28.04.2020
|
|
176
|
schema:
|
|
177
|
type: string
|
|
178
|
- name: dataInicioRegistro
|
|
179
|
in: query
|
|
180
|
description: >-
|
|
181
|
Data inicial do registro do boleto que delimita o período da
|
|
182
|
consulta. Ex: 22.04.2020
|
|
183
|
schema:
|
|
184
|
type: string
|
|
185
|
- name: dataFimRegistro
|
|
186
|
in: query
|
|
187
|
description: >-
|
|
188
|
Data final do registro do boleto que delimita o período da consulta
|
|
189
|
- deverá ser maior que a data de início. Campo não obrigatório. Se
|
|
190
|
informado, deverá ser preenchido dataInicioRegistro. Ex: 28.04.2020
|
|
191
|
schema:
|
|
192
|
type: string
|
|
193
|
- name: dataInicioMovimento
|
|
194
|
in: query
|
|
195
|
description: >-
|
|
196
|
Delimita o período da consulta de boletos liquidados, baixados ou
|
|
197
|
protestados, caso seja informado, no campo
|
|
198
|
codigoEstadoTituloCobranca os códigos 05, 06, 07 ou 09. Ex:
|
|
199
|
22.04.2020
|
|
200
|
schema:
|
|
201
|
type: string
|
|
202
|
- name: dataFimMovimento
|
|
203
|
in: query
|
|
204
|
description: >-
|
|
205
|
Data final do movimento que delimita o período da consulta de
|
|
206
|
boletos liquidados, baixados ou protestados, caso seja informado, no
|
|
207
|
campo codigoEstadoTituloCobranca os códigos 05, 06, 07 ou 09. Data
|
|
208
|
fim deverá ser maior que a data de início. Campo não obrigatório. Se
|
|
209
|
informado, deverá ser preenchido dataInicioMovimento. Ex: 28.04.2020
|
|
210
|
schema:
|
|
211
|
type: string
|
|
212
|
- name: codigoEstadoTituloCobranca
|
|
213
|
in: query
|
|
214
|
description: |-
|
|
215
|
Código da situação atual do boleto.
|
|
216
|
|
|
217
|
Domínios:
|
|
218
|
|
|
219
|
01 - NORMAL
|
|
220
|
02 - MOVIMENTO CARTORIO
|
|
221
|
03 - EM CARTORIO
|
|
222
|
04 - TITULO COM OCORRENCIA DE CARTORIO
|
|
223
|
05 - PROTESTADO ELETRONICO
|
|
224
|
06 - LIQUIDADO
|
|
225
|
07 - BAIXADO
|
|
226
|
08 - TITULO COM PENDENCIA DE CARTORIO
|
|
227
|
09 - TITULO PROTESTADO MANUAL
|
|
228
|
10 - TITULO BAIXADO/PAGO EM CARTORIO
|
|
229
|
11 - TITULO LIQUIDADO/PROTESTADO
|
|
230
|
12 - TITULO LIQUID/PGCRTO
|
|
231
|
13 - TITULO PROTESTADO AGUARDANDO BAIXA
|
|
232
|
14 - TITULO EM LIQUIDACAO
|
|
233
|
15 - TITULO AGENDADO
|
|
234
|
16 - TITULO CREDITADO
|
|
235
|
17 - PAGO EM CHEQUE - AGUARD.LIQUIDACAO
|
|
236
|
18 - PAGO PARCIALMENTE CREDITADO
|
|
237
|
80 - EM PROCESSAMENTO (ESTADO TRANSITÓRIO)
|
|
238
|
schema:
|
|
239
|
type: integer
|
|
240
|
format: int32
|
|
241
|
- name: boletoVencido
|
|
242
|
in: query
|
|
243
|
description: >-
|
|
244
|
Indica se o Boleto está vencido ou não. Campo obrigatoriamente
|
|
245
|
MAIÚSCULO.
|
|
246
|
|
|
247
|
Domínio:
|
|
248
|
|
|
249
|
S para boletos vencidos
|
|
250
|
|
|
251
|
N para boletos não vencidos
|
|
252
|
schema:
|
|
253
|
type: string
|
|
254
|
- name: indice
|
|
255
|
in: query
|
|
256
|
description: >
|
|
257
|
Somente deve ser utilizado em caso de pesquisas que retornem mais de
|
|
258
|
300 boletos. Caso o campo RPST "Indicador Continuidade" retorne com
|
|
259
|
o valor "S", o usuário deve informar o conteúdo do campo RPST
|
|
260
|
"Numero Ultimo Registro" a partir do qual será iniciada nova
|
|
261
|
consulta.
|
|
262
|
schema:
|
|
263
|
type: integer
|
|
264
|
format: int64
|
|
265
|
responses:
|
|
266
|
'200':
|
|
267
|
description: SUCESSO. A requisição foi atendida e resultou em resposta.
|
|
268
|
content:
|
|
269
|
application/json:
|
|
270
|
schema:
|
|
271
|
type: array
|
|
272
|
items:
|
|
273
|
$ref: '#/components/schemas/RespostaListaBoletos'
|
|
274
|
'400':
|
|
275
|
description: >-
|
|
276
|
REQUISIÇÃO INVÁLIDA. O servidor não pôde processar a requisição
|
|
277
|
devido a uma sintaxe de requisição malformada, estrutura da mensagem
|
|
278
|
da requisição inválida, ou valores inválidos.
|
|
279
|
content:
|
|
280
|
application/json:
|
|
281
|
schema:
|
|
282
|
$ref: '#/components/schemas/Erro-v2'
|
|
283
|
'401':
|
|
284
|
description: NÃO AUTORIZADO. A requisição requer autenticação do usuário.
|
|
285
|
content:
|
|
286
|
application/json:
|
|
287
|
schema:
|
|
288
|
$ref: '#/components/schemas/ErroOAuthNaoAutorizado'
|
|
289
|
'404':
|
|
290
|
description: >-
|
|
291
|
NÃO ENCONTRADO. O servidor não conseguiu encontrar o recurso
|
|
292
|
solicitado.
|
|
293
|
content:
|
|
294
|
application/json:
|
|
295
|
schema:
|
|
296
|
type: object
|
|
297
|
'500':
|
|
298
|
description: >-
|
|
299
|
ERRO INTERNO. O servidor encontrou uma condição inesperada que o
|
|
300
|
impediu de atender a requisição.
|
|
301
|
content:
|
|
302
|
application/json:
|
|
303
|
schema:
|
|
304
|
$ref: '#/components/schemas/Erro-v2'
|
|
305
|
'503':
|
|
306
|
description: >-
|
|
307
|
SERVIÇO INDISPONÍVEL. No momento o servidor não pode atender a
|
|
308
|
solicitação devido a uma sobrecarga temporária ou manutenção do
|
|
309
|
servidor.
|
|
310
|
content:
|
|
311
|
application/json:
|
|
312
|
schema:
|
|
313
|
$ref: '#/components/schemas/Erro-v2'
|
|
314
|
security:
|
|
315
|
- OAuth2:
|
|
316
|
- cobrancas.boletos-info
|
|
317
|
operationId: listaBoletosId
|
|
318
|
tags:
|
|
319
|
- boletos
|
|
320
|
post:
|
|
321
|
summary: Registra Boleto de Cobrança
|
|
322
|
description: 'Permite incluir um novo boleto de cobrança '
|
|
323
|
parameters:
|
|
324
|
- name: gw-dev-app-key
|
|
325
|
in: query
|
|
326
|
description: >-
|
|
327
|
É a chave de acesso do aplicativo do desenvolvedor utilizada em
|
|
328
|
produção, obtida no Portal do Desenvolvedor. Essa chave será usada
|
|
329
|
para identificação do aplicativo.
|
|
330
|
|
|
331
|
|
|
332
|
Para os testes em ambiente de homologação, trocar por gw-app-key.
|
|
333
|
|
|
334
|
|
|
335
|
Ex: 0021239456d80136bebf005056891bed.
|
|
336
|
|
|
337
|
CAMPO OBRIGATÓRIO.
|
|
338
|
required: true
|
|
339
|
schema:
|
|
340
|
type: string
|
|
341
|
- name: Authorization
|
|
342
|
in: header
|
|
343
|
description: |-
|
|
344
|
É um "token" de acesso fornecido pelo OAuth 2.0.
|
|
345
|
Ex: Bearer [ACCESS_TOKEN]
|
|
346
|
required: true
|
|
347
|
schema:
|
|
348
|
type: string
|
|
349
|
requestBody:
|
|
350
|
content:
|
|
351
|
application/json:
|
|
352
|
schema:
|
|
353
|
$ref: '#/components/schemas/RequisicaoRegistroBoletos'
|
|
354
|
required: true
|
|
355
|
responses:
|
|
356
|
'201':
|
|
357
|
description: >-
|
|
358
|
CRIADO. A solicitação foi atendida e resultou em um novo recurso
|
|
359
|
sendo criado.
|
|
360
|
content:
|
|
361
|
application/json:
|
|
362
|
schema:
|
|
363
|
$ref: '#/components/schemas/RespostaRegistroBoletos'
|
|
364
|
'400':
|
|
365
|
description: >-
|
|
366
|
REQUISIÇÃO INVÁLIDA. O servidor não pôde processar a requisição
|
|
367
|
devido a uma sintaxe de requisição malformada, estrutura da mensagem
|
|
368
|
da requisição inválida, ou valores inválidos.
|
|
369
|
content:
|
|
370
|
application/json:
|
|
371
|
schema:
|
|
372
|
$ref: '#/components/schemas/Erro-v4'
|
|
373
|
'401':
|
|
374
|
description: NÃO AUTORIZADO. A requisição requer autenticação do usuário.
|
|
375
|
content:
|
|
376
|
application/json:
|
|
377
|
schema:
|
|
378
|
$ref: '#/components/schemas/ErroOAuthNaoAutorizado'
|
|
379
|
'500':
|
|
380
|
description: >-
|
|
381
|
ERRO INTERNO. O servidor encontrou uma condição inesperada que o
|
|
382
|
impediu de atender a requisição.
|
|
383
|
content:
|
|
384
|
application/json:
|
|
385
|
schema:
|
|
386
|
$ref: '#/components/schemas/Erro-v4'
|
|
387
|
application/xml:
|
|
388
|
schema:
|
|
389
|
type: object
|
|
390
|
properties: {}
|
|
391
|
'503':
|
|
392
|
description: >
|
|
393
|
SERVIÇO INDISPONÍVEL. O servidor está impossibilitado de lidar com a
|
|
394
|
requisição no momento. Tente mais tarde.
|
|
395
|
content:
|
|
396
|
application/json:
|
|
397
|
schema:
|
|
398
|
$ref: '#/components/schemas/Erro-v4'
|
|
399
|
examples:
|
|
400
|
example-1:
|
|
401
|
value: {}
|
|
402
|
security:
|
|
403
|
- OAuth2:
|
|
404
|
- cobrancas.boletos-requisicao
|
|
405
|
x-codegen-request-body-name: body
|
|
406
|
operationId: incluiBoletoBancarioId
|
|
407
|
tags:
|
|
408
|
- boletos
|
|
409
|
/boletos/{id}:
|
|
410
|
get:
|
|
411
|
summary: Detalha um boleto bancário
|
|
412
|
description: Consulta detalhes de um boleto bancário.
|
|
413
|
parameters:
|
|
414
|
- name: id
|
|
415
|
in: path
|
|
416
|
description: Número do título de cobrança.
|
|
417
|
required: true
|
|
418
|
schema:
|
|
419
|
type: string
|
|
420
|
- name: gw-dev-app-key
|
|
421
|
in: query
|
|
422
|
description: >
|
|
423
|
É a chave de acesso do aplicativo do desenvolvedor utilizada em
|
|
424
|
produção, obtida no Portal do Desenvolvedor. Essa chave será usada
|
|
425
|
para identificação do aplicativo.
|
|
426
|
|
|
427
|
|
|
428
|
Para os testes em ambiente de homologação, trocar por gw-app-key.
|
|
429
|
|
|
430
|
|
|
431
|
Ex: 0021239456d80136bebf005056891bed.
|
|
432
|
|
|
433
|
CAMPO OBRIGATÓRIO.
|
|
434
|
required: true
|
|
435
|
schema:
|
|
436
|
type: string
|
|
437
|
- name: Authorization
|
|
438
|
in: header
|
|
439
|
description: |-
|
|
440
|
É um “token” de acesso fornecido pelo OAuth 2.0.
|
|
441
|
|
|
442
|
|
|
443
|
|
|
444
|
Example: Bearer [ACCESS_TOKEN]
|
|
445
|
required: true
|
|
446
|
schema:
|
|
447
|
type: string
|
|
448
|
- name: numeroConvenio
|
|
449
|
in: query
|
|
450
|
description: Número do convênio.
|
|
451
|
required: true
|
|
452
|
schema:
|
|
453
|
type: number
|
|
454
|
responses:
|
|
455
|
'200':
|
|
456
|
description: SUCESSO. A requisição foi atendida e resultou em resposta.
|
|
457
|
content:
|
|
458
|
application/json:
|
|
459
|
schema:
|
|
460
|
$ref: '#/components/schemas/RespostaDetalhamentoBoleto'
|
|
461
|
'400':
|
|
462
|
description: >-
|
|
463
|
REQUISIÇÃO INVÁLIDA. O servidor não pôde processar a requisição
|
|
464
|
devido a uma sintaxe de requisição malformada, estrutura da mensagem
|
|
465
|
da requisição inválida, ou valores inválidos.
|
|
466
|
content:
|
|
467
|
application/json:
|
|
468
|
schema:
|
|
469
|
$ref: '#/components/schemas/Erro'
|
|
470
|
'401':
|
|
471
|
description: NÃO AUTORIZADO. A requisição requer autenticação do usuário.
|
|
472
|
content:
|
|
473
|
application/json:
|
|
474
|
schema:
|
|
475
|
$ref: '#/components/schemas/ErroOAuthNaoAutorizado'
|
|
476
|
'404':
|
|
477
|
description: >-
|
|
478
|
NÃO ENCONTRADO. O servidor não conseguiu encontrar o recurso
|
|
479
|
solicitado.
|
|
480
|
content: {}
|
|
481
|
'500':
|
|
482
|
description: >-
|
|
483
|
ERRO INTERNO. O servidor encontrou uma condição inesperada que o
|
|
484
|
impediu de atender a requisição.
|
|
485
|
content:
|
|
486
|
application/json:
|
|
487
|
schema:
|
|
488
|
$ref: '#/components/schemas/Erro'
|
|
489
|
security:
|
|
490
|
- OAuth2:
|
|
491
|
- cobrancas.boletos-info
|
|
492
|
operationId: detalhaBoletoBancarioId
|
|
493
|
tags:
|
|
494
|
- boletos
|
|
495
|
patch:
|
|
496
|
summary: Altera um boleto bancário
|
|
497
|
description: >-
|
|
498
|
Realiza alterações nos valores dos campos presentes em um boleto
|
|
499
|
bancário já criado.
|
|
500
|
parameters:
|
|
501
|
- name: id
|
|
502
|
in: path
|
|
503
|
description: Número do título de cobrança.
|
|
504
|
required: true
|
|
505
|
schema:
|
|
506
|
type: string
|
|
507
|
- name: gw-dev-app-key
|
|
508
|
in: query
|
|
509
|
description: >-
|
|
510
|
É a chave de acesso do aplicativo do desenvolvedor utilizada em
|
|
511
|
produção, obtida no Portal do Desenvolvedor. Essa chave será usada
|
|
512
|
para identificação do aplicativo.
|
|
513
|
|
|
514
|
|
|
515
|
Para os testes em ambiente de homologação, trocar por gw-app-key.
|
|
516
|
|
|
517
|
|
|
518
|
Ex: 0021239456d80136bebf005056891bed.
|
|
519
|
|
|
520
|
CAMPO OBRIGATÓRIO.
|
|
521
|
required: true
|
|
522
|
schema:
|
|
523
|
type: string
|
|
524
|
- name: Authorization
|
|
525
|
in: header
|
|
526
|
description: |-
|
|
527
|
É um “token” de acesso fornecido pelo OAuth 2.0.
|
|
528
|
|
|
529
|
|
|
530
|
|
|
531
|
Example: Bearer [ACCESS_TOKEN]
|
|
532
|
required: true
|
|
533
|
schema:
|
|
534
|
type: string
|
|
535
|
requestBody:
|
|
536
|
description: >-
|
|
537
|
Representação dos campos de requisição de uma solicitação de alteração
|
|
538
|
dos dados de boletos bancários.
|
|
539
|
content:
|
|
540
|
application/json:
|
|
541
|
schema:
|
|
542
|
$ref: '#/components/schemas/RequisicaoAlterarBoleto'
|
|
543
|
required: true
|
|
544
|
responses:
|
|
545
|
'200':
|
|
546
|
description: SUCESSO. A requisição foi atendida e resultou em resposta.
|
|
547
|
content:
|
|
548
|
application/json:
|
|
549
|
schema:
|
|
550
|
$ref: '#/components/schemas/RespostaAlterarBoleto'
|
|
551
|
'400':
|
|
552
|
description: >-
|
|
553
|
REQUISIÇÃO INVÁLIDA. O servidor não pôde processar a requisição
|
|
554
|
devido a uma sintaxe de requisição malformada, estrutura da mensagem
|
|
555
|
da requisição inválida, ou valores inválidos.
|
|
556
|
content:
|
|
557
|
application/json:
|
|
558
|
schema:
|
|
559
|
$ref: '#/components/schemas/Erro'
|
|
560
|
'401':
|
|
561
|
description: NÃO AUTORIZADO. A requisição requer autenticação do usuário.
|
|
562
|
content:
|
|
563
|
application/json:
|
|
564
|
schema:
|
|
565
|
$ref: '#/components/schemas/ErroOAuthNaoAutorizado'
|
|
566
|
'403':
|
|
567
|
description: >-
|
|
568
|
PROIBIDO. A requisição foi válida, mas o servidor está recusando a
|
|
569
|
ação. O usuário pode não ter as permissões necessárias para um
|
|
570
|
recurso ou pode precisar de uma conta de algum tipo.
|
|
571
|
content:
|
|
572
|
application/json:
|
|
573
|
schema:
|
|
574
|
$ref: '#/components/schemas/Erro'
|
|
575
|
'404':
|
|
576
|
description: >-
|
|
577
|
NÃO ENCONTRADO. O servidor não conseguiu encontrar o recurso
|
|
578
|
solicitado.
|
|
579
|
content: {}
|
|
580
|
'500':
|
|
581
|
description: >-
|
|
582
|
ERRO INTERNO. O servidor encontrou uma condição inesperada que o
|
|
583
|
impediu de atender a requisição.
|
|
584
|
content:
|
|
585
|
application/json:
|
|
586
|
schema:
|
|
587
|
$ref: '#/components/schemas/Erro'
|
|
588
|
security:
|
|
589
|
- OAuth2:
|
|
590
|
- cobrancas.boletos-requisicao
|
|
591
|
x-codegen-request-body-name: body
|
|
592
|
operationId: alteraBoletoBancarioId
|
|
593
|
tags:
|
|
594
|
- boletos
|
|
595
|
/boletos/{id}/baixar:
|
|
596
|
post:
|
|
597
|
summary: Permitir a baixa/cancelamento de um título de cobrança.
|
|
598
|
description: Permite a baixa/cancelamento de um título de cobrança.
|
|
599
|
parameters:
|
|
600
|
- name: id
|
|
601
|
in: path
|
|
602
|
description: >-
|
|
603
|
Número do boleto bancário (único e exclusivo) que identifica o
|
|
604
|
título e é usado para pagá-lo.
|
|
605
|
required: true
|
|
606
|
schema:
|
|
607
|
type: string
|
|
608
|
- name: gw-dev-app-key
|
|
609
|
in: query
|
|
610
|
description: >-
|
|
611
|
É a chave de acesso do aplicativo do desenvolvedor utilizada em
|
|
612
|
produção, obtida no Portal do Desenvolvedor. Essa chave será usada
|
|
613
|
para identificação do aplicativo.
|
|
614
|
|
|
615
|
|
|
616
|
Para os testes em ambiente de homologação, trocar por gw-app-key.
|
|
617
|
|
|
618
|
|
|
619
|
Ex: 0021239456d80136bebf005056891bed.
|
|
620
|
|
|
621
|
CAMPO OBRIGATÓRIO.
|
|
622
|
required: true
|
|
623
|
schema:
|
|
624
|
type: string
|
|
625
|
- name: Authorization
|
|
626
|
in: header
|
|
627
|
description: |-
|
|
628
|
É um "token" de acesso fornecido pelo OAuth 2.0.
|
|
629
|
Ex: Bearer [ACCESS_TOKEN]
|
|
630
|
required: true
|
|
631
|
schema:
|
|
632
|
type: string
|
|
633
|
requestBody:
|
|
634
|
content:
|
|
635
|
application/json:
|
|
636
|
schema:
|
|
637
|
$ref: '#/components/schemas/RequisicaoBaixaBoleto'
|
|
638
|
required: true
|
|
639
|
responses:
|
|
640
|
'200':
|
|
641
|
description: SUCESSO. A requisição foi atendida e resultou em resposta.
|
|
642
|
content:
|
|
643
|
application/json:
|
|
644
|
schema:
|
|
645
|
$ref: '#/components/schemas/RespostaBaixaBoleto'
|
|
646
|
'400':
|
|
647
|
description: >-
|
|
648
|
SOLICITAÇÃO INCORRETA. O servidor não pode ou não processará a
|
|
649
|
solicitação devido a algo que parece ser um erro do lado cliente
|
|
650
|
(por exemplo, sintaxe malformada, quadro de mensagem inválida ou
|
|
651
|
roteamento de solicitação fraudulenta).
|
|
652
|
content:
|
|
653
|
application/json:
|
|
654
|
schema:
|
|
655
|
$ref: '#/components/schemas/Erro'
|
|
656
|
'401':
|
|
657
|
description: >-
|
|
658
|
NÃO AUTORIZADO. A requisição requer autenticação do usuário. Repita
|
|
659
|
a requisição com um campo do header de autorização.
|
|
660
|
content:
|
|
661
|
application/json:
|
|
662
|
schema:
|
|
663
|
$ref: '#/components/schemas/ErroOAuthNaoAutorizado'
|
|
664
|
'403':
|
|
665
|
description: >-
|
|
666
|
PROIBIDO. A requisição foi válida, mas o servidor está recusando a
|
|
667
|
ação. O usuário pode não ter as permissões necessárias para um
|
|
668
|
recurso ou pode precisar de uma conta de algum tipo.
|
|
669
|
content:
|
|
670
|
application/json:
|
|
671
|
schema:
|
|
672
|
$ref: '#/components/schemas/Erro'
|
|
673
|
'500':
|
|
674
|
description: >-
|
|
675
|
ERRO INTERNO. O servidor encontrou uma condição inesperada que
|
|
676
|
impediu o cumprimento da solicitação.
|
|
677
|
content:
|
|
678
|
application/json:
|
|
679
|
schema:
|
|
680
|
$ref: '#/components/schemas/Erro'
|
|
681
|
security:
|
|
682
|
- OAuth2:
|
|
683
|
- cobrancas.boletos-requisicao
|
|
684
|
x-codegen-request-body-name: body
|
|
685
|
operationId: permitirBaixaCancelamentoId
|
|
686
|
tags:
|
|
687
|
- boletos
|
|
688
|
/boletos/{id}/cancelar-pix:
|
|
689
|
parameters:
|
|
690
|
- schema:
|
|
691
|
type: string
|
|
692
|
name: id
|
|
693
|
in: path
|
|
694
|
required: true
|
|
695
|
description: >-
|
|
696
|
Número de identificação do boleto (correspondente ao NOSSO NÚMERO,
|
|
697
|
numeroTituloCliente), no formato STRING, com 20 dígitos, que deverá
|
|
698
|
ser formatado da seguinte forma: “000” + (número do convênio com 7
|
|
699
|
dígitos) + (10 algarismos - se necessário, completar com zeros à
|
|
700
|
esquerda). Campo Obrigatório.
|
|
701
|
post:
|
|
702
|
summary: Cancelar Pix de Boleto
|
|
703
|
operationId: cancelarPixBoletoId
|
|
704
|
responses:
|
|
705
|
'200':
|
|
706
|
description: SUCESSO. A requisição foi atendida e resultou em resposta.
|
|
707
|
content:
|
|
708
|
application/json:
|
|
709
|
schema:
|
|
710
|
type: object
|
|
711
|
properties:
|
|
712
|
pix:
|
|
713
|
type: object
|
|
714
|
properties:
|
|
715
|
chave:
|
|
716
|
type: string
|
|
717
|
description: Código chave do pagador do Pix.
|
|
718
|
qrCode:
|
|
719
|
type: object
|
|
720
|
properties:
|
|
721
|
url:
|
|
722
|
type: string
|
|
723
|
description: URL do payload do QR Code Pix.
|
|
724
|
txId:
|
|
725
|
type: string
|
|
726
|
description: Código que identifica a transação Pix - transactionID.
|
|
727
|
emv:
|
|
728
|
type: string
|
|
729
|
description: >-
|
|
730
|
BR Code no padrão EMV. Sequência de caracteres
|
|
731
|
correspondente ao payload do QR Code Pix.
|
|
732
|
'400':
|
|
733
|
description: >-
|
|
734
|
REQUISIÇÃO INVÁLIDA. O servidor não pôde processar a requisição
|
|
735
|
devido a uma sintaxe de requisição malformada, estrutura da mensagem
|
|
736
|
da requisição inválida, ou valores inválidos.
|
|
737
|
content:
|
|
738
|
application/json:
|
|
739
|
schema:
|
|
740
|
$ref: '#/components/schemas/Erro-v4'
|
|
741
|
'401':
|
|
742
|
description: NÃO AUTORIZADO. A requisição requer autenticação do usuário.
|
|
743
|
content:
|
|
744
|
application/json:
|
|
745
|
schema:
|
|
746
|
$ref: '#/components/schemas/ErroOAuthNaoAutorizado'
|
|
747
|
'403':
|
|
748
|
description: >-
|
|
749
|
PROIBIDO. A requisição foi válida, mas o servidor está recusando a
|
|
750
|
ação. O usuário pode não ter as permissões necessárias para um
|
|
751
|
recurso ou pode precisar de uma conta de algum tipo.
|
|
752
|
content:
|
|
753
|
application/json:
|
|
754
|
schema:
|
|
755
|
$ref: '#/components/schemas/Erro-v4'
|
|
756
|
'404':
|
|
757
|
description: >-
|
|
758
|
NÃO ENCONTRADO. O servidor não conseguiu encontrar o recurso
|
|
759
|
solicitado.
|
|
760
|
'500':
|
|
761
|
description: >-
|
|
762
|
ERRO INTERNO. O servidor encontrou uma condição inesperada que o
|
|
763
|
impediu de atender a requisição.
|
|
764
|
content:
|
|
765
|
application/json:
|
|
766
|
schema:
|
|
767
|
$ref: '#/components/schemas/Erro-v4'
|
|
768
|
tags:
|
|
769
|
- boletos
|
|
770
|
description: Cancelar Pix vinculado a um boleto de cobrança existente.
|
|
771
|
security:
|
|
772
|
- OAuth2:
|
|
773
|
- cobrancas.boletos-requisicao
|
|
774
|
parameters:
|
|
775
|
- schema:
|
|
776
|
type: string
|
|
777
|
in: header
|
|
778
|
name: Authorization
|
|
779
|
description: >-
|
|
780
|
É um “token” de acesso fornecido pelo OAuth 2.0.Example: Bearer
|
|
781
|
[ACCESS_TOKEN]
|
|
782
|
required: true
|
|
783
|
- schema:
|
|
784
|
type: string
|
|
785
|
in: query
|
|
786
|
name: gw-dev-app-key
|
|
787
|
description: >-
|
|
788
|
É a chave de acesso do aplicativo do desenvolvedor utilizada em
|
|
789
|
produção, obtida no Portal do Desenvolvedor. Essa chave será usada
|
|
790
|
para identificação do aplicativo.Para os testes em ambiente de
|
|
791
|
homologação, trocar por gw-app-key. Ex:
|
|
792
|
0021239456d80136bebf005056891bed. CAMPO OBRIGATÓRIO.
|
|
793
|
required: true
|
|
794
|
requestBody:
|
|
795
|
content:
|
|
796
|
application/json:
|
|
797
|
schema:
|
|
798
|
type: object
|
|
799
|
properties:
|
|
800
|
numeroConvenio:
|
|
801
|
type: integer
|
|
802
|
format: int32
|
|
803
|
description: Número do convênio de Cobrança do Cliente.
|
|
804
|
required:
|
|
805
|
- numeroConvenio
|
|
806
|
/boletos/{id}/gerar-pix:
|
|
807
|
parameters:
|
|
808
|
- schema:
|
|
809
|
type: string
|
|
810
|
name: id
|
|
811
|
in: path
|
|
812
|
required: true
|
|
813
|
description: >-
|
|
814
|
Número de identificação do boleto (correspondente ao NOSSO NÚMERO,
|
|
815
|
numeroTituloCliente), no formato STRING, com 20 dígitos, que deverá
|
|
816
|
ser formatado da seguinte forma: “000” + (número do convênio com 7
|
|
817
|
dígitos) + (10 algarismos - se necessário, completar com zeros à
|
|
818
|
esquerda). Campo Obrigatório.
|
|
819
|
post:
|
|
820
|
summary: Gerar Pix de Boleto
|
|
821
|
operationId: gerarPixBoletoId
|
|
822
|
responses:
|
|
823
|
'200':
|
|
824
|
description: SUCESSO. A requisição foi atendida e resultou em resposta.
|
|
825
|
content:
|
|
826
|
application/json:
|
|
827
|
schema:
|
|
828
|
type: object
|
|
829
|
properties:
|
|
830
|
pix:
|
|
831
|
type: object
|
|
832
|
properties:
|
|
833
|
chave:
|
|
834
|
type: string
|
|
835
|
description: Código chave do pagador do Pix.
|
|
836
|
qrCode:
|
|
837
|
type: object
|
|
838
|
properties:
|
|
839
|
url:
|
|
840
|
type: string
|
|
841
|
description: URL do payload do QR Code Pix.
|
|
842
|
txId:
|
|
843
|
type: string
|
|
844
|
description: Código que identifica a transação Pix - transactionID.
|
|
845
|
emv:
|
|
846
|
type: string
|
|
847
|
description: >-
|
|
848
|
BR Code no padrão EMV. Sequência de caracteres
|
|
849
|
correspondente ao payload do QR Code Pix.
|
|
850
|
'400':
|
|
851
|
description: >-
|
|
852
|
REQUISIÇÃO INVÁLIDA. O servidor não pôde processar a requisição
|
|
853
|
devido a uma sintaxe de requisição malformada, estrutura da mensagem
|
|
854
|
da requisição inválida, ou valores inválidos.
|
|
855
|
content:
|
|
856
|
application/json:
|
|
857
|
schema:
|
|
858
|
$ref: '#/components/schemas/Erro-v4'
|
|
859
|
'401':
|
|
860
|
description: NÃO AUTORIZADO. A requisição requer autenticação do usuário.
|
|
861
|
content:
|
|
862
|
application/json:
|
|
863
|
schema:
|
|
864
|
$ref: '#/components/schemas/ErroOAuthNaoAutorizado'
|
|
865
|
'403':
|
|
866
|
description: >-
|
|
867
|
PROIBIDO. A requisição foi válida, mas o servidor está recusando a
|
|
868
|
ação. O usuário pode não ter as permissões necessárias para um
|
|
869
|
recurso ou pode precisar de uma conta de algum tipo.
|
|
870
|
content:
|
|
871
|
application/json:
|
|
872
|
schema:
|
|
873
|
$ref: '#/components/schemas/Erro-v4'
|
|
874
|
'404':
|
|
875
|
description: >-
|
|
876
|
NÃO ENCONTRADO. O servidor não conseguiu encontrar o recurso
|
|
877
|
solicitado.
|
|
878
|
'500':
|
|
879
|
description: >-
|
|
880
|
ERRO INTERNO. O servidor encontrou uma condição inesperada que o
|
|
881
|
impediu de atender a requisição.
|
|
882
|
content:
|
|
883
|
application/json:
|
|
884
|
schema:
|
|
885
|
$ref: '#/components/schemas/Erro-v4'
|
|
886
|
tags:
|
|
887
|
- boletos
|
|
888
|
description: >-
|
|
889
|
Gerar Pix vinculado a um boleto de cobrança através de um QRCode
|
|
890
|
Dinâmico ou Estático.
|
|
891
|
security:
|
|
892
|
- OAuth2:
|
|
893
|
- cobrancas.boletos-requisicao
|
|
894
|
parameters:
|
|
895
|
- schema:
|
|
896
|
type: string
|
|
897
|
in: header
|
|
898
|
name: Authorization
|
|
899
|
description: >-
|
|
900
|
É um “token” de acesso fornecido pelo OAuth 2.0.Example: Bearer
|
|
901
|
[ACCESS_TOKEN]
|
|
902
|
required: true
|
|
903
|
- schema:
|
|
904
|
type: string
|
|
905
|
in: query
|
|
906
|
name: gw-dev-app-key
|
|
907
|
description: >-
|
|
908
|
É a chave de acesso do aplicativo do desenvolvedor utilizada em
|
|
909
|
produção, obtida no Portal do Desenvolvedor. Essa chave será usada
|
|
910
|
para identificação do aplicativo.Para os testes em ambiente de
|
|
911
|
homologação, trocar por gw-app-key. Ex:
|
|
912
|
0021239456d80136bebf005056891bed. CAMPO OBRIGATÓRIO.
|
|
913
|
required: true
|
|
914
|
requestBody:
|
|
915
|
content:
|
|
916
|
application/json:
|
|
917
|
schema:
|
|
918
|
type: object
|
|
919
|
properties:
|
|
920
|
numeroConvenio:
|
|
921
|
type: integer
|
|
922
|
format: int32
|
|
923
|
description: Número do convênio de Cobrança do Cliente.
|
|
924
|
required:
|
|
925
|
- numeroConvenio
|
|
926
|
/boletos/{id}/pix:
|
|
927
|
get:
|
|
928
|
summary: Consultar Pix de Boleto
|
|
929
|
description: Consultar os dados de um Pix vinculado a um boleto de cobrança.
|
|
930
|
parameters:
|
|
931
|
- name: id
|
|
932
|
in: path
|
|
933
|
description: >-
|
|
934
|
Número de identificação do boleto (correspondente ao NOSSO NÚMERO,
|
|
935
|
numeroTituloCliente), no formato STRING, com 20 dígitos, que deverá
|
|
936
|
ser formatado da seguinte forma: “000” + (número do convênio com 7
|
|
937
|
dígitos) + (10 algarismos - se necessário, completar com zeros à
|
|
938
|
esquerda). Campo Obrigatório.
|
|
939
|
required: true
|
|
940
|
schema:
|
|
941
|
type: string
|
|
942
|
- name: gw-dev-app-key
|
|
943
|
in: query
|
|
944
|
description: >
|
|
945
|
É a chave de acesso do aplicativo do desenvolvedor utilizada em
|
|
946
|
produção, obtida no Portal do Desenvolvedor. Essa chave será usada
|
|
947
|
para identificação do aplicativo.
|
|
948
|
|
|
949
|
|
|
950
|
Para os testes em ambiente de homologação, trocar por gw-app-key.
|
|
951
|
|
|
952
|
|
|
953
|
Ex: 0021239456d80136bebf005056891bed.
|
|
954
|
|
|
955
|
CAMPO OBRIGATÓRIO.
|
|
956
|
required: true
|
|
957
|
schema:
|
|
958
|
type: string
|
|
959
|
- name: Authorization
|
|
960
|
in: header
|
|
961
|
description: |-
|
|
962
|
É um “token” de acesso fornecido pelo OAuth 2.0.
|
|
963
|
|
|
964
|
|
|
965
|
|
|
966
|
Example: Bearer [ACCESS_TOKEN]
|
|
967
|
required: true
|
|
968
|
schema:
|
|
969
|
type: string
|
|
970
|
- name: numeroConvenio
|
|
971
|
in: query
|
|
972
|
description: Número do convênio de Cobrança do Cliente
|
|
973
|
required: true
|
|
974
|
schema:
|
|
975
|
type: number
|
|
976
|
responses:
|
|
977
|
'200':
|
|
978
|
description: SUCESSO. A requisição foi atendida e resultou em resposta.
|
|
979
|
content:
|
|
980
|
application/json:
|
|
981
|
schema:
|
|
982
|
$ref: '#/components/schemas/RespostaConsultaPixBoleto'
|
|
983
|
'400':
|
|
984
|
description: >-
|
|
985
|
REQUISIÇÃO INVÁLIDA. O servidor não pôde processar a requisição
|
|
986
|
devido a uma sintaxe de requisição malformada, estrutura da mensagem
|
|
987
|
da requisição inválida, ou valores inválidos.
|
|
988
|
content:
|
|
989
|
application/json:
|
|
990
|
schema:
|
|
991
|
$ref: '#/components/schemas/Erro-v4'
|
|
992
|
'401':
|
|
993
|
description: NÃO AUTORIZADO. A requisição requer autenticação do usuário.
|
|
994
|
content:
|
|
995
|
application/json:
|
|
996
|
schema:
|
|
997
|
$ref: '#/components/schemas/ErroOAuthNaoAutorizado'
|
|
998
|
'404':
|
|
999
|
description: >-
|
|
1000
|
NÃO ENCONTRADO. O servidor não conseguiu encontrar o recurso
|
|
1001
|
solicitado.
|
|
1002
|
content: {}
|
|
1003
|
'500':
|
|
1004
|
description: >-
|
|
1005
|
ERRO INTERNO. O servidor encontrou uma condição inesperada que o
|
|
1006
|
impediu de atender a requisição.
|
|
1007
|
content:
|
|
1008
|
application/json:
|
|
1009
|
schema:
|
|
1010
|
$ref: '#/components/schemas/Erro-v4'
|
|
1011
|
security:
|
|
1012
|
- OAuth2:
|
|
1013
|
- cobrancas.boletos-info
|
|
1014
|
operationId: consultarPixBoletoId
|
|
1015
|
tags:
|
|
1016
|
- boletos
|
|
1017
|
/convenios/{id}/listar-retorno-movimento:
|
|
1018
|
parameters:
|
|
1019
|
- schema:
|
|
1020
|
type: string
|
|
1021
|
example: '1234567'
|
|
1022
|
name: id
|
|
1023
|
in: path
|
|
1024
|
required: true
|
|
1025
|
description: >-
|
|
1026
|
Número identificador do convênio de intercambio de dados em meio
|
|
1027
|
eletrônico, pelo qual serão fornecidos os dados dos títulos de um ou
|
|
1028
|
mais serviços de cobrança contratados.
|
|
1029
|
post:
|
|
1030
|
summary: Listar Dados do Retorno do Convênio
|
|
1031
|
operationId: post-convenios-id-listar-retorno-movimento
|
|
1032
|
responses:
|
|
1033
|
'200':
|
|
1034
|
description: SUCESSO. A requisição foi atendida e resultou em resposta.
|
|
1035
|
content:
|
|
1036
|
application/json:
|
|
1037
|
schema:
|
|
1038
|
type: object
|
|
1039
|
properties:
|
|
1040
|
indicadorContinuidade:
|
|
1041
|
type: string
|
|
1042
|
enum:
|
|
1043
|
- S
|
|
1044
|
- 'N'
|
|
1045
|
example: S
|
|
1046
|
description: >-
|
|
1047
|
Indicador de continuidade para informar que a pesquisa
|
|
1048
|
possui mais registros a apresentar
|
|
1049
|
|
|
1050
|
S-Sim, N-Não
|
|
1051
|
numeroUltimoRegistro:
|
|
1052
|
type: integer
|
|
1053
|
example: 8900
|
|
1054
|
format: int64
|
|
1055
|
description: Numero do ultimo registro da consulta
|
|
1056
|
listaRegistro:
|
|
1057
|
type: array
|
|
1058
|
items:
|
|
1059
|
type: object
|
|
1060
|
properties:
|
|
1061
|
dataMovimentoRetorno:
|
|
1062
|
type: string
|
|
1063
|
description: >-
|
|
1064
|
Data do processamento do movimento de retorno de
|
|
1065
|
cobrança de Boleto.
|
|
1066
|
example: 24.03.2022
|
|
1067
|
numeroConvenio:
|
|
1068
|
type: integer
|
|
1069
|
description: Número do convênio de Cobrança do Cliente
|
|
1070
|
format: int64
|
|
1071
|
example: 1234567
|
|
1072
|
numeroTituloCobranca:
|
|
1073
|
type: string
|
|
1074
|
description: Nosso Número
|
|
1075
|
example: '00012345670000000001'
|
|
1076
|
codigoComandoAcao:
|
|
1077
|
type: integer
|
|
1078
|
description: >-
|
|
1079
|
Tipo de ação ou comando que o boleto sofre.
|
|
1080
|
|
|
1081
|
"COMANDO
|
|
1082
|
|
|
1083
|
02 - Confirmação de Entrada de Boleto
|
|
1084
|
|
|
1085
|
03 - Comando recusado (Motivo indicado na posição
|
|
1086
|
087/088)
|
|
1087
|
|
|
1088
|
05 - Liquidado sem registro (carteira 17-tipo4)
|
|
1089
|
|
|
1090
|
06 - Liquidação Normal
|
|
1091
|
|
|
1092
|
07 - Liquidação por Conta/Parcial
|
|
1093
|
|
|
1094
|
08 - Liquidação por Saldo
|
|
1095
|
|
|
1096
|
09 - Baixa de Titulo
|
|
1097
|
|
|
1098
|
10 - Baixa Solicitada
|
|
1099
|
|
|
1100
|
11 - Boletos em Ser (constara somente do arquivo de
|
|
1101
|
existência de cobrança, fornecido mediante
|
|
1102
|
solicitação do cliente)
|
|
1103
|
|
|
1104
|
12 - Abatimento Concedido
|
|
1105
|
|
|
1106
|
13 - Abatimento Cancelado
|
|
1107
|
|
|
1108
|
14 - Alteração de Vencimento do boleto
|
|
1109
|
|
|
1110
|
15 - Liquidação em Cartório
|
|
1111
|
|
|
1112
|
16 - Confirmação de alteração de juros de mora
|
|
1113
|
|
|
1114
|
19 - Confirmação de recebimento de instruções para
|
|
1115
|
protesto
|
|
1116
|
|
|
1117
|
20 - Débito em Conta
|
|
1118
|
|
|
1119
|
21 - Alteração do Nome do Sacado
|
|
1120
|
|
|
1121
|
22 - Alteração do Endereço do Sacado
|
|
1122
|
|
|
1123
|
23 - Indicação de encaminhamento a cartório
|
|
1124
|
|
|
1125
|
24 - Sustar Protesto
|
|
1126
|
|
|
1127
|
25 - Dispensar Juros de mora
|
|
1128
|
|
|
1129
|
26 - Alteração do número do boleto dado pelo Cedente
|
|
1130
|
(Seu número) – 10 e 15 posições
|
|
1131
|
|
|
1132
|
28 - Manutenção de titulo vencido
|
|
1133
|
|
|
1134
|
31 - Conceder desconto
|
|
1135
|
|
|
1136
|
32 - Não conceder desconto
|
|
1137
|
|
|
1138
|
33 - Retificar desconto
|
|
1139
|
|
|
1140
|
34 - Alterar data para desconto
|
|
1141
|
|
|
1142
|
35 - Cobrar Multa
|
|
1143
|
|
|
1144
|
36 - Dispensar Multa
|
|
1145
|
|
|
1146
|
37 - Dispensar Indexador
|
|
1147
|
|
|
1148
|
38 - Dispensar prazo limite para recebimento
|
|
1149
|
|
|
1150
|
39 - Alterar prazo limite para recebimento
|
|
1151
|
|
|
1152
|
41 - Alteração do número do controle do participante
|
|
1153
|
(25 posições)
|
|
1154
|
|
|
1155
|
42 - Alteração do número do documento do sacado
|
|
1156
|
(CNPJ/CPF)
|
|
1157
|
|
|
1158
|
44 - Boleto pago com cheque devolvido
|
|
1159
|
|
|
1160
|
46 - Boleto pago com cheque, aguardando compensação
|
|
1161
|
|
|
1162
|
61-Registrado QR Code Pix
|
|
1163
|
|
|
1164
|
72- Alteração de tipo de cobrança (específico para
|
|
1165
|
boletos das carteiras 11 e 17)
|
|
1166
|
|
|
1167
|
73 - Confirmação de Instrução de Parâmetro de
|
|
1168
|
Pagamento Parcial
|
|
1169
|
|
|
1170
|
85 - Inclusão de Negativação
|
|
1171
|
|
|
1172
|
86 - Exclusão de Negativação
|
|
1173
|
|
|
1174
|
93 - Baixa Operacional
|
|
1175
|
|
|
1176
|
96 - Despesas de Protesto
|
|
1177
|
|
|
1178
|
97 - Despesas de Sustação de Protesto
|
|
1179
|
|
|
1180
|
98 - Débito de Custas Antecipadas
|
|
1181
|
|
|
1182
|
|
|
1183
|
Observação:
|
|
1184
|
|
|
1185
|
Quando as posições 109-110 apresentarem
|
|
1186
|
“06”-Liquidação Normal e as posições 87-88
|
|
1187
|
apresentarem “03”-Liquidação por Saldo ou “11” –
|
|
1188
|
Liquidação por Saldo com Cheque a Compensar,
|
|
1189
|
significa que o valor residual foi liquidado
|
|
1190
|
totalmente."
|
|
1191
|
example: 2
|
|
1192
|
format: int32
|
|
1193
|
enum:
|
|
1194
|
- 2
|
|
1195
|
- 3
|
|
1196
|
- 5
|
|
1197
|
- 6
|
|
1198
|
- 7
|
|
1199
|
- 8
|
|
1200
|
- 9
|
|
1201
|
- 10
|
|
1202
|
- 11
|
|
1203
|
- 12
|
|
1204
|
- 13
|
|
1205
|
- 14
|
|
1206
|
codigoPrefixoAgencia:
|
|
1207
|
type: integer
|
|
1208
|
description: Agência do Beneficiário
|
|
1209
|
example: 1
|
|
1210
|
format: int32
|
|
1211
|
numeroContaCorrente:
|
|
1212
|
type: integer
|
|
1213
|
description: Conta Corrente do Beneficiário
|
|
1214
|
example: 123456789
|
|
1215
|
format: int64
|
|
1216
|
numeroCarteiraCobranca:
|
|
1217
|
type: integer
|
|
1218
|
description: Número da carteira do convênio de cobrança
|
|
1219
|
example: 17
|
|
1220
|
format: int32
|
|
1221
|
numeroVariacaoCarteiraCobranca:
|
|
1222
|
type: integer
|
|
1223
|
description: >-
|
|
1224
|
Número da variação da carteira do convênio de
|
|
1225
|
cobrança
|
|
1226
|
example: 35
|
|
1227
|
format: int32
|
|
1228
|
tipoCobranca:
|
|
1229
|
type: integer
|
|
1230
|
description: >-
|
|
1231
|
Código para identificar a característica dos boletos
|
|
1232
|
dentro das modalidades de cobrança existentes no
|
|
1233
|
banco
|
|
1234
|
|
|
1235
|
1 –Simples, 2-Vinculada, 4-Descontada, 7-Cobrança
|
|
1236
|
Simples Carteira 17, 8-Vendor
|
|
1237
|
example: 1
|
|
1238
|
format: int32
|
|
1239
|
enum:
|
|
1240
|
- 1
|
|
1241
|
- 2
|
|
1242
|
- 4
|
|
1243
|
- 7
|
|
1244
|
- 8
|
|
1245
|
codigoControleParticipante:
|
|
1246
|
type: string
|
|
1247
|
description: >-
|
|
1248
|
"Número de controle interno definido pelo
|
|
1249
|
Beneficiário.
|
|
1250
|
|
|
1251
|
Número adotado e controlado pelo Cliente, para
|
|
1252
|
identificar o título de cobrança. Para uso do Banco.
|
|
1253
|
Seu Número"
|
|
1254
|
example: A123456
|
|
1255
|
codigoEspecieBoleto:
|
|
1256
|
type: integer
|
|
1257
|
description: >-
|
|
1258
|
Código para identificar o tipo de boleto de cobrança
|
|
1259
|
(espécie)
|
|
1260
|
|
|
1261
|
"ESPÉCIE DO BOLETO: Esse campo será preenchido
|
|
1262
|
somente nas modalidades de Cobrança com Registro
|
|
1263
|
(Carteiras 11, 12, 17, 31 e 51)
|
|
1264
|
00 – informado nos registros com comando 97-Despesas de Sustação de Protesto nas posições 109/110 desde que o titulo não conste mais da existência
|
|
1265
|
01 – duplicata mercantil
|
|
1266
|
02 – nota promissória
|
|
1267
|
03 – nota de seguro
|
|
1268
|
05 – recibo
|
|
1269
|
08 – letra de câmbio
|
|
1270
|
09 – warrant
|
|
1271
|
10 – cheque
|
|
1272
|
12 – duplicata de serviço
|
|
1273
|
13 – nota de débito
|
|
1274
|
15 – apólice de seguro
|
|
1275
|
25 – dívida ativa da União
|
|
1276
|
26 – dívida ativa de Estado
|
|
1277
|
27 – dívida ativa de Município
|
|
1278
|
31 – Boleto de Cartão de Crédito
|
|
1279
|
32 – Boleto de Proposta
|
|
1280
|
|
|
1281
|
Para carteiras 16 e 18: Preenchido com zeros"
|
|
1282
|
example: 12
|
|
1283
|
format: int32
|
|
1284
|
enum:
|
|
1285
|
- 0
|
|
1286
|
- 1
|
|
1287
|
- 2
|
|
1288
|
- 3
|
|
1289
|
- 5
|
|
1290
|
- 8
|
|
1291
|
- 9
|
|
1292
|
- 10
|
|
1293
|
- 12
|
|
1294
|
- 13
|
|
1295
|
- 15
|
|
1296
|
- 25
|
|
1297
|
- 26
|
|
1298
|
- 27
|
|
1299
|
- 31
|
|
1300
|
- 32
|
|
1301
|
dataVencimentoBoleto:
|
|
1302
|
type: string
|
|
1303
|
description: Data de vencimento do boleto.
|
|
1304
|
example: 31.12.2022
|
|
1305
|
valorBoleto:
|
|
1306
|
type: number
|
|
1307
|
description: Valor do boleto no registro
|
|
1308
|
example: 100
|
|
1309
|
format: double
|
|
1310
|
codigoBancoRecebedor:
|
|
1311
|
type: integer
|
|
1312
|
description: >-
|
|
1313
|
Código ISPB da Instituição Financeira na qual o
|
|
1314
|
boleto foi pago.
|
|
1315
|
example: 237
|
|
1316
|
format: int32
|
|
1317
|
codigoPrefixoAgenciaRecebedora:
|
|
1318
|
type: integer
|
|
1319
|
description: >-
|
|
1320
|
Código do prefixo identificador de uma dependência
|
|
1321
|
da instituição financeira onde o boleto foi pago.
|
|
1322
|
example: 2
|
|
1323
|
format: int32
|
|
1324
|
dataCreditoPagamentoBoleto:
|
|
1325
|
type: string
|
|
1326
|
description: Data do crédito do pagamento do Boleto
|
|
1327
|
example: 03.02.2023
|
|
1328
|
valorTarifa:
|
|
1329
|
type: number
|
|
1330
|
description: >-
|
|
1331
|
Valor que o Cliente é debitado da tarifa por
|
|
1332
|
realizar um determinado ação
|
|
1333
|
format: double
|
|
1334
|
example: 9
|
|
1335
|
valorOutrasDespesasCalculadas:
|
|
1336
|
type: number
|
|
1337
|
description: >-
|
|
1338
|
Despesas calculadas conforme o comando determinado
|
|
1339
|
pelo Cliente.
|
|
1340
|
format: double
|
|
1341
|
example: 0
|
|
1342
|
valorJurosDesconto:
|
|
1343
|
type: number
|
|
1344
|
description: >-
|
|
1345
|
Valor de juros calculados apenas para boletos da
|
|
1346
|
modalidade do tipo de cobrança desconto.
|
|
1347
|
example: 1
|
|
1348
|
format: double
|
|
1349
|
valorIofDesconto:
|
|
1350
|
type: number
|
|
1351
|
description: Valor do IOF incidente sobre o valor do desconto.
|
|
1352
|
format: double
|
|
1353
|
example: 0.5
|
|
1354
|
valorAbatimento:
|
|
1355
|
type: number
|
|
1356
|
description: >-
|
|
1357
|
Valor do abatimento concedido sobre o valor do
|
|
1358
|
título.
|
|
1359
|
format: double
|
|
1360
|
example: 10
|
|
1361
|
valorDesconto:
|
|
1362
|
type: number
|
|
1363
|
description: Valor do desconto concedido sobre o valor do título.
|
|
1364
|
format: double
|
|
1365
|
example: 1
|
|
1366
|
valorRecebido:
|
|
1367
|
type: number
|
|
1368
|
description: Valor do recebido pelo título de cobrança do boleto.
|
|
1369
|
format: double
|
|
1370
|
example: 100
|
|
1371
|
valorJurosMora:
|
|
1372
|
type: number
|
|
1373
|
description: >-
|
|
1374
|
Valor dos juros de mora cobrados pelo atraso no
|
|
1375
|
pagamento do título.
|
|
1376
|
format: double
|
|
1377
|
example: 5
|
|
1378
|
valorOutrosValoresRecebidos:
|
|
1379
|
type: number
|
|
1380
|
description: >-
|
|
1381
|
Outros valores recebidos no momento do pagamento do
|
|
1382
|
Boleto (título).
|
|
1383
|
format: double
|
|
1384
|
example: 2
|
|
1385
|
valorAbatimentoNaoUtilizado:
|
|
1386
|
type: number
|
|
1387
|
description: >-
|
|
1388
|
Valor de abatimento ao qual o clente tem direito mas
|
|
1389
|
que não foi utilizado por ele (para comando 311 -
|
|
1390
|
liquidação).
|
|
1391
|
format: double
|
|
1392
|
example: 1
|
|
1393
|
valorLancamento:
|
|
1394
|
type: number
|
|
1395
|
description: >-
|
|
1396
|
Valor de lançamento calculado com base no valor
|
|
1397
|
pago, descontos e abatimentos.
|
|
1398
|
format: double
|
|
1399
|
example: 30
|
|
1400
|
codigoFormaPagamento:
|
|
1401
|
type: integer
|
|
1402
|
description: >-
|
|
1403
|
Indica a forma de pagamento do Boleto (título) de
|
|
1404
|
cobrança.
|
|
1405
|
|
|
1406
|
0-sem lançamento, 1-débito, 2-crédito
|
|
1407
|
format: int32
|
|
1408
|
example: 1
|
|
1409
|
enum:
|
|
1410
|
- 0
|
|
1411
|
- 1
|
|
1412
|
- 2
|
|
1413
|
codigoValorAjuste:
|
|
1414
|
type: integer
|
|
1415
|
description: >-
|
|
1416
|
Indica se ocorreu um ajuste a débito ou a crédito do
|
|
1417
|
Boleto.
|
|
1418
|
|
|
1419
|
0-sem ajuste, 1-ajuste de valor a débito, 2-ajuste
|
|
1420
|
de valor a crédito
|
|
1421
|
format: int32
|
|
1422
|
example: 2
|
|
1423
|
enum:
|
|
1424
|
- 0
|
|
1425
|
- 1
|
|
1426
|
- 2
|
|
1427
|
valorAjuste:
|
|
1428
|
type: number
|
|
1429
|
description: >-
|
|
1430
|
Para tipo de cobrança descontada, nos comandos de
|
|
1431
|
liquidação ou baixa de boleto, quando o Indicador de
|
|
1432
|
Valor é igual a 1 e houver valor a débito ou
|
|
1433
|
Indicador de valor igual a 2 é preenchido com o
|
|
1434
|
valor do ajuste.
|
|
1435
|
format: double
|
|
1436
|
example: 0.51
|
|
1437
|
codigoAutorizacaoPagamentoParcial:
|
|
1438
|
type: integer
|
|
1439
|
description: >-
|
|
1440
|
Indica se o boleto pode ser pago parcialmente ou
|
|
1441
|
não.
|
|
1442
|
|
|
1443
|
1 - Não aceita receber pagamento parcial de boletos,
|
|
1444
|
2-Aceita receber pagamento parcial de boletos
|
|
1445
|
format: int32
|
|
1446
|
example: 1
|
|
1447
|
enum:
|
|
1448
|
- 1
|
|
1449
|
- 2
|
|
1450
|
codigoCanalPagamento:
|
|
1451
|
type: integer
|
|
1452
|
description: >-
|
|
1453
|
Número do canal de pagamento do Boleto que
|
|
1454
|
identifica qual o meio utilizado para realizar o
|
|
1455
|
pagamento.
|
|
1456
|
|
|
1457
|
"CANAL UTILIZADO PARA PAGAMENTO/MEIOS DE
|
|
1458
|
APRESENTAÇÃO DO BOLETO AO SACADO:
|
|
1459
|
|
|
1460
|
Comando 02 nas posições 109/110 (Confirmação de
|
|
1461
|
entrada de boleto – Nota 07)
|
|
1462
|
|
|
1463
|
00 – Não é Sacado Eletrônico no DDA
|
|
1464
|
|
|
1465
|
50 – Sacado eletrônico no DDA
|
|
1466
|
|
|
1467
|
|
|
1468
|
Comando 06, 07, 08, 15 ou 46 nas posições 109/110
|
|
1469
|
(Liquidação de boleto – Nota 07)
|
|
1470
|
|
|
1471
|
01 – terminal de auto-atendimento
|
|
1472
|
|
|
1473
|
02 – internet
|
|
1474
|
|
|
1475
|
03 – central de atendimento (URA)
|
|
1476
|
|
|
1477
|
04 – gerenciador financeiro
|
|
1478
|
|
|
1479
|
05 – central de atendimento
|
|
1480
|
|
|
1481
|
06 – outro canal de auto-atendimento
|
|
1482
|
|
|
1483
|
07 – correspondente bancário
|
|
1484
|
|
|
1485
|
08 – guichê de caixa
|
|
1486
|
|
|
1487
|
09 – arquivo-eletrônico
|
|
1488
|
|
|
1489
|
10 – compensação
|
|
1490
|
|
|
1491
|
11 – outro canal eletrônico
|
|
1492
|
|
|
1493
|
61 - Pix
|
|
1494
|
|
|
1495
|
|
|
1496
|
Comando 93 nas posições 109/110 (Baixa Operacional –
|
|
1497
|
Nota 07)
|
|
1498
|
|
|
1499
|
01 - Liquidação Caixa
|
|
1500
|
|
|
1501
|
02 - Liquidação TAA
|
|
1502
|
|
|
1503
|
03 - Liquidação Internet
|
|
1504
|
|
|
1505
|
05 - Liquidação Correspondente Bancário
|
|
1506
|
|
|
1507
|
06 - Liquidação Central de Atendimento
|
|
1508
|
|
|
1509
|
07 - Liquidação Arquivo
|
|
1510
|
|
|
1511
|
08 - Liquidação Internet"
|
|
1512
|
format: int32
|
|
1513
|
example: 11
|
|
1514
|
URL:
|
|
1515
|
type: string
|
|
1516
|
description: >-
|
|
1517
|
Link do QRCode gerado na iniciação de um pagamento
|
|
1518
|
de título de cobrança vinculado ao sistema de
|
|
1519
|
pagamento instantâneo, que conterá as demais
|
|
1520
|
informações constantes no QRCODE para que os dados
|
|
1521
|
sejam apresentados para o pagador.
|
|
1522
|
example: >-
|
|
1523
|
qrcode.sed.desenv.bb.com.br/pix/v2/cobv/ce8a678e-0a0c-414e-938a-88dc072708a0
|
|
1524
|
textoIdentificadorQRCode:
|
|
1525
|
type: string
|
|
1526
|
description: >-
|
|
1527
|
Código que identifica a transação que vincula o
|
|
1528
|
QRCode disponibilizado para pagamento do título de
|
|
1529
|
cobrança vinculado ao sistema de pagamento
|
|
1530
|
instantâneo.
|
|
1531
|
example: 'BOLETO19221240800005487DATA17012022 '
|
|
1532
|
quantidadeDiasCalculo:
|
|
1533
|
type: integer
|
|
1534
|
description: >-
|
|
1535
|
Quantidade de dias para calculo do boleto de
|
|
1536
|
cobrança.
|
|
1537
|
|
|
1538
|
a) Carteiras 11, 12, 15, 16, 7, 18 e 31: quando o
|
|
1539
|
boleto for liquidado, é preenchido com o número de
|
|
1540
|
dias decorridos desde o vencimento até a liquidação.
|
|
1541
|
b) Carteira 51: igual ao número de dias sobre os
|
|
1542
|
quais foram calculados o desconto e o IOF.
|
|
1543
|
format: int32
|
|
1544
|
example: 12
|
|
1545
|
valorTaxaDesconto:
|
|
1546
|
type: number
|
|
1547
|
description: >-
|
|
1548
|
Valor da taxa de desconto aplicada ao boleto de
|
|
1549
|
cobrança.
|
|
1550
|
format: double
|
|
1551
|
example: 0.33
|
|
1552
|
valorTaxaIOF:
|
|
1553
|
type: number
|
|
1554
|
description: >-
|
|
1555
|
Valor da taxa de IOF calculado ao boleto de
|
|
1556
|
cobrança.
|
|
1557
|
format: double
|
|
1558
|
example: 1.2323
|
|
1559
|
naturezaRecebimento:
|
|
1560
|
type: integer
|
|
1561
|
description: "A natureza do Recebimento é o número de validação do ciclo de vida do boleto, que vai variar de acordo com o comando.\n\"NATUREZA DO RECEBIMENTO\na) comando 05, 06, 07, 08 ou 15 ou 46 nas posições 109/110\n01-liquidação normal\n02-liquidação parcial\n03-liquidação por saldo\n04-liquidação com cheque a compensar\n05-liquidação de boleto sem registro (carteira 7 tipo 4)\n07-liquidação na apresentação\n09-liquidação em cartório\n10-Liquidação Parcial com Cheque a Compensar\n11-Liquidação por Saldo com Cheque a Compensar\n61-Liquidação via Pix\n\nb) comando 02 nas posições 109/110 (ENTRADA):\n00-por meio magnético\n11-por via convencional\n16-por alteração do código do cedente\n17-por alteração da variação\n18-por alteração da carteira\nc) comandos 09, 10 ou 20 nas posições 109/110 (BAIXA):\n00-solicitada pelo cliente\n15-protestado\n18-por alteração da carteira\n19-débito automático\n31-liquidado anteriormente\n32-habilitado em processo\n33-incobrável por nosso intermédio\n34-transferido para créditos em liquidação\n46-por alteração da variação\n47-por alteração da variação\n51-acerto\n61-Registrado com QR Code Pix\n62-Registrado sem QR Code Pix\n90-baixa automática\n\nd) comando 03 nas posições 109/110 (RECUSA):\n01-identificação inválida\n02-variação da carteira inválida\n03-valor dos juros por um dia inválido\n04-valor do desconto inválido\n05-espécie de boleto inválida para carteira/variação\n06-espécie de valor invariável inválido\n07-prefixo da agência usuária inválido\n08-valor do boleto/apólice inválido\n09-data de vencimento inválida\n10-fora do prazo/só admissível na carteira \n11-inexistência de margem para desconto\n12-o banco não tem agência na praça do sacado\n13-razões cadastrais\n14-sacado interligado com o sacador (só admissível em cobrança simples- cart. 11 e 17)\n15-Titulo sacado contra órgão do Poder Público (só admissível na carteira 11 e sem ordem de protesto)\n16-Titulo preenchido de forma irregular \n17-Titulo rasurado\n18-Endereço do sacado não localizado ou incompleto \n19-Código do cedente inválido \n20-Nome/endereço do cliente não informado (ECT)\n21-Carteira inválida\n22-Quantidade de valor variável inválida\n23-Faixa nosso-numero excedida\n24-Valor do abatimento inválido\n25-Novo número do boleto dado pelo cedente inválido (Seu número)\n26-Valor do IOF de seguro inválido\n27-Nome do sacado/cedente inválido\n28-Data do novo vencimento inválida\n29-Endereço não informado\n30-Registro de boleto já liquidado (carteira 17-tipo 4)\n31-Numero do borderô inválido\n32-Nome da pessoa autorizada inválido\n33-Nosso número já existente\n34-Numero da prestação do contrato inválido\n35-percentual de desconto inválido\n36-Dias para fichamento de protesto inválido\n37-Data de emissão do boleto inválida\n38-Data do vencimento anterior à data da emissão do boleto\n39-Comando de alteração indevido para a carteira\n40-Tipo de moeda inválido\n41-Abatimento não permitido\n42-CEP/UF inválido/não compatíveis (ECT)\n43-Código de unidade variável incompatível com a data de emissão do boleto\n44-Dados para débito ao sacado inválidos\n45-Carteira/variação encerrada\n46-Convenio encerrado\n47-Titulo tem valor diverso do informado\n48-Motivo de baixa invalido para a carteira\n49-Abatimento a cancelar não consta do boleto\n50-Comando incompatível com a carteira\n51-Código do convenente invalido\n52-Abatimento igual ou maior que o valor do titulo\n53-Titulo já se encontra na situação pretendida\n54-Titulo fora do prazo admitido para a conta 1\n55-Novo vencimento fora dos limites da carteira\n56-Titulo não pertence ao convenente\n57-Variação incompatível com a carteira\n58-Impossível a variação única para a carteira indicada \n59-Titulo vencido em transferência para a carteira 51\n60-Titulo com prazo superior a 179 dias em variação única para carteira 51\n61-Titulo já foi fichado para protesto\n62-Alteração da situação de débito inválida para o código de responsabilidade\n63-DV do nosso número inválido\n64-Titulo não passível de débito/baixa – situação anormal\n65-Titulo com ordem de não protestar – não pode ser encaminhado a cartório\n66-Número do documento do sacado (CNPJ/CPF) inválido\n67-Titulo/carne rejeitado\n69-Valor/Percentual de Juros Inválido\n70-Boleto já se encontra isento de juros\n71-Código de Juros Inválido\n72 - Prefixo da Ag. cobradora inválido\n73 – Numero do controle do participante inválido\n74 – Cliente não cadastrado no CIOPE (Desconto/Vendor)\n75 – Qtde. de dias do prazo limite p/ recebimento de boleto vencido inválido\n76 – Titulo excluído automaticamente por decurso de prazo CIOPE (Desconto/Vendor)\n77 – Titulo vencido transferido para a conta 1 – Carteira vinculada\n84 – Boleto não localizado na existência/Baixado por protesto\n80-Nosso numero inválido\n81-Data para concessão do desconto inválida. Gerada nos seguintes casos:\n11\t - erro na data do desconto;\n12\t - data do desconto anterior à data de emissão\n82-CEP do sacado inválido\n83-Carteira/variação não localizada no cedente\n84-Titulo não localizado na existência\n85-Recusa do Comando “41” – Parâmetro de Liquidação Parcial.\n99-Outros motivos\n\nComando 72 nas posições 109/110 (Alteração de Tipo de Cobrança):\n00-transferência de boleto de cobrança simples para descontada ou vice-versa\n52-reembolso de boleto vendor ou descontado, quando ocorrerem reembolsos de boletos por falta de liquidação. Não há migração de carteira descontada para simples.\n\nComando 85 nas posições 109/110:\n01 - Negativação aceita no BB \n02 - Negativação aceita no agente negativador \n03 - Inclusão cancelada \n04 - Negativação recusada - pagador menor de idade \n05 - Negativação recusada - espécie do boleto não permitida \n06 - Negativação recusada - beneficiário não é PJ \n07 - Negativação recusada - moeda do boleto não é Real \n08 - Negativação recusada - endereço do pagador inválido \n09 - Negativação recusada pelo agente negativador\n10 - Negativação recusada - situação do boleto não permite NGTV \n11 - Negativação recusada - cadastro do benef. desatualizado \n12 - Negativação recusada - boleto inexistente \n13 - Negativação recusada - pagador não identificado \n14 - Recusa de tarifação de negativação\n15 - Negativação recusada - motivos diversos \nComando 86 nas posições 109/110:\n01 - Exclusão cancelada \n02 - Negativação excluída no agente negativador \n03 - Negativação excluída - devolução pelos correios \n04 - Negativação excluída - data de ocorrência decursada \n05 - Negativação excluída - determinação judicial \n06 - Negativação excluída - contestação do interessado \n07 - Negativação excluída - carta não retornou do correio \n08 - Exclusão negativação recusada - registro inexistente\n09 - Exclusão de negativação aceita no BB\n15 - Exclusão negativação recusada - motivos diversos \n\nComando 93 nas posições 109/110:\n01 - Baixa Operacional BB \n02 - Baixa Operacional Outros Bancos\n10 - Cancelamento de Baixa Operacional\""
|
|
1562
|
format: int32
|
|
1563
|
example: 7
|
|
1564
|
codigoTipoCobrancaComando:
|
|
1565
|
type: integer
|
|
1566
|
description: >-
|
|
1567
|
Código do tipo de cobrança original. O objetivo é
|
|
1568
|
preservar o tipo de cobrança original.
|
|
1569
|
|
|
1570
|
0-Caso não haja alteração de tipo de cobrança,
|
|
1571
|
1-Simples, 2-Vinculada, 4-Descontada, 7-Cobrança
|
|
1572
|
Simples Carteira 17, 8-Vendor
|
|
1573
|
format: int32
|
|
1574
|
example: 0
|
|
1575
|
enum:
|
|
1576
|
- 0
|
|
1577
|
- 1
|
|
1578
|
- 2
|
|
1579
|
- 4
|
|
1580
|
- 7
|
|
1581
|
- 8
|
|
1582
|
dataLiquidacaoBoleto:
|
|
1583
|
type: string
|
|
1584
|
description: Data de liquidação do boleto.
|
|
1585
|
example: dd.mm.aaaa
|
|
1586
|
examples:
|
|
1587
|
example-1:
|
|
1588
|
value:
|
|
1589
|
indicadorContinuidade: S
|
|
1590
|
numeroUltimoRegistro: 8900
|
|
1591
|
listaRegistro:
|
|
1592
|
- dataMovimentoRetorno: 24.03.2022
|
|
1593
|
numeroConvenio: 1234567
|
|
1594
|
numeroTituloCobranca: '00012345670000000001'
|
|
1595
|
codigoComandoAcao: 2
|
|
1596
|
codigoPrefixoAgencia: 1
|
|
1597
|
numeroContaCorrente: 123456789
|
|
1598
|
numeroCarteiraCobranca: 17
|
|
1599
|
numeroVariacaoCarteiraCobranca: 35
|
|
1600
|
tipoCobranca: 1
|
|
1601
|
codigoControleParticipante: A123456
|
|
1602
|
codigoEspecieBoleto: 0
|
|
1603
|
dataVencimentoBoleto: 31.12.2022
|
|
1604
|
valorBoleto: 100
|
|
1605
|
codigoBancoRecebedor: 237
|
|
1606
|
codigoPrefixoAgenciaRecebedora: 2
|
|
1607
|
dataCreditoPagamentoBoleto: 03.02.2023
|
|
1608
|
valorTarifa: 9
|
|
1609
|
valorOutrasDespesasCalculadas: 0
|
|
1610
|
valorJurosDesconto: 1
|
|
1611
|
valorIofDesconto: 0.5
|
|
1612
|
valorAbatimento: 10
|
|
1613
|
valorDesconto: 1
|
|
1614
|
valorRecebido: 100
|
|
1615
|
valorJurosMora: 5
|
|
1616
|
valorOutrosValoresRecebidos: 2
|
|
1617
|
valorAbatimentoNaoUtilizado: 1
|
|
1618
|
valorLancamento: 30
|
|
1619
|
codigoFormaPagamento: 0
|
|
1620
|
codigoValorAjuste: 0
|
|
1621
|
valorAjuste: 0.51
|
|
1622
|
codigoAutorizacaoPagamentoParcial: 1
|
|
1623
|
codigoCanalPagamento: 11
|
|
1624
|
URL: >-
|
|
1625
|
qrcode.sed.desenv.bb.com.br/pix/v2/cobv/ce8a678e-0a0c-414e-938a-88dc072708a0
|
|
1626
|
textoIdentificadorQRCode: 'BOLETO19221240800005487DATA17012022 '
|
|
1627
|
quantidadeDiasCalculo: 12
|
|
1628
|
valorTaxaDesconto: 0.33
|
|
1629
|
valorTaxaIOF: 1.2323
|
|
1630
|
naturezaRecebimento: 7
|
|
1631
|
codigoTipoCobrancaComando: 0
|
|
1632
|
dataLiquidacaoBoleto: dd.mm.aaaa
|
|
1633
|
'400':
|
|
1634
|
description: >-
|
|
1635
|
REQUISIÇÃO INVÁLIDA. O servidor não pôde processar a requisição
|
|
1636
|
devido a uma sintaxe de requisição malformada, estrutura da mensagem
|
|
1637
|
da requisição inválida, ou valores inválidos.
|
|
1638
|
content:
|
|
1639
|
application/json:
|
|
1640
|
schema:
|
|
1641
|
$ref: '#/components/schemas/Erro-v4'
|
|
1642
|
'401':
|
|
1643
|
description: NÃO AUTORIZADO. A requisição requer autenticação do usuário.
|
|
1644
|
content:
|
|
1645
|
application/json:
|
|
1646
|
schema:
|
|
1647
|
$ref: '#/components/schemas/ErroOAuthNaoAutorizado'
|
|
1648
|
'403':
|
|
1649
|
description: >-
|
|
1650
|
PROIBIDO. A requisição foi válida, mas o servidor está recusando a
|
|
1651
|
ação. O usuário pode não ter as permissões necessárias para um
|
|
1652
|
recurso ou pode precisar de uma conta de algum tipo.
|
|
1653
|
content:
|
|
1654
|
application/json:
|
|
1655
|
schema:
|
|
1656
|
$ref: '#/components/schemas/Erro-v4'
|
|
1657
|
'404':
|
|
1658
|
description: >-
|
|
1659
|
NÃO ENCONTRADO. O servidor não conseguiu encontrar o recurso
|
|
1660
|
solicitado.
|
|
1661
|
'500':
|
|
1662
|
description: >-
|
|
1663
|
ERRO INTERNO. O servidor encontrou uma condição inesperada que o
|
|
1664
|
impediu de atender a requisição.
|
|
1665
|
content:
|
|
1666
|
application/json:
|
|
1667
|
schema:
|
|
1668
|
$ref: '#/components/schemas/Erro-v4'
|
|
1669
|
description: Lista os dados do retorno de movimento do convênio de Cobranças
|
|
1670
|
requestBody:
|
|
1671
|
content:
|
|
1672
|
application/json:
|
|
1673
|
schema:
|
|
1674
|
type: object
|
|
1675
|
properties:
|
|
1676
|
dataMovimentoRetornoInicial:
|
|
1677
|
type: string
|
|
1678
|
description: >-
|
|
1679
|
Data inicial do processamento do movimento de retorno de
|
|
1680
|
cobrança de Boleto.
|
|
1681
|
example: 01.03.2022
|
|
1682
|
dataMovimentoRetornoFinal:
|
|
1683
|
type: string
|
|
1684
|
description: >-
|
|
1685
|
Data final do processamento do movimento de retorno de
|
|
1686
|
cobrança de Boleto.
|
|
1687
|
example: 20.03.2022
|
|
1688
|
codigoPrefixoAgencia:
|
|
1689
|
type: integer
|
|
1690
|
description: Código do prefixo identificador de uma dependência do Banco.
|
|
1691
|
example: 1
|
|
1692
|
format: int64
|
|
1693
|
numeroContaCorrente:
|
|
1694
|
type: integer
|
|
1695
|
description: >-
|
|
1696
|
Número identificador de uma Conta Corrente contratada pelo
|
|
1697
|
cliente junto ao Banco do Brasil.
|
|
1698
|
example: 12345678
|
|
1699
|
format: int64
|
|
1700
|
numeroCarteiraCobranca:
|
|
1701
|
type: integer
|
|
1702
|
description: >-
|
|
1703
|
Número identificador da carteira de Cobrança. Indica o tipo
|
|
1704
|
de serviço de cobrança, para o qual são aplicadas regras
|
|
1705
|
específicas.
|
|
1706
|
example: 17
|
|
1707
|
format: int32
|
|
1708
|
numeroVariacaoCarteiraCobranca:
|
|
1709
|
type: integer
|
|
1710
|
description: >-
|
|
1711
|
Número identificador da variação da Carteira de Cobrança.
|
|
1712
|
Identifica cada grupo de condições específicas (variação)
|
|
1713
|
para um mesmo tipo de serviço de cobrança contratado pelo
|
|
1714
|
cliente (carteira), visando separar os títulos de cobrança
|
|
1715
|
de acordo com os interesses do próprio cliente e previamente
|
|
1716
|
negociados com o Banco.
|
|
1717
|
example: 35
|
|
1718
|
format: int32
|
|
1719
|
numeroRegistroPretendido:
|
|
1720
|
type: integer
|
|
1721
|
description: >-
|
|
1722
|
Número do registro ou da página que deseja buscar na
|
|
1723
|
consulta. Quando primeira chamada, informar "001"
|
|
1724
|
example: 1
|
|
1725
|
format: int64
|
|
1726
|
quantidadeRegistroPretendido:
|
|
1727
|
type: integer
|
|
1728
|
description: >-
|
|
1729
|
Quantidade de registros ou páginas que desejar buscar na
|
|
1730
|
consulta. Quantidade máxima de 10000 boletos por chamada
|
|
1731
|
format: int64
|
|
1732
|
example: 10000
|
|
1733
|
required:
|
|
1734
|
- dataMovimentoRetornoInicial
|
|
1735
|
- dataMovimentoRetornoFinal
|
|
1736
|
examples:
|
|
1737
|
example-1:
|
|
1738
|
value:
|
|
1739
|
dataMovimentoRetornoInicial: 01.03.2022
|
|
1740
|
dataMovimentoRetornoFinal: 20.03.2022
|
|
1741
|
codigoPrefixoAgencia: 1
|
|
1742
|
numeroContaCorrente: 12345678
|
|
1743
|
numeroCarteiraCobranca: 17
|
|
1744
|
numeroVariacaoCarteiraCobranca: 35
|
|
1745
|
numeroRegistroPretendido: 1
|
|
1746
|
quantidadeRegistroPretendido: 10000
|
|
1747
|
tags:
|
|
1748
|
- movimento
|
|
1749
|
parameters:
|
|
1750
|
- schema:
|
|
1751
|
type: string
|
|
1752
|
in: header
|
|
1753
|
name: Authorization
|
|
1754
|
description: >-
|
|
1755
|
É um “token” de acesso fornecido pelo OAuth 2.0.Example: Bearer
|
|
1756
|
[ACCESS_TOKEN]
|
|
1757
|
required: true
|
|
1758
|
- schema:
|
|
1759
|
type: string
|
|
1760
|
in: header
|
|
1761
|
name: gw-dev-app-key
|
|
1762
|
description: >-
|
|
1763
|
É a chave de acesso do aplicativo do desenvolvedor utilizada em
|
|
1764
|
produção, obtida no Portal do Desenvolvedor. Essa chave será usada
|
|
1765
|
para identificação do aplicativo.Para os testes em ambiente de
|
|
1766
|
homologação, trocar por gw-app-key. Ex:
|
|
1767
|
0021239456d80136bebf005056891bed. CAMPO OBRIGATÓRIO.
|
|
1768
|
required: true
|
|
1769
|
security:
|
|
1770
|
- OAuth2:
|
|
1771
|
- cobrancas.boletos-info
|
|
1772
|
components:
|
|
1773
|
schemas:
|
|
1774
|
RequisicaoAlterarBoleto:
|
|
1775
|
title: RequisicaoAlterarBoleto
|
|
1776
|
required:
|
|
1777
|
- indicadorAlterarAbatimento
|
|
1778
|
- indicadorAlterarDataDesconto
|
|
1779
|
- indicadorAlterarDesconto
|
|
1780
|
- indicadorAlterarEnderecoPagador
|
|
1781
|
- indicadorAlterarPrazoBoletoVencido
|
|
1782
|
- indicadorAlterarSeuNumero
|
|
1783
|
- indicadorAtribuirDesconto
|
|
1784
|
- indicadorCancelarProtesto
|
|
1785
|
- indicadorCobrarJuros
|
|
1786
|
- indicadorCobrarMulta
|
|
1787
|
- indicadorDispensarJuros
|
|
1788
|
- indicadorDispensarMulta
|
|
1789
|
- indicadorIncluirAbatimento
|
|
1790
|
- indicadorNegativar
|
|
1791
|
- indicadorNovaDataVencimento
|
|
1792
|
- indicadorProtestar
|
|
1793
|
- indicadorSustacaoProtesto
|
|
1794
|
type: object
|
|
1795
|
properties:
|
|
1796
|
numeroConvenio:
|
|
1797
|
type: integer
|
|
1798
|
description: >-
|
|
1799
|
Identificador determinado pelo sistema de boleto bancário para
|
|
1800
|
fornecer a emissão e liquidação do boleto e, portanto, usado para
|
|
1801
|
creditar o Beneficiário.
|
|
1802
|
format: int32
|
|
1803
|
indicadorNovaDataVencimento:
|
|
1804
|
type: string
|
|
1805
|
description: >-
|
|
1806
|
Indica a intenção de atribuir nova data de vencimento ao boleto.
|
|
1807
|
Valores a informar:
|
|
1808
|
|
|
1809
|
"S" -> Sim, desejo alterar
|
|
1810
|
|
|
1811
|
"N" -> Não, não desejo alterar
|
|
1812
|
alteracaoData:
|
|
1813
|
$ref: '#/components/schemas/alteracaoData'
|
|
1814
|
indicadorAtribuirDesconto:
|
|
1815
|
type: string
|
|
1816
|
description: >-
|
|
1817
|
Indica a intenção de atribuir desconto ao boleto. Valores a
|
|
1818
|
informar:
|
|
1819
|
|
|
1820
|
"S" -> Sim, desejo alterar
|
|
1821
|
|
|
1822
|
"N" -> Não, não desejo alterar
|
|
1823
|
desconto:
|
|
1824
|
$ref: '#/components/schemas/desconto'
|
|
1825
|
indicadorAlterarDesconto:
|
|
1826
|
type: string
|
|
1827
|
description: |-
|
|
1828
|
Indica a intenção de alterar desconto do boleto. Valores a informar:
|
|
1829
|
"S" -> Sim, desejo alterar
|
|
1830
|
"N" -> Não, não desejo alterar
|
|
1831
|
alteracaoDesconto:
|
|
1832
|
$ref: '#/components/schemas/alteracaoDesconto'
|
|
1833
|
indicadorAlterarDataDesconto:
|
|
1834
|
type: string
|
|
1835
|
description: >-
|
|
1836
|
Indica a intenção de alterar a data do desconto do boleto. Valores a
|
|
1837
|
informar:
|
|
1838
|
|
|
1839
|
"S" -> Sim, desejo alterar
|
|
1840
|
|
|
1841
|
"N" -> Não, não desejo alterar
|
|
1842
|
alteracaoDataDesconto:
|
|
1843
|
$ref: '#/components/schemas/alteracaoDataDesconto'
|
|
1844
|
indicadorProtestar:
|
|
1845
|
type: string
|
|
1846
|
description: |-
|
|
1847
|
Indica a intenção de protestar o boleto. Valores a informar:
|
|
1848
|
"S" -> Sim, desejo alterar
|
|
1849
|
"N" -> Não, não desejo alterar
|
|
1850
|
protesto:
|
|
1851
|
$ref: '#/components/schemas/protesto'
|
|
1852
|
indicadorSustacaoProtesto:
|
|
1853
|
type: string
|
|
1854
|
description: >-
|
|
1855
|
Indica a intenção de sustar/cancelar um comando de protesto do
|
|
1856
|
boleto que já tenha sido processado pelo Banco. Valores a informar:
|
|
1857
|
|
|
1858
|
"S" -> Sim, desejo alterar
|
|
1859
|
|
|
1860
|
"N" -> Não, não desejo alterar.
|
|
1861
|
indicadorCancelarProtesto:
|
|
1862
|
type: string
|
|
1863
|
description: >-
|
|
1864
|
Deve ser utilizada para cancelar uma instrução de protesto enviada
|
|
1865
|
ao Banco na mesma data ou que ainda não tenha sido processada pelo
|
|
1866
|
Banco. Valores a informar:
|
|
1867
|
|
|
1868
|
"S" -> Sim, desejo alterar
|
|
1869
|
|
|
1870
|
"N" -> Não, não desejo alterar
|
|
1871
|
indicadorIncluirAbatimento:
|
|
1872
|
type: string
|
|
1873
|
description: >-
|
|
1874
|
Indica a intenção de incluir abatimento no boleto. Valores a
|
|
1875
|
informar:
|
|
1876
|
|
|
1877
|
"S" -> Sim, desejo alterar
|
|
1878
|
|
|
1879
|
"N" -> Não, não desejo alterar
|
|
1880
|
abatimento:
|
|
1881
|
$ref: '#/components/schemas/abatimento'
|
|
1882
|
indicadorAlterarAbatimento:
|
|
1883
|
type: string
|
|
1884
|
description: >-
|
|
1885
|
Indica a intenção de alterar o valor do abatimento no boleto.
|
|
1886
|
Domínio:
|
|
1887
|
|
|
1888
|
"S" -> Sim, desejo alterar
|
|
1889
|
|
|
1890
|
"N" -> Não, não desejo alterar
|
|
1891
|
alteracaoAbatimento:
|
|
1892
|
$ref: '#/components/schemas/alteracaoAbatimento'
|
|
1893
|
indicadorCobrarJuros:
|
|
1894
|
type: string
|
|
1895
|
description: |-
|
|
1896
|
Indica a intenção de cobrar juros no boleto. Valores a informar:
|
|
1897
|
"S" -> Sim, desejo alterar
|
|
1898
|
"N" -> Não, não desejo alterar
|
|
1899
|
juros:
|
|
1900
|
$ref: '#/components/schemas/juros'
|
|
1901
|
indicadorDispensarJuros:
|
|
1902
|
type: string
|
|
1903
|
description: |-
|
|
1904
|
Indica a intenção de dispensar juros no boleto. Valores a informar:
|
|
1905
|
"S" -> Sim, desejo alterar
|
|
1906
|
"N" -> Não, não desejo alterar
|
|
1907
|
indicadorCobrarMulta:
|
|
1908
|
type: string
|
|
1909
|
description: |-
|
|
1910
|
Indica a intenção de cobrar multa no boleto. Valores a informar:
|
|
1911
|
"S" -> Sim, desejo alterar
|
|
1912
|
"N" -> Não, não desejo alterar
|
|
1913
|
multa:
|
|
1914
|
$ref: '#/components/schemas/multa'
|
|
1915
|
indicadorDispensarMulta:
|
|
1916
|
type: string
|
|
1917
|
description: >-
|
|
1918
|
Indica a intenção de dispensar cobrança de multa no boleto. Valores
|
|
1919
|
a informar:
|
|
1920
|
|
|
1921
|
"S" -> Sim, desejo alterar
|
|
1922
|
|
|
1923
|
"N" -> Não, não desejo alterar
|
|
1924
|
indicadorNegativar:
|
|
1925
|
type: string
|
|
1926
|
description: >-
|
|
1927
|
Indica a intenção de negativar ou cancelar negativação boleto.
|
|
1928
|
(Inclusão ou Cancelamento) Valores a informar:
|
|
1929
|
|
|
1930
|
"S" -> Sim, desejo alterar
|
|
1931
|
|
|
1932
|
"N" -> Não, não desejo alterar
|
|
1933
|
negativacao:
|
|
1934
|
$ref: '#/components/schemas/negativacao'
|
|
1935
|
indicadorAlterarSeuNumero:
|
|
1936
|
type: string
|
|
1937
|
description: >-
|
|
1938
|
Indica a intenção de alterar Seu Numero no boleto. Valores a
|
|
1939
|
informar:
|
|
1940
|
|
|
1941
|
"S" -> Sim, desejo alterar
|
|
1942
|
|
|
1943
|
"N" -> Não, não desejo alterar
|
|
1944
|
alteracaoSeuNumero:
|
|
1945
|
$ref: '#/components/schemas/alteracaoSeuNumero'
|
|
1946
|
indicadorAlterarEnderecoPagador:
|
|
1947
|
type: string
|
|
1948
|
description: >-
|
|
1949
|
Indica a intenção de alterar endereço do Pagador no boleto. Valores
|
|
1950
|
a informar:
|
|
1951
|
|
|
1952
|
"S" -> Sim, desejo alterar
|
|
1953
|
|
|
1954
|
"N" -> Não, não desejo alterar
|
|
1955
|
alteracaoEndereco:
|
|
1956
|
$ref: '#/components/schemas/alteracaoEndereco'
|
|
1957
|
indicadorAlterarPrazoBoletoVencido:
|
|
1958
|
type: string
|
|
1959
|
description: >-
|
|
1960
|
Indica a intenção de prazo de aceite de boleto vencido. Valores a
|
|
1961
|
informar:
|
|
1962
|
|
|
1963
|
"S" -> Sim, desejo alterar
|
|
1964
|
|
|
1965
|
"N" -> Não, não desejo alterar
|
|
1966
|
alteracaoPrazo:
|
|
1967
|
$ref: '#/components/schemas/alteracaoPrazo'
|
|
1968
|
description: >-
|
|
1969
|
Representação dos campos de requisição de uma solicitação de alteração
|
|
1970
|
dos dados de boletos bancários.
|
|
1971
|
RequisicaoBaixaBoleto:
|
|
1972
|
required:
|
|
1973
|
- numeroConvenio
|
|
1974
|
type: object
|
|
1975
|
properties:
|
|
1976
|
numeroConvenio:
|
|
1977
|
type: number
|
|
1978
|
description: >-
|
|
1979
|
Identificador determinado pelo sistema de boleto bancário usado para
|
|
1980
|
emissão e liquidação do boleto e, portanto, usado para creditar o
|
|
1981
|
Beneficiário.
|
|
1982
|
description: Objeto de requisição da baixa de boletos.
|
|
1983
|
RequisicaoRegistroBoletos:
|
|
1984
|
type: object
|
|
1985
|
description: >-
|
|
1986
|
Representação dos campos de requisição de uma solicitação de criação de
|
|
1987
|
boletos bancários.
|
|
1988
|
title: ''
|
|
1989
|
properties:
|
|
1990
|
numeroConvenio:
|
|
1991
|
type: integer
|
|
1992
|
description: >-
|
|
1993
|
Número do convênio de Cobrança do Cliente. Identificador determinado
|
|
1994
|
pelo sistema Cobrança para controlar a emissão de boletos,
|
|
1995
|
liquidação, crédito de valores ao Beneficiário e intercâmbio de
|
|
1996
|
dados com o cliente.
|
|
1997
|
format: int64
|
|
1998
|
numeroCarteira:
|
|
1999
|
type: integer
|
|
2000
|
description: >-
|
|
2001
|
Características do serviço de boleto bancário e como ele deve ser
|
|
2002
|
tratado pelo banco.
|
|
2003
|
format: int32
|
|
2004
|
numeroVariacaoCarteira:
|
|
2005
|
type: integer
|
|
2006
|
description: Número da variação da carteira do convênio de cobrança.
|
|
2007
|
format: int32
|
|
2008
|
codigoModalidade:
|
|
2009
|
type: integer
|
|
2010
|
description: >-
|
|
2011
|
Identifica a característica dos boletos dentro das modalidades de
|
|
2012
|
cobrança existentes no banco.
|
|
2013
|
|
|
2014
|
|
|
2015
|
Domínio:
|
|
2016
|
|
|
2017
|
01 - SIMPLES;
|
|
2018
|
|
|
2019
|
04 - VINCULADA
|
|
2020
|
format: int32
|
|
2021
|
dataEmissao:
|
|
2022
|
type: string
|
|
2023
|
description: 'Data de emissão do boleto (formato "dd.mm.aaaaa"). '
|
|
2024
|
dataVencimento:
|
|
2025
|
type: string
|
|
2026
|
description: Data de vencimento do boleto (formato "dd.mm.aaaaa").
|
|
2027
|
valorOriginal:
|
|
2028
|
type: number
|
|
2029
|
description: >-
|
|
2030
|
Valor de cobrança > 0.00, emitido em Real (formato decimal separado
|
|
2031
|
por "."). Valor do boleto no registro. Deve ser maior que a soma dos
|
|
2032
|
campos “VALOR DO DESCONTO DO TÍTULO” e “VALOR DO ABATIMENTO DO
|
|
2033
|
TÍTULO”, se informados. Informação não passível de alteração após a
|
|
2034
|
criação. No caso de emissão com valor equivocado, sugerimos cancelar
|
|
2035
|
e emitir novo boleto.
|
|
2036
|
format: float
|
|
2037
|
valorAbatimento:
|
|
2038
|
type: number
|
|
2039
|
description: >-
|
|
2040
|
Valor de dedução do boleto >= 0.00 (formato decimal separado por
|
|
2041
|
".").
|
|
2042
|
format: float
|
|
2043
|
quantidadeDiasProtesto:
|
|
2044
|
type: number
|
|
2045
|
description: >-
|
|
2046
|
Quantos dias após a data de vencimento do boleto para iniciar o
|
|
2047
|
processo de cobrança através de protesto. (valor inteiro >= 0).
|
|
2048
|
format: float
|
|
2049
|
quantidadeDiasNegativacao:
|
|
2050
|
type: integer
|
|
2051
|
description: >-
|
|
2052
|
Quantos dias após a data de vencimento do boleto para iniciar o
|
|
2053
|
processo de negativação através da opção escolhida no campo
|
|
2054
|
orgaoNegativador. (valor inteiro >= 0).
|
|
2055
|
format: int32
|
|
2056
|
orgaoNegativador:
|
|
2057
|
type: integer
|
|
2058
|
description: |-
|
|
2059
|
Código do Órgão Negativador.
|
|
2060
|
|
|
2061
|
Domínio:
|
|
2062
|
10 - SERASA
|
|
2063
|
format: int32
|
|
2064
|
indicadorAceiteTituloVencido:
|
|
2065
|
type: string
|
|
2066
|
description: >-
|
|
2067
|
Indicador de que o boleto pode ou não ser recebido após o
|
|
2068
|
vencimento. Campo não obrigatório
|
|
2069
|
|
|
2070
|
|
|
2071
|
Se não informado, será assumido a informação de limite de
|
|
2072
|
recebimento que está definida no convênio.
|
|
2073
|
|
|
2074
|
|
|
2075
|
Quando informado "S" em conjunto com o campo
|
|
2076
|
"numeroDiasLimiteRecebimento", será definido a quantidade de dias
|
|
2077
|
(corridos) que este boleto ficará disponível para pagamento após seu
|
|
2078
|
vencimento.
|
|
2079
|
|
|
2080
|
Obs.: Se definido "S" e o campo "numeroDiasLimiteRecebimento" ficar
|
|
2081
|
com valor zero também será assumido a informação de limite de
|
|
2082
|
recebimento que está definida no convênio.
|
|
2083
|
|
|
2084
|
|
|
2085
|
Quando informado "N", fica definindo que o boleto NÃO permite
|
|
2086
|
pagamento em atraso, portanto só aceitará pagamento até a data do
|
|
2087
|
vencimento ou o próximo dia útil, quando o vencimento ocorrer em dia
|
|
2088
|
não útil.
|
|
2089
|
|
|
2090
|
|
|
2091
|
Quando informado qualquer valor diferente de "S" ou "N" será
|
|
2092
|
assumido a informação de limite de recebimento que está definida no
|
|
2093
|
convênio.
|
|
2094
|
numeroDiasLimiteRecebimento:
|
|
2095
|
type: integer
|
|
2096
|
description: Número de dias limite para recebimento. Informar valor inteiro > 0.
|
|
2097
|
format: int32
|
|
2098
|
codigoAceite:
|
|
2099
|
type: string
|
|
2100
|
description: >-
|
|
2101
|
Código para identificar se o boleto de cobrança foi aceito
|
|
2102
|
(reconhecimento da dívida pelo Pagador).
|
|
2103
|
|
|
2104
|
|
|
2105
|
Domínios:
|
|
2106
|
|
|
2107
|
A - ACEITE
|
|
2108
|
|
|
2109
|
N - NAO ACEITE
|
|
2110
|
codigoTipoTitulo:
|
|
2111
|
type: integer
|
|
2112
|
description: |-
|
|
2113
|
Código para identificar o tipo de boleto de cobrança.
|
|
2114
|
|
|
2115
|
Domínios:
|
|
2116
|
1- CHEQUE
|
|
2117
|
2- DUPLICATA MERCANTIL
|
|
2118
|
3- DUPLICATA MTIL POR INDICACAO
|
|
2119
|
4- DUPLICATA DE SERVICO
|
|
2120
|
5- DUPLICATA DE SRVC P/INDICACAO
|
|
2121
|
6- DUPLICATA RURAL
|
|
2122
|
7- LETRA DE CAMBIO
|
|
2123
|
8- NOTA DE CREDITO COMERCIAL
|
|
2124
|
9- NOTA DE CREDITO A EXPORTACAO
|
|
2125
|
10- NOTA DE CREDITO INDULTRIAL
|
|
2126
|
11- NOTA DE CREDITO RURAL
|
|
2127
|
12- NOTA PROMISSORIA
|
|
2128
|
13- NOTA PROMISSORIA RURAL
|
|
2129
|
14- TRIPLICATA MERCANTIL
|
|
2130
|
15- TRIPLICATA DE SERVICO
|
|
2131
|
16- NOTA DE SEGURO
|
|
2132
|
17- RECIBO
|
|
2133
|
18- FATURA
|
|
2134
|
19- NOTA DE DEBITO
|
|
2135
|
20- APOLICE DE SEGURO
|
|
2136
|
21- MENSALIDADE ESCOLAR
|
|
2137
|
22- PARCELA DE CONSORCIO
|
|
2138
|
23- DIVIDA ATIVA DA UNIAO
|
|
2139
|
24- DIVIDA ATIVA DE ESTADO
|
|
2140
|
25- DIVIDA ATIVA DE MUNICIPIO
|
|
2141
|
31- CARTAO DE CREDITO
|
|
2142
|
32- BOLETO PROPOSTA
|
|
2143
|
33- BOLETO APORTE
|
|
2144
|
99- OUTROS.
|
|
2145
|
format: int32
|
|
2146
|
descricaoTipoTitulo:
|
|
2147
|
type: string
|
|
2148
|
description: Descrição do tipo de boleto.
|
|
2149
|
indicadorPermissaoRecebimentoParcial:
|
|
2150
|
type: string
|
|
2151
|
description: >
|
|
2152
|
Código para identificação da autorização de pagamento parcial do
|
|
2153
|
boleto.
|
|
2154
|
|
|
2155
|
|
|
2156
|
Domínios:
|
|
2157
|
|
|
2158
|
S - SIM
|
|
2159
|
|
|
2160
|
N - NÃO
|
|
2161
|
numeroTituloBeneficiario:
|
|
2162
|
type: string
|
|
2163
|
description: >-
|
|
2164
|
Número de identificação do boleto (correspondente ao SEU NÚMERO), no
|
|
2165
|
formato STRING (Limitado a 15 caracteres - Letras Maiúsculas).
|
|
2166
|
campoUtilizacaoBeneficiario:
|
|
2167
|
type: string
|
|
2168
|
description: Informações adicionais sobre o beneficiário.
|
|
2169
|
numeroTituloCliente:
|
|
2170
|
type: string
|
|
2171
|
description: >-
|
|
2172
|
Número de identificação do boleto (correspondente ao NOSSO NÚMERO),
|
|
2173
|
no formato STRING, com 20 dígitos, que deverá ser formatado da
|
|
2174
|
seguinte forma: “000” + (número do convênio com 7 dígitos) + (10
|
|
2175
|
algarismos - se necessário, completar com zeros à esquerda).
|
|
2176
|
mensagemBloquetoOcorrencia:
|
|
2177
|
type: string
|
|
2178
|
description: >-
|
|
2179
|
Mensagem definida pelo beneficiário para ser impressa no boleto.
|
|
2180
|
(Limitado a 30 caracteres)
|
|
2181
|
desconto:
|
|
2182
|
type: object
|
|
2183
|
description: >-
|
|
2184
|
Define a ausência ou a forma como será concedido o desconto para o
|
|
2185
|
Título de Cobrança.
|
|
2186
|
properties:
|
|
2187
|
tipo:
|
|
2188
|
type: integer
|
|
2189
|
description: |-
|
|
2190
|
Como o desconto será concedido, inteiro >= 0. Domínios:
|
|
2191
|
0 - SEM DESCONTO;
|
|
2192
|
1 - VLR FIXO ATE A DATA INFORMADA;
|
|
2193
|
2 - PERCENTUAL ATE A DATA INFORMADA;
|
|
2194
|
3 - DESCONTO POR DIA DE ANTECIPACAO.
|
|
2195
|
format: int32
|
|
2196
|
dataExpiracao:
|
|
2197
|
type: string
|
|
2198
|
description: >-
|
|
2199
|
Se tipo > 0, Definir uma data de expiração do desconto, no
|
|
2200
|
formato "dd.mm.aaaa".
|
|
2201
|
porcentagem:
|
|
2202
|
type: number
|
|
2203
|
description: >-
|
|
2204
|
Se tipo = 2, definir uma porcentagem de desconto >= 0.00
|
|
2205
|
(formato decimal separado por ".").
|
|
2206
|
format: float
|
|
2207
|
valor:
|
|
2208
|
type: number
|
|
2209
|
description: >-
|
|
2210
|
Se tipo = 1, definir um valor de desconto >= 0.00 (formato
|
|
2211
|
decimal separado por ".").
|
|
2212
|
format: float
|
|
2213
|
segundoDesconto:
|
|
2214
|
type: object
|
|
2215
|
properties:
|
|
2216
|
dataExpiracao:
|
|
2217
|
type: string
|
|
2218
|
description: >-
|
|
2219
|
Se tipo > 0, Definir uma data de expiração do desconto, no
|
|
2220
|
formato "dd.mm.aaaa" .
|
|
2221
|
porcentagem:
|
|
2222
|
type: number
|
|
2223
|
description: >-
|
|
2224
|
Se tipo = 2, definir uma porcentagem de desconto >= 0.00
|
|
2225
|
(formato decimal separado por ".").
|
|
2226
|
format: float
|
|
2227
|
valor:
|
|
2228
|
type: number
|
|
2229
|
description: >-
|
|
2230
|
Se tipo = 1, definir um valor de desconto >= 0.00 (formato
|
|
2231
|
decimal separado por ".").
|
|
2232
|
format: float
|
|
2233
|
terceiroDesconto:
|
|
2234
|
type: object
|
|
2235
|
properties:
|
|
2236
|
dataExpiracao:
|
|
2237
|
type: string
|
|
2238
|
description: >-
|
|
2239
|
Se tipo > 0, Definir uma data de expiração do desconto, no
|
|
2240
|
formato "dd.mm.aaaa".
|
|
2241
|
porcentagem:
|
|
2242
|
type: number
|
|
2243
|
description: >-
|
|
2244
|
Se tipo = 2, definir uma porcentagem de desconto >= 0.00
|
|
2245
|
(formato decimal separado por ".").
|
|
2246
|
format: float
|
|
2247
|
valor:
|
|
2248
|
type: number
|
|
2249
|
description: >-
|
|
2250
|
Se tipo = 1, definir um valor de desconto >= 0.00 (formato
|
|
2251
|
decimal separado por ".").
|
|
2252
|
format: float
|
|
2253
|
jurosMora:
|
|
2254
|
type: object
|
|
2255
|
description: >-
|
|
2256
|
Código utilizado pela FEBRABAN para identificar o tipo de taxa de
|
|
2257
|
juros, sendo:
|
|
2258
|
|
|
2259
|
0 - DISPENSAR, 1 - VALOR DIA ATRASO, 2 - TAXA MENSAL, 3 - ISENTO.
|
|
2260
|
Se informado ‘0’ (zero) ou ‘3’ (três), os campos “PERCENTUAL DE
|
|
2261
|
JUROS DO TÍTULO” e “VALOR DO JUROS DO TÍTULO” não devem ser
|
|
2262
|
informados ou ser informados igual a ‘0’ (zero).
|
|
2263
|
|
|
2264
|
|
|
2265
|
O valor de juros e multa incidem sobre o valor atual do boleto
|
|
2266
|
(valor do boleto - valor de abatimento).
|
|
2267
|
properties:
|
|
2268
|
tipo:
|
|
2269
|
type: integer
|
|
2270
|
description: >-
|
|
2271
|
Código utilizado pela FEBRABAN para identificar o tipo de taxa
|
|
2272
|
de juros.
|
|
2273
|
|
|
2274
|
|
|
2275
|
Domínios:
|
|
2276
|
|
|
2277
|
0 - DISPENSAR;
|
|
2278
|
|
|
2279
|
1 - VALOR DIA ATRASO;
|
|
2280
|
|
|
2281
|
2 - TAXA MENSAL;
|
|
2282
|
|
|
2283
|
3 - ISENTO.
|
|
2284
|
format: int32
|
|
2285
|
porcentagem:
|
|
2286
|
type: number
|
|
2287
|
description: >-
|
|
2288
|
Se tipo = 2, definir uma porcentagem de juros >= 0.00 (formato
|
|
2289
|
decimal separado por ".").
|
|
2290
|
format: float
|
|
2291
|
valor:
|
|
2292
|
type: number
|
|
2293
|
description: >-
|
|
2294
|
Se tipo = 1, definir um valor de juros >= 0.00 (formato decimal
|
|
2295
|
separado por ".").
|
|
2296
|
format: float
|
|
2297
|
multa:
|
|
2298
|
type: object
|
|
2299
|
description: >-
|
|
2300
|
Código para identificação do tipo de multa para o Título de
|
|
2301
|
Cobrança, inteiro >= 0, sendo: 0 - Sem multa, 1 - Valor da Multa, 2
|
|
2302
|
- Percentual da Multa. Se informado ‘0’ (zero) os campos “DATA DE
|
|
2303
|
MULTA”, “PERCENTUAL DE MULTA” e “VALOR DA MULTA” não devem ser
|
|
2304
|
informados ou ser informados iguais a ‘0’ (zero).
|
|
2305
|
|
|
2306
|
|
|
2307
|
O valor de juros e multa incidem sobre o valor atual do boleto
|
|
2308
|
(valor do boleto - valor de abatimento).
|
|
2309
|
properties:
|
|
2310
|
tipo:
|
|
2311
|
type: integer
|
|
2312
|
description: |-
|
|
2313
|
Como a multa será concedida, inteiro >= 0.
|
|
2314
|
|
|
2315
|
Domínios:
|
|
2316
|
0 - DISPENSAR;
|
|
2317
|
1 - VALOR DIA ATRASO;
|
|
2318
|
2 - TAXA MENSAL;
|
|
2319
|
3 - ISENTO.
|
|
2320
|
format: int32
|
|
2321
|
data:
|
|
2322
|
type: string
|
|
2323
|
description: 'Se tipo > 0, Definir uma data de multa, no formato "dd.mm.aaaa" '
|
|
2324
|
porcentagem:
|
|
2325
|
type: number
|
|
2326
|
description: >-
|
|
2327
|
Se tipo = 2, definir porcentagem >= 0.00 (formato decimal
|
|
2328
|
separado por ".").
|
|
2329
|
format: float
|
|
2330
|
valor:
|
|
2331
|
type: number
|
|
2332
|
description: >-
|
|
2333
|
Se tipo = 1, definir valor do juros >= 0.00 (formato decimal
|
|
2334
|
separado por ".").
|
|
2335
|
format: float
|
|
2336
|
pagador:
|
|
2337
|
type: object
|
|
2338
|
properties:
|
|
2339
|
tipoInscricao:
|
|
2340
|
type: integer
|
|
2341
|
description: |-
|
|
2342
|
Código que identifica o tipo de inscrição do Pagador.
|
|
2343
|
|
|
2344
|
Domínios:
|
|
2345
|
1 - CPF;
|
|
2346
|
2 - CNPJ
|
|
2347
|
format: int32
|
|
2348
|
numeroInscricao:
|
|
2349
|
type: integer
|
|
2350
|
description: |-
|
|
2351
|
Número de inscrição do pagador.
|
|
2352
|
Para o tipo = 1, informar numero do CPF.
|
|
2353
|
Para o tipo = 2, informar numero do CNPJ.
|
|
2354
|
format: int64
|
|
2355
|
nome:
|
|
2356
|
type: string
|
|
2357
|
description: Nome do pagador.
|
|
2358
|
endereco:
|
|
2359
|
type: string
|
|
2360
|
description: Endereço do pagador.
|
|
2361
|
cep:
|
|
2362
|
type: integer
|
|
2363
|
description: Código postal do pagador.
|
|
2364
|
format: int32
|
|
2365
|
cidade:
|
|
2366
|
type: string
|
|
2367
|
description: Cidade do pagador.
|
|
2368
|
bairro:
|
|
2369
|
type: string
|
|
2370
|
description: Bairro do pagador.
|
|
2371
|
uf:
|
|
2372
|
type: string
|
|
2373
|
description: Sigla do unidade federativa em que o pagador vive.
|
|
2374
|
telefone:
|
|
2375
|
type: string
|
|
2376
|
description: Número de telefone do pagador.
|
|
2377
|
required:
|
|
2378
|
- tipoInscricao
|
|
2379
|
- numeroInscricao
|
|
2380
|
beneficiarioFinal:
|
|
2381
|
type: object
|
|
2382
|
properties:
|
|
2383
|
tipoInscricao:
|
|
2384
|
type: integer
|
|
2385
|
description: |-
|
|
2386
|
Código que identifica o tipo de inscrição do beneficiário final.
|
|
2387
|
|
|
2388
|
Domínios:
|
|
2389
|
1 - CPF;
|
|
2390
|
2 - CNPJ
|
|
2391
|
format: int32
|
|
2392
|
numeroInscricao:
|
|
2393
|
type: integer
|
|
2394
|
description: |-
|
|
2395
|
Número de registro do beneficiário final.
|
|
2396
|
Para o tipo = 1, informar numero do CPF.
|
|
2397
|
Para o tipo = 2, informar numero do CNPJ.
|
|
2398
|
format: int64
|
|
2399
|
nome:
|
|
2400
|
type: string
|
|
2401
|
description: Nome do beneficiário final
|
|
2402
|
indicadorPix:
|
|
2403
|
type: string
|
|
2404
|
description: >-
|
|
2405
|
Código para informar se o boleto terá um QRCode Pix atrelado. Se
|
|
2406
|
informado caracter inválido, assumirá 'N'.
|
|
2407
|
|
|
2408
|
|
|
2409
|
Domínios:
|
|
2410
|
|
|
2411
|
'S' - QRCODE DINAMICO;
|
|
2412
|
|
|
2413
|
'N' - SEM PIX; OUTRO - SEM PIX
|
|
2414
|
required:
|
|
2415
|
- numeroConvenio
|
|
2416
|
- dataVencimento
|
|
2417
|
- valorOriginal
|
|
2418
|
RespostaAlterarBoleto:
|
|
2419
|
title: RespostaAlterarBoleto
|
|
2420
|
type: object
|
|
2421
|
properties:
|
|
2422
|
numeroContratoCobranca:
|
|
2423
|
type: integer
|
|
2424
|
description: >-
|
|
2425
|
Código adotado pelo Banco para identificar o Contrato entre este e a
|
|
2426
|
Empresa Cliente
|
|
2427
|
format: int32
|
|
2428
|
dataAtualizacao:
|
|
2429
|
type: string
|
|
2430
|
description: Data do pedido de atualização do boleto bancário.
|
|
2431
|
horarioAtualizacao:
|
|
2432
|
type: string
|
|
2433
|
description: Horário do pedido de atualização do boleto bancário.HH:mm:ss
|
|
2434
|
description: >-
|
|
2435
|
Representação dos campos de resposta de uma solicitação de alteração dos
|
|
2436
|
dados de boletos bancários.
|
|
2437
|
RespostaBaixaBoleto:
|
|
2438
|
required:
|
|
2439
|
- dataBaixa
|
|
2440
|
- horarioBaixa
|
|
2441
|
- numeroContratoCobranca
|
|
2442
|
type: object
|
|
2443
|
properties:
|
|
2444
|
numeroContratoCobranca:
|
|
2445
|
type: string
|
|
2446
|
description: Número do contrato de cobrança do boleto bancário.
|
|
2447
|
dataBaixa:
|
|
2448
|
type: string
|
|
2449
|
description: Data do pedido de baixa do boleto bancário.
|
|
2450
|
horarioBaixa:
|
|
2451
|
type: string
|
|
2452
|
description: Horário do pedido de baixa do boleto bancário.HH:mm:ss
|
|
2453
|
description: Objeto de resposta da baixa de boletos.
|
|
2454
|
RespostaConsultaPixBoleto:
|
|
2455
|
type: object
|
|
2456
|
description: >-
|
|
2457
|
Representação dos campos de resposta de uma solicitação de detalhamento
|
|
2458
|
de pix vinculado a boleto bancário.
|
|
2459
|
title: ''
|
|
2460
|
properties:
|
|
2461
|
id:
|
|
2462
|
type: string
|
|
2463
|
description: >-
|
|
2464
|
Número de identificação do boleto (correspondente ao NOSSO NÚMERO,
|
|
2465
|
numeroTituloCliente), no formato STRING, com 20 dígitos, que deverá
|
|
2466
|
ser formatado da seguinte forma: “000” + (número do convênio com 7
|
|
2467
|
dígitos) + (10 algarismos - se necessário, completar com zeros à
|
|
2468
|
esquerda). Campo Obrigatório.
|
|
2469
|
minLength: 20
|
|
2470
|
maxLength: 20
|
|
2471
|
dataRegistroTituloCobranca:
|
|
2472
|
type: string
|
|
2473
|
description: Data de registro do boleto no banco.
|
|
2474
|
agenciaBeneficiario:
|
|
2475
|
type: integer
|
|
2476
|
description: Número da agência do beneficiário, sem o dígito verificador.
|
|
2477
|
contaBeneficiario:
|
|
2478
|
type: integer
|
|
2479
|
description: Número da conta do beneficiário, sem o dígito verificador.
|
|
2480
|
valorOriginalTituloCobranca:
|
|
2481
|
type: number
|
|
2482
|
description: Valor original do boleto indicado quando do registro.
|
|
2483
|
format: float
|
|
2484
|
validadeTituloCobranca:
|
|
2485
|
type: string
|
|
2486
|
description: Data de validade do boleto.
|
|
2487
|
pix:
|
|
2488
|
type: object
|
|
2489
|
properties:
|
|
2490
|
valorRecebido:
|
|
2491
|
type: number
|
|
2492
|
description: Valor recebido via Pix.
|
|
2493
|
format: float
|
|
2494
|
timestamp:
|
|
2495
|
type: string
|
|
2496
|
description: Data e hora do recebimento via Pix.
|
|
2497
|
chave:
|
|
2498
|
type: string
|
|
2499
|
description: Código chave do pagador do Pix.
|
|
2500
|
textoRetorno:
|
|
2501
|
type: string
|
|
2502
|
description: Texto da mensagem de retorno do Pix.
|
|
2503
|
idInstituicaoPagador:
|
|
2504
|
type: integer
|
|
2505
|
description: Código identificador da instituição do pagador do Pix.
|
|
2506
|
agenciaPagador:
|
|
2507
|
type: integer
|
|
2508
|
description: Prefixo da agência do pagador do Pix.
|
|
2509
|
contaPagador:
|
|
2510
|
type: integer
|
|
2511
|
description: Número da conta corrente do pagador do Pix.
|
|
2512
|
tipoPessoaPagador:
|
|
2513
|
type: integer
|
|
2514
|
description: >-
|
|
2515
|
Código do tipo de pessoa do pagador do Pix. Este valor pode ser
|
|
2516
|
1 para Pessoa Física ou 2 para Pessoa Jurídica.
|
|
2517
|
minimum: 1
|
|
2518
|
maximum: 2
|
|
2519
|
idPagador:
|
|
2520
|
type: integer
|
|
2521
|
description: Número do CPF ou CNPJ do pagador do Pix.
|
|
2522
|
format: float
|
|
2523
|
qrCode:
|
|
2524
|
type: object
|
|
2525
|
properties:
|
|
2526
|
url:
|
|
2527
|
type: string
|
|
2528
|
description: 'URL do payload do QR Code Pix '
|
|
2529
|
txId:
|
|
2530
|
type: string
|
|
2531
|
description: Codigo que identifica a transação Pix - transactionID
|
|
2532
|
emv:
|
|
2533
|
type: string
|
|
2534
|
description: >-
|
|
2535
|
BR Code no padrão EMV. Sequência de caracteres correspondente ao
|
|
2536
|
payload do QR Code Pix.
|
|
2537
|
tipo:
|
|
2538
|
type: integer
|
|
2539
|
description: >-
|
|
2540
|
Código do tipo de QR Code do Pix. Este valor pode ser 1 para
|
|
2541
|
Estático ou 2 para Dinâmico.
|
|
2542
|
minimum: 1
|
|
2543
|
maximum: 2
|
|
2544
|
RespostaDetalhamentoBoleto:
|
|
2545
|
type: object
|
|
2546
|
description: >-
|
|
2547
|
Representação dos campos de resposta de uma solicitação de detalhamento
|
|
2548
|
de boletos bancários.
|
|
2549
|
title: ''
|
|
2550
|
properties:
|
|
2551
|
codigoLinhaDigitavel:
|
|
2552
|
type: string
|
|
2553
|
description: Campo correpondente à linha digitável do boleto.
|
|
2554
|
textoEmailPagador:
|
|
2555
|
type: string
|
|
2556
|
description: E-mail do Pagador.
|
|
2557
|
textoMensagemBloquetoTitulo:
|
|
2558
|
type: string
|
|
2559
|
description: Mensagem para ser impressa no boleto.
|
|
2560
|
codigoTipoMulta:
|
|
2561
|
type: number
|
|
2562
|
description: >
|
|
2563
|
Código para identificação do tipo de multa para o Título de
|
|
2564
|
Cobrança.
|
|
2565
|
|
|
2566
|
|
|
2567
|
Domínios:
|
|
2568
|
|
|
2569
|
0 - Sem multa
|
|
2570
|
|
|
2571
|
1 - Valor da Multa
|
|
2572
|
|
|
2573
|
2 - Percentual da Multa.
|
|
2574
|
codigoCanalPagamento:
|
|
2575
|
type: number
|
|
2576
|
description: >-
|
|
2577
|
Código para identificação da forma de pagamento e do canal onde foi
|
|
2578
|
pago o boleto. Composto por 3 dígitos.
|
|
2579
|
|
|
2580
|
|
|
2581
|
O primeiro dígito é:
|
|
2582
|
|
|
2583
|
1 Espécie
|
|
2584
|
|
|
2585
|
2 Débito em conta
|
|
2586
|
|
|
2587
|
3 Cartão de crédito
|
|
2588
|
|
|
2589
|
4 Cheque
|
|
2590
|
|
|
2591
|
|
|
2592
|
Os dois últimos:
|
|
2593
|
|
|
2594
|
01 Agencias - Postos tradicionais
|
|
2595
|
|
|
2596
|
02 Terminal de Auto-atendimento
|
|
2597
|
|
|
2598
|
03 Internet (home / office banking)
|
|
2599
|
|
|
2600
|
05 Correspondente bancário
|
|
2601
|
|
|
2602
|
06 Central de atendimento(Call Center)
|
|
2603
|
|
|
2604
|
07 Arquivo Eletrônico
|
|
2605
|
|
|
2606
|
08 DDA
|
|
2607
|
|
|
2608
|
61 Pix
|
|
2609
|
numeroContratoCobranca:
|
|
2610
|
type: number
|
|
2611
|
description: >-
|
|
2612
|
Código adotado pelo Banco para identificar o Contrato entre este e a
|
|
2613
|
Empresa Cliente.
|
|
2614
|
codigoTipoInscricaoSacado:
|
|
2615
|
type: number
|
|
2616
|
description: >-
|
|
2617
|
Código que identifica o tipo de inscrição da Empresa ou Pessoa
|
|
2618
|
Física perante uma Instituição governamental.
|
|
2619
|
|
|
2620
|
|
|
2621
|
Domínios:
|
|
2622
|
|
|
2623
|
|
|
2624
|
1 - CPF
|
|
2625
|
|
|
2626
|
|
|
2627
|
2 - CNPJ
|
|
2628
|
numeroInscricaoSacadoCobranca:
|
|
2629
|
type: number
|
|
2630
|
description: >-
|
|
2631
|
Número de inscrição da Empresa ou Pessoa Física perante uma
|
|
2632
|
Instituição governamental.
|
|
2633
|
codigoEstadoTituloCobranca:
|
|
2634
|
type: number
|
|
2635
|
description: |-
|
|
2636
|
Código da situação atual do boleto.
|
|
2637
|
|
|
2638
|
Domínios:
|
|
2639
|
|
|
2640
|
1 - NORMAL
|
|
2641
|
2 - MOVIMENTO CARTORIO
|
|
2642
|
3 - EM CARTORIO
|
|
2643
|
4 - TITULO COM OCORRENCIA DE CARTORIO
|
|
2644
|
5 - PROTESTADO ELETRONICO
|
|
2645
|
6 - LIQUIDADO
|
|
2646
|
7 - BAIXADO
|
|
2647
|
8 - TITULO COM PENDENCIA DE CARTORIO
|
|
2648
|
9 - TITULO PROTESTADO MANUAL
|
|
2649
|
10 - TITULO BAIXADO/PAGO EM CARTORIO
|
|
2650
|
11 - TITULO LIQUIDADO/PROTESTADO
|
|
2651
|
12 - TITULO LIQUID/PGCRTO
|
|
2652
|
13 - TITULO PROTESTADO AGUARDANDO BAIXA
|
|
2653
|
14 - TITULO EM LIQUIDACAO
|
|
2654
|
15 - TITULO AGENDADO
|
|
2655
|
16 - TITULO CREDITADO
|
|
2656
|
17 - PAGO EM CHEQUE - AGUARD.LIQUIDACAO
|
|
2657
|
18 - PAGO PARCIALMENTE
|
|
2658
|
19 - PAGO PARCIALMENTE CREDITADO
|
|
2659
|
21 - TITULO AGENDADO COMPE
|
|
2660
|
80 - EM PROCESSAMENTO (ESTADO TRANSITÓRIO)
|
|
2661
|
codigoTipoTituloCobranca:
|
|
2662
|
type: number
|
|
2663
|
description: "Código para identificar o tipo de boleto de cobrança.\n\nDomínios:\n\n1\t- CHEQUE\n2\t- DUPLICATA MERCANTIL\n3\t- DUPLICATA MTIL POR INDICACAO\n4\t- DUPLICATA DE SERVICO\n5\t- DUPLICATA DE SRVC P/INDICACAO\n6\t- DUPLICATA RURAL\n7\t- LETRA DE CAMBIO\n8\t- NOTA DE CREDITO COMERCIAL\n9\t- NOTA DE CREDITO A EXPORTACAO\n10\t- NOTA DE CREDITO INDULTRIAL\n11\t- NOTA DE CREDITO RURAL\n12\t- NOTA PROMISSORIA\n13\t- NOTA PROMISSORIA RURAL\n14\t- TRIPLICATA MERCANTIL\n15\t- TRIPLICATA DE SERVICO\n16\t- NOTA DE SEGURO\n17\t- RECIBO\n18\t- FATURA\n19\t- NOTA DE DEBITO\n20\t- APOLICE DE SEGURO\n21\t- MENSALIDADE ESCOLAR\n22\t- PARCELA DE CONSORCIO\n23\t- DIVIDA ATIVA DA UNIAO\n24\t- DIVIDA ATIVA DE ESTADO\n25\t- DIVIDA ATIVA DE MUNICIPIO\n31\t- CARTAO DE CREDITO\n32 \t- BOLETO PROPOSTA\n99\t- OUTROS"
|
|
2664
|
codigoModalidadeTitulo:
|
|
2665
|
type: number
|
|
2666
|
description: >-
|
|
2667
|
Código para identificar a característica dos boletos dentro das
|
|
2668
|
modalidades de cobrança existentes no banco.
|
|
2669
|
|
|
2670
|
|
|
2671
|
Domínios:
|
|
2672
|
|
|
2673
|
|
|
2674
|
1 - SIMPLES
|
|
2675
|
|
|
2676
|
4 - VINCULADA
|
|
2677
|
codigoAceiteTituloCobranca:
|
|
2678
|
type: string
|
|
2679
|
description: >-
|
|
2680
|
Código para identificar se o boleto de cobrança foi aceito
|
|
2681
|
(reconhecimento da dívida pelo Pagador).
|
|
2682
|
|
|
2683
|
|
|
2684
|
Domínios:
|
|
2685
|
|
|
2686
|
|
|
2687
|
A - ACEITE
|
|
2688
|
|
|
2689
|
N - NAO ACEITE
|
|
2690
|
codigoPrefixoDependenciaCobrador:
|
|
2691
|
type: number
|
|
2692
|
description: Código agência da praça do pagador (endereço).
|
|
2693
|
codigoIndicadorEconomico:
|
|
2694
|
type: number
|
|
2695
|
description: "Código para identificar a moeda referenciada no boleto.\n\nDomínios:\n0\t- NENHUM\n1\t- FAJTR\n2\t- DOLAR\n3\t- EURO\n4\t- IENE\n5\t- MARCO ALEMAO\n6\t- FTR\n7\t- IDTR\n8\t- UFIR\n9\t- REAL\n10\t- SELIC\n11\t- IGP-M\n12\t- INPC\n13\t- TR (BESC)"
|
|
2696
|
numeroTituloCedenteCobranca:
|
|
2697
|
type: string
|
|
2698
|
description: >-
|
|
2699
|
Campo destinado para uso da Empresa Beneficiário para identificação
|
|
2700
|
do boleto. Equivalente ao SEU NÚMERO ou ao numeroTituloBeneficiario
|
|
2701
|
do request do registro
|
|
2702
|
codigoTipoJuroMora:
|
|
2703
|
type: number
|
|
2704
|
description: >-
|
|
2705
|
Código utilizado pela FEBRABAN para identificar o tipo de taxa de
|
|
2706
|
juros.
|
|
2707
|
|
|
2708
|
|
|
2709
|
Domínios:
|
|
2710
|
|
|
2711
|
0 - DISPENSAR
|
|
2712
|
|
|
2713
|
1 - VALOR DIA ATRASO
|
|
2714
|
|
|
2715
|
2 - TAXA MENSAL
|
|
2716
|
|
|
2717
|
3 - ISENTO
|
|
2718
|
dataEmissaoTituloCobranca:
|
|
2719
|
type: string
|
|
2720
|
description: Data de emissão do boleto.
|
|
2721
|
dataRegistroTituloCobranca:
|
|
2722
|
type: string
|
|
2723
|
description: Data de registro do boleto.
|
|
2724
|
dataVencimentoTituloCobranca:
|
|
2725
|
type: string
|
|
2726
|
description: Data de vencimento do boleto.
|
|
2727
|
valorOriginalTituloCobranca:
|
|
2728
|
type: number
|
|
2729
|
description: Valor original do boleto indicado quando do registro.
|
|
2730
|
format: float
|
|
2731
|
valorAtualTituloCobranca:
|
|
2732
|
type: number
|
|
2733
|
description: >-
|
|
2734
|
Valor atualizado do boleto, considerando possíveis multa, juros,
|
|
2735
|
mora, descontos, etc., que incidiram sob o valor original
|
|
2736
|
format: float
|
|
2737
|
valorPagamentoParcialTitulo:
|
|
2738
|
type: number
|
|
2739
|
description: Valores já recebidos em pagamentos parciais.
|
|
2740
|
format: float
|
|
2741
|
valorAbatimentoTituloCobranca:
|
|
2742
|
type: number
|
|
2743
|
description: >-
|
|
2744
|
Valor do abatimento (redução do valor do documento, devido a algum
|
|
2745
|
problema), expresso em moeda corrente.
|
|
2746
|
format: float
|
|
2747
|
percentualImpostoSobreOprFinanceirasTituloCobranca:
|
|
2748
|
type: number
|
|
2749
|
description: >-
|
|
2750
|
Percentual do IOF - Imposto sobre Operações Financeiras - de um
|
|
2751
|
boleto prêmio de seguro na sua data de emissão, expresso de acordo
|
|
2752
|
com o tipo de moeda.
|
|
2753
|
format: float
|
|
2754
|
valorImpostoSobreOprFinanceirasTituloCobranca:
|
|
2755
|
type: number
|
|
2756
|
description: >-
|
|
2757
|
Valor do IOF - Imposto sobre Operações Financeiras - de um boleto
|
|
2758
|
prêmio de seguro na sua data de emissão, expresso de acordo com o
|
|
2759
|
tipo de moeda.
|
|
2760
|
format: float
|
|
2761
|
valorMoedaTituloCobranca:
|
|
2762
|
type: number
|
|
2763
|
description: Valor do boleto expresso em moeda variável.
|
|
2764
|
format: float
|
|
2765
|
percentualJuroMoraTitulo:
|
|
2766
|
type: number
|
|
2767
|
description: Porcentagem sobre o valor do boleto a ser cobrada de juros de mora.
|
|
2768
|
valorJuroMoraTitulo:
|
|
2769
|
type: number
|
|
2770
|
description: Valor sobre o valor do boleto a ser cobrado de juros de mora.
|
|
2771
|
format: float
|
|
2772
|
percentualMultaTitulo:
|
|
2773
|
type: number
|
|
2774
|
description: Porcentagem sobre o valor do boleto a ser cobrada de multa.
|
|
2775
|
format: float
|
|
2776
|
valorMultaTituloCobranca:
|
|
2777
|
type: number
|
|
2778
|
description: Valor sobre o valor do boleto a ser cobrado de multa.
|
|
2779
|
format: float
|
|
2780
|
quantidadeParcelaTituloCobranca:
|
|
2781
|
type: number
|
|
2782
|
description: Quantidade de parcela do boleto.
|
|
2783
|
dataBaixaAutomaticoTitulo:
|
|
2784
|
type: string
|
|
2785
|
description: Data da baixa automática do boleto, conforme cadastrado no convênio.
|
|
2786
|
textoCampoUtilizacaoCedente:
|
|
2787
|
type: string
|
|
2788
|
description: >-
|
|
2789
|
Texto de observações destinado ao envio de mensagens livres, a serem
|
|
2790
|
impressas no campo de instruções da ficha de compensação do Boleto
|
|
2791
|
de Pagamento.
|
|
2792
|
indicadorCobrancaPartilhadoTitulo:
|
|
2793
|
type: string
|
|
2794
|
description: |-
|
|
2795
|
Código para identificação de Rateio de Crédito (partilhamento).
|
|
2796
|
|
|
2797
|
Domínios:
|
|
2798
|
|
|
2799
|
S - SIM
|
|
2800
|
|
|
2801
|
N - NÃO
|
|
2802
|
nomeSacadoCobranca:
|
|
2803
|
type: string
|
|
2804
|
description: >-
|
|
2805
|
Nome que identifica a pessoa, física ou jurídica, a qual se quer
|
|
2806
|
fazer referência.
|
|
2807
|
textoEnderecoSacadoCobranca:
|
|
2808
|
type: string
|
|
2809
|
description: >-
|
|
2810
|
Texto referente a localização da rua/avenida, número, complemento
|
|
2811
|
para entrega de correspondência.
|
|
2812
|
nomeBairroSacadoCobranca:
|
|
2813
|
type: string
|
|
2814
|
description: Texto referente ao bairro para entrega de correspondência.
|
|
2815
|
nomeMunicipioSacadoCobranca:
|
|
2816
|
type: string
|
|
2817
|
description: >-
|
|
2818
|
Texto referente ao nome do município componente do endereço
|
|
2819
|
utilizado para entrega de correspondência.
|
|
2820
|
siglaUnidadeFederacaoSacadoCobranca:
|
|
2821
|
type: string
|
|
2822
|
description: >-
|
|
2823
|
Código do estado, unidade da federação componente do endereço
|
|
2824
|
utilizado para entrega de correspondência.
|
|
2825
|
numeroCepSacadoCobranca:
|
|
2826
|
type: number
|
|
2827
|
description: Código adotado pelos Correios, para identificação de logradouros.
|
|
2828
|
valorMoedaAbatimentoTitulo:
|
|
2829
|
type: number
|
|
2830
|
description: Valor da moeda do abatimento.
|
|
2831
|
format: float
|
|
2832
|
dataProtestoTituloCobranca:
|
|
2833
|
type: string
|
|
2834
|
description: Data para inicialização do processo de cobrança via protesto.
|
|
2835
|
codigoTipoInscricaoSacador:
|
|
2836
|
type: number
|
|
2837
|
description: >-
|
|
2838
|
Código que identifica o tipo de inscrição do Beneficiário original
|
|
2839
|
do boleto de cobrança.
|
|
2840
|
|
|
2841
|
|
|
2842
|
Domínios:
|
|
2843
|
|
|
2844
|
|
|
2845
|
1 - CPF
|
|
2846
|
|
|
2847
|
|
|
2848
|
2 - CNPJ
|
|
2849
|
numeroInscricaoSacadorAvalista:
|
|
2850
|
type: number
|
|
2851
|
description: Número de inscrição do Beneficiário original do boleto de cobrança.
|
|
2852
|
nomeSacadorAvalistaTitulo:
|
|
2853
|
type: string
|
|
2854
|
description: >-
|
|
2855
|
Nome que identifica a entidade, pessoa física ou jurídica,
|
|
2856
|
Beneficiário original do boleto de cobrança.
|
|
2857
|
percentualDescontoTitulo:
|
|
2858
|
type: number
|
|
2859
|
description: Percentual de desconto a ser concedido sobre o boleto de cobrança.
|
|
2860
|
format: float
|
|
2861
|
dataDescontoTitulo:
|
|
2862
|
type: string
|
|
2863
|
description: Data limite do desconto do boleto de cobrança.
|
|
2864
|
valorDescontoTitulo:
|
|
2865
|
type: number
|
|
2866
|
description: Valor de desconto a ser concedido sobre o boleto de cobrança.
|
|
2867
|
format: float
|
|
2868
|
codigoDescontoTitulo:
|
|
2869
|
type: number
|
|
2870
|
description: >-
|
|
2871
|
Código para identificação do tipo de desconto que deverá ser
|
|
2872
|
concedido.
|
|
2873
|
|
|
2874
|
|
|
2875
|
Domínios:
|
|
2876
|
|
|
2877
|
|
|
2878
|
0 - SEM DESCONTO
|
|
2879
|
|
|
2880
|
|
|
2881
|
1 - VLR FIXO ATE A DATA INFORMADA
|
|
2882
|
|
|
2883
|
|
|
2884
|
2 - PERCENTUAL ATE A DATA INFORMADA
|
|
2885
|
|
|
2886
|
|
|
2887
|
3 - DESCONTO POR DIA DE ANTECIPACAO
|
|
2888
|
percentualSegundoDescontoTitulo:
|
|
2889
|
type: number
|
|
2890
|
description: >-
|
|
2891
|
Percentual do segundo desconto a ser concedido sobre o boleto de
|
|
2892
|
cobrança.
|
|
2893
|
format: float
|
|
2894
|
dataSegundoDescontoTitulo:
|
|
2895
|
type: string
|
|
2896
|
description: Data limite do segundo desconto do boleto de cobrança.
|
|
2897
|
valorSegundoDescontoTitulo:
|
|
2898
|
type: number
|
|
2899
|
description: >-
|
|
2900
|
Valor do segundo desconto a ser concedido sobre o boleto de
|
|
2901
|
cobrança.
|
|
2902
|
format: float
|
|
2903
|
codigoSegundoDescontoTitulo:
|
|
2904
|
type: number
|
|
2905
|
description: >-
|
|
2906
|
Código para identificação do tipo do segundo desconto que deverá ser
|
|
2907
|
concedido.
|
|
2908
|
|
|
2909
|
|
|
2910
|
Domínios:
|
|
2911
|
|
|
2912
|
|
|
2913
|
0 - SEM DESCONTO
|
|
2914
|
|
|
2915
|
|
|
2916
|
1 - VLR FIXO ATE A DATA INFORMADA
|
|
2917
|
|
|
2918
|
|
|
2919
|
2 - PERCENTUAL ATE A DATA INFORMADA
|
|
2920
|
|
|
2921
|
|
|
2922
|
3 - DESCONTO POR DIA DE ANTECIPACAO
|
|
2923
|
percentualTerceiroDescontoTitulo:
|
|
2924
|
type: number
|
|
2925
|
description: >-
|
|
2926
|
Percentual do terceiro desconto a ser concedido sobre o boleto de
|
|
2927
|
cobrança.
|
|
2928
|
format: float
|
|
2929
|
dataTerceiroDescontoTitulo:
|
|
2930
|
type: string
|
|
2931
|
description: Data limite do terceiro desconto do boleto de cobrança.
|
|
2932
|
valorTerceiroDescontoTitulo:
|
|
2933
|
type: number
|
|
2934
|
description: >-
|
|
2935
|
Valor do terceiro desconto a ser concedido sobre o boleto de
|
|
2936
|
cobrança.
|
|
2937
|
format: float
|
|
2938
|
codigoTerceiroDescontoTitulo:
|
|
2939
|
type: number
|
|
2940
|
description: >-
|
|
2941
|
Código para identificação do tipo do terceiro desconto que deverá
|
|
2942
|
ser concedido.
|
|
2943
|
|
|
2944
|
|
|
2945
|
Domínios:
|
|
2946
|
|
|
2947
|
|
|
2948
|
0 - SEM DESCONTO
|
|
2949
|
|
|
2950
|
|
|
2951
|
1 - VLR FIXO ATE A DATA INFORMADA
|
|
2952
|
|
|
2953
|
|
|
2954
|
2 - PERCENTUAL ATE A DATA INFORMADA
|
|
2955
|
|
|
2956
|
|
|
2957
|
3 - DESCONTO POR DIA DE ANTECIPACAO
|
|
2958
|
dataMultaTitulo:
|
|
2959
|
type: string
|
|
2960
|
description: Data para início da cobrança da multa.
|
|
2961
|
numeroCarteiraCobranca:
|
|
2962
|
type: number
|
|
2963
|
description: Número da carteira do convênio de cobrança.
|
|
2964
|
numeroVariacaoCarteiraCobranca:
|
|
2965
|
type: number
|
|
2966
|
description: Número da variação da carteira do convênio de cobrança.
|
|
2967
|
quantidadeDiaProtesto:
|
|
2968
|
type: number
|
|
2969
|
description: >-
|
|
2970
|
Número de dias decorrentes após a data de vencimento para
|
|
2971
|
inicialização do processo de cobrança via protesto.
|
|
2972
|
quantidadeDiaPrazoLimiteRecebimento:
|
|
2973
|
type: number
|
|
2974
|
description: >-
|
|
2975
|
Número de dias corridos para recebimento do boleto após a data de
|
|
2976
|
vencimento.
|
|
2977
|
dataLimiteRecebimentoTitulo:
|
|
2978
|
type: string
|
|
2979
|
description: Data limite para recebimento do boleto após a data de vencimento.
|
|
2980
|
indicadorPermissaoRecebimentoParcial:
|
|
2981
|
type: string
|
|
2982
|
description: >-
|
|
2983
|
Código para identificação da autorização de pagamento parcial do
|
|
2984
|
boleto.
|
|
2985
|
|
|
2986
|
|
|
2987
|
Domínios:
|
|
2988
|
|
|
2989
|
|
|
2990
|
S - SIM
|
|
2991
|
|
|
2992
|
|
|
2993
|
N - NAO
|
|
2994
|
textoCodigoBarrasTituloCobranca:
|
|
2995
|
type: string
|
|
2996
|
description: Código de barras do boleto.
|
|
2997
|
codigoOcorrenciaCartorio:
|
|
2998
|
type: number
|
|
2999
|
description: "Código para identificação das ocorrências de retorno do cartório.\n\nDomínios:\n\n0\t- TITULO PROTOCOLADO - ANTIGO \"TEC\"\n\n1\t- TITULO PAGO EM CARTORIO\n\n2\t- TITULO PROTESTADO - ANTIGO \"DDP\"\n\n3\t- TITULO RETIRADO CARTORIO - ANT. DDS\n\n4\t- TITULO SUSTADO JUDICIALMENTE\n\n5\t- TITULO RECUSADO SEM CUSTAS\n\n6\t- TITULO RECUSADO COM CUSTAS\n\n7\t- TITULO PAGO LIQUIDACAO CONDICIONAL\n\n8\t- TITULO ACEITO\n\n9\t- CUSTAS DE EDITAL\n\n20\t- LQ. CARTORIO AG. SEMI-AUTOM.\n\n21\t- CHQ DEVOLV. TIT. ENC. PROT.\n\n22\t- TITULO SUSTADO DEFINITIVO\n\n23\t- RETIRADA APÓS SUSTAÇÃO JUDICIAL\n\n59\t- PAGTO CONDICIONAL VIA SELTEC\n\n60\t- TITULO PAGO EM CARTORIO-SELTEC"
|
|
3000
|
valorImpostoSobreOprFinanceirasRecebidoTitulo:
|
|
3001
|
type: number
|
|
3002
|
description: Valor do IOF recebido.
|
|
3003
|
format: float
|
|
3004
|
valorAbatimentoTotal:
|
|
3005
|
type: number
|
|
3006
|
description: Valor do abatimento concedido.
|
|
3007
|
format: float
|
|
3008
|
valorJuroMoraRecebido:
|
|
3009
|
type: number
|
|
3010
|
description: Valor dos juros recebidos.
|
|
3011
|
format: float
|
|
3012
|
valorDescontoUtilizado:
|
|
3013
|
type: number
|
|
3014
|
description: Valor de desconto utilizado pelo pagador.
|
|
3015
|
format: float
|
|
3016
|
valorPagoSacado:
|
|
3017
|
type: number
|
|
3018
|
description: Valor pago.
|
|
3019
|
format: float
|
|
3020
|
valorCreditoCedente:
|
|
3021
|
type: number
|
|
3022
|
description: Valor líquido creditado ao beneficiário.
|
|
3023
|
format: float
|
|
3024
|
codigoTipoLiquidacao:
|
|
3025
|
type: number
|
|
3026
|
description: "Código para identificação do tipo de liquidação.\n\nDomínios:\n\n1\tCAIXA\n2\tVIA COMPE\n3\tEM CARTORIO\n4\tEM CARTORIO - SEM EXISTENCIA 17 POS\n5\tTITULO EM LIQUIDACAO - ORIGEM AGE\n6\tTITULO EM LIQUIDACAO - PGT\n7\tBANCO POSTAL\n8\tTITULO LIQUIDADO VIA COMPE/STR"
|
|
3027
|
dataCreditoLiquidacao:
|
|
3028
|
type: string
|
|
3029
|
description: >-
|
|
3030
|
Data a qual será creditado o valor inerente ao título (este campo só
|
|
3031
|
será preenchido após a liquidação, ou seja, após
|
|
3032
|
codigoEstadoTituloCobranca = 6).
|
|
3033
|
dataRecebimentoTitulo:
|
|
3034
|
type: string
|
|
3035
|
description: Data para a qual foi agendado o recebimento/pagamento do título.
|
|
3036
|
codigoPrefixoDependenciaRecebedor:
|
|
3037
|
type: number
|
|
3038
|
description: Código agência da praça do recebimento do boleto.
|
|
3039
|
codigoNaturezaRecebimento:
|
|
3040
|
type: number
|
|
3041
|
description: >-
|
|
3042
|
Código para identificar as ocorrências (rejeições, tarifas, custas,
|
|
3043
|
liquidação e baixas) do boleto.
|
|
3044
|
|
|
3045
|
|
|
3046
|
Domínios:
|
|
3047
|
|
|
3048
|
|
|
3049
|
1 - NORMAL
|
|
3050
|
|
|
3051
|
2 - POR CONTA
|
|
3052
|
|
|
3053
|
3 - POR SALDO
|
|
3054
|
|
|
3055
|
4 - CHEQUE A COMPENSAR
|
|
3056
|
|
|
3057
|
7 - LIQUIDADO NA APRESENTACAO
|
|
3058
|
|
|
3059
|
8 - POR CONTA EM CARTORIO
|
|
3060
|
|
|
3061
|
9 - EM CARTORIO
|
|
3062
|
numeroIdentidadeSacadoTituloCobranca:
|
|
3063
|
type: string
|
|
3064
|
description: Número de identidade do sacado do título.
|
|
3065
|
codigoResponsavelAtualizacao:
|
|
3066
|
type: string
|
|
3067
|
description: >-
|
|
3068
|
Código para identificação do sistema/usuário responsável pela
|
|
3069
|
atualização do boleto.
|
|
3070
|
codigoTipoBaixaTitulo:
|
|
3071
|
type: number
|
|
3072
|
description: "Código para identificação do tipo de baixa do boleto.\n\nDomínios:\n\n1\t- BAIXADO POR SOLICITACAO\n2\t- ENTREGA FRANCO PAGAMENTO\n9\t- COMANDADA BANCO\n10\t- COMANDADA CLIENTE - ARQUIVO\n11\t- COMANDADA CLIENTE - ON-LINE\n12\t- DECURSO PRAZO - CLIENTE\n13\t- DECURSO PRAZO - BANCO\n15\t- PROTESTADO\n31\t- LIQUIDADO ANTERIORMENTE\n32\t- HABILITADO EM PROCESSO\n35\t- TRANSFERIDO PARA PERDAS\n51\t- REGISTRADO INDEVIDAMENTE\n90\t- BAIXA AUTOMATICA"
|
|
3073
|
valorMultaRecebido:
|
|
3074
|
type: number
|
|
3075
|
description: Valor de multa recebido.
|
|
3076
|
format: float
|
|
3077
|
valorReajuste:
|
|
3078
|
type: number
|
|
3079
|
description: Valor do reajuste (índice econômico).
|
|
3080
|
format: float
|
|
3081
|
valorOutroRecebido:
|
|
3082
|
type: number
|
|
3083
|
description: Outros valores recebidos.
|
|
3084
|
format: float
|
|
3085
|
codigoIndicadorEconomicoUtilizadoInadimplencia:
|
|
3086
|
type: number
|
|
3087
|
description: Código do índice econômico utilizado para o cálculo de juros/multa.
|
|
3088
|
format: float
|
|
3089
|
RespostaListaBoletos:
|
|
3090
|
type: object
|
|
3091
|
description: Objeto de Resposta do recurso GET Lista Boletos
|
|
3092
|
properties:
|
|
3093
|
indicadorContinuidade:
|
|
3094
|
type: string
|
|
3095
|
description: >-
|
|
3096
|
Indicador de que a consulta resultou em uma quantidade superior a
|
|
3097
|
300 boletos (capacidade de resposta por requisição do serviço). Uma
|
|
3098
|
nova requisição, nos mesmos moldes, deve ser feita para consultar o
|
|
3099
|
restante dos boletos. Para tanto, deverá ser utilizado o valor
|
|
3100
|
informado no atributo "Número Último Registro" como valor inicial da
|
|
3101
|
próxima consulta.
|
|
3102
|
example: s
|
|
3103
|
quantidadeRegistros:
|
|
3104
|
type: integer
|
|
3105
|
description: 'Quantidade de boletos que atendem os critérios da requisição. '
|
|
3106
|
format: int32
|
|
3107
|
example: 300
|
|
3108
|
proximoIndice:
|
|
3109
|
type: integer
|
|
3110
|
description: >-
|
|
3111
|
Número do último registro apresentado pela lista, que poderá ser
|
|
3112
|
utilizado como parâmetro inicial de uma nova requisição para
|
|
3113
|
consultar os boletos restantes.
|
|
3114
|
format: int32
|
|
3115
|
example: 300
|
|
3116
|
boletos:
|
|
3117
|
type: array
|
|
3118
|
items:
|
|
3119
|
type: object
|
|
3120
|
properties:
|
|
3121
|
numeroBoletoBB:
|
|
3122
|
type: string
|
|
3123
|
description: >-
|
|
3124
|
Número de identificação do boleto (correspondente ao NOSSO
|
|
3125
|
NÚMERO), no formato STRING, com 20 dígitos. Corresponde aos
|
|
3126
|
campos numeroTituloCliente (requisição do registro do boleto),
|
|
3127
|
numero (resposta do registro) e id (detalhamento do boleto).
|
|
3128
|
example: '00024589070000000412'
|
|
3129
|
estadoTituloCobranca:
|
|
3130
|
type: string
|
|
3131
|
description: |-
|
|
3132
|
Texto da situação atual do boleto.
|
|
3133
|
|
|
3134
|
Possíveis valores de retorno:
|
|
3135
|
- NORMAL
|
|
3136
|
- MOVIMENTO CARTORIO
|
|
3137
|
- EM CARTORIO
|
|
3138
|
- TITULO COM OCORRENCIA DE CARTORIO
|
|
3139
|
- PROTESTADO ELETRONICO
|
|
3140
|
- LIQUIDADO
|
|
3141
|
- BAIXADO
|
|
3142
|
- TITULO COM PENDENCIA DE CARTORIO
|
|
3143
|
- TITULO PROTESTADO MANUAL
|
|
3144
|
example: Mvto. Cartorio
|
|
3145
|
dataRegistro:
|
|
3146
|
type: string
|
|
3147
|
description: |
|
|
3148
|
Data de registro do boleto.
|
|
3149
|
example: 01.05.2020
|
|
3150
|
dataVencimento:
|
|
3151
|
type: string
|
|
3152
|
description: |
|
|
3153
|
Data de vencimento do boleto
|
|
3154
|
example: 01.05.2020
|
|
3155
|
dataMovimento:
|
|
3156
|
type: string
|
|
3157
|
description: >
|
|
3158
|
Data do evento que baixou, protestou ou liquidou o boleto. No
|
|
3159
|
caso de títulos vigentes, ainda que vencidos, equivale a data
|
|
3160
|
de registro.
|
|
3161
|
example: 01.05.2020
|
|
3162
|
valorOriginal:
|
|
3163
|
type: number
|
|
3164
|
description: |
|
|
3165
|
Valor do boleto no registro.
|
|
3166
|
format: float
|
|
3167
|
example: 1000
|
|
3168
|
valorAtual:
|
|
3169
|
type: number
|
|
3170
|
description: |
|
|
3171
|
Valor atualizado do boleto.
|
|
3172
|
format: float
|
|
3173
|
example: 10000
|
|
3174
|
valorPago:
|
|
3175
|
type: number
|
|
3176
|
description: |
|
|
3177
|
Valor pago pelo pagador/sacado.
|
|
3178
|
format: float
|
|
3179
|
example: 9000
|
|
3180
|
contrato:
|
|
3181
|
type: integer
|
|
3182
|
description: >-
|
|
3183
|
Código do contrato entre o Banco do Brasil e a empresa
|
|
3184
|
cliente.
|
|
3185
|
format: int32
|
|
3186
|
example: 0
|
|
3187
|
carteiraConvenio:
|
|
3188
|
type: integer
|
|
3189
|
description: |
|
|
3190
|
Número da carteira do convênio de cobrança.
|
|
3191
|
format: int32
|
|
3192
|
example: 17
|
|
3193
|
variacaoCarteiraConvenio:
|
|
3194
|
type: integer
|
|
3195
|
description: Número da variação da carteira do convênio de cobrança.
|
|
3196
|
format: int32
|
|
3197
|
example: 27
|
|
3198
|
codigoEstadoTituloCobranca:
|
|
3199
|
type: integer
|
|
3200
|
description: |-
|
|
3201
|
Código da situação atual do boleto:
|
|
3202
|
|
|
3203
|
Domínios:
|
|
3204
|
01 - NORMAL
|
|
3205
|
02 - MOVIMENTO CARTORIO
|
|
3206
|
03 - EM CARTORIO
|
|
3207
|
04 - TITULO COM OCORRENCIA DE CARTORIO
|
|
3208
|
05 - PROTESTADO ELETRONICO
|
|
3209
|
06 - LIQUIDADO
|
|
3210
|
07 - BAIXADO
|
|
3211
|
08 - TITULO COM PENDENCIA DE CARTORIO
|
|
3212
|
09 - TITULO PROTESTADO MANUAL
|
|
3213
|
format: int32
|
|
3214
|
example: 1
|
|
3215
|
dataCredito:
|
|
3216
|
type: string
|
|
3217
|
description: Data do crédito dos valores ao beneficiário
|
|
3218
|
example: 01.05.2020
|
|
3219
|
RespostaRegistroBoletos:
|
|
3220
|
type: object
|
|
3221
|
description: >-
|
|
3222
|
Representação dos campos de resposta de uma solicitação de criação de
|
|
3223
|
boletos bancários.
|
|
3224
|
properties:
|
|
3225
|
numero:
|
|
3226
|
type: string
|
|
3227
|
description: Identificador exclusivo do boleto.
|
|
3228
|
numeroCarteira:
|
|
3229
|
type: number
|
|
3230
|
description: Número da carteira do convênio de cobrança
|
|
3231
|
numeroVariacaoCarteira:
|
|
3232
|
type: number
|
|
3233
|
description: Número da variação da carteira do convênio de cobrança
|
|
3234
|
codigoCliente:
|
|
3235
|
type: number
|
|
3236
|
description: Identificação do cliente.
|
|
3237
|
linhaDigitavel:
|
|
3238
|
type: string
|
|
3239
|
description: Linha digitável do boleto.
|
|
3240
|
codigoBarraNumerico:
|
|
3241
|
type: string
|
|
3242
|
description: Define o código de barras numérico do boleto.
|
|
3243
|
numeroContratoCobranca:
|
|
3244
|
type: number
|
|
3245
|
description: Define o número do contrato de cobrança do boleto.
|
|
3246
|
beneficiario:
|
|
3247
|
type: object
|
|
3248
|
properties:
|
|
3249
|
agencia:
|
|
3250
|
type: number
|
|
3251
|
description: Agência do beneficiário.
|
|
3252
|
contaCorrente:
|
|
3253
|
type: number
|
|
3254
|
description: Número da conta corrente do beneficiário.
|
|
3255
|
tipoEndereco:
|
|
3256
|
type: number
|
|
3257
|
description: Código do tipo de endereço do beneficiário.
|
|
3258
|
logradouro:
|
|
3259
|
type: string
|
|
3260
|
description: Nome do logradouro do beneficiário.
|
|
3261
|
bairro:
|
|
3262
|
type: string
|
|
3263
|
description: Bairro do Beneficiário.
|
|
3264
|
cidade:
|
|
3265
|
type: string
|
|
3266
|
description: Cidade do Beneficiário.
|
|
3267
|
codigoCidade:
|
|
3268
|
type: number
|
|
3269
|
description: Identificador da cidade do beneficiário.
|
|
3270
|
uf:
|
|
3271
|
type: string
|
|
3272
|
description: Sigla do Estado do beneficiário.
|
|
3273
|
cep:
|
|
3274
|
type: number
|
|
3275
|
description: Código Postal do Beneficiário.
|
|
3276
|
indicadorComprovacao:
|
|
3277
|
type: string
|
|
3278
|
description: Indicador de prova de vida do beneficiário.
|
|
3279
|
qrCode:
|
|
3280
|
type: object
|
|
3281
|
properties:
|
|
3282
|
url:
|
|
3283
|
type: string
|
|
3284
|
description: 'URL do payload do QR Code Pix '
|
|
3285
|
txId:
|
|
3286
|
type: string
|
|
3287
|
description: Codigo que identifica a transação Pix - transactionID
|
|
3288
|
emv:
|
|
3289
|
type: string
|
|
3290
|
description: >-
|
|
3291
|
BR Code no padrão EMV. Sequência de caracteres correspondente ao
|
|
3292
|
payload do QR Code Pix.
|
|
3293
|
abatimento:
|
|
3294
|
title: abatimento
|
|
3295
|
type: object
|
|
3296
|
properties:
|
|
3297
|
valorAbatimento:
|
|
3298
|
type: number
|
|
3299
|
description: >-
|
|
3300
|
Valor do abatimento (reduz valor do boleto) expresso em moeda
|
|
3301
|
corrente.
|
|
3302
|
format: double
|
|
3303
|
description: Inclusão de Abatimento em Boleto Bancário
|
|
3304
|
alteracaoAbatimento:
|
|
3305
|
title: alteracaoAbatimento
|
|
3306
|
type: object
|
|
3307
|
properties:
|
|
3308
|
novoValorAbatimento:
|
|
3309
|
type: number
|
|
3310
|
description: >-
|
|
3311
|
Novo valor do abatimento (reduz valor do boleto) expresso em moeda
|
|
3312
|
corrente.
|
|
3313
|
format: double
|
|
3314
|
description: Alterar valor do abatimento concedido em um Boleto Bancário
|
|
3315
|
alteracaoData:
|
|
3316
|
title: alteracaoData
|
|
3317
|
type: object
|
|
3318
|
properties:
|
|
3319
|
novaDataVencimento:
|
|
3320
|
type: string
|
|
3321
|
description: Nova data de vencimento do boleto.
|
|
3322
|
description: Alteração de data de vencimento do boleto.
|
|
3323
|
alteracaoDataDesconto:
|
|
3324
|
title: alteracaoDataDesconto
|
|
3325
|
type: object
|
|
3326
|
properties:
|
|
3327
|
novaDataLimitePrimeiroDesconto:
|
|
3328
|
type: string
|
|
3329
|
description: Nova data limite do Primeiro Desconto
|
|
3330
|
novaDataLimiteSegundoDesconto:
|
|
3331
|
type: string
|
|
3332
|
description: |
|
|
3333
|
Nova data limite do Segundo Desconto
|
|
3334
|
novaDataLimiteTerceiroDesconto:
|
|
3335
|
type: string
|
|
3336
|
description: Nova data limite do Terceiro Desconto
|
|
3337
|
description: >-
|
|
3338
|
Alteração das datas limites para concessão de desconto no Boleto
|
|
3339
|
Bancário
|
|
3340
|
alteracaoDesconto:
|
|
3341
|
title: alteracaoDesconto
|
|
3342
|
type: object
|
|
3343
|
properties:
|
|
3344
|
tipoPrimeiroDesconto:
|
|
3345
|
type: integer
|
|
3346
|
description: >-
|
|
3347
|
Código para identificação do tipo de desconto que deverá ser
|
|
3348
|
concedido como Primeiro Desconto. Valores a informar:
|
|
3349
|
|
|
3350
|
0 - Sem desconto
|
|
3351
|
|
|
3352
|
1 - Valor fixo até a data
|
|
3353
|
|
|
3354
|
2 - Percentual até a data informada
|
|
3355
|
|
|
3356
|
3 - Desconto por dia de antecipação
|
|
3357
|
format: int32
|
|
3358
|
novoValorPrimeiroDesconto:
|
|
3359
|
type: number
|
|
3360
|
description: Novo valor do Primeiro Desconto
|
|
3361
|
format: double
|
|
3362
|
novoPercentualPrimeiroDesconto:
|
|
3363
|
type: number
|
|
3364
|
description: >-
|
|
3365
|
Novo percentual de desconto sobre o valor do boleto no Primeiro
|
|
3366
|
Desconto
|
|
3367
|
format: double
|
|
3368
|
novaDataLimitePrimeiroDesconto:
|
|
3369
|
type: string
|
|
3370
|
description: Nova data limite do Primeiro Desconto
|
|
3371
|
tipoSegundoDesconto:
|
|
3372
|
type: integer
|
|
3373
|
description: >-
|
|
3374
|
Código para identificação do tipo de desconto que deverá ser
|
|
3375
|
concedido como Segundo Desconto. Valores a informar:
|
|
3376
|
|
|
3377
|
0 - Sem desconto
|
|
3378
|
|
|
3379
|
1 - Valor fixo até a data
|
|
3380
|
|
|
3381
|
2 - Percentual até a data informada
|
|
3382
|
|
|
3383
|
3 - Desconto por dia de antecipação
|
|
3384
|
format: int32
|
|
3385
|
novoValorSegundoDesconto:
|
|
3386
|
type: number
|
|
3387
|
description: |
|
|
3388
|
Novo valor do Segundo Desconto
|
|
3389
|
format: double
|
|
3390
|
novoPercentualSegundoDesconto:
|
|
3391
|
type: number
|
|
3392
|
description: >-
|
|
3393
|
Novo percentual de desconto sobre o valor do boleto no Segundo
|
|
3394
|
Desconto
|
|
3395
|
format: double
|
|
3396
|
novaDataLimiteSegundoDesconto:
|
|
3397
|
type: string
|
|
3398
|
description: Nova data limite do Segundo Desconto
|
|
3399
|
tipoTerceiroDesconto:
|
|
3400
|
type: integer
|
|
3401
|
description: >-
|
|
3402
|
Código para identificação do tipo de desconto que deverá ser
|
|
3403
|
concedido como Terceiro Desconto. Valores a informar:
|
|
3404
|
|
|
3405
|
0 - Sem desconto
|
|
3406
|
|
|
3407
|
1 - Valor fixo até a data
|
|
3408
|
|
|
3409
|
2 - Percentual até a data informada
|
|
3410
|
|
|
3411
|
3 - Desconto por dia de antecipação
|
|
3412
|
format: int32
|
|
3413
|
novoValorTerceiroDesconto:
|
|
3414
|
type: number
|
|
3415
|
description: Novo valor do Terceiro Desconto
|
|
3416
|
format: double
|
|
3417
|
novoPercentualTerceiroDesconto:
|
|
3418
|
type: number
|
|
3419
|
description: >-
|
|
3420
|
Novo percentual de desconto sobre o valor do boleto no Terceiro
|
|
3421
|
Desconto
|
|
3422
|
format: double
|
|
3423
|
novaDataLimiteTerceiroDesconto:
|
|
3424
|
type: string
|
|
3425
|
description: Nova data limite do Terceiro Desconto
|
|
3426
|
description: Alteração de desconto em Boletos Bancários
|
|
3427
|
alteracaoEndereco:
|
|
3428
|
title: alteracaoEndereco
|
|
3429
|
type: object
|
|
3430
|
properties:
|
|
3431
|
enderecoPagador:
|
|
3432
|
type: string
|
|
3433
|
description: Endereço do Pagador
|
|
3434
|
bairroPagador:
|
|
3435
|
type: string
|
|
3436
|
description: Bairro do Pagador
|
|
3437
|
cidadePagador:
|
|
3438
|
type: string
|
|
3439
|
description: Cidade do Pagador
|
|
3440
|
UFPagador:
|
|
3441
|
type: string
|
|
3442
|
description: UF do Pagador
|
|
3443
|
CEPPagador:
|
|
3444
|
type: integer
|
|
3445
|
description: CEP do Pagador
|
|
3446
|
format: int32
|
|
3447
|
description: Alteração de dados do Endereço do Pagador em Boleto bancário
|
|
3448
|
alteracaoSeuNumero:
|
|
3449
|
title: alteracaoSeuNumero
|
|
3450
|
type: object
|
|
3451
|
properties:
|
|
3452
|
codigoSeuNumero:
|
|
3453
|
type: string
|
|
3454
|
description: >-
|
|
3455
|
Número adotado e controlado pelo Cliente, para identificar o título
|
|
3456
|
de cobrança.
|
|
3457
|
description: Alteração de Seu Número em Boleto Bancário
|
|
3458
|
alteracaoPrazo:
|
|
3459
|
title: alteracaoPrazo
|
|
3460
|
type: object
|
|
3461
|
properties:
|
|
3462
|
quantidadeDiasAceite:
|
|
3463
|
type: integer
|
|
3464
|
description: >-
|
|
3465
|
Quantidade máxima de dias corridos para recebimento do boleto após a
|
|
3466
|
data de vencimento
|
|
3467
|
format: int32
|
|
3468
|
description: Alteração de prazo limite de aceite após vencimento de Boleto Bancário
|
|
3469
|
desconto:
|
|
3470
|
title: desconto
|
|
3471
|
type: object
|
|
3472
|
properties:
|
|
3473
|
tipoPrimeiroDesconto:
|
|
3474
|
type: integer
|
|
3475
|
description: >-
|
|
3476
|
Código para identificação do tipo de desconto que deverá ser
|
|
3477
|
concedido como Primeiro Desconto. Valores a informar:
|
|
3478
|
|
|
3479
|
0 - Sem desconto
|
|
3480
|
|
|
3481
|
1 - Valor fixo até a data
|
|
3482
|
|
|
3483
|
2 - Percentual até a data informada
|
|
3484
|
|
|
3485
|
3 - Desconto por dia de antecipação
|
|
3486
|
format: int32
|
|
3487
|
valorPrimeiroDesconto:
|
|
3488
|
type: number
|
|
3489
|
description: |
|
|
3490
|
Valor do Primeiro Desconto
|
|
3491
|
format: double
|
|
3492
|
percentualPrimeiroDesconto:
|
|
3493
|
type: number
|
|
3494
|
description: |
|
|
3495
|
Percentual de desconto sobre o valor do boleto no Primeiro Desconto
|
|
3496
|
format: double
|
|
3497
|
dataPrimeiroDesconto:
|
|
3498
|
type: string
|
|
3499
|
description: |
|
|
3500
|
Data limite do Primeiro Desconto
|
|
3501
|
tipoSegundoDesconto:
|
|
3502
|
type: integer
|
|
3503
|
description: >-
|
|
3504
|
Código para identificação do tipo de desconto que deverá ser
|
|
3505
|
concedido como Segundo Desconto. Valores a informar:
|
|
3506
|
|
|
3507
|
0 - Sem desconto
|
|
3508
|
|
|
3509
|
1 - Valor fixo até a data
|
|
3510
|
|
|
3511
|
2 - Percentual até a data informada
|
|
3512
|
|
|
3513
|
3 - Desconto por dia de antecipação
|
|
3514
|
format: int32
|
|
3515
|
valorSegundoDesconto:
|
|
3516
|
type: number
|
|
3517
|
description: |
|
|
3518
|
Valor do Segundo Desconto
|
|
3519
|
format: double
|
|
3520
|
percentualSegundoDesconto:
|
|
3521
|
type: number
|
|
3522
|
description: |
|
|
3523
|
Percentual de desconto sobre o valor do boleto no Segundo Desconto
|
|
3524
|
format: double
|
|
3525
|
dataSegundoDesconto:
|
|
3526
|
type: string
|
|
3527
|
description: |
|
|
3528
|
Data limite do Segundo Desconto
|
|
3529
|
tipoTerceiroDesconto:
|
|
3530
|
type: integer
|
|
3531
|
description: >-
|
|
3532
|
Código para identificação do tipo de desconto que deverá ser
|
|
3533
|
concedido como Terceiro Desconto. Valores a informar:
|
|
3534
|
|
|
3535
|
0 - Sem desconto
|
|
3536
|
|
|
3537
|
1 - Valor fixo até a data
|
|
3538
|
|
|
3539
|
2 - Percentual até a data informada
|
|
3540
|
|
|
3541
|
3 - Desconto por dia de antecipação
|
|
3542
|
format: int32
|
|
3543
|
valorTerceiroDesconto:
|
|
3544
|
type: number
|
|
3545
|
description: |
|
|
3546
|
Valor do Terceiro Desconto
|
|
3547
|
format: double
|
|
3548
|
percentualTerceiroDesconto:
|
|
3549
|
type: number
|
|
3550
|
description: |
|
|
3551
|
Percentual de desconto sobre o valor do boleto no Terceiro Desconto
|
|
3552
|
format: double
|
|
3553
|
dataTerceiroDesconto:
|
|
3554
|
type: string
|
|
3555
|
description: |
|
|
3556
|
Data limite do Terceiro Desconto
|
|
3557
|
description: Inclusão de desconto em Boleto Bancário
|
|
3558
|
protesto:
|
|
3559
|
title: protesto
|
|
3560
|
type: object
|
|
3561
|
properties:
|
|
3562
|
quantidadeDiasProtesto:
|
|
3563
|
type: number
|
|
3564
|
description: >-
|
|
3565
|
Quantos dias após a data de vencimento do boleto para iniciar o
|
|
3566
|
processo de cobrança através de protesto. (valor inteiro >= 0).
|
|
3567
|
format: float
|
|
3568
|
description: Inclusão de Protesto em Boleto Bancário
|
|
3569
|
juros:
|
|
3570
|
title: juros
|
|
3571
|
type: object
|
|
3572
|
properties:
|
|
3573
|
tipoJuros:
|
|
3574
|
type: integer
|
|
3575
|
description: Valor do Juros de Mora a ser aplicado sobre o valor do Boleto
|
|
3576
|
format: int32
|
|
3577
|
valorJuros:
|
|
3578
|
type: number
|
|
3579
|
description: Taxa do Juros de Mora a ser aplicado sobre o valor do Boleto
|
|
3580
|
format: double
|
|
3581
|
taxaJuros:
|
|
3582
|
type: number
|
|
3583
|
description: >-
|
|
3584
|
Código para identificação do tipo de Juros de Mora que deverá ser
|
|
3585
|
aplicado ao Boleto. Valores a informar:
|
|
3586
|
|
|
3587
|
0 - Dispensar
|
|
3588
|
|
|
3589
|
1 - Valor por dia de atraso
|
|
3590
|
|
|
3591
|
2 - Taxa Mensal
|
|
3592
|
|
|
3593
|
3 - Isento
|
|
3594
|
format: double
|
|
3595
|
description: Inclusão de Juros de Mora em Boleto Bancário
|
|
3596
|
multa:
|
|
3597
|
title: multa
|
|
3598
|
type: object
|
|
3599
|
properties:
|
|
3600
|
tipoMulta:
|
|
3601
|
type: integer
|
|
3602
|
description: Porcentagem sobre o valor do boleto a ser cobrada de multa
|
|
3603
|
format: int32
|
|
3604
|
valorMulta:
|
|
3605
|
type: number
|
|
3606
|
description: Data para início da cobrança da multa
|
|
3607
|
format: float
|
|
3608
|
dataInicioMulta:
|
|
3609
|
type: string
|
|
3610
|
description: Código para identificação do tipo de multa
|
|
3611
|
taxaMulta:
|
|
3612
|
type: number
|
|
3613
|
description: Valor sobre o valor do boleto a ser cobrado de multa
|
|
3614
|
format: float
|
|
3615
|
description: Inclusão de multa em Boleto Bancário
|
|
3616
|
negativacao:
|
|
3617
|
title: negativacao
|
|
3618
|
type: object
|
|
3619
|
properties:
|
|
3620
|
quantidadeDiasNegativacao:
|
|
3621
|
type: integer
|
|
3622
|
description: >-
|
|
3623
|
Quantidade de dias, após o vencimento do Boleto, que o Boleto será
|
|
3624
|
Negativado
|
|
3625
|
format: int32
|
|
3626
|
tipoNegativacao:
|
|
3627
|
type: integer
|
|
3628
|
description: >-
|
|
3629
|
Código para identificação do tipo de Negativação que deverá ser
|
|
3630
|
aplicado ao Boleto. Valores a informar:
|
|
3631
|
|
|
3632
|
1 - Incluir Negativação
|
|
3633
|
|
|
3634
|
2 - Alterar Negativação
|
|
3635
|
|
|
3636
|
3 - Cancelar Negativação
|
|
3637
|
|
|
3638
|
4 - Excluir Negativação
|
|
3639
|
format: int32
|
|
3640
|
description: Inclui condições de Negativação de Boleto Bancário
|
|
3641
|
Erro:
|
|
3642
|
type: object
|
|
3643
|
properties:
|
|
3644
|
errors:
|
|
3645
|
type: array
|
|
3646
|
items:
|
|
3647
|
type: object
|
|
3648
|
properties:
|
|
3649
|
code:
|
|
3650
|
type: string
|
|
3651
|
description: Código e versão do erro.
|
|
3652
|
message:
|
|
3653
|
type: string
|
|
3654
|
description: Mensagem de erro.
|
|
3655
|
description: Representação de um objeto de erro.
|
|
3656
|
ErroOAuthNaoAutorizado:
|
|
3657
|
type: object
|
|
3658
|
properties:
|
|
3659
|
statusCode:
|
|
3660
|
type: number
|
|
3661
|
description: Código do estado do erro.
|
|
3662
|
error:
|
|
3663
|
type: string
|
|
3664
|
description: Tipo do erro.
|
|
3665
|
message:
|
|
3666
|
type: string
|
|
3667
|
description: Mensagem do erro.
|
|
3668
|
attributes:
|
|
3669
|
type: object
|
|
3670
|
properties:
|
|
3671
|
error:
|
|
3672
|
type: string
|
|
3673
|
description: Mensagem do erro.
|
|
3674
|
description: Atributos do erro.
|
|
3675
|
description: Representação de um objeto de erro do OAuth 2.0.
|
|
3676
|
Erro-v2:
|
|
3677
|
title: Erro-v2
|
|
3678
|
type: object
|
|
3679
|
properties:
|
|
3680
|
erros:
|
|
3681
|
type: array
|
|
3682
|
items:
|
|
3683
|
type: object
|
|
3684
|
properties:
|
|
3685
|
codigoMensagem:
|
|
3686
|
type: string
|
|
3687
|
versaoMensagem:
|
|
3688
|
type: string
|
|
3689
|
textoMensagem:
|
|
3690
|
type: string
|
|
3691
|
codigoRetorno:
|
|
3692
|
type: string
|
|
3693
|
description: Representação de um objeto de erro v2.
|
|
3694
|
Erro-v4:
|
|
3695
|
type: object
|
|
3696
|
description: Representa os campos de erro de uma requisição a um recurso.
|
|
3697
|
x-oad-type: object
|
|
3698
|
properties:
|
|
3699
|
erros:
|
|
3700
|
type: array
|
|
3701
|
description: Lista que contém os objetos de erro.
|
|
3702
|
x-oad-type: array
|
|
3703
|
items:
|
|
3704
|
type: object
|
|
3705
|
description: Objeto de erro.
|
|
3706
|
x-oad-type: object
|
|
3707
|
properties:
|
|
3708
|
codigo:
|
|
3709
|
type: string
|
|
3710
|
description: Código da mensagem de erro.
|
|
3711
|
example: '9999999'
|
|
3712
|
versao:
|
|
3713
|
type: string
|
|
3714
|
description: Versão da mensagem de erro.
|
|
3715
|
example: '1'
|
|
3716
|
mensagem:
|
|
3717
|
type: string
|
|
3718
|
description: Mensagem de erro.
|
|
3719
|
example: >-
|
|
3720
|
Erros do tipo 4XX são erros de chamada de responsabilidade de
|
|
3721
|
quem está acionando este recurso. Erros do tipo 5XX são erros
|
|
3722
|
internos no BB.
|
|
3723
|
ocorrencia:
|
|
3724
|
type: string
|
|
3725
|
description: Código da ocorrência do erro. Não se trata de código HTTP.
|
|
3726
|
example: 2AzBShK/zFE=C0700051620C
|
|
3727
|
title: ''
|
|
3728
|
securitySchemes:
|
|
3729
|
OAuth2:
|
|
3730
|
type: oauth2
|
|
3731
|
description: >-
|
|
3732
|
pt-BR: Com a proteção de credenciais de usuários, o OAuth 2.0 permite a
|
|
3733
|
recuperação segura de recursos seguros.
|
|
3734
|
flows:
|
|
3735
|
clientCredentials:
|
|
3736
|
tokenUrl: https://oauth.sandbox.bb.com.br/oauth/token
|
|
3737
|
scopes:
|
|
3738
|
cobrancas.boletos-requisicao: Permite registrar e baixar boletos de cobrança.
|
|
3739
|
cobrancas.boletos-info: Permite consultar detalhes de boletos de cobrança.
|
|
3740
|
refreshUrl: https://oauth.sandbox.bb.com.br/oauth/token
|
|
3741
|
tags:
|
|
3742
|
- name: boletos
|
|
3743
|
description: Recursos relacionados a boletos.
|
|
3744
|
- name: movimento
|
|
3745
|
description: Recursos relacionados a movimentação.
|