github.com/mundipagg/boleto-api@v0.0.0-20230620145841-3f9ec742599f/FAQ.md (about) 1 # Boleto API 2 3 ## FAQ 4 5 ### No campo `codigoTipoTitulo` nós podemos enviar estes códigos: 6 7 1 = CHEQUE 8 9 2 = DUPLICATA-MERCANTIL 10 11 4 = DUPLICATA-SERVICO 12 13 6 = DUPLICATA-RURAL 14 15 7 = LETRA-DE-CAMBIO 16 17 12 = NOTA-PROMISSORIA 18 19 13 = NOTA-PROMISSORIA-RURAL 20 21 17 = RECIBO 22 23 19 = NOTA-DE-DEBITO 24 25 23 = DIVIDA-ATIVA-UNIAO 26 27 24 = DIVIDA-ATIVA-ESTADO 28 29 25 = DIVIDA-ATIVA-MUNICIPIO 30 31 Qual código nós devemos enviar? Estamos mandando por padrão `19` 32 33 __R.__ Este parâmetro é definido pela empresa. 34 35 ### No campo `numeroCarteira` estamos mandando 17 por padrão, para eCommerce esta é a carteira ideal? 36 37 __R.__ Somente será utilizada a 17. 38 39 ### No campo `codigoModalidadeTITULO` estamos mandando por padrão 1 40 41 As opções são: 42 43 1 – Carteira Simples; 4 – Vinculada 6 – Descontada; 8 – Vendor 44 45 __R.__ Continuar utilizando 1 46 47 ### `dataEmissaoTITULO` e `dataVencimentoTITULO` podemos mandar um boleto que vence no mesmo dia? Data de emissão e vencimento ser a mesma? 48 49 __R.__ Pode. 50 51 ### O que é `indicadorPermissaoRecebimentoParcial` Indicador de Recebimento Parcial, pra que serve? Estamos mandando sempre `N` 52 53 __R.__ Serve para o boleto ser pago parcialmente, podem ser feitos vários pagamentos até a liquidação total. (__OBS:__ não vamos usar isso) 54 55 ### `textoNumeroTITULOBeneficiario` seu número, porque usar este se temos o nosso número que é de controle da empresa também? 56 57 __R.__ Campo padrão não obrigatório. (__OBS:__ não vamos usar isso) 58 59 ### Por que existe o campo `textoMensagemBloquetoOcorrencia` se nós temos o trabalho de gerar o html do boleto? 60 61 __R.__ Campo padrão não obrigatório. (__OBS:__ não vamos usar isso) 62 63 ### Existe alguma API onde a gente só envia as informações do boleto e vocês retornam o layout pra gente preenchido? 64 65 ### Os campos que possuem Numérico(algum número) é necessário completar o número com zeros a esquerda? 66 67 ### Por que quando eu envio um request passando um CPF para o pagador na API de homologação de vocês eu recebo um erro? 68 69 __R.__ Eles possuem uma relação de testes no ambiente de homologação 70 71 ### Por que vem "Cliente nao informado" no campo de resposta `nomeLogradouroBeneficiario`, estamos mandando o Request corretamente? 72 73 #### Request 74 75 ```xml 76 <?xml version="1.0" encoding="UTF-8"?> 77 <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:sch="http://www.tibco.com/schemas/bws_registro_cbr/Recursos/XSD/Schema.xsd"> 78 <soapenv:Header /> 79 <soapenv:Body> 80 <sch:requisicao> 81 <sch:numeroConvenio>1014051</sch:numeroConvenio> 82 <sch:numeroCarteira>17</sch:numeroCarteira> 83 <sch:numeroVariacaoCarteira>19</sch:numeroVariacaoCarteira> 84 <sch:codigoModalidadeTitulo>1</sch:codigoModalidadeTitulo> 85 <sch:dataEmissaoTitulo>18.04.2017</sch:dataEmissaoTitulo> 86 <sch:dataVencimentoTitulo>19.04.2017</sch:dataVencimentoTitulo> 87 <sch:valorOriginalTitulo>100</sch:valorOriginalTitulo> 88 <sch:codigoTipoDesconto>0</sch:codigoTipoDesconto> 89 <sch:codigoTipoMulta>0</sch:codigoTipoMulta> 90 <sch:codigoAceiteTitulo>N</sch:codigoAceiteTitulo> 91 <sch:codigoTipoTitulo>19</sch:codigoTipoTitulo> 92 <sch:textoDescricaoTipoTitulo /> 93 <sch:indicadorPermissaoRecebimentoParcial>N</sch:indicadorPermissaoRecebimentoParcial> 94 <sch:textoNumeroTituloBeneficiario /> 95 <sch:textoNumeroTituloCliente>00010140510000066673</sch:textoNumeroTituloCliente> 96 <sch:textoMensagemBloquetoOcorrencia>Pagamento disponível até a data de vencimento</sch:textoMensagemBloquetoOcorrencia> 97 <sch:codigoTipoInscricaoPagador>2</sch:codigoTipoInscricaoPagador> 98 <sch:numeroInscricaoPagador>73400584000166</sch:numeroInscricaoPagador> 99 <sch:nomePagador>Mundipagg Tecnologia em Pagamentos</sch:nomePagador> 100 <sch:textoEnderecoPagador>R. Conde de Bonfim</sch:textoEnderecoPagador> 101 <sch:numeroCepPagador>20520051</sch:numeroCepPagador> 102 <sch:nomeMunicipioPagador>Rio de Janeiro</sch:nomeMunicipioPagador> 103 <sch:nomeBairroPagador>Tijuca</sch:nomeBairroPagador> 104 <sch:siglaUfPagador>RJ</sch:siglaUfPagador> 105 <sch:codigoChaveUsuario>1</sch:codigoChaveUsuario> 106 <sch:codigoTipoCanalSolicitacao>5</sch:codigoTipoCanalSolicitacao> 107 </sch:requisicao> 108 </soapenv:Body> 109 </soapenv:Envelope> 110 ``` 111 112 #### Response 113 114 ```xml 115 <?xml version="1.0" encoding="UTF-8"?> 116 <SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"> 117 <SOAP-ENV:Body> 118 <ns0:resposta xmlns:ns0="http://www.tibco.com/schemas/bws_registro_cbr/Recursos/XSD/Schema.xsd"> 119 <ns0:siglaSistemaMensagem /> 120 <ns0:codigoRetornoPrograma>0</ns0:codigoRetornoPrograma> 121 <ns0:nomeProgramaErro /> 122 <ns0:textoMensagemErro /> 123 <ns0:numeroPosicaoErroPrograma>0</ns0:numeroPosicaoErroPrograma> 124 <ns0:codigoTipoRetornoPrograma>0</ns0:codigoTipoRetornoPrograma> 125 <ns0:textoNumeroTituloCobrancaBb>00010140510000066673</ns0:textoNumeroTituloCobrancaBb> 126 <ns0:numeroCarteiraCobranca>17</ns0:numeroCarteiraCobranca> 127 <ns0:numeroVariacaoCarteiraCobranca>19</ns0:numeroVariacaoCarteiraCobranca> 128 <ns0:codigoPrefixoDependenciaBeneficiario>3851</ns0:codigoPrefixoDependenciaBeneficiario> 129 <ns0:numeroContaCorrenteBeneficiario>8570</ns0:numeroContaCorrenteBeneficiario> 130 <ns0:codigoCliente>932131545</ns0:codigoCliente> 131 <ns0:linhaDigitavel>00190000090101405100500066673179971340000010000</ns0:linhaDigitavel> 132 <ns0:codigoBarraNumerico>00199713400000100000000001014051000006667317</ns0:codigoBarraNumerico> 133 <ns0:codigoTipoEnderecoBeneficiario>0</ns0:codigoTipoEnderecoBeneficiario> 134 <ns0:nomeLogradouroBeneficiario>Cliente nao informado.</ns0:nomeLogradouroBeneficiario> 135 <ns0:nomeBairroBeneficiario /> 136 <ns0:nomeMunicipioBeneficiario /> 137 <ns0:codigoMunicipioBeneficiario>0</ns0:codigoMunicipioBeneficiario> 138 <ns0:siglaUfBeneficiario /> 139 <ns0:codigoCepBeneficiario>0</ns0:codigoCepBeneficiario> 140 <ns0:indicadorComprovacaoBeneficiario /> 141 <ns0:numeroContratoCobranca>17414296</ns0:numeroContratoCobranca> 142 </ns0:resposta> 143 </SOAP-ENV:Body> 144 </SOAP-ENV:Envelope> 145 ``` 146 147 ### Por que quando faço uma requisição pasando o meu CPF ele diz que não encontrou na base e me retorna um erro? 148 149 O código de erro `CBRSR005` não consta no Manual. 150 Eu preciso colocar zeros a esquerda do CPF? 151 152 __R.__ Não vai ocorrer em produção 153 154 #### Request 155 156 ```xml 157 <?xml version="1.0" encoding="UTF-8"?> 158 <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:sch="http://www.tibco.com/schemas/bws_registro_cbr/Recursos/XSD/Schema.xsd"> 159 <soapenv:Header /> 160 <soapenv:Body> 161 <sch:requisicao> 162 <sch:numeroConvenio>1014051</sch:numeroConvenio> 163 <sch:numeroCarteira>17</sch:numeroCarteira> 164 <sch:numeroVariacaoCarteira>19</sch:numeroVariacaoCarteira> 165 <sch:codigoModalidadeTitulo>1</sch:codigoModalidadeTitulo> 166 <sch:dataEmissaoTitulo>18.04.2017</sch:dataEmissaoTitulo> 167 <sch:dataVencimentoTitulo>19.04.2017</sch:dataVencimentoTitulo> 168 <sch:valorOriginalTitulo>100</sch:valorOriginalTitulo> 169 <sch:codigoTipoDesconto>0</sch:codigoTipoDesconto> 170 <sch:codigoTipoMulta>0</sch:codigoTipoMulta> 171 <sch:codigoAceiteTitulo>N</sch:codigoAceiteTitulo> 172 <sch:codigoTipoTitulo>19</sch:codigoTipoTitulo> 173 <sch:textoDescricaoTipoTitulo /> 174 <sch:indicadorPermissaoRecebimentoParcial>N</sch:indicadorPermissaoRecebimentoParcial> 175 <sch:textoNumeroTituloBeneficiario /> 176 <sch:textoNumeroTituloCliente>00010140510000066673</sch:textoNumeroTituloCliente> 177 <sch:textoMensagemBloquetoOcorrencia>Pagamento disponível até a data de vencimento</sch:textoMensagemBloquetoOcorrencia> 178 <sch:codigoTipoInscricaoPagador>1</sch:codigoTipoInscricaoPagador> 179 <sch:numeroInscricaoPagador>15075791794</sch:numeroInscricaoPagador> 180 <sch:nomePagador>Mundipagg Tecnologia em Pagamentos</sch:nomePagador> 181 <sch:textoEnderecoPagador>R. Conde de Bonfim</sch:textoEnderecoPagador> 182 <sch:numeroCepPagador>20520051</sch:numeroCepPagador> 183 <sch:nomeMunicipioPagador>Rio de Janeiro</sch:nomeMunicipioPagador> 184 <sch:nomeBairroPagador>Tijuca</sch:nomeBairroPagador> 185 <sch:siglaUfPagador>RJ</sch:siglaUfPagador> 186 <sch:codigoChaveUsuario>1</sch:codigoChaveUsuario> 187 <sch:codigoTipoCanalSolicitacao>5</sch:codigoTipoCanalSolicitacao> 188 </sch:requisicao> 189 </soapenv:Body> 190 </soapenv:Envelope> 191 ``` 192 193 #### Response 194 195 ```xml 196 <?xml version="1.0" encoding="UTF-8"?> 197 <SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"> 198 <SOAP-ENV:Body> 199 <ns0:resposta xmlns:ns0="http://www.tibco.com/schemas/bws_registro_cbr/Recursos/XSD/Schema.xsd"> 200 <ns0:siglaSistemaMensagem /> 201 <ns0:codigoRetornoPrograma>5</ns0:codigoRetornoPrograma> 202 <ns0:nomeProgramaErro>CBRSR005</ns0:nomeProgramaErro> 203 <ns0:textoMensagemErro>?CPF do pagador nao encontrado na base.</ns0:textoMensagemErro> 204 <ns0:numeroPosicaoErroPrograma>5</ns0:numeroPosicaoErroPrograma> 205 <ns0:codigoTipoRetornoPrograma>0</ns0:codigoTipoRetornoPrograma> 206 <ns0:textoNumeroTituloCobrancaBb /> 207 <ns0:numeroCarteiraCobranca>17</ns0:numeroCarteiraCobranca> 208 <ns0:numeroVariacaoCarteiraCobranca>19</ns0:numeroVariacaoCarteiraCobranca> 209 <ns0:codigoPrefixoDependenciaBeneficiario>3851</ns0:codigoPrefixoDependenciaBeneficiario> 210 <ns0:numeroContaCorrenteBeneficiario>8570</ns0:numeroContaCorrenteBeneficiario> 211 <ns0:codigoCliente>932131545</ns0:codigoCliente> 212 <ns0:linhaDigitavel /> 213 <ns0:codigoBarraNumerico /> 214 <ns0:codigoTipoEnderecoBeneficiario>0</ns0:codigoTipoEnderecoBeneficiario> 215 <ns0:nomeLogradouroBeneficiario /> 216 <ns0:nomeBairroBeneficiario /> 217 <ns0:nomeMunicipioBeneficiario /> 218 <ns0:codigoMunicipioBeneficiario>0</ns0:codigoMunicipioBeneficiario> 219 <ns0:siglaUfBeneficiario /> 220 <ns0:codigoCepBeneficiario>0</ns0:codigoCepBeneficiario> 221 <ns0:indicadorComprovacaoBeneficiario /> 222 <ns0:numeroContratoCobranca>17414296</ns0:numeroContratoCobranca> 223 </ns0:resposta> 224 </SOAP-ENV:Body> 225 </SOAP-ENV:Envelope> 226 ```