{"openapi":"3.0.0","info":{"title":"5.9.4.1 - Payment Interface Management","description":"# O objetivo desta API é fazer a manutenção do boleto de faturamento, como criação, alteração e cancelamento, assim como a criação do arquivo de remessa do boleto para envio ao banco e impressão de seus PDFs invocando procedimentos do BOLBA da brMalls. \n\nBOLBA é a solução customizada no EBS de gerenciamento de boletos da brMalls.\n\nDominio Funcional: 5.9.4.1 Payment Interface Management - Gerenciamento de interface de pagamento - recupera e transmite informações de pagamento com organizações de canais de pagamento (instituições financeiras / câmaras de compensação) de maneira segura, de acordo com os contratos.\n\n> _Para utilização do serviço é necessário cadastro em nossa API Manager\n(https://integration.brmalls.com.br/store/site/pages/sign-up.jag) e\ninscrever a aplicação no serviço, o mesmo será aprovado por **TICORE**._","contact":{"name":"Integração","email":"gd_ti_integracao@brmalls.com.br"},"version":"1.1.0"},"servers":[{"description":"SwaggerHub API Auto Mocking","url":"https://virtserver.swaggerhub.com/brmalls/5.9.4.1-PaymentInterfaceManagement/1.1.0"},{"description":"API no API Manager","url":"https://api-gtw.integracao.brmalls.com.br/customer/PaymentInterfaceManagement"}],"tags":[{"name":"BankSlip"}],"paths":{"/bankslip":{"post":{"tags":["BankSlip"],"summary":"Criar um boleto de faturamento no banco de dados","description":"Usado para criação de um boleto de faturamento no banco de dados.","requestBody":{"description":"Boleto a ser criado.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BankSlipCreateRequest"}}}},"responses":{"200":{"description":"Boleto de faturamento criado.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BankSlipHeader"}}}},"400":{"description":"Requisição Inválida.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Dado não encontrado.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"500":{"description":"Erro Interno.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}},"patch":{"tags":["BankSlip"],"summary":"Prorrogar um boleto de faturamento","description":"Prorrogar um boleto de faturamento.","parameters":[{"name":"slipId","in":"query","description":"Id de um boleto.","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"description":"Boleto a ser prorrogado.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BankSlipUpdateRequest"}}}},"responses":{"200":{"description":"Boleto de faturamento.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BankSlipHeader"}}}},"412":{"description":"Falha de pré-condição.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"400":{"description":"Requisição Inválida.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Dado não encontrado.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"500":{"description":"Erro Interno.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/bankslip/cancellation":{"post":{"tags":["BankSlip"],"summary":"Cancelar um boleto de faturamento","description":"Usado para cancelamento de um boleto de faturamento. Somente poderá ocorrer para boletos com status G - Gerado ou E - Enviado. Se o boleto tiver status E, significa que ja foi enviado ao banco, e qualquer alteração ou cancelamento do mesmo, deverá ser reenviado uma remessa ao banco. Logo, no retorno deste endpoint, será informado um remitId (id da remessa) para este boleto, que deverá ser passado no endpoint /bankslip/remit juntamente com o status C de Cancelamento para a criação do arquivo de remessa ao banco.","parameters":[{"name":"slipId","in":"query","description":"Id de um boleto.","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Boleto de faturamento cancelado.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BankSlipHeader"}}}},"412":{"description":"Falha de pré-condição.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Dado não encontrado.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"500":{"description":"Erro Interno.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/bankslip/remit":{"post":{"tags":["BankSlip"],"summary":"Criar o arquivo de remessa do boleto de faturamento para envio ao banco","description":"Criar o arquivo de remessa do boleto de faturamento para envio ao banco.<br>**Deve ser usado após alteração ou cancelamento de um boleto.**","parameters":[{"name":"remitId","in":"query","description":"Id da remessa do boleto.","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"remitType","in":"query","description":"Tipo de Remessa a ser criada. Possíveis valores: \"A\" de Alteracao e \"C\" de Cancelamento.","required":true,"schema":{"type":"string","enum":["A","C"]}}],"responses":{"200":{"description":"Arquivo de remessa do boleto criado."},"400":{"description":"Requisiçao Invalida.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Dado não encontrado.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"500":{"description":"Erro Interno.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/bankslip/pdfprinting":{"post":{"tags":["BankSlip"],"summary":"Solicitar impressao do arquivo de PDF do boleto","description":"Solicitar impressao do arquivo de PDF do boleto.","parameters":[{"name":"reportId","in":"query","description":"Id da impressão do boleto.","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"slipType","in":"query","description":"Tipo do Boleto. Possiveis Valores: \"A\" de Administrativo ou \"C\" de cobrança ","required":true,"schema":{"type":"string","enum":["C","A"]}}],"responses":{"200":{"description":"Solicitação de Impressão do PDF do Boleto criada.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BankSlipPdfPrintingResponse"}}}},"400":{"description":"Requisição Inválida.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Dado não encontrado.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"500":{"description":"Erro Interno.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}}},"components":{"schemas":{"Error":{"title":"Error","type":"object","properties":{"code":{"type":"string"},"description":{"type":"string"},"message":{"type":"string"}}},"BankSlipCreateRequest":{"type":"object","properties":{"slipNumber":{"type":"integer","format":"int64","description":"Número do boleto de faturamento.","example":123036635},"customerId":{"type":"integer","format":"int64","description":"Id da conta do cliente.","example":7739},"luc":{"type":"string","description":"Código da LUC (Alias) da linha da conta do cliente.","example":"SNS0AE11"},"customerInscription":{"type":"string","description":"CNPJ ou CPF completos de um cliente sem formatação.<br>CPNJ: 14 digitos. No EBS essa informação, somente para CNPJ está prefixada com digito 0, retornando 15 caracteres.<br>CPF: 11 digitos.","example":"042591651006931"},"slipDueDate":{"description":"Data de vencimento do boleto no formato AAAA-MM-DD","type":"string","format":"datetime","example":"2021-11-03"},"slipType":{"description":"Tipo do boleto. Possíveis valores: \"A\" de Administrativo ou \"C\" de cobrança. Condição feita sobre o Nosso numero do Boleto. Quando este valor for nulo, trata-se de um boleto Administrativo, caso contrario, é um boleto de Cobrança.","type":"string","example":"C"},"slipStatus":{"description":"Status do Boleto. <br>Possiveis valores: <br>R - Retornado; <br>C - Cancelado; <br>E - Enviado;<br>G - Gerado","type":"string","example":"E"},"slipGranteeBankAccountId":{"type":"integer","format":"int64","description":"Id da conta do cedente bancario do boleto.","example":11639},"slipGrantee":{"type":"string","description":"Cedente do Boleto.","example":"CONSORCIO EMPREENDEDOR DO SHOPPING TAMBORE"},"slipOurNumber":{"description":"Nosso numero do boleto. Também usado para classificar o tipo do boleto. Quando este valor for nulo, é um boleto Administrativo, caso contrario, boleto de Cobrança.","type":"string","example":"109/20037330-5"},"slipBankNumber":{"type":"string","description":"Numero do banco do Boleto.","example":"341"},"slipLimitDate":{"description":"Data limite do boleto no formato AAAA-MM-DD","type":"string","format":"date","example":"2021-11-03"},"slipWriteLine":{"type":"string","description":"Linha do Boleto.","example":"34191.09107 00491.572939 80867.700009 8 48860002988405"},"slipBarCodeText":{"type":"string","description":"Codigo de barra do Boleto.","example":"34198488600029884051091000491572938086770000"}}},"BankSlipUpdateRequest":{"type":"object","properties":{"slipDueDate":{"description":"Data de vencimento do boleto no formato AAAA-MM-DD","type":"string","format":"datetime","example":"2021-11-03"},"slipLimitDate":{"description":"Data limite do boleto no formato AAAA-MM-DD","type":"string","format":"date","example":"2021-11-03"},"slipComment":{"description":"Comentario do Boleto.","type":"string","example":"NÃO RECEBER APOS A DATA DE VENCIMENTO"}}},"BankSlipHeader":{"type":"object","properties":{"slipId":{"type":"integer","format":"int64","description":"Id do boleto de faturamento.","example":3503343},"slipNumber":{"type":"integer","format":"int64","description":"Número do boleto de faturamento.","example":123036635},"customerId":{"type":"integer","format":"int64","description":"Id da conta do cliente.","example":7739},"luc":{"type":"string","description":"Código da LUC (Alias) da linha da conta do cliente.","example":"SNS0AE11"},"customerInscription":{"type":"string","description":"CNPJ ou CPF completos de um cliente sem formatação.<br>CPNJ: 14 digitos. No EBS essa informação, somente para CNPJ está prefixada com digito 0, retornando 15 caracteres.<br>CPF: 11 digitos.","example":"042591651006931"},"slipDueDate":{"description":"Data de vencimento do boleto no formato AAAA-MM-DD","type":"string","format":"datetime","example":"2021-11-03"},"slipType":{"description":"Tipo do boleto. Possíveis valores: \"A\" de Administrativo ou \"C\" de cobrança. Condição feita sobre o Nosso numero do Boleto. Quando este valor for nulo, trata-se de um boleto Administrativo, caso contrario, é um boleto de Cobrança.","type":"string","example":"C"},"slipStatus":{"description":"Status do Boleto. <br>Possiveis valores: <br>R - Retornado; <br>C - Cancelado; <br>E - Enviado;<br>G - Gerado","type":"string","example":"E"},"slipGranteeBankAccountId":{"type":"integer","format":"int64","description":"Id da conta do cedente bancario do boleto.","example":11639},"slipGrantee":{"type":"string","description":"Cedente do Boleto.","example":"CONSORCIO EMPREENDEDOR DO SHOPPING TAMBORE"},"slipOurNumber":{"description":"Nosso numero do boleto. Também usado para classificar o tipo do boleto. Quando este valor for nulo, é um boleto Administrativo, caso contrario, boleto de Cobrança.","type":"string","example":"109/20037330-5"},"slipBankNumber":{"type":"string","description":"Numero do banco do Boleto.","example":"341"},"slipLimitDate":{"description":"Data limite do boleto no formato AAAA-MM-DD","type":"string","format":"date","example":"2021-11-03"},"slipWriteLine":{"type":"string","description":"Linha do Boleto.","example":"34191.09107 00491.572939 80867.700009 8 48860002988405"},"slipBarCodeText":{"type":"string","description":"Codigo de barra do Boleto.","example":"34198488600029884051091000491572938086770000"},"remitId":{"type":"integer","format":"int64","description":"Id da remessa bancaria do boleto.","example":123},"batchId":{"type":"integer","format":"int64","description":"Id do lote do boleto.","example":321},"reportId":{"type":"integer","format":"int64","description":"Id de impressao do boleto.","example":321}}},"BankSlipPdfPrintingResponse":{"type":"object","properties":{"slipNumber":{"type":"integer","format":"int64","description":"Número do boleto.","example":928421},"pdfPrintingRequestId":{"type":"integer","format":"int64","description":"Id da solicitação de impressão do boleto ao programa concorrente do EBS.","example":123036635}}}},"securitySchemes":{"oauth2":{"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://api-gtw.integracao.brmalls.com.br/token","scopes":{}}}}}},"security":[{"oauth2":[]}]}