Se você é um desenvolvedor e pretende integrar seu site ou aplicação a um sistema completo de gestão de cobranças on-line, você está no lugar certo!.
\nEsta documentação é destinada a desenvolvedores que desejam integrar seu site ou aplicação com a API da ReCB. São descritas as funcionalidades da API, métodos e parâmetros técnicos, são disponibilizados códigos prontos de exemplos para facilitar suas atividades de desenvolvimento.
\nA ReCB é uma empresa Intermediadora de Pagamentos. Por meio dela, você pode emitir cobranças para seus clientes (por boleto) sem ter que realizar convênios específicos com bancos. Atendendo a determinação da Febraban, os boletos e carnês gerados pela ReCB são registrados.
\nPara iniciar o desenvolvimento, entre em contato com a ReCB através do e-mail: suporte@recb.com.br ou telefone (86) 3303-5697, para obter as informações necessárias para acesso ao ambiente de homologação/testes. Forneceremos as seguintes informações para o seu acesso:
\nApós a homologação a ReCB fornecerá novos dados de acesso para o ambiente produção.
\nDeverão ser gerados alguns boletos com valores baixos (sugestão R$ 15,00 com desconto de R$ 5,00), para conferirmos o registro e liquidação após o pagamento, efetuando a baixa automática obtendo as informações via API.
\nEm todas requisições POST, serão realizadas autenticações, validando os parâmetros especificados no item [ 2-Começando ]. Também será validado o IP de origem, caso não esteja cadastrado não será possível obter respostas da API. \nCaso ocorra algum erro na autenticação, será listado um json com a mensagem de erro abaixo:
\n{\n \"message\": {\n \"title\": \"Erro\",\n \"message\": \"Usuario, senha ou token invalidos\",\n \"messageID\": \"101\"\n }\n}\n\n\n\nNa geração de todo Carnet, serão usados obrigatoriamente os métodos dentro dos seguintes procedimentos abaixo:
\n [3-Autenticação] >> [7.1-create_category] >> [7.3-create_payer] >> [7.5-create_carnet]\nConforme dito anteriormente, um “Carnet” sempre estará associado a uma “Categoria e a um “Cliente”, portanto será necessário sempre executar o Fluxo Obrigatório conforme descrito acima no item [4].
\nUm carnê é um conjunto de transações (parcelas/boletos) geradas em lote e com forma de pagamento já definida. As parcelas de um carnê vencem mensalmente, de acordo com a data definida por você.
\nPor exemplo, ao gerar um carnê com o vencimento da primeira parcela em 10/11/2018, o vencimento da segunda parcela será 10/12/2018, e assim sucessivamente. O intervalo é sempre de 1 (um) mês entre elas (mensal).
\nAinda cabe frisar que cada carnê gerado possui uma identificação única denominada [carnetID], e cada parcela desse carnê também possuem um identificador único denominado [ticketID], assim como o pagador possui um identificador único [payerID] e a categoria [categoryID].
\nCategoria: [categoryID]: \"/src/category/create\" ou \"/src/category/detail\"
\n\n\n[ description ]\n[ valor ]
\n
Pagador: [payerID]: \"/src/payer/create\" ou \"/src/payer/detail\"
\n\n\n[ categoryID ]\n [ nome_razao_social ]\n [ nome_abreviado ]\n [ cpf/cnpj ]\n [ insc_estadual ]\n [ rg ]\n [ org_exp ]\n [ data_nasc ]\n [ endereco ]\n [ numero ]\n [ bairro ]\n [ cidade ]\n [ estado ]\n [ cep ]\n [ fone_res ]\n [ fone_cel ]\n [ obs ]
\n
Carnet: [carnetID]: \"/src/carnet/createAllBanks\" ou \"/src/carnet/detail\"
\n\n\n[ categoryID ]\n [ payerID ]\n [ dia ]\n [ mes ]\n [ ano ]\n [ qtd_parcelas ]\n [ periodicidade ]\n [ valor_parcela ]\n [ msg_boleto1 ]\n [ msg_boleto2 ]\n [ msg_personalizada ]\n [ multa ]\n [ mora ]\n [ desconto ]
\n
\n\nOBSERVAÇÕES IMPORTANTES:
\n
Multa máxima de 10%
\nJuros/Mora ao dia máximo de 1%
\nDesconto máximo de 90% do valor nominal do boleto.
\nNota 01: \"Campos opcionais\": É possível usar múltiplos descontos para boletos padrão Itaú. Caso necessite ativar esta opção, solicite a ReCB, pois o padrão é desativado.
\n\n\n[ data_desconto_1 ]: Data limite para o primeiro desconto.\n [ valor_desconto_1 ]: Valor em reais(R$) para o primeiro desconto.\n [ data_desconto_2 ]: Data limite para o segundo desconto.\n [ valor_desconto_2 ]: Valor em reais(R$) para o segundo desconto.\n [ data_desconto_3 ]: Data limite para o terceiro desconto.\n [ valor_desconto_3 ]: Valor em reais(R$) para o terceiro desconto.
\n
Nota 02: \"Campos opcionais\": Recomendamos a utilização do valor do desconto em reais(R$), para isso você deve preencher o campo [ desconto ] com o valor \"0.00\", e utilizar apenas os campos opcionais [ data_desconto_1 ] referente a data limite para concessão do desconto e [ valor_desconto_1 ] com o valor em reais(R$) a ser concedido até a data limite. Esta funcionalidade poderá ser utilizada para emissão de boletos padrão BB ou Itaú. Reforçamos que o valor do desconto em R$ não deve ultrapassar 90% do valor nominal do boleto.
\nSeguem abaixo as requisições utilizando método {POST}, presentes na API da ReCB Cobrança Inteligente.\nUtilize os exemplos listados na opção \"Example Request\" para visualizar o código necessário para executar requisições de cada método, bem como observar as respostas logo abaixo na opção \"Example Response\".
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[{"content":"[ 1-Introdução ]","slug":"1-introducao"},{"content":"[ 2-Começando ]","slug":"2-comecando"},{"content":"[ 3 - Autenticação ]","slug":"3-autenticacao"},{"content":"[ 4 - Fluxo obrigatório para geração de novos Carnets ]","slug":"4-fluxo-obrigatorio-para-geracao-de-novos-carnets"},{"content":"[ 5 - Gerando Carnês ]","slug":"5-gerando-carnes"},{"content":"[ 6 - Estrutura hierárquica dos atributos: Schema ]","slug":"6-estrutura-hierarquica-dos-atributos-schema"},{"content":"[ 7 - Métodos disponíveis na API ]","slug":"7-metodos-disponiveis-na-api"}],"owner":"5034290","collectionId":"105c89cd-dd67-4cc9-995b-d40d4a921579","publishedId":"RWgxuvRX","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"publishDate":"2018-10-25T23:40:07.000Z"},"item":[{"name":"API ReCB - 7.1: Create_Category","id":"bd3a4034-de1a-41c9-8357-58ba97b6964c","request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/x-www-form-urlencoded","type":"text"},{"key":"cache-control","value":"no-cache"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"client_id","value":"{{client_id}}","sessionValue":"[{\"key\":\"$clientID\",\"value\":\"131\",\"description\":\"Cliente ID na ReCB\",\"enabled\":false}]","description":"Cliente ID na ReCB
\n","type":"text"},{"key":"client_user","value":"{{client_user}}","description":"User ID na ReCB
\n"},{"key":"client_pass","value":"{{client_pas}}","sessionValue":"X3VsA94@c7XZ","description":"Senha do User na ReCB
\n","type":"text"},{"key":"client_token","value":"{{client_token}}","sessionValue":"7E444CFE-AFE5-4EA2-B748-F7C4A7CB3884","description":"Token
\n","type":"text"},{"key":"client_ip","value":"{{client_ip}}","sessionValue":"187.","description":"Ip do cliente
\n","type":"text"},{"key":"description","value":"TESTES-POSTMAN","description":"nome da categoria
\n","type":"text"},{"key":"value","value":"0.00","description":"valor da categoria
\n","type":"text"}]},"url":"{{URL}}/src/category/create.php","description":"Cria uma nova categoria caso não exista. Cada transação retornará uma única chave identificadora \"categoryID\".
\n\n\nObjeto JSON instanciado com parâmetros a serem enviados:
\n
\n{\n\"description\": “MAIO-2018”,\n\"value\": “0,00”\n}\n\n\n\n\nResposta do Objeto JSON enviado:
\n
\n{\n\"Message\": {\n\"Title\": \"sucesso!\",\n\"Message\": \"Categoria cadastrada com sucesso.\",\n\"MessageId\": 0\n},\n\"DataReturn\": {\n\"categoryID\": 1\n}\n}\n\n\n\n\nMensagens de retorno:
\n
| messageId | \nStatus | \nDescrição | \n
|---|---|---|
| 0 | \nSucesso | \nCategoria encontrada/cadastrada com sucesso. | \n
| 00 | \nErro | \nMáximo de caracteres é de 150, valor precisa de ponto, valor nao pode ter virgula. | \n
| 1 | \nErro | \nVerifique o(s) parâmetro(s) de entrada. | \n
| 2 | \nErro | \nConsulte a documentação sobre os valores e tamanhos de campos a serem enviados. | \n
| 3 | \nSucesso | \nCategoria não encontrada. | \n
Autenticação: Cliente ID na ReCB
\n","key":"client_id","sessionValue":"[{\"key\":\"$clientID\",\"value\":\"131\",\"description\":\"Cliente ID na ReCB\",\"enabled\":false}]","type":"text","value":"{{client_id}}"},{"description":"Autenticação: User ID na ReCB
\n","key":"client_user","value":"{{client_user}}"},{"description":"Autenticação: Senha do User na ReCB
\n","key":"client_pass","sessionValue":"X3VsA94@c7XZ","type":"text","value":"{{client_pas}}"},{"description":"Autenticação: Token
\n","key":"client_token","sessionValue":"7E444CFE-AFE5-4EA2-B748-F7C4A7CB3884","type":"text","value":"{{client_token}}"},{"description":"Autenticação: Ip do cliente
\n","key":"client_ip","sessionValue":"187.","type":"text","value":"{{client_ip}}"},{"key":"categoryID","value":"{{categoryID}}","description":"Imput: id da categoria
\n","type":"text"}]},"url":"http://35.199.90.140/app/api/v1/src/category/detail.php","description":"Retorna informações sobre uma categoria já criada através do método [7.1 - Create_Category]. Cada transação retornará \"categoryID\", \"name\" e \"value\".
\n\n\nObjeto JSON instanciado com parâmetro a serem enviados:
\n
\n{\n\"categoryID\": 17720\n}\n\n\n\n\nResposta do Objeto JSON enviado:
\n
\n{\n\"message\": {\n\"title\": \"Sucesso\",\n\"message\": \"Categoria encontrados\",\n\"messageID\": \"0\"\n},\n\"DataReturn\": {\n\"cartegoryID\": \"19842\",\n\"name\": \"TESTES-POSTMAN\",\n\"value\": \"0,00\"\n}\n}\n\n\n\n\nMensagens de retorno:
\n
| messageId | \nStatus | \nDescrição | \n
|---|---|---|
| 0 | \nSucesso | \nCategoria encontrada com sucesso. | \n
| 1 | \nErro | \nVerifique o parâmetro de entrada. | \n
| 2 | \nSucesso | \nCategoria não encontrada. | \n
Cliente ID na ReCB
\n","type":"text"},{"key":"client_user","value":"{{client_user}}","description":"User ID na ReCB
\n"},{"key":"client_pass","value":"{{client_pas}}","sessionValue":"X3VsA94@c7XZ","description":"Senha do User na ReCB
\n","type":"text"},{"key":"client_token","value":"{{client_token}}","sessionValue":"7E444CFE-AFE5-4EA2-B748-F7C4A7CB3884","description":"Token
\n","type":"text"},{"key":"client_ip","value":"{{client_ip}}","sessionValue":"187.","description":"Ip do cliente
\n","type":"text"},{"key":"categoryID","value":"22563","description":"Id da categoria criada
\n","type":"text"},{"key":"nome_razao_social","value":"NATAN GUEDES","description":"Nome completo
\n","type":"text"},{"key":"nome_abreviado","value":"NATAN GUEDES","description":"Nome Completo
\n","type":"text"},{"key":"cpf_cnpj","value":"77865979304","description":"CPF/CNPJ Válido
\n","type":"text"},{"key":"insc_estadual","value":"","description":"Somente para PJ
\n","type":"text"},{"key":"rg","value":"1234567","description":"Apenas números RG
\n","type":"text"},{"key":"org_exp","value":"SSP-PI","description":"Órgão expedidor RG
\n","type":"text"},{"key":"email","value":"teste@teste.com.br","description":"e-mail válido
\n","type":"text"},{"key":"data_nasc","value":"01/01/1956","description":"data de nascimento dd/mm/yyyy
\n","type":"text"},{"key":"endereco","value":"RUA DOM SEVERINO","description":"endereço
\n","type":"text"},{"key":"numero","value":"1234","description":"número
\n","type":"text"},{"key":"bairro","value":"HORTO","description":"bairro
\n","type":"text"},{"key":"cidade","value":"TERESINA","description":"cidade
\n","type":"text"},{"key":"estado","value":"PI","description":"estado
\n","type":"text"},{"key":"cep","value":"64000000","description":"cep
\n","type":"text"},{"key":"fone_res","value":"8622222222","description":"telefone
\n","type":"text"},{"key":"fone_cel","value":"86999999999","description":"celular
\n","type":"text"},{"key":"obs","value":"MENSAGEM IMPORTANTE","description":"observaçoes
\n","type":"text"}]},"url":"http://35.199.90.140/app/api/v1/src/payer/create.php","description":"Cria um novo pagador caso não exista. Cada transação criada retornará uma única chave identificadora \"payerID\".
\n\n\nObjeto JSON instanciado com parâmetro a serem enviados:
\n
\n{\n\"categoriaID\": 1,\n\"nome_razao_social\": \"RAIMUNDO DE SOUSA SOARES\",\n\"nome_abreviado\": \"RAIMUNDO DE SOUSA SOARES\",\n\"cpf_cnpj\": \"09812345678\",\n\"insc_estadual\": “\",\n“rg\": \"1345678\",\n\"org_exp\": \"SSP-PI\",\n\"email\": \"raimundoss@hotmail.com\",\n\"data_nasc\": \"30/09/1956\",\n\"endereco\": \"Rua Vinte\",\n“numero\": \"4326\",\n\"bairro\": \"Tres Andares\",\n\"cidade\": \"TERESINA\",\n\"estado\": \"PI\",\n\"cep\": \"64010775\",\n\"fone_res\": \"86999999999\",\n\"fone_cel\": \"86999999999\",\n\"obs\": \"OBS IMPORTANTE\"\n}\n\n\n\n\nResposta do Objeto JSON enviado:
\n
\n{\n\"Message\": {\n\"Title\": \"sucesso!\",\n\"Message\": \"Pagador encontrado/cadastrado com sucesso.\",\n\"MessageId\": 0\n},\n\"DataReturn\": {\n\"payerID\": 1\n}\n}\n\n\n\n\nMensagens de retorno:
\n
| messageId | \nStatus | \nDescrição | \n
|---|---|---|
| 0 | \nSucesso | \nPagador encontrado/cadastrado com sucesso. | \n
| 00 | \nErro | \nMáximo de caracteres é de 150. | \n
| 1 | \nErro | \nVerifique o(s) parâmetro(s) de entrada. | \n
| 01 | \nErro | \nData de nascimento inválida. | \n
| 2 | \nErro | \nCPF/CNPJ inválido. | \n
| 02 | \nErro | \nE-mail inválido (sem “@” ou sem “.com” ou “.com.br”). | \n
| 3 | \nErro | \nConsulte a documentação sobre os valores e tamanhos de campos a serem enviados. | \n
| 03 | \nErro | \nE-mail com mais de 50 posições. | \n
| 4/5 | \nErro | \nPagador não cadastrado. | \n
Cliente ID na ReCB
\n","key":"client_id","sessionValue":"[{\"key\":\"$clientID\",\"value\":\"131\",\"description\":\"Cliente ID na ReCB\",\"enabled\":false}]","type":"text","value":"{{client_id}}"},{"description":"User ID na ReCB
\n","key":"client_user","value":"{{client_user}}"},{"description":"Senha do User na ReCB
\n","key":"client_pass","sessionValue":"X3VsA94@c7XZ","type":"text","value":"{{client_pas}}"},{"description":"Token
\n","key":"client_token","sessionValue":"7E444CFE-AFE5-4EA2-B748-F7C4A7CB3884","type":"text","value":"{{client_token}}"},{"description":"Ip do cliente
\n","key":"client_ip","sessionValue":"187.","type":"text","value":"{{client_ip}}"},{"description":"ID do cliente
\n","key":"payerID","type":"text","value":"640409"}]},"url":"http://35.199.90.140/app/api/v1/src/payer/detail.php","description":"Retorna informações sobre um pagador já criado através do método [7.3 - Create_Payer]. Cada transação retornará\n“cartegoryID”, “nome_razao_social”, “nome_abreviado”, “cpf_cnpj”, “insc_estadual”, “rg”, “org_exp”, “data_nasc”, “endereço”, “numero”, “bairro”, “cidade”, “estado”, “cep”, “fone_res”, “fone_cel”, “obs”, \"situacao\".
\n\n\nObjeto JSON instanciado com parâmetro a serem enviados:
\n
\n{\n\"payerID\": 579037\n}\n\n\n\n\nResposta do Objeto JSON enviado:
\n
\n{\n\"Message\": {\n\"Title\": \"sucesso!\",\n\"Message\": \"Pagador encontrado com sucesso.\",\n\"MessageId\": 0\n},\n\"DataReturn\": {\n “cartegoryID”: 579037\n “nome_razao_social”: RAIMUNDO DE SOUSA SOARES\n “nome_abreviado”: RAIMUNDO DE SOUSA SOARES\n “cpf_cnpj”: 14912393000114\n “insc_estadual”: 1234567890\n “rg”: 1345678\n “org_exp”: SSP-PI\n “data_nasc”: 30091956\n “endereço”: Rua Vinte\n “numero”: 4326\n “bairro”: Tres Andares\n “cidade”: TERESINA\n “estado”: PI\n “cep”: 64010775\n “fone_res”: 86999999999\n “fone_cel”: 86999999999\n “obs”: OBS IMPORTANTE,\n\"situacao\": \"Ativo\"\n}\n}\n\n\n\n\nMensagens de retorno:
\n
| messageId | \nStatus | \nDescrição | \n
|---|---|---|
| 0 | \nSucesso | \nPagador encontrado com sucesso. | \n
| 1 | \nErro | \nVerifique o parâmetro de entrada. | \n
| 2 | \nSucesso | \nPagador não encontrado. | \n
Cliente ID na ReCB
\n","key":"client_id","sessionValue":"[{\"key\":\"$clientID\",\"value\":\"131\",\"description\":\"Cliente ID na ReCB\",\"enabled\":false}]","type":"text","value":"{{client_id}}"},{"description":"User ID na ReCB
\n","key":"client_user","value":"{{client_user}}"},{"description":"Senha do User na ReCB
\n","key":"client_pass","sessionValue":"X3VsA94@c7XZ","type":"text","value":"{{client_pas}}"},{"description":"Token
\n","key":"client_token","sessionValue":"7E444CFE-AFE5-4EA2-B748-F7C4A7CB3884","type":"text","value":"{{client_token}}"},{"description":"Peer utilizado para acesso a API
\n","key":"client_ip","sessionValue":"187.","type":"text","value":"{{client_ip}}"},{"description":"id da categoria
\n","key":"categoryID","sessionValue":"04/06/2018","type":"text","value":"23475"},{"description":"id do pagador
\n","key":"payerID","type":"text","value":"746292"},{"description":"dia primeiro boleto
\n","key":"dia","type":"text","value":"25"},{"description":"mes do primeiro boleto
\n","key":"mes","type":"text","value":"12"},{"description":"ano do primeiro boleto
\n","key":"ano","type":"text","value":"2024"},{"description":"quantidade de parcelas
\n","key":"qtd_parcelas","type":"text","value":"1"},{"description":"periodicidade da geração (default = 30)
\n","key":"periodicidade","type":"text","value":"30"},{"description":"valor boleto. Mínimo 10,00
\n","key":"valor_parcela","type":"text","value":"10.00"},{"description":"mensagem 01 - corpo do boleto
\n","key":"msg_boleto1","type":"text","value":"MSG 001"},{"description":"mensagem 02 - corpo do boleto
\n","key":"msg_boleto2","type":"text","value":"MSG 002"},{"description":"mensagem 03 - corpo do boleto
\n","key":"msg_personalizada","type":"text","value":"MSG 003"},{"description":"multa em % (Multa máxima 10%)
\n","key":"multa","type":"text","value":"2.00"},{"description":"mora em % (Mora máxima 1%)
\n","key":"mora","type":"text","value":"0.10"},{"description":"desconto em % (Desconto máximo 90%)\nOBS: Ver nota 01 para funcionalidade de múltiplos descontos boletos Itaú e nota 02 para utilização do desconto em reais(R$) boletos Itaú ou BB - campos opcionais abaixo:
\n","key":"desconto","type":"text","value":"80.00"},{"description":"opcional1: data limite para o primeiro desconto(formato: “DD/MM/AAAA”)
\n","key":"data_desconto_1","type":"text","value":""},{"description":"opcional2: valor do primeiro desconto (Valor em R$ não pode ser superior a 90% do valor nominal do boleto)
\n","key":"valor_desconto_1","type":"text","value":""},{"description":"opcional3: data limite para o segundo desconto(formato: “DD/MM/AAAA”)
\n","key":"data_desconto_2","type":"text","value":""},{"description":"opcional4: valor do segundo desconto
\n","key":"valor_desconto_2","type":"text","value":""},{"description":"opcional5: data limite para o terceiro desconto(formato: “DD/MM/AAAA”)
\n","key":"data_desconto_3","type":"text","value":""},{"description":"opcional6: valor do terceiro desconto
\n","key":"valor_desconto_3","type":"text","value":""}]},"url":"http://35.199.90.140/app/api/v1/src/carnet/createAllBanks.php","description":"\n\nUtilizado para geração de um ou mais boletos/tickets, geradas em lote e com uma forma de pagamento já definida. As parcelas de um carnê vencem mensalmente, de acordo com a data definida pelo integrador.
\n
\n\nUm carnê possui o status:
\n
- 0 = Normal\n - 1 = Cancelado\n - 2 = Quitado\n - 3 = Excluído
\n\nCada carnê gerado possui uma identificação única denominada \"carnetID\", e cada parcela desse carnê também possuem um identificador único denominado \"ticketID\".
\n
\n\nObjeto JSON instanciado com parâmetro a serem enviados:
\n
\n{\n{\n\"categoryID\": [categoryID], \n\"payerID\": [payerID],\n\"dia\": \"01\",\n\"mes\": \"11\",\n\"ano\": \"2018\",\n\"qtd_parcelas\": \"2\",\n\"periodicidade\": \"30\",\n\"valor_parcela\": \"30.00\",\n\"msg_boleto1\": \"COBRAR JUROS/MULTA APÓS O VENCIMENTO\",\n\"msg_boleto2\": \"2 VIA DO BOLETO: RECB.COM.BR/2VIA\",\n\"msg_personalizada\": \"MENSAGEM PERSONALIZADA\",\n\"multa\": \"2.00\",\n\"mora\": \"0.10\",\n\"desconto\": \"0.00\"\n};\n# Campos opcionais: ver Nota 01 e Nota 02 no item [ 6 - Estrutura hierárquica dos atributos: Schema ] do menu para utilização dos campos opcionais:\n\"data_desconto_1\": \"01/05/2018\", #default = “”\n\"valor_desconto_1\": \"10.00\"; #default = “”\n\"data_desconto_2\": \"\",\n\"valor_desconto_2\": \"\",\n\"data_desconto_3\": \"\",\n\"valor_desconto_3\": \"\"\n}\n\n\n\n\nResposta do Objeto JSON enviado:
\n
\n[DataReturn] => Array {\n[0] => Array\n(\n“CarnetID”: 1,\n“TicketID”: 8301081,\n“Value”: “30.00”,\n“NumeroDoc”: 8301081,\n“NossoNumero”: 00075343,\n“DataVencimento”: “01112018”,\n“LinhaDigitavel”: “75691.43535 01003.102009 00753.430016 3 73350000009453”,\n“CodBarras”:“75691435350100310200900753430016373350000009453”\n“codBancoEmissor”: “756”\n“dateCreate”: “01052018”\n“timeCreate”: “115641”\n)\n[1] => Array\n(\n“CarnetID”: 1,\n“TicketID”: 8301082,\n“Value”: “30.00”,\n“NumeroDoc”: 8301082,\n“NossoNumero”: 00075350,\n“DataVencimento”: “01122018”,\n“LinhaDigitavel”: “75691.43535 01003.102009 00753.500016 2 73350000009261”,\n“CodBarras”: “75691435350100310200900753500016273350000009261”\n“codBancoEmissor”: “756”\n“dateCreate”: “01052018”\n“timeCreate”: “115641”\n)\n},\n{\n\"Message\": {\n\"Title\": \"sucesso!\",\n\"Message\": \"Carnet gerado com sucesso.\",\n\"MessageId\": 0\n}\n\n\n\n\nMensagens de retorno:
\n
| messageId | \nStatus | \nDescrição | \n
|---|---|---|
| messageID_0 | \nSucesso | \nCarnet gerado com sucesso. | \n
| messageID_1 | \nErro | \nVerifique o parâmetro de entrada. | \n
| messageID_2 | \nErro | \nVerifique se há parâmetros vazios. | \n
| messageID_3 | \nErro | \nConsulte a documentação sobre os valores e tamanhos de campos a serem enviados. | \n
| messageID_4 | \nErro | \nCarnet não gerado. | \n
| messageID_5 | \nErro | \nTicket não gerado. | \n
| messageID_6 | \nErro | \nO valor da parcela não é valido. | \n
| messageID_7 | \nErro | \nExiste vírgula no valor. | \n
| messageID_8 | \nErro | \nValor da parcela menor que o permitido. | \n
| messageID_9 | \nErro | \nO valor da multa não é válido. | \n
| messageID_10 | \nErro | \nExiste vírgula na multa. | \n
| messageID_11 | \nErro | \nO valor da mora não é válida. | \n
| messageID_12 | \nErro | \nExiste vírgula na mora. | \n
| messageID_13 | \nErro | \nO valor do desconto não é válido. | \n
| messageID_14 | \nErro | \nExiste vírgula no desconto. | \n
| messageID_15 | \nErro | \nPrecisa-se de ponto decimal no desconto. | \n
| messageID_16 | \nErro | \nData de vencimento inválida. | \n
| messageID_17 | \nErro | \nData não permitida, inferior a data atual. | \n
| messageID_18 | \nErro | \nO valor da parcela ultrapassa a quantidade exigida. | \n
| messageID_19 | \nErro | \nO valor da multa ultrapassa a quantidade exigida. | \n
| messageID_20 | \nErro | \nO valor da mora ultrapassa a quantidade exigida. | \n
| messageID_21 | \nErro | \nO valor do desconto ultrapassa a quantidade exigida. | \n
| messageID_22 | \nErro | \nA quantidade de parcelas está zerada ou maior que a permitida. | \n
| messageID_23 | \nErro | \nPeriodicidade diferente de 30. | \n
| messageID_24 | \nErro | \nData de primeiro desconto inválida. | \n
| messageID_25 | \nErro | \nO valor do primeiro desconto não é válido. | \n
| messageID_26 | \nErro | \nExiste vírgula no primeiro desconto. | \n
| messageID_27 | \nErro | \nPrecisa-se de ponto decimal no primeiro desconto. | \n
| messageID_28 | \nErro | \nO valor do primeiro desconto ultrapassa a quantidade exigida. | \n
| messageID_29 | \nErro | \nData de segundo desconto inválida. | \n
| messageID_30 | \nErro | \nO valor do segundo desconto não é válido. | \n
| messageID_31 | \nErro | \nExiste vírgula no segundo desconto. | \n
| messageID_32 | \nErro | \nPrecisa-se de ponto decimal no segundo desconto. | \n
| messageID_33 | \nErro | \nO valor do segundo desconto ultrapassa a quantidade exigida. | \n
| messageID_34 | \nErro | \nData de terceiro desconto inválida. | \n
| messageID_35 | \nErro | \nO valor do terceiro desconto não é válido. | \n
| messageID_36 | \nErro | \nExiste vírgula no terceiro desconto. | \n
| messageID_37 | \nErro | \nPrecisa-se de ponto decimal no terceiro desconto. | \n
| messageID_38 | \nErro | \nO valor do desconto ultrapassa a quantidade exigida. | \n
| messageID_39 | \nErro | \nValor Desconto 1 (R$) maior que o permitido, sendo acima de 90% do valor do boleto. | \n
| messageID_40 | \nErro | \nValor Desconto 2 (R$) maior que o permitido, sendo acima de 90% do valor do boleto. | \n
| messageID_41 | \nErro | \nValor Desconto 3 (R$) maior que o permitido, sendo acima de 90% do valor do boleto. | \n
| messageID_42 | \nErro | \nMora (%) maior que o permitido (1%) conforme art. 406 do Código Civil e artigo 161, parágrafo primeiro, do Código Tributário Nacional. | \n
| messageID_43 | \nErro | \nMulta (%) maior que o permitido (10%) conforme art. 406 do Código Civil e art 161, parágrafo primeiro, do Código Tributário Nacional. | \n
| messageID_44 | \nErro | \nDesconto (%) maior que o permitido. Regra Bancária. | \n
| messageID_45 | \nErro | \nData de primeiro desconto não permitida. Retroativa/Inferior a data atual. | \n
| messageID_46 | \nErro | \nData de segundo desconto não permitida. Retroativa/Inferior a data atual. | \n
| messageID_47 | \nErro | \nData de terceiro desconto não permitida. Retroativa/Inferior a data atual. | \n
Cliente ID na ReCB
\n","key":"client_id","sessionValue":"[{\"key\":\"$clientID\",\"value\":\"131\",\"description\":\"Cliente ID na ReCB\",\"enabled\":false}]","type":"text","value":"{{client_id}}"},{"description":"User ID na ReCB
\n","key":"client_user","value":"{{client_user}}"},{"description":"Senha do User na ReCB
\n","key":"client_pass","sessionValue":"X3VsA94@c7XZ","type":"text","value":"{{client_pas}}"},{"description":"Token
\n","key":"client_token","sessionValue":"7E444CFE-AFE5-4EA2-B748-F7C4A7CB3884","type":"text","value":"{{client_token}}"},{"description":"Ip do cliente
\n","key":"client_ip","sessionValue":"187.","type":"text","value":"{{client_ip}}"},{"description":"id do Carnet
\n","key":"carnetID","sessionValue":"04/06/2018","type":"text","value":"1941806"}]},"url":"http://35.199.90.140/app/api/v1/src/carnet/detail.php","description":"Retorna informações sobre um carnet e seus respectivos ticket(s) criado(s). O parâmetro de entrada será o \"carnetID\".
\n\n\nO parâmetro “statusticket” tem os seguintes status:
\n
\n0=Gerado | 1=Pago | 2=Vencido | 3=Deletado | 4=Renegociado\n\n\n
\n\nObjeto JSON instanciado com parâmetro a serem enviados:
\n
\n{\n\"carnetID\": 1188637\n}\n\n\n\n\nResposta do Objeto JSON enviado:
\n
\n{\n\"Message\": {\n\"Title\": \"sucesso!\",\n\"Message\": \"Carnet encontrado com sucesso.\",\n\"MessageId\": 0\n},\n[DataReturn] => Array {\n[0] => Array\n(\n“carnetID”: 1188637\n“payerID”: 579037\n“categoryID”: 17720\n“statuscarnet”: Normal\n“ticketID”: 8348632\n“value”: 10,00\n“numerodoc”: 8348632\n“nossonumero”: 28834\n“datavenc”: 01012018\n“datapag”: 01012018\n“linhadigitavel”: 75691.43535 01003.102009 00288.340011 5 73910000001000\n“codbarras”: 75695739100000010001435301003102000028834001\n“statusticket”: Gerado\n“codBancoEmissor”: “756”\n“dateCreate”: “16022018”\n“timeCreate”: “115641”\n)\n}\n\n\n\n\nMensagens de retorno:
\n
| messageId | \nStatus | \nDescrição | \n
|---|---|---|
| 0 | \nSucesso | \nCarnet encontrado com sucesso. | \n
| 1 | \nErro | \nVerifique o parâmetro de entrada. | \n
| 2 | \nSucesso | \nCarnet não encontrado. | \n
| 3 | \nErro | \nTicket(s) de Carnet não encontrado(s). | \n
Cliente ID na ReCB
\n","key":"client_id","sessionValue":"[{\"key\":\"$clientID\",\"value\":\"131\",\"description\":\"Cliente ID na ReCB\",\"enabled\":false}]","type":"text","value":"{{client_id}}"},{"description":"User ID na ReCB
\n","key":"client_user","value":"{{client_user}}"},{"description":"Senha do User na ReCB
\n","key":"client_pass","sessionValue":"X3VsA94@c7XZ","type":"text","value":"{{client_pas}}"},{"description":"Token
\n","key":"client_token","sessionValue":"7E444CFE-AFE5-4EA2-B748-F7C4A7CB3884","type":"text","value":"{{client_token}}"},{"description":"Ip do cliente
\n","key":"client_ip","sessionValue":"187.","type":"text","value":"{{client_ip}}"},{"key":"carnetID","value":"1352127","description":"Id do Carnet a ser cancelado
\n","type":"text"},{"key":"msgcancel","value":"CANCELADO PELO POSTMAN","description":"Motivo do cancelamento
\n","type":"text"}]},"url":"http://35.199.90.140/app/api/v1/src/carnet/cancel.php","description":"Cancela um carnê e todas as suas respectivas parcelas(tickets), através do parâmetro \"carnetID\" e \"msgcancel\" são obrigatórios.
\n\n\nObjeto JSON instanciado com parâmetro a serem enviados:
\n
\n{\n\"carnetID\": 1188636\n\"msgcancel\": “Cancelado via API”\n}\n\n\n\n\nResposta do Objeto JSON enviado:
\n
\n{\n\"Message\": {\n\"Title\": \"sucesso!\",\n\"Message\": \"Ticket cancelado.\",\n\"MessageId\": 0\n},\n[DataReturn] => Array {\n[0] => Array\n(\n[0] => Array\n(\n“carnetID”: 1188636\n“payerID”: 579037\n“categoryID”: 17720\n“statusCarnet”: Cancelado\n“ticketID”: 8348624\n“value”: 39,00\n“numeroDoc”: 8348624\n“nossoNumero”: 28755\n“dataVenc”: 01112017\n“dataPag”: 01012018\n“linhaDigitavel”: 75691.43535 01003.102009 00287.550016 1 73300000003900\n“codBarras”: 75691733000000039001435301003102000028755001\n“statusTicket”: Cancelado\n“codBancoEmissor”: “756”\n“dateCreate”: “16022018”\n“timeCreate”: “115641”\n)\n}\n\n\n\n\nMensagens de retorno:
\n
| messageId | \nStatus | \nDescrição | \n
|---|---|---|
| 0 | \nSucesso | \nTicket cancelado com sucesso. | \n
| 1 | \nErro | \nVerifique o parâmetro de entrada. | \n
| 2 | \nSucesso | \nCarnet não encontrado. | \n
| 3 | \nErro: | \nCarnet não cancelado. | \n
Cliente ID na ReCB
\n","key":"client_id","sessionValue":"[{\"key\":\"$clientID\",\"value\":\"131\",\"description\":\"Cliente ID na ReCB\",\"enabled\":false}]","type":"text","value":"{{client_id}}"},{"description":"User ID na ReCB
\n","key":"client_user","value":"{{client_user}}"},{"description":"Senha do User na ReCB
\n","key":"client_pass","sessionValue":"X3VsA94@c7XZ","type":"text","value":"{{client_pas}}"},{"description":"Token
\n","key":"client_token","sessionValue":"7E444CFE-AFE5-4EA2-B748-F7C4A7CB3884","type":"text","value":"{{client_token}}"},{"description":"Ip do cliente
\n","key":"client_ip","sessionValue":"187.","type":"text","value":"{{client_ip}}"},{"description":"Id do Ticket
\n","key":"ticketID","type":"text","value":"10855379"}]},"url":"http://35.199.90.140/app/api/v1/src/ticket/detail.php","description":"Retorna os dados de uma parcela especificada de um carnet, através dos parâmetro \"ticketID\".
\n\n\nO parâmetro “statusticket” tem os seguintes status:
\n
\n0=Gerado | 1=Pago | 2=Vencido | 3=Deletado | 4=Renegociado\n\n\n
\n\nObjeto JSON instanciado com parâmetro a serem enviados:
\n
\n{\n\"ticketID\": 8348629\n}\n\n\n\n\nResposta do Objeto JSON enviado:
\n
\nArray\n(\n\"message\": Array\n(\n\"title\": Sucesso\n\"message\": Boleto encontrado\n\"messageID': 0\n)\n[DataReturn] => Array\n(\n\"ticketID\": 9169939\n\"value\": 15,92\n\"valorRecebido\": 0,00\n\"numeroDoc\": 9169939\n\"nossoNumero\": 312982\n\"dataVenc\" => 18102018\n\"dataPag\": \n\"linhaDigitavel:\" 34191.09008 03129.828848 00853.390003 8 76810000001592\n\"codBarras\": 34198768100000015921090003129828840085339000\n\"statusTicket\": Cancelado\n\"codBancoEmissor\": 341\n\"dateCreate\": 10102018\n\"timeCreate\": 104300\n\"DataDesconto1\": \n\"ValorDesconto1\": \n\"DataDesconto2\": \n\"ValorDesconto2\": \n\"DataDesconto3\": \n\"ValorDesconto3\": \n)\n)\n\n\n
\n\nMensagens de retorno:
\n
| messageId | \nStatus | \nDescrição | \n
|---|---|---|
| 0 | \nSucesso | \nTicket encontrado. | \n
| 1 | \nErro | \nVerifique o parâmetro de entrada. | \n
| 2 | \nSucesso | \nTicket não encontrada. | \n
Cliente ID na ReCB
\n","key":"client_id","sessionValue":"[{\"key\":\"$clientID\",\"value\":\"131\",\"description\":\"Cliente ID na ReCB\",\"enabled\":false}]","type":"text","value":"{{client_id}}"},{"description":"User ID na ReCB
\n","key":"client_user","value":"{{client_user}}"},{"description":"Senha do User na ReCB
\n","key":"client_pass","sessionValue":"X3VsA94@c7XZ","type":"text","value":"{{client_pas}}"},{"description":"Token
\n","key":"client_token","sessionValue":"7E444CFE-AFE5-4EA2-B748-F7C4A7CB3884","type":"text","value":"{{client_token}}"},{"description":"Ip do cliente
\n","key":"client_ip","sessionValue":"187.","type":"text","value":"{{client_ip}}"},{"description":"Id do Ticket a ser cancelado
\n","key":"ticketID","type":"text","value":"9170087"}]},"url":"http://35.199.90.140/app/api/v1/src/ticket/cancel.php","description":"Cancela uma parcela especificada de um carnet, através dos parâmetro ticketID.
\n\n\nObjeto JSON instanciado com parâmetro a serem enviados:
\n
\n{\n\"ticketID\": 8348629\n}\n\n\n\n\nResposta do Objeto JSON enviado:
\n
\n{\n\"Message\": {\n\"Title\": \"sucesso!\",\n\"Message\": \"Ticket cancelado.\",\n\"MessageId\": 0\n},\n[DataReturn] => Array {\n[0] => Array\n(\n“ticketID”: 8348632\n“value”: 10,00\n“valorRecebido”: 10,00\n“numeroDoc”: 8348632\n“nossoNumero”: 28834\n“dataVenc”: 01012018\n“dataPag”: 01012018\n“linhaDigitavel”: 75691.43535 01003.102009 00288.340011 5 73910000001000\n“codBarras”: 75695739100000010001435301003102000028834001\n“statusTicket”: Cancelado\n“codBancoEmissor”: “756”\n“dateCreate”: “16022018”\n“timeCreate”: “115641”\n)\n}\n\n\n\n\nMensagens de retorno:
\n
| messageId | \nStatus | \nDescrição | \n
|---|---|---|
| 0 | \nSucesso | \nTicket cancelado. | \n
| 1 | \nErro | \nVerifique o parâmetro de entrada. | \n
| 2 | \nSucesso | \nTicket não encontrado/cancelado. | \n
Cliente ID na ReCB
\n","type":"text"},{"key":"client_user","value":"{{client_user}}","description":"User ID na ReCB
\n"},{"key":"client_pass","value":"{{client_pas}}","sessionValue":"X3VsA94@c7XZ","description":"Senha do User na ReCB
\n","type":"text"},{"key":"client_token","value":"{{client_token}}","sessionValue":"7E444CFE-AFE5-4EA2-B748-F7C4A7CB3884","description":"Token
\n","type":"text"},{"key":"client_ip","value":"{{client_ip}}","sessionValue":"187.","description":"Ip do cliente
\n","type":"text"},{"key":"datePayments","value":"06/04/2021","sessionValue":"04/06/2018","description":"Data dos pagamentos a serem retornados
\n","type":"text"}]},"url":"http://35.199.90.140/app/api/v1/src/ticket/payments.php","description":"Listar todos os boletos (tickets) pagos, através do parâmetro datePayments. Este procedimento deve ser utilizado para obter os boletos (tickets) pagos em uma determinada data, para fins de baixa ou retorno dos pagamentos efetuados.
\n\n\nObjeto JSON instanciado com parâmetro a serem enviados:
\n
\n{\n\"datePayments\": “02/10/2018”\n}\n\n\n\n\nResposta do Objeto JSON enviado:
\n
\nArray\n(\n[message] => Array\n(\n[title] => Sucesso\n[message] => Pagamento(s) encontrado(s)\n[messageID] => 0\n)\n[DataReturn] => Array\n(\n[0] => Array\n(\n[ticketID] => 9165785\n[value] => 152,78\n[valorRecebido] => 152,78\n[numeroDoc] => 9165785\n[nossoNumero] => 17183250009165785\n[dataVenc] => 05102018\n[dataPag] => 03102018\n[linhaDigitavel] => 00190.00009 01718.325002 09165.785172 7 76680000015278\n[codBarras] => 00197766800000152780000001718325000916578517\n[statusTicket] => Pago\n[codBancoEmissor] => 001\n[dateCreate] => 03102018\n[timeCreate] => 091330\n[paymentID] => 616473\n)\n)\n)\n\n\n
\n\nMensagens de retorno:
\n
| messageId | \nStatus | \nDescrição | \n
|---|---|---|
| 0 | \nSucesso | \nPagamento(s) encontrado(s) com sucesso. | \n
| 1 | \nErro | \nVerifique o parâmetro de entrada. | \n
| 2 | \nSucesso | \nPagamento(s) não encontrado(s). | \n
Cliente ID na ReCB
\n","key":"client_id","sessionValue":"[{\"key\":\"$clientID\",\"value\":\"131\",\"description\":\"Cliente ID na ReCB\",\"enabled\":false}]","type":"text","value":"{{client_id}}"},{"description":"User ID na ReCB
\n","key":"client_user","value":"{{client_user}}"},{"description":"Senha do User na ReCB
\n","key":"client_pass","sessionValue":"X3VsA94@c7XZ","type":"text","value":"{{client_pas}}"},{"description":"Token
\n","key":"client_token","sessionValue":"7E444CFE-AFE5-4EA2-B748-F7C4A7CB3884","type":"text","value":"{{client_token}}"},{"description":"Ip do cliente
\n","key":"client_ip","sessionValue":"187.","type":"text","value":"{{client_ip}}"},{"description":"id do Carnet a sewr enviado por e-mail
\n","key":"carnetID","sessionValue":"04/06/2018","type":"text","value":"1352156"}]},"url":"http://35.199.90.140/app/api/v1/src/carnet/send.php","description":"Envia um e-mail com os links de todos os boletos do Carnet, para que o cliente possa reimprimi-los.
\n\n\nObjeto JSON instanciado com parâmetro a serem enviados:
\n
\n{\n\"carnetID\": 1188637\n}\n\n\n\n\nResposta do Objeto JSON enviado:
\n
\n{\n\"Message\": {\n\"Title\": \"sucesso!\",\n\"Message\": \"Carnet enviado por e-mail com sucesso.\",\n\"MessageId\": 0\n}\n}\n\n\n\n\nMensagens de retorno:
\n
| messageId | \nStatus | \nDescrição | \n
|---|---|---|
| 0 | \nSucesso | \nCarnet enviado por e-mail com sucesso. | \n
| 1 | \nErro | \nVerifique o parâmetro de entrada. | \n
| 2 | \nSucesso | \nCarnet não encontrado. | \n
| 3 | \nErro | \nBoletos não encontrados no Carnet. | \n
| 4 | \nSucesso | \nNão conseguimos disparar o e-mail. | \n
| 5 | \nSucesso | \nNão foi possível enviar o e-mail. | \n
Cliente ID na ReCB
\n","key":"client_id","sessionValue":"[{\"key\":\"$clientID\",\"value\":\"131\",\"description\":\"Cliente ID na ReCB\",\"enabled\":false}]","type":"text","value":"{{client_id}}"},{"description":"User ID na ReCB
\n","key":"client_user","value":"{{client_user}}"},{"description":"Senha do User na ReCB
\n","key":"client_pass","sessionValue":"X3VsA94@c7XZ","type":"text","value":"{{client_pas}}"},{"description":"Token
\n","key":"client_token","sessionValue":"7E444CFE-AFE5-4EA2-B748-F7C4A7CB3884","type":"text","value":"{{client_token}}"},{"description":"Ip do cliente
\n","key":"client_ip","sessionValue":"187.","type":"text","value":"{{client_ip}}"},{"description":"id do ticket a ser enviado por e-mail
\n","key":"ticketID","sessionValue":"04/06/2018","type":"text","value":"9170088"}]},"url":"http://35.199.90.140/app/api/v1/src/ticket/send.php","description":"Envia um e-mail com o link de um boleto específico, para que o cliente possa reimprimi-los.
\n\n\nObjeto JSON instanciado com parâmetro a serem enviados:
\n
\n{\n\"ticketID\": 8348645\n}\n\n\n\n\nResposta do Objeto JSON enviado:
\n
\n{\n\"Message\": {\n\"Title\": \"sucesso!\",\n\"Message\": \"Boleto enviado por e-mail com sucesso.\",\n\"MessageId\": 0\n}\n}\n\n\n\n\nMensagens de retorno:
\n
| messageId | \nStatus | \nDescrição | \n
|---|---|---|
| 0 | \nSucesso | \nBoleto enviado por e-mail com sucesso. | \n
| 1 | \nErro | \nVerifique o parâmetro de entrada. | \n
| 2 | \nSucesso | \nBoleto não encontrado. | \n
| 3 | \nSucesso | \nNão conseguimos disparar o e-mail. | \n
| 4 | \nSucesso | \nNão foi possível enviar o e-mail. | \n
Médoto ainda não está disponível na versão atual.
\n","urlObject":{"host":["{{URL}}"],"query":[],"variable":[]}},"response":[{"id":"637af6f5-fb1d-45a7-ad74-4ee6ea7e9dbe","name":"Request Error (messageID=101)","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/x-www-form-urlencoded"},{"key":"cache-control","value":"no-cache"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"client_id","value":"131","sessionValue":"[{\"key\":\"$clientID\",\"value\":\"131\",\"description\":\"Cliente ID na ReCB\",\"enabled\":false}]","description":"Cliente ID na ReCB","type":"text"},{"key":"client_user","value":"3147","description":"User ID na ReCB"},{"key":"client_pass","value":"X3VsA94@c7XZ","sessionValue":"X3VsA94@c7XZ","description":"Senha do User na ReCB","type":"text"},{"key":"client_token","value":"7E444CFE-AFE5-4EA2-B748-F7C4A7CB3884","sessionValue":"7E444CFE-AFE5-4EA2-B748-F7C4A7CB3884","description":"Token","type":"text"},{"key":"client_ip","value":"187.123.43.13","sessionValue":"187.","type":"text"},{"key":"datePayments","value":"04/06/2018","sessionValue":"04/06/2018","description":"Data dos pagamentos","type":"text"}]},"url":"http://35.199.90.140/app/api/v1/src/ticket/payments.php"},"status":"OK","code":200,"_postman_previewlanguage":"html","header":[{"key":"Connection","value":"keep-alive","name":"Connection","description":"Options that are desired for the connection"},{"key":"Content-Encoding","value":"gzip","name":"Content-Encoding","description":"The type of encoding used on the data."},{"key":"Content-Type","value":"text/html; charset=UTF-8","name":"Content-Type","description":"The mime type of this content"},{"key":"Date","value":"Mon, 20 Aug 2018 19:08:17 GMT","name":"Date","description":"The date and time that the message was sent"},{"key":"Server","value":"nginx/1.12.0","name":"Server","description":"A name for the server"},{"key":"Transfer-Encoding","value":"chunked","name":"Transfer-Encoding","description":"The form of encoding used to safely transfer the entity to the user. Currently defined methods are: chunked, compress, deflate, gzip, identity."},{"key":"Vary","value":"Accept-Encoding","name":"Vary","description":"Tells downstream proxies how to match future request headers to decide whether the cached response can be used rather than requesting a fresh one from the origin server."},{"key":"X-Frame-Options","value":"SAMEORIGIN","name":"X-Frame-Options","description":"Clickjacking protection: \"deny\" - no rendering within a frame, \"sameorigin\" - no rendering if origin mismatch"},{"key":"X-Powered-By","value":"PHP/5.6.30","name":"X-Powered-By","description":"Specifies the technology (ASP.NET, PHP, JBoss, e.g.) supporting the web application (version details are often in X-Runtime, X-Version, or X-AspNet-Version)"}],"cookie":[],"responseTime":null,"body":"{\"message\":{\"title\":\"Erro\",\"message\":\"Usuario, senha ou token invalidos\",\"messageID\":\"101\"}}"}],"_postman_id":"cc167ec4-7904-46bb-872f-7f60c32c69d6"},{"name":"API ReCB - 7.14: Fetch_Payments","id":"ca4215cb-7d83-42f4-a197-f1d45037d16c","request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/x-www-form-urlencoded"},{"key":"cache-control","value":"no-cache"}],"body":{"mode":"urlencoded","urlencoded":[{"description":"Cliente ID na ReCB
\n","key":"client_id","sessionValue":"[{\"key\":\"$clientID\",\"value\":\"131\",\"description\":\"Cliente ID na ReCB\",\"enabled\":false}]","type":"text","value":"{{client_id}}"},{"description":"User ID na ReCB
\n","key":"client_user","value":"{{client_user}}"},{"description":"Senha do User na ReCB
\n","key":"client_pass","sessionValue":"X3VsA94@c7XZ","type":"text","value":"{{client_pas}}"},{"description":"Token
\n","key":"client_token","sessionValue":"7E444CFE-AFE5-4EA2-B748-F7C4A7CB3884","type":"text","value":"{{client_token}}"},{"description":"Ip do cliente
\n","key":"client_ip","sessionValue":"187.","type":"text","value":"{{client_ip}}"},{"description":"Data de importação dos pagamentos a serem retornados
\n","key":"datePayments","sessionValue":"04/06/2018","type":"text","value":"05/05/2021"}]},"url":"http://35.199.90.140/app/api/v1/src/ticket/fetchPayments.php","description":"Listar todos os boletos tickets/boletos pagos, através do parâmetro \"datePayments\". Este procedimento deve ser utilizado para obter os boletos (tickets) importados em uma determinada data na ReCB, para fins de baixa ou retorno dos pagamentos efetuados.
\n\n\nObjeto JSON instanciado com parâmetro a serem enviados:
\n
\n{\n\"datePayments\": “02/10/2018”\n}\n\n\n\n\nResposta do Objeto JSON enviado:
\n
\n{\n\"Message\": {\n\"Title\": \"sucesso!\",\n\"Message\": \"Carnet encontrado com sucesso.\",\n\"MessageId\": 0\n},\n[DataReturn] => Array {\n[0] => Array\n(\n“ticketID”: 8707521\n“paymentID”: “615246”\n“valorRecebido”: 281,30\n“tarifa”: 6,00\n“nossoNumero”: 28834\n“dataPag”: 02102018\n“dataCred”: 09102018\n“status”: Gerado\n“codBancoEmissor”: “001”\n)\n}\n\n\n\n\nMensagens de retorno:
\n
| messageId | \nStatus | \nDescrição | \n
|---|---|---|
| 0 | \nSucesso | \nPagamento(s) encontrado(s) com sucesso. | \n
| 1 | \nErro | \nVerifique o parâmetro de entrada. | \n
| 2 | \nSucesso | \nPagamento(s) não encontrado(s). | \n
Cliente ID na ReCB
\n","key":"client_id","sessionValue":"[{\"key\":\"$clientID\",\"value\":\"131\",\"description\":\"Cliente ID na ReCB\",\"enabled\":false}]","type":"text","value":"{{client_id}}"},{"description":"User ID na ReCB
\n","key":"client_user","value":"{{client_user}}"},{"description":"Senha do User na ReCB
\n","key":"client_pass","sessionValue":"X3VsA94@c7XZ","type":"text","value":"{{client_pas}}"},{"description":"Token
\n","key":"client_token","sessionValue":"7E444CFE-AFE5-4EA2-B748-F7C4A7CB3884","type":"text","value":"{{client_token}}"},{"description":"Ip do cliente
\n","key":"client_ip","sessionValue":"187.","type":"text","value":"{{client_ip}}"},{"description":"ID do ticket a ser retornado, informa status registro e link para impressão
\n","key":"ticketID","sessionValue":"04/06/2018","type":"text","value":"11054078"}]},"url":"http://35.199.90.140/app/api/v1/src/ticket/fetchTicket.php","description":"Retorna os dados de uma parcela especificada de um carnet, através dos parâmetro \"ticketID\", com seu status em relação ao registro bancário \"statusTicketBank\" e o link \"linkTicket\" para impressão do boleto.
\n\n\nO parâmetro “statusticket” tem os seguintes status:
\n
\n0=Gerado | 1=Pago | 2=Vencido | 3=Deletado | 4=Renegociado\n\n\n
\n\nO parâmetro “statusTicketBank” tem os seguintes status:
\n
\n0=SEM REGISTRO | 1=REMESSADO | 2=BAIXA_POR_VENCIMENTO | 4=CANCELADO_PELO_CLIENTE | 5=REGISTRADO | 6=RECUSADO\n\n\n
\n\nObjeto JSON instanciado com parâmetro a serem enviados:
\n
\n{\n\"ticketID\": 8348629\n}\n\n\n\n\nResposta do Objeto JSON enviado:
\n
\n{\n\"Message\": {\n\"Title\": \"sucesso!\",\n\"Message\": \"Boleto encontrado\",\n\"MessageId\": 0\n},\n[DataReturn] => Array\n(\n“ticketID”: 8707547\n“value”: 331,00\n“multa”: 2,00\n“mora”: 0,03\n“desconto”: 9,37\n“valorRecebido”: 300,00\n“numeroDoc”: 8707547\n“nossoNumero”: 17183250008707547\n“dataVenc”: 15062018\n“dataPag”: 08062018\n“linhaDigitavel”: 00190.00009 01718.325002 08707.547103 3 75560000033100\n“codBarras”: 00193755600000331000000001718325000870754717\n“statusTicket”: Pago\n“codBancoEmissor”: “001”\n“dateCreate”: “23022018”\n“timeCreate”: “172326”\n“linkTicket”: “https://35.199.90.140/app/BoletoWebBBReg/recboleto.php?tk=ODcwNzU0Nw==”\n“statusTicketBank”: “REGISTRADO”\n)\n)\n\n\n\n\nMensagens de retorno:
\n
| messageId | \nStatus | \nDescrição | \n
|---|---|---|
| 0 | \nSucesso | \nTicket encontrado com sucesso. | \n
| 1 | \nErro | \nVerifique o parâmetro de entrada. | \n
| 2 | \nSucesso | \nTicket não encontrado. | \n
Cliente ID na ReCB
\n","key":"client_id","sessionValue":"[{\"key\":\"$clientID\",\"value\":\"131\",\"description\":\"Cliente ID na ReCB\",\"enabled\":false}]","type":"text","value":"{{client_id}}"},{"description":"User ID na ReCB
\n","key":"client_user","value":"{{client_user}}"},{"description":"Senha do User na ReCB
\n","key":"client_pass","sessionValue":"X3VsA94@c7XZ","type":"text","value":"{{client_pas}}"},{"description":"Token
\n","key":"client_token","sessionValue":"7E444CFE-AFE5-4EA2-B748-F7C4A7CB3884","type":"text","value":"{{client_token}}"},{"description":"Peer utilizado para acesso a API
\n","key":"client_ip","sessionValue":"187.","type":"text","value":"{{client_ip}}"},{"description":"id da categoria
\n","key":"categoryID","sessionValue":"04/06/2018","type":"text","value":"{{categoryID}}"},{"description":"id do pagador
\n","key":"payerID","type":"text","value":"746486"},{"description":"dia primeiro boleto
\n","key":"dia","type":"text","value":"20"},{"description":"mes do primeiro boleto
\n","key":"mes","type":"text","value":"11"},{"description":"ano do primeiro boleto
\n","key":"ano","type":"text","value":"2025"},{"description":"quantidade de parcelas
\n","key":"qtd_parcelas","type":"text","value":"1"},{"description":"periodicidade da geração (default = 30)
\n","key":"periodicidade","type":"text","value":"30"},{"description":"valor boleto. Mínimo 10,00
\n","key":"valor_parcela","type":"text","value":"10.00"},{"description":"mensagem 01 - corpo do boleto
\n","key":"msg_boleto1","type":"text","value":"MSG 001"},{"description":"mensagem 02 - corpo do boleto
\n","key":"msg_boleto2","type":"text","value":"MSG 002"},{"description":"mensagem 03 - corpo do boleto
\n","key":"msg_personalizada","type":"text","value":"MSG 003"},{"description":"multa em % (Multa máxima 10%)
\n","key":"multa","type":"text","value":"2.00"},{"description":"mora em % (Mora máxima 1%)
\n","key":"mora","type":"text","value":"0.10"},{"description":"desconto em % (Desconto máximo 90%)\nOBS: Ver nota 01 para funcionalidade de múltiplos descontos boletos Itaú e nota 02 para utilização do desconto em reais(R$) boletos Itaú ou BB - campos opcionais abaixo:
\n","key":"desconto","type":"text","value":"80.00"},{"description":"opcional1: data limite para o primeiro desconto(formato: “DD/MM/AAAA”)
\n","key":"data_desconto_1","type":"text","value":""},{"description":"opcional2: valor do primeiro desconto (Valor em R$ não pode ser superior a 90% do valor nominal do boleto)
\n","key":"valor_desconto_1","type":"text","value":""},{"description":"opcional3: data limite para o segundo desconto(formato: “DD/MM/AAAA”)
\n","key":"data_desconto_2","type":"text","value":""},{"description":"opcional4: valor do segundo desconto
\n","key":"valor_desconto_2","type":"text","value":""},{"description":"opcional5: data limite para o terceiro desconto(formato: “DD/MM/AAAA”)
\n","key":"data_desconto_3","type":"text","value":""},{"description":"opcional6: valor do terceiro desconto
\n","key":"valor_desconto_3","type":"text","value":""},{"key":"dias_apos_vencimento","value":"10","description":"opcional7: Dias após o vencimento, somente para boletos CEF
\n","type":"text"}]},"url":"http://35.199.90.140/app/api/v1/src/carnet/createAllBanks_2.php","description":"\n\nPermite que o Parceiro gere um carnê informando a quantidade de dias limite/baixa após o vencimento do boleto. Ideal para realização de concursos ou outros eventos que precisam determinar uma data limite para o pagamento do boleto emitido (dias_apos_vencimento).
\n
\n\nOBS: Esta funcionalidade está disponível apenas para boletos emitidos padrão Caixa Econômica.
\n
\n\nUm carnê possui o status:
\n
- 0 = Normal\n - 1 = Cancelado\n - 2 = Quitado\n - 3 = Excluído
\n\nCada carnê gerado possui uma identificação única denominada \"carnetID\", e cada parcela desse carnê também possuem um identificador único denominado \"ticketID\".
\n
\n\nObjeto JSON instanciado com parâmetro a serem enviados:
\n
\n{\n{\n\"categoryID\": [categoryID], \n\"payerID\": [payerID],\n\"dia\": \"01\",\n\"mes\": \"11\",\n\"ano\": \"2018\",\n\"qtd_parcelas\": \"2\",\n\"periodicidade\": \"30\",\n\"valor_parcela\": \"30.00\",\n\"msg_boleto1\": \"COBRAR JUROS/MULTA APÓS O VENCIMENTO\",\n\"msg_boleto2\": \"2 VIA DO BOLETO: RECB.COM.BR/2VIA\",\n\"msg_personalizada\": \"MENSAGEM PERSONALIZADA\",\n\"multa\": \"2.00\",\n\"mora\": \"0.10\",\n\"desconto\": \"0.00\"\n};\n# Campos opcionais: ver Nota 01 e Nota 02 no item [ 6 - Estrutura hierárquica dos atributos: Schema ] do menu para utilização dos campos opcionais:\n\"data_desconto_1\": \"01/05/2018\", #default = “”\n\"valor_desconto_1\": \"10.00\"; #default = “”\n\"data_desconto_2\": \"\",\n\"valor_desconto_2\": \"\",\n\"data_desconto_3\": \"\",\n\"valor_desconto_3\": \"\",\n\"dias_apos_vencimento\": \"30\"\n}\n\n\n\n\nResposta do Objeto JSON enviado:
\n
\n{\n \"DataReturn\": [\n {\n \"CarnetID\": \"1967548\",\n \"TicketID\": \"10948954\",\n \"Value\": \"10,00\",\n \"NumeroDoc\": \"10948954\",\n \"NossoNumero\": \"140000000109489549\",\n \"DataVencimento\": \"11042021\",\n \"LinhaDigitavel\": \"10499.30611 02000.100046 01094.895487 1 85870000001000\",\n \"CodBarras\": \"10491858700000010009306102000100040109489548\",\n \"codBancoEmissor\": \"104\",\n \"dateCreate\": \"18032021\",\n \"timeCreate\": \"152743\",\n \"DataDesconto1\": null,\n \"ValorDesconto1\": null,\n \"DataDesconto2\": null,\n \"ValorDesconto2\": null,\n \"DataDesconto3\": null,\n \"ValorDesconto3\": null,\n \"dias_apos_vencimento\": \"05\"\n }\n ],\n \"message\": {\n \"title\": \"Sucesso\",\n \"message\": \"Carnê gerado com sucesso!\",\n \"messageID\": \"0\"\n }\n}\n\n\n\n\nMensagens de retorno:
\n
| messageId | \nStatus | \nDescrição | \n
|---|---|---|
| messageID_0 | \nSucesso | \nCarnet gerado com sucesso. | \n
| messageID_1 | \nErro | \nVerifique o parâmetro de entrada. | \n
| messageID_2 | \nErro | \nVerifique se há parâmetros vazios. | \n
| messageID_3 | \nErro | \nConsulte a documentação sobre os valores e tamanhos de campos a serem enviados. | \n
| messageID_4 | \nErro | \nCarnet não gerado. | \n
| messageID_5 | \nErro | \nTicket não gerado. | \n
| messageID_6 | \nErro | \nO valor da parcela não é valido. | \n
| messageID_7 | \nErro | \nExiste vírgula no valor. | \n
| messageID_8 | \nErro | \nValor da parcela menor que o permitido. | \n
| messageID_9 | \nErro | \nO valor da multa não é válido. | \n
| messageID_10 | \nErro | \nExiste vírgula na multa. | \n
| messageID_11 | \nErro | \nO valor da mora não é válida. | \n
| messageID_12 | \nErro | \nExiste vírgula na mora. | \n
| messageID_13 | \nErro | \nO valor do desconto não é válido. | \n
| messageID_14 | \nErro | \nExiste vírgula no desconto. | \n
| messageID_15 | \nErro | \nPrecisa-se de ponto decimal no desconto. | \n
| messageID_16 | \nErro | \nData de vencimento inválida. | \n
| messageID_17 | \nErro | \nData não permitida, inferior a data atual. | \n
| messageID_18 | \nErro | \nO valor da parcela ultrapassa a quantidade exigida. | \n
| messageID_19 | \nErro | \nO valor da multa ultrapassa a quantidade exigida. | \n
| messageID_20 | \nErro | \nO valor da mora ultrapassa a quantidade exigida. | \n
| messageID_21 | \nErro | \nO valor do desconto ultrapassa a quantidade exigida. | \n
| messageID_22 | \nErro | \nA quantidade de parcelas está zerada ou maior que a permitida. | \n
| messageID_23 | \nErro | \nPeriodicidade diferente de 30. | \n
| messageID_24 | \nErro | \nData de primeiro desconto inválida. | \n
| messageID_25 | \nErro | \nO valor do primeiro desconto não é válido. | \n
| messageID_26 | \nErro | \nExiste vírgula no primeiro desconto. | \n
| messageID_27 | \nErro | \nPrecisa-se de ponto decimal no primeiro desconto. | \n
| messageID_28 | \nErro | \nO valor do primeiro desconto ultrapassa a quantidade exigida. | \n
| messageID_29 | \nErro | \nData de segundo desconto inválida. | \n
| messageID_30 | \nErro | \nO valor do segundo desconto não é válido. | \n
| messageID_31 | \nErro | \nExiste vírgula no segundo desconto. | \n
| messageID_32 | \nErro | \nPrecisa-se de ponto decimal no segundo desconto. | \n
| messageID_33 | \nErro | \nO valor do segundo desconto ultrapassa a quantidade exigida. | \n
| messageID_34 | \nErro | \nData de terceiro desconto inválida. | \n
| messageID_35 | \nErro | \nO valor do terceiro desconto não é válido. | \n
| messageID_36 | \nErro | \nExiste vírgula no terceiro desconto. | \n
| messageID_37 | \nErro | \nPrecisa-se de ponto decimal no terceiro desconto. | \n
| messageID_38 | \nErro | \nO valor do desconto ultrapassa a quantidade exigida. | \n
| messageID_39 | \nErro | \nValor Desconto 1 (R$) maior que o permitido, sendo acima de 90% do valor do boleto. | \n
| messageID_40 | \nErro | \nValor Desconto 2 (R$) maior que o permitido, sendo acima de 90% do valor do boleto. | \n
| messageID_41 | \nErro | \nValor Desconto 3 (R$) maior que o permitido, sendo acima de 90% do valor do boleto. | \n
| messageID_42 | \nErro | \nMora (%) maior que o permitido (1%) conforme art. 406 do Código Civil e artigo 161, parágrafo primeiro, do Código Tributário Nacional. | \n
| messageID_43 | \nErro | \nMulta (%) maior que o permitido (10%) conforme art. 406 do Código Civil e art 161, parágrafo primeiro, do Código Tributário Nacional. | \n
| messageID_44 | \nErro | \nDesconto (%) maior que o permitido. Regra Bancária. | \n
| messageID_45 | \nErro | \nData de primeiro desconto não permitida. Retroativa/Inferior a data atual. | \n
| messageID_46 | \nErro | \nData de segundo desconto não permitida. Retroativa/Inferior a data atual. | \n
| messageID_47 | \nErro | \nData de terceiro desconto não permitida. Retroativa/Inferior a data atual. | \n
Cliente ID na ReCB
\n","key":"client_id","sessionValue":"[{\"key\":\"$clientID\",\"value\":\"131\",\"description\":\"Cliente ID na ReCB\",\"enabled\":false}]","type":"text","value":"{{client_id}}"},{"description":"User ID na ReCB
\n","key":"client_user","value":"{{client_user}}"},{"description":"Senha do User na ReCB
\n","key":"client_pass","sessionValue":"X3VsA94@c7XZ","type":"text","value":"{{client_pas}}"},{"description":"Token
\n","key":"client_token","sessionValue":"7E444CFE-AFE5-4EA2-B748-F7C4A7CB3884","type":"text","value":"{{client_token}}"},{"description":"Ip do cliente
\n","key":"client_ip","sessionValue":"187.","type":"text","value":"{{client_ip}}"},{"key":"categoryID","type":"text","value":"22563"},{"key":"nome_razao_social","type":"text","value":"NATAN GUEDES"},{"key":"nome_abreviado","type":"text","value":"NATAN GUEDES"},{"key":"cpf_cnpj","type":"text","value":"77865979304"},{"key":"insc_estadual","type":"text","value":""},{"key":"rg","type":"text","value":"1234567"},{"key":"org_exp","type":"text","value":"SSP-PI"},{"key":"email","type":"text","value":"teste@teste.com.br"},{"key":"data_nasc","type":"text","value":"01/01/1956"},{"key":"endereco","type":"text","value":"RUA DOM SEVERINO"},{"key":"numero","type":"text","value":"1234"},{"key":"bairro","type":"text","value":"HORTO"},{"key":"cidade","type":"text","value":"TERESINA"},{"key":"estado","type":"text","value":"PI"},{"key":"cep","type":"text","value":"64000000"},{"key":"fone_res","type":"text","value":"8622222222"},{"key":"fone_cel","type":"text","value":"86999999999"},{"key":"obs","type":"text","value":"MENSAGEM IMPORTANTE"}]},"url":"http://35.199.90.140/app/api/v1/src/payer/update.php","description":"Permite que o Parceiro atualize os dados cadastrais de um cliente já cadastrado.
\nÉ realizada uma busca pelo CPF para localizar e atualizar o cliente caso seja encontrado.
\n\n\nObjeto JSON instanciado com parâmetro a serem enviados:
\n
\n{\n\"categoriaID\": 1,\n\"nome_razao_social\": \"RAIMUNDO DE SOUSA SOARES\",\n\"nome_abreviado\": \"RAIMUNDO DE SOUSA SOARES\",\n\"cpf_cnpj\": \"09812345678\",\n\"insc_estadual\": “\",\n“rg\": \"1345678\",\n\"org_exp\": \"SSP-PI\",\n\"email\": \"raimundoss@hotmail.com\",\n\"data_nasc\": \"30/09/1956\",\n\"endereco\": \"Rua Vinte\",\n“numero\": \"4326\",\n\"bairro\": \"Tres Andares\",\n\"cidade\": \"TERESINA\",\n\"estado\": \"PI\",\n\"cep\": \"64010775\",\n\"fone_res\": \"86999999999\",\n\"fone_cel\": \"86999999999\",\n\"obs\": \"OBS IMPORTANTE\"\n}\n\n\n\n\nResposta do Objeto JSON enviado:
\n
\n{\n \"message\": {\n \"title\": \"Sucesso\",\n \"message\": \"Pagador atualizado com sucesso!\",\n \"messageID\": \"0\"\n },\n \"DataReturn\": {\n \"payerID\": \"1\"\n }\n}\n\n\n\n\nMensagens de retorno:
\n
| messageId | \nStatus | \nDescrição | \n
|---|---|---|
| 0 | \nSucesso | \nPagador encontrado/cadastrado com sucesso. | \n
| 00 | \nErro | \nMáximo de caracteres é de 150. | \n
| 1 | \nErro | \nVerifique o(s) parâmetro(s) de entrada. | \n
| 01 | \nErro | \nData de nascimento inválida. | \n
| 2 | \nErro | \nCPF/CNPJ inválido. | \n
| 02 | \nErro | \nE-mail inválido (sem “@” ou sem “.com” ou “.com.br”). | \n
| 3 | \nErro | \nConsulte a documentação sobre os valores e tamanhos de campos a serem enviados. | \n
| 03 | \nErro | \nE-mail com mais de 50 posições. | \n
| 4/5 | \nErro | \nPagador não cadastrado. | \n