· 5 years ago · Jul 13, 2020, 09:34 PM
1
21. Obtendo Authorization Code:
3 GET https://api.sisbr.com.br/auth/oauth2/authorize?response_type=code&redirect_uri=[[url_Callback]]&client_id=[[client_id]]&versaoHash=3&scope=[[scope]]
4
5
62. Obtendo Access Token
7 POST https://api.sisbr.com.br/auth/token
8
9 Headers
10 Content-type: "www/form-url-encoded"
11 Authorization: Basic [[token_basic]]
12
13 Payload
14 grant_type=authorization_code&code=[[code]]&redirect_uri=[[callback_url]]
15
16
173. Utilizando o Refresh Token
18 POST https://api.sisbr.com.br/auth/token
19
20 Headers
21 Content-type: "www/form-url-encoded"
22 Authorization: Basic [[token_basic]]
23
24 Payload
25 grant_type=refresh_token&refresh_token=[[refresh_token]]
26
27
284. Exemplo de consumo da Api de Cobrança Bancária
29
30 - Incluir Boleto
31 POST https://api.sisbr.com.br/cooperado/cobranca-bancaria/v1/boletos
32
33 Headers
34 Content-type: "application/json"
35 Authorization: Bearer [[access-token]]
36 Client_id: [[Consumer Key]]
37
38 Payload
39 [
40 {
41 "numeroContrato": [[value]],
42 "modalidade": [[value]],
43 "numeroContaCorrente": [[value]],
44 "especieDocumento": [[value]],
45 "dataEmissao": [[value]],
46 "nossoNumero": [[value]],
47 "seuNumero": [[value]],
48 "identificacaoBoletoEmpresa": [[value]],
49 "identificacaoEmissaoBoleto": [[value]],
50 "identificacaoDistribuicaoBoleto": [[value]],
51 "valor": [[value]],
52 "dataVencimento": [[value]],
53 "dataLimitePagamento": [[value]],
54 "valorAbatimento": [[value]],
55 "tipoDesconto": [[value]],
56 "dataPrimeiroDesconto": [[value]],
57 "valorPrimeiroDesconto": [[value]],
58 "dataSegundoDesconto": [[value]],
59 "valorSegundoDesconto": [[value]],
60 "dataTerceiroDesconto": [[value]],
61 "valorTerceiroDesconto": [[value]],
62 "tipoMulta": [[value]],
63 "dataMulta": [[value]],
64 "valorMulta": [[value]],
65 "tipoJurosMora": [[value]],
66 "dataJurosMora": [[value]],
67 "valorJurosMora": [[value]],
68 "numeroParcela": [[value]],
69 "aceite": [[value]],
70 "codigoNegativacao": [[value]],
71 "numeroDiasNegativacao": [[value]],
72 "codigoProtesto": [[value]],
73 "numeroDiasProtesto": [[value]],
74 "pagador": {
75 "numeroCpfCnpj": [[value]],
76 "nome": [[value]],
77 "endereco": [[value]],
78 "bairro": [[value]],
79 "cidade": [[value]],
80 "cep": [[value]],
81 "uf": [[value]],
82 "email": [
83 [[value]]
84 ]
85 },
86 "sacadorAvalista": {
87 "numeroCpfCnpjSacadorAvalista": [[value]],
88 "nomeSacadorAvalista": [[value]]
89 },
90 "mensagensInstrucao": {
91 "mensagens": [
92 [[value1]],
93 [[value2]],
94 [[value3]],
95 [[value4]],
96 [[value5]]
97 ]
98 },
99 "gerarPdf": [[valueBoolean]]
100 }
101 ]
102
103 scope: "cobranca_boletos_incluir"
104
105 ========================================================================================
106
107 - Consultar Boleto
108
109 GET https://api.sisbr.com.br/cooperado/cobranca-bancaria/v1/boletos?numeroContrato=[[value]]&modalidade=[[value]]&nossoNumero=[[value]]&linhaDigitavel=[[value]]&codigoBarras=[[value]]
110
111 Headers
112 Content-type: "application/json"
113 Authorization: Bearer [[access-token]]
114 Client_id: [[Consumer Key]]
115
116 scope: "cobranca_boletos_consultar"
117
118 ========================================================================================
119
120 - Listar Boletos por Pagador
121
122 GET https://api.sisbr.com.br/cooperado/cobranca-bancaria/v1/boletos/pagadores/[[numero-CpfCnpj]]?numeroContrato=[[value]]&codigoSituacao=[[value]]&dataInicio=[[value]]&dataFim=[[value]]
123
124 Headers
125 Content-type: "application/json"
126 Authorization: Bearer [[access-token]]
127 Client_id: [[Consumer Key]]
128
129 scope: "cobranca_boletos_pagador"
130
131 ========================================================================================
132
133 - Emitir Segunda-via de um Boleto
134
135 GET https://api.sisbr.com.br/cooperado/cobranca-bancaria/v1/boletos/segunda-via?numeroContrato=[[value]]&modalidade=[[value]]&nossoNumero=[[value]]&linhaDigitavel=[[value]]&codigoBarras=[[value]]&gerarPdf=[[valueBoolean]]
136
137 Headers
138 Content-type: "application/json"
139 Authorization: Bearer [[access-token]]
140 Client_id: [[Consumer Key]]
141
142 scope: "cobranca_boletos_segunda_via"
143
144 ========================================================================================
145
146 - Alterar informações de valor de desconto e/ou data de desconto de boletos
147
148 PATCH https://api.sisbr.com.br/cooperado/cobranca-bancaria/v1/boletos/descontos
149
150 Headers
151 Content-type: "application/json"
152 Authorization: Bearer [[access-token]]
153 Client_id: [[Consumer Key]]
154
155 Payload
156 [
157 {
158 "numeroContrato": [[value]],
159 "modalidade": [[value]],
160 "nossoNumero": [[value]],
161 "tipoDesconto": [[value]],
162 "dataPrimeiroDesconto": [[value]],
163 "valorPrimeiroDesconto": [[value]],
164 "dataSegundoDesconto": [[value]],
165 "valorSegundoDesconto": [[value]],
166 "dataTerceiroDesconto": [[value]],
167 "valorTerceiroDesconto": [[value]]
168 }
169 ]
170
171 scope: "cobranca_boletos_descontos"
172
173 ========================================================================================
174
175 - Alterar o valor de abatimento de boletos
176
177 PATCH https://api.sisbr.com.br/cooperado/cobranca-bancaria/v1/boletos/abatimentos
178
179 Headers
180 Content-type: "application/json"
181 Authorization: Bearer [[access-token]]
182 Client_id: [[Consumer Key]]
183
184 Payload
185 [
186 {
187 "numeroContrato": [[value]],
188 "modalidade": [[value]],
189 "nossoNumero": [[value]],
190 "valorAbatimento": [[value]]
191 }
192 ]
193
194 scope: "cobranca_boletos_abatimentos"
195
196 ========================================================================================
197
198 - Alterar o valor nominal de boletos de cartão de crédito
199
200 PATCH https://api.sisbr.com.br/cooperado/cobranca-bancaria/v1/boletos/valor-nominal
201
202 Headers
203 Content-type: "application/json"
204 Authorization: Bearer [[access-token]]
205 Client_id: [[Consumer Key]]
206
207 Payload
208 [
209 {
210 "numeroContrato": [[value]],
211 "modalidade": [[value]],
212 "nossoNumero": [[value]],
213 "valor": [[value]]
214 }
215 ]
216
217 scope: "cobranca_boletos_valor_nominal"
218
219 ========================================================================================
220
221 - Alterar seu número e/ou número de controle da empresa dos boletos
222
223 PATCH https://api.sisbr.com.br/cooperado/cobranca-bancaria/v1/boletos/seu-numero
224
225 Headers
226 Content-type: "application/json"
227 Authorization: Bearer [[access-token]]
228 Client_id: [[Consumer Key]]
229
230 Payload
231 [
232 {
233 "numeroContrato": [[value]],
234 "modalidade": [[value]],
235 "nossoNumero": [[value]],
236 "seuNumero": [[value]],
237 "identificacaoBoletoEmpresa": [[value]]
238 }
239 ]
240
241 scope: "cobranca_boletos_seu_numero"
242
243 ========================================================================================
244
245 - Alterar espécie de documento dos boletos
246
247 PATCH https://api.sisbr.com.br/cooperado/cobranca-bancaria/v1/boletos/especie-documento
248
249 Headers
250 Content-type: "application/json"
251 Authorization: Bearer [[access-token]]
252 Client_id: [[Consumer Key]]
253
254 Payload
255 [
256 {
257 "numeroContrato": [[value]],
258 "modalidade": [[value]],
259 "nossoNumero": [[value]],
260 "especieDocumento": [[value]]
261 }
262 ]
263
264 scope: "cobranca_boletos_especie_documento"
265
266 ========================================================================================
267
268 - Comandar a baixa de boletos
269
270 PATCH https://api.sisbr.com.br/cooperado/cobranca-bancaria/v1/boletos/baixa
271
272 Headers
273 Content-type: "application/json"
274 Authorization: Bearer [[access-token]]
275 Client_id: [[Consumer Key]]
276
277 Payload
278 [
279 {
280 "numeroContrato": [[value]],
281 "modalidade": [[value]],
282 "nossoNumero": [[value]],
283 "seuNumero": [[value]]
284 }
285 ]
286
287 scope: "cobranca_boletos_baixa"
288
289 ========================================================================================
290
291 - Alterar informações de pagadores de boletos
292
293 PUT https://api.sisbr.com.br/cooperado/cobranca-bancaria/v1/pagadores
294
295 Headers
296 Content-type: "application/json"
297 Authorization: Bearer [[access-token]]
298 Client_id: [[Consumer Key]]
299
300 Payload
301 [
302 {
303 "numeroContrato": [[value]],
304 "modalidade": [[value]],
305 "nossoNumero": [[value]],
306 "numeroCpfCnpj": [[value]],
307 "nome": [[value]],
308 "endereco": [[value]],
309 "bairro": [[value]],
310 "cidade": [[value]],
311 "cep": [[value]],
312 "uf": [[value]],
313 "email": [
314 [[value]]
315 ]
316 }
317 ]
318
319 scope: "cobranca_pagadores"
320
321 ========================================================================================
322
323 - Negativar pagadores de boletos
324
325 POST https://api.sisbr.com.br/cooperado/cobranca-bancaria/v1/boletos/negativacoes
326
327 Headers
328 Content-type: "application/json"
329 Authorization: Bearer [[access-token]]
330 Client_id: [[Consumer Key]]
331
332 Payload
333 [
334 {
335 "numeroContrato": [[value]],
336 "modalidade": [[value]],
337 "nossoNumero": [[value]]
338 }
339 ]
340
341 scope: "cobranca_boletos_negativacoes_incluir"
342
343 ========================================================================================
344
345 - Cancelar o apontamento da negativação de pagadores de boletos
346
347 PATCH https://api.sisbr.com.br/cooperado/cobranca-bancaria/v1/boletos/negativacoes
348
349 Headers
350 Content-type: "application/json"
351 Authorization: Bearer [[access-token]]
352 Client_id: [[Consumer Key]]
353
354 Payload
355 [
356 {
357 "numeroContrato": [[value]],
358 "modalidade": [[value]],
359 "nossoNumero": [[value]]
360 }
361 ]
362
363 scope: "cobranca_boletos_negativacoes_alterar"
364
365 ========================================================================================
366
367 - Baixar a negativação de pagadores de boletos
368
369 DELETE https://api.sisbr.com.br/cooperado/cobranca-bancaria/v1/boletos/negativacoes
370
371 Headers
372 Content-type: "application/json"
373 Authorization: Bearer [[access-token]]
374 Client_id: [[Consumer Key]]
375
376 Payload
377 [
378 {
379 "numeroContrato": [[value]],
380 "modalidade": [[value]],
381 "nossoNumero": [[value]]
382 }
383 ]
384
385 scope: "cobranca_boletos_negativacoes_baixar"
386
387 ========================================================================================
388
389 - Protestar boletos
390
391 POST https://api.sisbr.com.br/cooperado/cobranca-bancaria/v1/boletos/protestos
392
393 Headers
394 Content-type: "application/json"
395 Authorization: Bearer [[access-token]]
396 Client_id: [[Consumer Key]]
397
398 Payload
399 [
400 {
401 "numeroContrato": [[value]],
402 "modalidade": [[value]],
403 "nossoNumero": [[value]]
404 }
405 ]
406
407 scope: "cobranca_boletos_protestos_incluir"
408
409 ========================================================================================
410
411 - Cancelar o apontamento de protesto de boletos
412
413 PATCH https://api.sisbr.com.br/cooperado/cobranca-bancaria/v1/boletos/protestos
414
415 Headers
416 Content-type: "application/json"
417 Authorization: Bearer [[access-token]]
418 Client_id: [[Consumer Key]]
419
420 Payload
421 [
422 {
423 "numeroContrato": [[value]],
424 "modalidade": [[value]],
425 "nossoNumero": [[value]]
426 }
427 ]
428
429 scope: "cobranca_boletos_protestos_alterar"
430
431 ========================================================================================
432
433 - Desistir do protesto de boletos
434
435 DELETE https://api.sisbr.com.br/cooperado/cobranca-bancaria/v1/boletos/protestos
436
437 Headers
438 Content-type: "application/json"
439 Authorization: Bearer [[access-token]]
440 Client_id: [[Consumer Key]]
441
442 Payload
443 [
444 {
445 "numeroContrato": [[value]],
446 "modalidade": [[value]],
447 "nossoNumero": [[value]]
448 }
449 ]
450
451 scope: "cobranca_boletos_protestos_desistir"
452
453 ========================================================================================
454
455 - Solicitar a movimentação da carteira de cobrança registrada para beneficiário informado
456
457 POST https://api.sisbr.com.br/cooperado/cobranca-bancaria/v1/boletos/solicitacoes/movimentacao
458
459 Headers
460 Content-type: "application/json"
461 Authorization: Bearer [[access-token]]
462 Client_id: [[Consumer Key]]
463
464 Payload
465 {
466 "numeroContrato": [[value]],
467 "tipoMovimento": [[value]],
468 "dataInicial": [[value]],
469 "dataFinal": [[value]]
470 }
471
472 scope: "cobranca_boletos_solicitacao_movimentacao_incluir"
473
474 ========================================================================================
475
476 - Consultar a situação da solicitação da movimentação
477 GET https://api.sisbr.com.br/cooperado/cobranca-bancaria/v1/boletos/solicitacoes/movimentacao?codigoSolicitacao=[[value]]
478
479 Headers
480 Content-type: "application/json"
481 Authorization: Bearer [[access-token]]
482 Client_id: [[Consumer Key]]
483
484 scope: "cobranca_boletos_solicitacao_movimentacao_consultar"
485
486 ========================================================================================
487
488 - Download do(s) arquivo(s) de movimentação
489
490 GET https://api.sisbr.com.br/cooperado/cobranca-bancaria/v1/boletos/movimentacao-download?codigoSolicitacao=[[value]]&idArquivo=[[value]]
491
492 Headers
493 Content-type: "application/json"
494 Authorization: Bearer [[access-token]]
495 Client_id: [[Consumer Key]]
496
497 scope: "cobranca_boletos_solicitacao_movimentacao_download"
498
499 ========================================================================================