Bem vindo

Bem vindo a documentação da API Intermeio.

A versão 4 da API traz os seguintes novos recursos:


  • Nova forma de autenticação - Json Web Token
  • Consulta das seguintes transações
    • Boletos unitários
    • Boletos por Data
    • Boletos em Lote
  • Personalização da comunicação digital
  • Frentes personalizáveis de cobrança

Em caso de dúvidas, contate-nos nos canais de atendimento:

E-mail: suporte@intermeio.com

Skype: suporte@intermeio.com

Ambientes e requisições

Com a finalidade de garantir um melhor serviço, a Intermeio disponibiliza a seus clientes um ambiente de desenvolvimento para testes e homologação, e um ambiente de produção.

O EndPoint de desenvolvimento é diferente do EndPoint de produção.

Hubs Intermeio

A Intermeio disponibiliza 2 hubs para requisições API, com a finalidade de aumentar a disponibilidade e facilidade de manutenção dos canais sem prejudicar a oferta dos serviços.

Recomenda-se ao desenvolvedor responsável por fazer a integração, implementar uma lógica a seus sistemas de modo que, se uma requisição falhar (como, por exemplo, retornar algum erro não tratado), a URL de [EndPoint] seja alternada e a requisição seja feita novamente.

API EndPoint de Produção:

https://api.intermeiopagamentos.com

https://api.intermeiopagamentos.com.br


API EndPoint de Desenvolvimento:

https://sandbox.intermeiopagamentos.com

Validações dos ambientes


Gerais

  • Todas as requisições devem conter em seu header o Content-type: application/json.
  • Não é possível fazer requisições via AJAX para a API por motivos de baixa segurança e exposição de dados sensíveis no navegador do cliente.

Desenvolvimento

  • A validação de IP do requisitante é desabilitada para facilitar o desenvolvimento.
  • Os dados tem persistência indefinida no ambiente de Desenvolvimento (SandBox).
Importante:
O Valor máximo para boletos em desenvolvimento é de R$ 2,99.

Produção

  • A validação de IP do requisitante é habilitada.

Autenticação

A autenticação de usuários na versão 4 da API é feita utilizando o Json Web Token (JWT).

Requisição POST

URL da chamada:

[EndPoint]/Login

Nota:
O Json Web Token (JWT) é usado no header de Autenticação de todas as chamadas feitas à API-V4
Importante:
O Json Web Token (JWT) tem validade de um mês.
Após a expiração do mesmo, é necessário criar outro. Recomenda-se criar uma sub-rotina que crie outro Token caso a requisição tenha um retorno com status 401. Ou seja, caso o Token tenha expirado ou a Intermeio tenha o invalidado por quaisquer motivos

Objeto da Requisição

Parâmetro Tipo Obrigatório Descrição
UserId String Sim Identificador do usuário fazendo a requisição.
Password String Sim Senha do usuário fazendo a requisição.
                                                            {
                                                                   "UserId": "teste@provedor.com", 
                                                                   "Password": "senhaUsuarioTeste"
                                                            }
                                                            
                                                         using System;
                                                         using System.Text;
                                                         using System.Net.Http;
                                                         using System.Net.Http.Headers;
                                                         using Newtonsoft.Json;
                                                         using System.Collections.Generic;
                                                         
                                                         public class ApiIntermeio {
                                                                public dynamic GerarJsonWebToken() {
                                                               
                                                                          var jsonTokenObj = new {
                                                                              UserId = "teste@provedor.com",
                                                                              Password = "senhaUsuarioTeste"
                                                                          }
         
                                                                          using (var requisicao = new  HttpClient()) {
                                                                              var serialize = JsonConvert.SerializeObject(jsonTokenObj);
                                                                              var strContent = new StringContent(serialize, System.Text.Encoding.UTF8, "application/json");
                                                                              try {
                                                                                  requisicao.DefaultRequestHeaders.Accept.Clear(); 
                                                                                  requisicao.TryAddWithoutValidation("Content-Type", "application/json");
                                                                                  var result = requisicao.PostAsync("https://api.intermeiopagamentos.com.br/Login", strContent).Result;
                                                                                  dynamic resultado = JsonConvert.DeserializeObject(result.Content.ReadAsStringAsync().Result); 
                                                                                  return resultado;
                                                                              }
                                                                               catch (Exception ex) {
                                                                                  return ex;
                                                                              }
                                                                          }
                                                                      }
                                                   }
                                                         
                                                   

Retorno

Parâmetro Tipo Descrição
Authenticated Boolean Status de autenticação do usuário no sistema.
Created String Data de criação do Token.
Expiration String Data de validade do Token.
AccessToken String Json Web Token que será usado para fazer as requisições.
Message String Mensagem de retorno.
                                                                  {
                                                                         "authenticated": true, 
                                                                         "created": "2019-03-27 10:55:36", 
                                                                         "expiration": "2019-04-28 09:08:56", 
                                                                         "accessToken":"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VySWQiOiJiMDhmODZhZi0zNWRhLTQ4ZjItOGZhYi1jZWYzOTA0NjYwYmQifQ.-xN_h82PHVTCMA9vdoHrcZxH-x5mb11y1537t3rGzcM", 
                                                                         "message": "Usuário autenticado!"
                                                                  }
                                                                  

Transações

A API Intermeio oferece duas opções de transações para os clientes.

  • Boleto Unitário: Emissão de apenas um boleto para um sacado. Não é possível fazer parcelamento ou recorrência. A opção de Split é disponibilizada.
  • Registro de boletos em Lote: Emissão de um lote de boletos para um sacado, com limite máximo de boletos a ser combinado. A opção de Split é disponibilizada.

Ambas as formas de transação disponibilizam a opção de Split.


Importante:

Os campos ValorTitulo, PercentualJuros, ValorJuros, PercentualMulta, ValorMulta seguem o seguinte formato: "27" = "R$ 0.27" para Valores e "35" = "0.35%" para Porcentagens.
Os dois últimos digitos são as casas decimais.

Boleto Unitário

Requisição POST

URL da chamada:

[EndPoint]/Boleto

Header da Requisição

O header da requisição deverá ter o seguinte formato:

Authorization: Bearer JWT
Content-Type: Application/Json

Objeto da Requisição

Parâmetro Tipo Tamanho Obrigatório Descrição
ValorTitulo String 17 Sim Valor do título.
DataVencimento String 10 Sim Data de Vencimento maior ou igual data atual. Formato: "dd/mm/aaaa".
NumeroDocumento String 10 Sim Identificador único do cliente em sistema próprio.
PercentualJuros String 8 Não Porcentagem de juros ao mês.
ValorJuros String 17 Não Valor em R$ de juros ao dia.
QntDiasJuros Integer 3 Não O cálculo dos juros será iniciado a partir da quantidade de dias informada.
PercentualMulta String 8 Não Porcentagem de multa ao mês.
ValorMulta String 17 Não Valor em R$ de multa após o vencimento do título.
QntDiasMulta Integer 3 Não O cálculo das multas será iniciado a partir da quantidade de dias informada.
Instrucao1 String 80 Não Primeira instrução do boleto.
Instrucao2 String 80 Não Segunda instrução do boleto.
Instrucao3 String 80 Não Terceira instrução do boleto.
Instrucao4 String 80 Não Quarta instrução do boleto.
NomeSacado String 70 Sim Nome do sacado.
DocumentoSacado String 14 Sim CPF ou CNPJ do sacado.
EmailSacado String 70 Sim E-mail do sacado.
TelefoneSacado String 70 Sim Telefone do sacado.
CepLogradouro String 8 Sim CEP do endereço do sacado.
Logradouro String 40 Sim Logradouro do sacado. Ex.: "Av".
EnderecoLogradouro String 40 Sim Endereço do sacado.
BairroLogradouro String 40 Sim Bairro do endereço do sacado.
NumeroLogradouro String 10 Sim Número do endereço do sacado.
ComplementoLogradouro String 15 Sim Complemento do endereço do sacado.
CidadeLogradouro String 30 Sim Cidade do endereço do sacado.
EstadoLogradouro String 2 Sim Estado do endereço do sacado. Ex: "SP".
Split Objeto 1 Não Objeto contendo as informações do Split.

Split

Parâmetro Tipo Tamanho Obrigatório Descrição
ClientesSplit Arranjo N Sim Lista de Objetos do tipo ClienteSplit que irão participar do Split.

ClienteSplit

Parâmetro Tipo Tamanho Obrigatório Descrição
NomeRazao String 70 Sim Nome do participante do Split.
Documento String 14 Sim Documento do participante do Split.
Email String 70 Sim E-mail do participante do Split.
Celular String 12 Sim Celular do cliente participante do Split.
Porcentagem String 5 Sim Porcentagem que o cliente receberá do valor total do título.
                                                         public void GerarBoleto() {      
                                                                using (var requisicao = new HttpClient()) {
                                                                       try {
                                                                              string jsonToken = new ApiIntermeio().GerarJsonWebToken().accessToken;
                                                                              var boletoModel = MontarBoleto();

                                                                              var serialize = JsonConvert.SerializeObject(boletoModel);
                                                                              var strContent = new StringContent(serialize, System.Text.Encoding.UTF8, "application/json" )

                                                                              requisicao.DefaultRequestHeaders.Accept.Clear();
                                                                              requisicao.DefaultRequestHeaders.TryAddWithoutValidation("Authorization", $"Bearer {jsonToken}");
                                                                              var result = requisicao.PostAsync("https://api.intermeiopagamentos.com.br/Boleto/Gerar/", strContent).Result;
                                                                              dynamic resultado = JsonConvert.DeserializeObject(result.Content.ReadAsStringAsync().Result);
                                                                          }
                                                                          catch (Exception ex)
                                                                          {
                                                                          }
                                                                      }
                                                                  }
      
                                                                  private object MontarBoleto()
                                                                  {
                                                                         var ClientesSplit = new List<Object>();
      
                                                                         var clientSplit = new {
                                                                                NomeRazao = "Fabio Santos",
                                                                                Documento = "55866955867",
                                                                                Email = "teste@teste.com.br",
                                                                                Porcentagem = "16",
                                                                                Celular = "11978544862"
                                                                            }
      
                                                                            var clientSplit2 = new {
                                                                                   NomeRazao = "Fulano da Silva",
                                                                                   Documento = "14386172084",
                                                                                   Email = "Fulano@teste.com.br",
                                                                                   Porcentagem = "28",
                                                                                   Celular = "11968295485"
                                                                               }
      
                                                                               ClientesSplit.Add(clientSplit);
                                                                               ClientesSplit.Add(clientSplit2);
      
                                                                               var  Boleto = new {
                                                                                      DataVencimento = "10/10/2020",
                                                                                NumeroDocumento = "123456789",
                                                                                PercentualJuros = "0",
                                                                                PercentualMulta = "0",
                                                                                QntDiasJuros = 0,
                                                                                QntDiasMulta = 0,
                                                                                ValorTitulo = "20",
                                                                                ValorJuros = 0,
                                                                                ValorMulta = 0,
                                                                                Instrucao1 = "Instrução 1",
                                                                                Instrucao2 = "Instrução 2",
                                                                                Instrucao3 = "Instrução 3",
                                                                                Instrucao4 = "Instrução 4",
                                                                                NomeSacado = "Zezinho Juarez",
                                                                                BairroLogradouro = "Tatuape",
                                                                                TelefoneSacado = "11944445555",
                                                                                CepLogradouro = "03633020",
                                                                                CidadeLogradouro = "Sao Paulo",
                                                                                ComplementoLogradouro = "Casa",
                                                                                DocumentoSacado = "14386172084",
                                                                                EmailSacado = "jose@gmail.com",
                                                                                EnderecoLogradouro = "Francisco Gonzales",
                                                                                EstadoLogradouro = "SP",
                                                                                Logradouro = "Rua",
                                                                                NumeroLogradouro = "94",
                                                                                Split = new { ClientesSplit }
                                                                            };
      
                                                                         var boletoModel = Boleto;
                                                                         return boletoModel;
                                                                  }
      
                                                                
                                                         
                                                      
                                                              {
                                                                  "nomeSacado": "JOSÉ DAS COUVES", 
                                                                  "documentoSacado":"56999866847", 
                                                                  "logradouro": "AVENIDA",
                                                                  "enderecoLogradouro": "Paulista",
                                                                  "complementoLogradouro": "Conjunto 10",
                                                                  "bairroLogradouro": "Jardim Paulista",
                                                                  "cepLogradouro": "04045004",
                                                                  "numeroLogradouro": "1500",
                                                                  "cidadeLogradouro": "São Paulo",
                                                                  "estadoLogradouro": "SP",
                                                                  "emailSacado": "josedascouves@gmail.com", 
                                                                  "telefoneSacado":"11967654563",
                                                                  "nossoNumero": "3821738912",
                                                                  "numeroDocumento": "3721832179213",
                                                                  "dataVencimento": "10/04/2019",
                                                                  "valorTitulo": 100,
                                                                  "instrucao1": "",
                                                                  "instrucao2": "",
                                                                  "instrucao3": "",
                                                                  "instrucao4": "",
                                                                  "percentualJuros": 0.1,
                                                                  "valorJuros": 0,
                                                                  "qntDiasJuros": 3,
                                                                  "percentualMulta": 0.1,
                                                                  "valorMulta": 0,
                                                                  "qntDiasMultas": 3,
                                                                  "celular": null,
                                                                  "split": {
                                                                      "ClientesSplit": [
                                                                          {
                                                                              "NomeRazao": "Fabio Santos",
                                                                              "Documento": "14386172084",
                                                                              "Email": "teste@teste.com.br",
                                                                              "Celular": "11978556589",
                                                                              "Porcentagem": "16"
                                                                          },
                                                                          {
                                                                              "NomeRazao": "Fulano da Silva",
                                                                              "Documento": "14386172084",
                                                                              "Email": "Fulano@teste.com.br",
                                                                              "Celular": "11988587848",
                                                                              "Porcentagem": "56"
                                                                          }
                                                                      ]
                                                                  }                                                               
                                                              }
                                                         

Retorno

Parâmetro Tipo Descrição
status Boolean Status da resposta do servidor.
resultado Objeto Objeto contendo as informações do boleto emitido.

O objeto Resultado possui as informações enviadas no objeto de requisição mais as seguintes informações:

Parâmetro Tipo Descrição
nossoNumero String Código de controle do boleto no banco.
hashBoleto String Identificador único do boleto.
numeroDocumento String Número do documento.
dataPagamento String Data de quando o pagamento foi feito.
valorpago Decimal Valor do título que foi pago.
statusBoleto String Status do pagamento do boleto.
linhadigitavel String Código do boleto para fazer o pagamento.
codigoDoCodigoDeBarras String Código usado para renderizar o código de barras.
compensado String Informa se o valor do boleto pago pelo sacado já foi transferido ao cedente.
dataCompensacao String Data em que o valor do boleto foi compensado.
processado String Informa se o boleto já foi processado pela Intermeio.
                                                                  {
                                                                         "status": true, 
                                                                         "resultado": {
                                                                             "nomeSacado": "JOSÉ DAS COUVES",
                                                                             "hashBoleto": "89FCA4322-4F1F-428F-AD2F-0EA56T782B29" 
                                                                             "documentoSacado":"56999866847", 
                                                                             "logradouro": "AVENIDA",
                                                                             "enderecoLogradouro": "Paulista",
                                                                             "complementoLogradouro": "Conjunto 10",
                                                                             "bairroLogradouro": "Jardim Paulista",
                                                                             "cepLogradouro": "04045004",
                                                                             "numeroLogradouro": "1500",
                                                                             "cidadeLogradouro": "São Paulo",
                                                                             "estadoLogradouro": "SP",
                                                                             "emailSacado": "josedascouves@gmail.com", 
                                                                             "telefoneSacado":"11967654563",
                                                                             "nossoNumero": "3821738912",
                                                                             "numeroDocumento": "3721832179213,
                                                                             "dataVencimento": "10/04/2019",
                                                                             "valorBoleto": 100,
                                                                             "instrucao1": "",
                                                                             "instrucao2": "",
                                                                             "instrucao3": "",
                                                                             "instrucao4": "", 
                                                                             "dataPagamento": null, 
                                                                             "valorpago": 0,
                                                                             "statusBoleto": 0,
                                                                             "dataDaBaixa": null,
                                                                             "percentualJuros": 0.1,
                                                                             "valorJuros": 0,
                                                                             "qntDiasJuros": 3,
                                                                             "percentualMulta": 0.1,
                                                                             "valorMulta": 0,
                                                                             "qntDiasMultas": 3,
                                                                             "linhaDigitavel": "2379339225 69087000001 16000034005 1 78720000001000",
                                                                             "codigoDoCodigoDeBarras": "23799787200000010003392099087000001600003400",
                                                                             "celular": null,
                                                                             "compensado": false,
                                                                             "dataCompensacao": null,
                                                                             "processado": false,
                                                                             "split": {
                                                                                 "ClientesSplit": [
                                                                                     {
                                                                                         "NomeRazao": "Fabio Santos",
                                                                                         "Documento": "14386172084",
                                                                                         "Email": "teste@teste.com.br",
                                                                                         "Celular": "11978556589",
                                                                                         "Porcentagem": "16"
                                                                                     },
                                                                                     {
                                                                                         "NomeRazao": "Fulano da Silva",
                                                                                         "Documento": "14386172084",
                                                                                         "Email": "Fulano@teste.com.br",
                                                                                         "Celular": "11988587848",
                                                                                         "Porcentagem": "56"
                                                                                     }
                                                                                 ]
                                                                             }
                                                                         }
                                                                  }
                                                                  

Registro de boletos em Lote

As regras para cada boleto contido no lote de boletos são as mesmas para o Boleto Unitário

O prazo máximo para processamento e registro dos boletos do lote é de 24 horas, podendo ocorrer em minutos após a solicitação. Este prazo varia de acordo com a quantidade de boletos contidos no lote.

Após o processamento do lote, a API comunicará o resultado do processamento via requisição POST para uma URL pré-configurada pelo cliente.

Requisição POST

URL da chamada:

[EndPoint]/Boleto/Lote

Header da Requisição

O header da requisição deverá ter o seguinte formato:

Authorization: Bearer JWT
Content-Type: Application/Json

Objeto da Requisição

Parâmetro Tipo Obrigatório Descrição
Boletos Arranjo de Objetos Sim Arranjo de Objetos do tipo Boleto, contendo as mesmas informações que um boleto unitário contém.
ImpressaoEPostagem Boolean Sim Informa se os boletos serão impressos e enviados por correio para os sacados.
                                                         public void GerarBoletoLote() {
                                                                var jsonToken = new ApiIntermeio().GerarJsonWebToken().accessToken;
      
                                                                using (var requisicao = new HttpClient()) {
                                                                       try {
                                                                              var listaBoleto = new List<Object>();

                                                                              for(int i = 0; i < 4; i++)
                                                                                  listaBoleto.Add(MontarBoleto());

                                                                              var BoletoLote = new { Boletos = listaBoleto, ImpressaoEPostagem = true};

                                                                              var serialize = JsonConvert.SerializeObject(BoletoLote);
                                                                              var strContent = new StringContent(serialize, Encoding.UTF8, "application/json");

                                                                              requisicao.DefaultRequestHeaders.Accept.Clear();
                                                                              requisicao.DefaultRequestHeaders.TryAddWithoutValidation("Authorization", $"Bearer {jsonToken}");
                                                                              requisicao.DefaultRequestHeaders.Add("Accept", "application/json");
                                                                              dynamic resultado = JsonConvert.DeserializeObject(result.Content.ReadAsStringAsync().Result);
                                                                          }
                                                                          catch (Exception ex)
                                                                          {
                                                                          }
                                                                      }
                                                                  }
      
                                                                  private object MontarBoleto()
                                                                  {
                                                                         var ClientesSplit = new List<Object>();
      
                                                                         var clientSplit = new {
                                                                                NomeRazao = "Fabio Santos",
                                                                                Documento = "56999866847",
                                                                                Email = "teste@teste.com.br",
                                                                                Porcentagem = "16"
                                                                            }
      
                                                                            var clientSplit2 = new {
                                                                                   NomeRazao = "Fulano da Silva",
                                                                                   Documento = "14386172084",
                                                                                   Email = "Fulano@teste.com.br",
                                                                                   Porcentagem = "28"
                                                                               }
      
                                                                               ClientesSplit.Add(clientSplit);
                                                                               ClientesSplit.Add(clientSplit2);
      
                                                                               var  Boleto = new {
                                                                                      DataVencimento = "10/10/2020",
                                                                                NumeroDocumento = "123456789",
                                                                                PercentualJuros = "0",
                                                                                PercentualMulta = "0",
                                                                                QntDiasJuros = 0,
                                                                                QntDiasMulta = 0,
                                                                                ValorTitulo = "20",
                                                                                ValorJuros = 0,
                                                                                ValorMulta = 0,
                                                                                Instrucao1 = "Instrução 1",
                                                                                Instrucao2 = "Instrução 2",
                                                                                Instrucao3 = "Instrução 3",
                                                                                Instrucao4 = "Instrução 4",
                                                                                NomeSacado = "Zezinho Juarez",
                                                                                BairroLogradouro = "Tatuape",
                                                                                TelefoneSacado = "11944445555",
                                                                                CepLogradouro = "03633020",
                                                                                CidadeLogradouro = "Sao Paulo",
                                                                                ComplementoLogradouro = "Casa",
                                                                                DocumentoSacado = "14386172084",
                                                                                EmailSacado = "jose@gmail.com",
                                                                                EnderecoLogradouro = "Francisco Gonzales",
                                                                                EstadoLogradouro = "SP",
                                                                                Logradouro = "Rua",
                                                                                NumeroLogradouro = "94",
                                                                                Split = new { ClientesSplit }
                                                                            };
      
                                                                         var boletoModel = Boleto;
                                                                         return boletoModel;
                                                                  }
      
                                                                
                                                         
                                                      
                                               {
                                                    "ImpressaoEPostagem": true,
                                                    "Boletos": [
                                                        {
                                                               "nomeSacado": "JOSÉ DAS COUVES",
                                                               "hashBoleto": "89FCA4322-4F1F-428F-AD2F-0EA56T782B29",
                                                               "documentoSacado":"56999866847", 
                                                               "logradouro": "AVENIDA",
                                                               "enderecoLogradouro": "Paulista",
                                                               "complementoLogradouro": "Conjunto 10",
                                                               "bairroLogradouro": "Jardim Paulista",
                                                               "cepLogradouro": "04045004",
                                                               "numeroLogradouro": "1500",
                                                               "cidadeLogradouro": "São Paulo",
                                                               "estadoLogradouro": "SP",
                                                               "emailSacado": "josedascouves@gmail.com", 
                                                               "telefoneSacado":"11967654563",
                                                               "nossoNumero": "3821738912",
                                                               "numeroDocumento": "3721832179213",
                                                               "dataVencimento": "10/04/2019",
                                                               "valorTitulo": 100,
                                                               "instrucao1": "",
                                                               "instrucao2": "",
                                                               "instrucao3": "",
                                                               "instrucao4": "",
                                                               "percentualJuros": 0.1,
                                                               "valorJuros": 0,
                                                               "qntDiasJuros": 3,
                                                               "percentualMulta": 0.1,
                                                               "valorMulta": 0,
                                                               "qntDiasMultas": 3,
                                                               "celular": null,
                                                               "split": {
                                                                   "ClientesSplit": [
                                                                       {
                                                                           "NomeRazao": "Fabio Santos",
                                                                           "Documento": "14386172084",
                                                                           "Email": "teste@teste.com.br",
                                                                           "Celular": "11978556589",
                                                                           "Porcentagem": "16"
                                                                       },
                                                                       {
                                                                           "NomeRazao": "Fulano da Silva",
                                                                           "Documento": "14386172084",
                                                                           "Email": "Fulano@teste.com.br",
                                                                           "Celular": "11988587848",
                                                                           "Porcentagem": "56"
                                                                       }
                                                                   ]
                                                               }
                                                           },
                                                           {
                                                               "nomeSacado": "JOSÉ DAS COUVES",
                                                               "hashBoleto": "89FCA4322-4F1F-428F-AD2F-0EA56T782B29",
                                                               "documentoSacado":"56999866847", 
                                                               "logradouro": "AVENIDA",
                                                               "enderecoLogradouro": "Paulista",
                                                               "complementoLogradouro": "Conjunto 10",
                                                               "bairroLogradouro": "Jardim Paulista",
                                                               "cepLogradouro": "04045004",
                                                               "numeroLogradouro": "1500",
                                                               "cidadeLogradouro": "São Paulo",
                                                               "estadoLogradouro": "SP",
                                                               "emailSacado": "josedascouves@gmail.com", 
                                                               "telefoneSacado":"11967654563",
                                                               "nossoNumero": "3821738912",
                                                               "numeroDocumento": "3721832179213",
                                                               "dataVencimento": "10/04/2019",
                                                               "valorTitulo": 100,
                                                               "instrucao1": "",
                                                               "instrucao2": "",
                                                               "instrucao3": "",
                                                               "instrucao4": "",
                                                               "percentualJuros": 0.1,
                                                               "valorJuros": 0,
                                                               "qntDiasJuros": 3,
                                                               "percentualMulta": 0.1,
                                                               "valorMulta": 0,
                                                               "qntDiasMultas": 3,
                                                               "celular": null,
                                                               "split": {
                                                                   "ClientesSplit": [
                                                                       {
                                                                           "NomeRazao": "Fabio Santos",
                                                                           "Documento": "14386172084",
                                                                           "Email": "teste@teste.com.br",
                                                                           "Celular": "11978556589",
                                                                           "Porcentagem": "16"
                                                                       },
                                                                       {
                                                                           "NomeRazao": "Fulano da Silva",
                                                                           "Documento": "14386172084",
                                                                           "Email": "Fulano@teste.com.br",
                                                                           "Celular": "11988587848",
                                                                           "Porcentagem": "56"
                                                                       }
                                                                   ]
                                                               }
                                                           }
                                                       ]
                                               } 

                                                                
                                                         
                                                      

Retorno

Parâmetro Tipo Descrição
status Boolean Informa se o lote de boletos foi recebido pela Intermeio com sucesso.
resultado Objeto Objeto contendo o identificador do lote de Boletos recém emitido e mensagem informando o status atual do lote.

                                              {
                                                       "status": true,
                                                       "resultado": {
                                                           "id": "60a57f6b-0a6a-49fc-8b03-bdbb5c7c35b8",
                                                           "mensagem": "Lote registrado com sucesso!"
                                                       }
                                               }
                                                                           

Alteração de vencimento

A API Intermeio oferece a opção de mudar a Data de Vencimento de um lote de boletos emitido anteriormente.

Requisição POST

URL da chamada:

[EndPoint]/Lote/Vencimentos

Header da Requisição

O header da requisição deverá ter o seguinte formato:

Authorization: Bearer JWT
Content-Type: Application/Json

Objeto da Requisição

Parâmetro Tipo Obrigatório Descrição
Array[] Arranjo de Objetos Sim Arranjo de Objetos contendo o identificador boleto [hashBoleto] e a nova data de vencimento para o título. [dataVencimento].

                                                      [
                                                          {
                                                                 "hashBoleto": "89FCA4322-4F1F-428F-AD2F-0EA56T782B29",
                                                                 "dataVencimento": "15/10/2019"
                                                             },
                                                             {
                                                                 "hashBoleto": "89FCA4322-4F1F-428F-AD2F-0EA56T782B29",
                                                                 "dataVencimento": "05/11/2019"
                                                             }
                                                      ]
                                                                                              
                                             

Retorno

Parâmetro Tipo Descrição
status Boolean Informa se o lote de boletos foi recebido pela Intermeio com sucesso.
resultado Objeto Objeto contendo o identificador do lote de Boletos recém emitido e mensagem informando o status atual do lote.

                                              {
                                                       "status": true,
                                                       "resultado": {
                                                           "id": "60a57f6b-0a6a-49fc-8b03-bdbb5c7c35b8",
                                                           "mensagem": "Lote registrado com sucesso!"
                                                       }
                                               }
                                                                           

Baixa de Títulos

A API oferece um método para baixa (cancelamento) de títulos emitidos.

Requisição POST

URL da chamada:

[EndPoint]/Lote/Baixas

Header da Requisição

O header da requisição deverá ter o seguinte formato:

Authorization: Bearer JWT
Content-Type: Application/Json

Objeto da Requisição

Parâmetro Tipo Obrigatório Descrição
Array[] Arranjo de Objetos Sim Arranjo de Objetos contendo o identificador boleto [hashBoleto].
                                                [
                                                        {
                                                                    "hashBoleto": "e84aba4c-88b8-406e-8592-373ce91f30de"
                                                        },
                                                        {
                                                                "hashBoleto": "f25536bb-b5c7-47d2-9809-af660dce9726"
                                                        },
                                                        {
                                                                "hashBoleto": "d840a7ad-8358-4abc-b0cd-340ee23705f4"
                                                        }
                                                ]
                                                                                                 
                                                

Retorno

Parâmetro Tipo Descrição
status Boolean Informa se o lote de boletos foi recebido pela Intermeio com sucesso.
resultado Objeto Objeto contendo o identificador do lote de Boletos recém emitido e mensagem informando o status atual do lote.

                                                 {
                                                          "status": true,
                                                          "resultado": {
                                                              "id": "60a57f6b-0a6a-49fc-8b03-bdbb5c7c35b8",
                                                              "mensagem": "Lote registrado com sucesso!"
                                                          }
                                                  }
                                                                              

Abatimentos de Valores

Contendo o identificador do boleto (hashBoleto) é possível fazer um abatimento do valor total de um título que já foi emitido.

Requisição POST

URL da chamada:

[EndPoint]/Lote/Abatimentos

Header da Requisição

O header da requisição deverá ter o seguinte formato:

Authorization: Bearer JWT
Content-Type: Application/Json

Importante:

O campo valorAbatimento segue o seguinte formato: "27" = "R$ 0.27" para Valores e "35" = "0.35%" para Porcentagens.
Os dois últimos digitos são as casas decimais.

Objeto da Requisição

Parâmetro Tipo Obrigatório Descrição
Array[] Arranjo de Objetos Sim Arranjo de Objetos contendo o identificador boleto [hashBoleto] e o valor que deve ser abatido [valorAbatimento].
                                                   [
                                                           {
                                                                  "hashBoleto": "e84aba4c-88b8-406e-8592-373ce91f30de",
                                                                  "valorAbatimento": "1000"
                                                           },
                                                           {
                                                                   "hashBoleto": "f25536bb-b5c7-47d2-9809-af660dce9726",
                                                                   "valorAbatimento": "750"
                                                           },
                                                           {
                                                                   "hashBoleto": "d840a7ad-8358-4abc-b0cd-340ee23705f4",
                                                                   "valorAbatimento": "99"
                                                           }
                                                   ]
                                                                                                    
                                                   

Retorno

Parâmetro Tipo Descrição
status Boolean Informa se o lote de boletos foi recebido pela Intermeio com sucesso.
resultado Objeto Objeto contendo o identificador do lote de Boletos recém emitido e mensagem informando o status atual do lote.

                                                    {
                                                             "status": true,
                                                             "resultado": {
                                                                 "id": "60a57f6b-0a6a-49fc-8b03-bdbb5c7c35b8",
                                                                 "mensagem": "Lote registrado com sucesso!"
                                                             }
                                                     }
                                                                                 

Consultas

A API Intermeio oferece três opções de consulta para os clientes.

  • Consulta de Boleto Unitário por ID
  • Consulta de Boletos Unitários por intervalo de data.
  • Consulta de Boletos em Lote por ID

As três opções de consulta são feitas através de requisições GET.


Header da Requisição

O header das requisições deverão ter o seguinte formato:

Authorization: Bearer JWT
Content-Type: Application/Json

Boleto Unitário

Requisição GET

URL da chamada:

[EndPoint]/Boleto/Consulta/[Identificador]

Query String da Requisição

Parâmetro Tipo Obrigatório Descrição
Identificador String Sim Identificador único do boleto.
                                                                  public void ConsultaBoletoUnitario() {
                                                                         string jsonToken = "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VySWQiOiJiMDhmODZhZi0zNWRhLTQ4ZjItOGZhYi1jZWYzOTA0NjYwYmQifQ.-xN_h82PHVTCMA9vdoHrcZxH-x5mb11y1537t3rGzcM";
      
                                                                         string identificadorDoBoleto = "3fd85e6a-9972-4f7a-8a6a-9726862aed82";
      
                                                                         using (var requisicao = new HttpClient()) {
                                                                                requisicao.DefaultRequestHeaders.Accept.Clear();
                                                                                requisicao.DefaultRequestHeaders.Authorization = new AuthenticationHeaderValue("Bearer", jsonToken);
                                                                                requisicao.DefaultRequestHeaders.Add("Accept", "application/json");
      
                                                                                HttpResponseMessage response = await requisicao.GetAsync($"https://api.intermeiopagamentos.com.br/Boleto/Consulta/{identificadorDoBoleto}");
                                                                                HttpContent content = response.Content;
      
                                                                                var resultado = content.ReadAsAsync<Object>().Result;
                                                                            }                                                              
                                                                           }
                                                               

Retorno

Parâmetro Tipo Descrição
status Boolean Status da resposta do servidor.
resultado Objeto Objeto contendo dados do boleto consultado.

                                                                           {
                                                                                  "status": true, 
                                                                                  "resultado": {
                                                                                      "nomeSacado": "JOSÉ DAS COUVES", 
                                                                                      "documentoSacado":"56999866847", 
                                                                                      "logradouro": "AVENIDA",
                                                                                      "enderecoLogradouro": "Paulista",
                                                                                      "complementoLogradouro": "Conjunto 10",
                                                                                      "bairroLogradouro": "Jardim Paulista",
                                                                                      "cepLogradouro": "04045004",
                                                                                      "numeroLogradouro": "1500",
                                                                                      "cidadeLogradouro": "São Paulo",
                                                                                      "estadoLogradouro": "SP",
                                                                                      "emailSacado": "josedascouves@gmail.com", 
                                                                                      "telefoneSacado":"11967654563",
                                                                                      "nossoNumero": "3821738912",
                                                                                      "numeroDocumento": "3721832179213",
                                                                                      "dataVencimento": "10/04/2019",
                                                                                      "valorBoleto": 100,
                                                                                      "instrucao1": "",
                                                                                      "instrucao2": "",
                                                                                      "instrucao3": "",
                                                                                      "instrucao4": "", 
                                                                                      "dataPagamento": null, 
                                                                                      "valorpago": 0,
                                                                                      "statusBoleto": 0,
                                                                                      "dataDaBaixa": null,
                                                                                      "percentualJuros": 0.1,
                                                                                      "valorJuros": 0,
                                                                                      "qntDiasJuros": 3,
                                                                                      "percentualMulta": 0.1,
                                                                                      "valorMulta": 0,
                                                                                      "qntDiasMultas": 3,
                                                                                      "linhaDigitavel": "2379339225 69087000001 16000034005 1 78720000001000",
                                                                                      "codigoDoCodigoDeBarras": "23799787200000010003392099087000001600003400",
                                                                                      "celular": null,
                                                                                      "compensado": false,
                                                                                      "dataCompensacao": null,
                                                                                      "processado": false,
                                                                                      "split": {
                                                                                          "ClientesSplit": [
                                                                                              {
                                                                                                  "NomeRazao": "Fabio Santos",
                                                                                                  "Documento": "14386172084",
                                                                                                  "Email": "teste@teste.com.br",
                                                                                                  "Celular": "11978556589",
                                                                                                  "Porcentagem": "16"
                                                                                              },
                                                                                              {
                                                                                                  "NomeRazao": "Fulano da Silva",
                                                                                                  "Documento": "14386172084",
                                                                                                  "Email": "Fulano@teste.com.br",
                                                                                                  "Celular": "11988587848",
                                                                                                  "Porcentagem": "56"
                                                                                              }
                                                                                          ]
                                                                                      }
                                                                                  }
                                                                           }
                                                                           

Boleto por Data

Requisição GET

URL da chamada:

[EndPoint]/Boleto/Consulta?dtInicio=[dataInicio]&dtFim=[dataFim]

Query String da Requisição

Parâmetro Tipo Obrigatório Descrição
dtInicio String Sim Identificador único do boleto.
dtFim String Sim Identificador único do boleto.
pag Integer Não Página que será retornada.
qnt Integer Não Quantidade de registros por página.
                                                                     public void ConsultaBoletoData() {
                                                                            string jsonToken = "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VySWQiOiJiMDhmODZhZi0zNWRhLTQ4ZjItOGZhYi1jZWYzOTA0NjYwYmQifQ.-xN_h82PHVTCMA9vdoHrcZxH-x5mb11y1537t3rGzcM";
         
                                                                            string dtInicio = "25-03-2019";
                                                                            string dtFim = "25-04-2019";
         
                                                                            using (var requisicao = new HttpClient()) {
                                                                                   requisicao.DefaultRequestHeaders.Accept.Clear();
                                                                                   requisicao.DefaultRequestHeaders.Authorization = new AuthenticationHeaderValue("Bearer", jsonToken);
                                                                                   requisicao.DefaultRequestHeaders.Add("Accept", "application/json");
         
                                                                                   HttpResponseMessage response = await requisicao.GetAsync($"https://api.intermeiopagamentos.com.br/Boleto/Consulta?dtInicio={dtInicio}&dtFim={dtFim}");
                                                                                   HttpContent content = response.Content;
         
                                                                                   var resultado = content.ReadAsAsync<Object>().Result;
                                                                               }                                                              
                                                                              }
                                                                  

Retorno

Parâmetro Tipo Descrição
status Boolean Status da resposta do servidor.
paginacao Objeto Objeto contendo as informações da paginação.
resultado Objeto Arranjo de Objetos contendo as informações dos boletos emitidos entre a Data Início e a Data Fim.
                                                                                 {
                                                                                        "status": true,
                                                                                        "paginacao": {
                                                                                              "paginaAtual": 1,
                                                                                              "totalPaginas": 1,
                                                                                              "registrosPorPagina": 50,
                                                                                              "totalDeRegistros": 2
                                                                                          }
                                                                                        "resultado": [
                                                                          {
                                                                              "nomeSacado": "JOSÉ DAS COUVES", 
                                                                              "documentoSacado":"56999866847", 
                                                                              "logradouro": "AVENIDA",
                                                                              "enderecoLogradouro": "Paulista",
                                                                              "complementoLogradouro": "Conjunto 10",
                                                                              "bairroLogradouro": "Jardim Paulista",
                                                                              "cepLogradouro": "04045004",
                                                                              "numeroLogradouro": "1500",
                                                                              "cidadeLogradouro": "São Paulo",
                                                                              "estadoLogradouro": "SP",
                                                                              "emailSacado": "josedascouves@gmail.com", 
                                                                              "telefoneSacado":"11967654563",
                                                                              "nossoNumero": "3821738912",
                                                                              "numeroDocumento": "3721832179213",
                                                                              "dataVencimento": "10/04/2019",
                                                                              "valorBoleto": 100,
                                                                              "instrucao1": "",
                                                                              "instrucao2": "",
                                                                              "instrucao3": "",
                                                                              "instrucao4": "", 
                                                                              "dataPagamento": null, 
                                                                              "valorpago": 0,
                                                                              "statusBoleto": 0,
                                                                              "dataDaBaixa": null,
                                                                              "percentualJuros": 0.1,
                                                                              "valorJuros": 0,
                                                                              "qntDiasJuros": 3,
                                                                              "percentualMulta": 0.1,
                                                                              "valorMulta": 0,
                                                                              "qntDiasMulta": 3,
                                                                              "linhaDigitavel": "2379339225 69087000001 16000034005 1 78720000001000",
                                                                              "codigoDoCodigoDeBarras": "23799787200000010003392099087000001600003400",
                                                                              "celular": null,
                                                                              "compensado": false,
                                                                              "dataCompensacao": null,
                                                                              "processado": false,
                                                                              "split": {
                                                                                  "ClientesSplit": [
                                                                                      {
                                                                                          "NomeRazao": "Fabio Santos",
                                                                                          "Documento": "14386172084",
                                                                                          "Email": "teste@teste.com.br",
                                                                                          "Celular": "11978556589",
                                                                                          "Porcentagem": "16"
                                                                                      },
                                                                                      {
                                                                                          "NomeRazao": "Fulano da Silva",
                                                                                          "Documento": "14386172084",
                                                                                          "Email": "Fulano@teste.com.br",
                                                                                          "Celular": "11988587848",
                                                                                          "Porcentagem": "56"
                                                                                      }
                                                                                  ]
                                                                              }                                                               
                                                                          },
                                                                          {
                                                                              "nomeSacado": "JOSÉ DAS COUVES", 
                                                                              "documentoSacado":"56999866847", 
                                                                              "logradouro": "AVENIDA",
                                                                              "enderecoLogradouro": "Paulista",
                                                                              "complementoLogradouro": "Conjunto 10",
                                                                              "bairroLogradouro": "Jardim Paulista",
                                                                              "cepLogradouro": "04045004",
                                                                              "numeroLogradouro": "1500",
                                                                              "cidadeLogradouro": "São Paulo",
                                                                              "estadoLogradouro": "SP",
                                                                              "emailSacado": "josedascouves@gmail.com", 
                                                                              "telefoneSacado":"11967654563",
                                                                              "nossoNumero": "3821738912",
                                                                              "numeroDocumento": "3721832179213,
                                                                              "dataVencimento": "10/04/2019",
                                                                              "valorBoleto": 100,
                                                                              "instrucao1": "",
                                                                              "instrucao2": "",
                                                                              "instrucao3": "",
                                                                              "instrucao4": "", 
                                                                              "dataPagamento": null, 
                                                                              "valorpago": 0,
                                                                              "statusBoleto": 0,
                                                                              "dataDaBaixa": null,
                                                                              "percentualJuros": 0.1,
                                                                              "valorJuros": 0,
                                                                              "qntDiasJuros": 3,
                                                                              "percentualMulta": 0.1,
                                                                              "valorMulta": 0,
                                                                              "qntDiasMultas": 3,
                                                                              "linhaDigitavel": "2379339225 69087000001 16000034005 1 78720000001000",
                                                                              "codigoDoCodigoDeBarras": "23799787200000010003392099087000001600003400",
                                                                              "celular": null,
                                                                              "compensado": false,
                                                                              "dataCompensacao": null,
                                                                              "processado": false,
                                                                              "split": {
                                                                                  "ClientesSplit": [
                                                                                      {
                                                                                          "NomeRazao": "Fabio Santos",
                                                                                          "Documento": "14386172084",
                                                                                          "Email": "teste@teste.com.br",
                                                                                          "Celular": "11978556589",
                                                                                          "Porcentagem": "16"
                                                                                      },
                                                                                      {
                                                                                          "NomeRazao": "Fulano da Silva",
                                                                                          "Documento": "14386172084",
                                                                                          "Email": "Fulano@teste.com.br",
                                                                                          "Celular": "11988587848",
                                                                                          "Porcentagem": "56"
                                                                                      }
                                                                                  ]
                                                                              }                                                               
                                                                          }
                                                                      ]
                                                                                 }
                                                                                 

Boleto em Lote

Requisição GET

URL da chamada:

[EndPoint]/Lote/Consulta/[Identificador]

Query String da Requisição

Parâmetro Tipo Obrigatório Descrição
Identificador String Sim Identificador único do lote de boletos.
                                                                        public void ConsultaBoletoLote() {
                                                                               string jsonToken = "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VySWQiOiJiMDhmODZhZi0zNWRhLTQ4ZjItOGZhYi1jZWYzOTA0NjYwYmQifQ.-xN_h82PHVTCMA9vdoHrcZxH-x5mb11y1537t3rGzcM";
            
                                                                               string identificadorDoLote = "3051c9a5-c02b-43f4-8db8-8fab414c8704";
            
                                                                               using (var requisicao = new HttpClient()) {
                                                                                      requisicao.DefaultRequestHeaders.Accept.Clear();
                                                                                      requisicao.DefaultRequestHeaders.Authorization = new AuthenticationHeaderValue("Bearer", jsonToken);
                                                                                      requisicao.DefaultRequestHeaders.Add("Accept", "application/json");
            
                                                                                      HttpResponseMessage response = await requisicao.GetAsync($"https://api.intermeiopagamentos.com.br/Lote/Consulta/{identificadorDoLote}");
                                                                                      HttpContent content = response.Content;
            
                                                                                      var resultado = content.ReadAsAsync<Object>().Result;
                                                                                  }                                                              
                                                                                 }
                                                                     

Retorno

Parâmetro Tipo Descrição
status Boolean Status da resposta do servidor.
resultado Objeto Objeto contendo as informações do lote de boletos.

Conteúdo do objeto Resultado

Parâmetro Tipo Descrição
id String Identificador do lote de boleto.
processado Boolean false
arquivoProcessado String Url para acesso ao arquivo JSON do lote de boletos.

                                                  {
                                                         "status": true,
                                                         "resultado": {
                                                               "id": "c7473785-d99c-4f82-88d5-1c34e38e3409",
                                                               "processado": false,
                                                               "arquivoProcessado": null
                                                           }                                                                                    
                                                  }
                                             

Envio

A API Intermeio oferece duas opções de serviço de envio.

  • E-mail
  • SMS

O serviço deve ser habilitado previamente para que possa ser utilizado.





E-mail

Requisição POST

URL da chamada:

[EndPoint]/Email

Objeto da Requisição

Parâmetro Tipo Obrigatório Descrição
Destinatarios Arranjo de String Sim Lista de destinatários do E-mail.
Cc Arranjo de String Não Lista de destinatários para os quais o E-mail deve ser copiado.
Cco Arranjo de String Não Lista de destinatários para os quais o E-mail deve ser copiado de forma oculta.
Anexos Arranjo de Objetos Não Lista de objetos do tipo Anexo.
Assunto String Sim Assunto do E-mail sendo enviado.
Msg String Sim Mensagem que será enviada aos destinatários.

Objeto Anexo

Parâmetro Tipo Obrigatório Descrição
NomeArquivo String Sim Nome do arquivo contendo o anexo, com extensão.
BytesArquivo String Sim String contendo o arquivo em Bytes.
                                                   {
                                                          "Destinatarios": [
                                                              "teste1@provedor.com",
                                                              "teste2@provedor.com",
                                                              "teste3@provedor.com"
                                                          ],
                                                          "Cc": [
                                                              "teste1@intermeio.com"
                                                          ],
                                                          "Cco": [
                                                              "teste@teste1.com"
                                                          ],
                                                          "Anexos": [
                                                              {
                                                                  "NomeArquivo": "teste.pdf",
                                                                  "BytesArquivo": "JVBERi0xLjUNCiW1tbW1DQoxIDAgb2JqDQo8PC9UeXBlL0NhdGFsb2cvUGFnZXMgMiAwIFIvTGFuZyhwdC1CUikgL1N0cnVjdFRyZWVSb290IDEwIDAgUi9NYXJrSW5mbzw8L01hcmtlZCB0cnVlPj4+Pg0KZW5kb2JqDQoyIDAgb2JqDQo8PC9UeXBlL1BhZ2VzL0NvdW50IDEvS2lkc1sgMyAwIFJdID4+DQplbmRvYmoNCjMgMCBvYmoNCjw8L1R5cGUvUGFnZS9QYXJlbnQgMiAwIFIvUmVzb3VyY2VzPDwvRm9udDw8L0YxIDUgMCBSPj4vRXh0R1N0YXRlPDwvR1M3IDcgMCBSL0dTOCA4IDAgUj4+L1Byb2NTZXRbL1BERi9UZXh0L0ltYWdlQi9JbWFnZUMvSW1hZ2VJXSA+Pi9NZWRpYUJveFsgMCAwIDU5NS4zMiA4NDEuOTJdIC9Db250ZW50cyA0IDAgUi9Hcm91cDw8L1R5cGUvR3JvdXAvUy9UcmFuc3BhcmVuY3kvQ1MvRGV2aWNlUkdCPj4vVGFicy9TL1N0cnVjdFBhcmVudHMgMD4+DQplbmRvYmoNCjQgMCBvYmoNCjw8L0ZpbHRlci9GbGF0ZURlY29kZS9MZW5ndGggMjM5Pj4NCnN0cmVhbQ0KeJytkT9rw0AMxfeD+w5vtAuW76/vDkKG2GlIIdBQQ4fSKbmGDrZp4n7/2iZDQ9uhYA0SEkLvxxPyRywW+a7cVhDLJVZViQ/OBIkxvHcSAjZY0greSAoK58jZ8x1azlY1Z/m9hHIUCtRvnI3bAsNEB1ISzhgKBnUz7G2eHE6X4TROU+ev3Yazl2Tb9mmmk3gecxPfu/QV9QNn60Fhz9kMRNoWJG+IJpCrPm71sN6VwDdr5IzWBEeFhROK5L851Hwc0inSBoUNpP0PkKo7pJlKPps4lrbv0swkOMap9PHSx9k/ZJQm4f4C+s2ZL7mhibsNCmVuZHN0cmVhbQ0KZW5kb2JqDQo1IDAgb2JqDQo8PC9UeXBlL0ZvbnQvU3VidHlwZS9UcnVlVHlwZS9OYW1lL0YxL0Jhc2VGb250L0FyaWFsL0VuY29kaW5nL1dpbkFuc2lFbmNvZGluZy9Gb250RGVzY3JpcHRvciA2IDAgUi9GaXJzdENoYXIgMzIvTGFzdENoYXIgMTE3L1dpZHRocyAxOSAwIFI+Pg0KZW5kb2JqDQo2IDAgb2JqDQo8PC9UeXBlL0ZvbnREZXNjcmlwdG9yL0ZvbnROYW1lL0FyaWFsL0ZsYWdzIDMyL0l0YWxpY0FuZ2xlIDAvQXNjZW50IDkwNS9EZXNjZW50IC0yMTAvQ2FwSGVpZ2h0IDcyOC9BdmdXaWR0aCA0NDEvTWF4V2lkdGggMjY2NS9Gb250V2VpZ2h0IDQwMC9YSGVpZ2h0IDI1MC9MZWFkaW5nIDMzL1N0ZW1WIDQ0L0ZvbnRCQm94WyAtNjY1IC0yMTAgMjAwMCA3MjhdID4+DQplbmRvYmoNCjcgMCBvYmoNCjw8L1R5cGUvRXh0R1N0YXRlL0JNL05vcm1hbC9jYSAxPj4NCmVuZG9iag0KOCAwIG9iag0KPDwvVHlwZS9FeHRHU3RhdGUvQk0vTm9ybWFsL0NBIDE+Pg0KZW5kb2JqDQo5IDAgb2JqDQo8PC9BdXRob3IoU3Vwb3J0ZSBJbnRlcm1laW8pIC9DcmVhdG9yKP7/AE0AaQBjAHIAbwBzAG8AZgB0AK4AIABXAG8AcgBkACAAMgAwADEANikgL0NyZWF0aW9uRGF0ZShEOjIwMTkwNDI0MTA0ODAzLTAzJzAwJykgL01vZERhdGUoRDoyMDE5MDQyNDEwNDgwMy0wMycwMCcpIC9Qcm9kdWNlcij+/wBNAGkAYwByAG8AcwBvAGYAdACuACAAVwBvAHIAZAAgADIAMAAxADYpID4+DQplbmRvYmoNCjE2IDAgb2JqDQo8PC9UeXBlL09ialN0bS9OIDgvRmlyc3QgNTMvRmlsdGVyL0ZsYXRlRGVjb2RlL0xlbmd0aCAzMDg+Pg0Kc3RyZWFtDQp4nJVSTYvCMBC9C/6H+QeTtHb1IMKyKruIIq2wB/EQ62wttonEFPTfb6at2IML7iHJfLz3knlEDkCAHEIkQY5AigBkCDLyS0Dg61JCKHwjgGgw8A2I3oYwHuOacQJiTHCNm9uZMHG2St2soBIXWxA7wHUGNWYy6fdeoMj/U4KnFHGnKOueXsQzxzx1fYz42EHL7+A3lig2xmFsClqqM5vByl6XdN1lX7jComEj0+mu6OoWdAPZSs+9ljaOcMXbTB8eycZD9+aKCaUOP0kdyDYxc+7xly5yTclR8Qu58K69gnK50W1uXf6jfFBn38ae9saccGrSqvRvqiuXI5FrrFmq1JpO/nH0eyef5qowWaeQFPmBOtjmHg/LrCpxnmeVpXbWVVVetvy1ooe7fznf7/0C2uG+Yw0KZW5kc3RyZWFtDQplbmRvYmoNCjE5IDAgb2JqDQpbIDI3OCAwIDAgMCAwIDAgMCAwIDAgMCAwIDAgMCAwIDAgMCAwIDAgMCAwIDAgMCAwIDAgMCAwIDAgMCAwIDAgMCAwIDAgMCAwIDAgNzIyIDAgMCAwIDAgMjc4IDAgMCAwIDAgMCAwIDAgMCAwIDAgMCAwIDAgMCAwIDAgMCAwIDAgMCAwIDAgMCAwIDAgNTAwIDU1NiA1NTYgMCAwIDAgMjIyIDAgMCAwIDgzMyA1NTYgNTU2IDAgMCAzMzMgNTAwIDI3OCA1NTZdIA0KZW5kb2JqDQoyMCAwIG9iag0KPDwvVHlwZS9YUmVmL1NpemUgMjAvV1sgMSA0IDJdIC9Sb290IDEgMCBSL0luZm8gOSAwIFIvSURbPDdBODZCODNBMDUzOUY1NEM5RDAwQ0Q5RjE2QzdDRDdEPjw3QTg2QjgzQTA1MzlGNTRDOUQwMENEOUYxNkM3Q0Q3RD5dIC9GaWx0ZXIvRmxhdGVEZWNvZGUvTGVuZ3RoIDgwPj4NCnN0cmVhbQ0KeJxjYACC//8ZgaQgAwOIqoVQW8EU42EwxfQHTDHPBlMs1RBqA4R6CpQHahBgYIFQrBCKDUIxQyioEnagBtbTMB4jhGICCrInMzAAAGziCa8NCmVuZHN0cmVhbQ0KZW5kb2JqDQp4cmVmDQowIDIxDQowMDAwMDAwMDEwIDY1NTM1IGYNCjAwMDAwMDAwMTcgMDAwMDAgbg0KMDAwMDAwMDEyNSAwMDAwMCBuDQowMDAwMDAwMTgxIDAwMDAwIG4NCjAwMDAwMDA0NTEgMDAwMDAgbg0KMDAwMDAwMDc2NCAwMDAwMCBuDQowMDAwMDAwOTIzIDAwMDAwIG4NCjAwMDAwMDExNDcgMDAwMDAgbg0KMDAwMDAwMTIwMCAwMDAwMCBuDQowMDAwMDAxMjUzIDAwMDAwIG4NCjAwMDAwMDAwMTEgNjU1MzUgZg0KMDAwMDAwMDAxMiA2NTUzNSBmDQowMDAwMDAwMDEzIDY1NTM1IGYNCjAwMDAwMDAwMTQgNjU1MzUgZg0KMDAwMDAwMDAxNSA2NTUzNSBmDQowMDAwMDAwMDE2IDY1NTM1IGYNCjAwMDAwMDAwMTcgNjU1MzUgZg0KMDAwMDAwMDAxOCA2NTUzNSBmDQowMDAwMDAwMDAwIDY1NTM1IGYNCjAwMDAwMDE4OTEgMDAwMDAgbg0KMDAwMDAwMjExNCAwMDAwMCBuDQp0cmFpbGVyDQo8PC9TaXplIDIxL1Jvb3QgMSAwIFIvSW5mbyA5IDAgUi9JRFs8N0E4NkI4M0EwNTM5RjU0QzlEMDBDRDlGMTZDN0NEN0Q+PDdBODZCODNBMDUzOUY1NEM5RDAwQ0Q5RjE2QzdDRDdEPl0gPj4NCnN0YXJ0eHJlZg0KMjM5Mw0KJSVFT0YNCnhyZWYNCjAgMA0KdHJhaWxlcg0KPDwvU2l6ZSAyMS9Sb290IDEgMCBSL0luZm8gOSAwIFIvSURbPDdBODZCODNBMDUzOUY1NEM5RDAwQ0Q5RjE2QzdDRDdEPjw3QTg2QjgzQTA1MzlGNTRDOUQwMENEOUYxNkM3Q0Q3RD5dIC9QcmV2IDIzOTMvWFJlZlN0bSAyMTE0Pj4NCnN0YXJ0eHJlZg0KMjk2OA0KJSVFT0Y="
                                                              }
                                                          ],
                                                          "Assunto": "Teste email",
                                                          "Msg": "Mensagem de teste!"
                                                   }
                                                   
                                                   public void EnviaEmail() {
                                                             string jsonToken = new ApiIntermeio().GerarJsonWebToken().accessToken;
                  
                                                             using (var requisicao = new HttpClient()) {
                                                                    try {
                                                                           requisicao.DefaultRequestHeaders.Accept.Clear();
                                                                           requisicao.DefaultRequestHeaders.TryAddWithoutValidation("Authorization", $"Bearer {jsonToken}");
                  
                                                                           var Destinatarios = new List<String>();
                                                                           Destinatarios.Add("teste1@provedor.com");
                                                                           Destinatarios.Add("teste2@provedor.com");
                                                                           Destinatarios.Add("teste3@provedor.com");
                  
                                                                           var Cc = new List<String>();
                                                                           Cc.Add("teste1@intermeio.com");
                                                               
                                                                           var Cco = new List<String>();
                                                                           Cco.Add("teste2@test.com");
                                                               
                                                                           var Assunto = "Email de teste";
                  
                                                                           var Msg = "Mensagem de teste!";
                  
                                                                           var emailModel = new {
                                                                               Destinatarios = Destinatarios,
                                                                               Cc = Cc,
                                                                               Cco = Cco,
                                                                               Assunto = Assunto,
                                                                               Msg = Msg
                                                                           };

                                                                           var serialize = JsonConvert.SerializeObject(emailModel);
                                                                           var strContent = new StringContent(serialize, System.Text.Encoding.UTF8, "application/json");
                  
                                                                           var result = requisicao.PostAsync("https://api.intermeiopagamentos.com.br/Email", strContent).Result;
                                                                           dynamic resultado = JsonConvert.DeserializeObject(result.Content.ReadAsStringAsync().Result);
                                                                       } catch (Exception ex) {
                                                                       }
                                                                   }
                                                            }
                                                                           

Retorno

Parâmetro Tipo Descrição
status Boolean Informa se o email foi enviado.
resultado String Informa o resultado do envio.
                                                         {
                                                                "status": true,
                                                                "resultado": "Email enviado com sucesso"
                                                         }
                                                      

SMS Simples

Requisição POST

URL da chamada:

[EndPoint]/Sms

Objeto da Requisição

Parâmetro Tipo Obrigatório Descrição
From String Sim Identificador do remetente do SMS.
Msg String Sim Mensagem que será enviada por SMS.
Celular String Sim Número de celular do receptor do SMS.
                                                public void EnviaSMS() {
                                                          string jsonToken = new ApiIntermeio().GerarJsonWebToken().accessToken;
               
                                                          using (var requisicao = new HttpClient()) {
                                                                    try {
                                                                        requisicao.DefaultRequestHeaders.Accept.Clear();
                                                                        requisicao.TryAddWithoutValidation("Authorization", $"Bearer {jsonToken}");
               
                                                                        var Remetente =  "Intermeio";
                                                                        var Mensagem =  "Olá, mensagem de teste!";
                                                                        var CelularDestinatario =  "5511956858754";
               
                                                                        var smsModel = new {
                                                                            From = Remetente,
                                                                            Msg = Mensagem,
                                                                            Celular = CelularDestinatario
                                                                        };

                                                                        var serialize = JsonConvert.SerializeObject(smsModel);
                                                                        var strContent = new StringContent(serialize, System.Text.Encoding.UTF8, "application/json");
               
                                                                        var result = requisicao.PostAsync("https://api.intermeiopagamentos.com.br/Sms", strContent).Result;
                                                                        dynamic resultado = JsonConvert.DeserializeObject(result.Content.ReadAsAsync().Result);
                                                                    } catch (Exception ex) {
                                                                    }
                                                                }
                                                         }
                                             
                                                         {
                                                                "From": "Intermeio",
                                                                "Msg": "Testando SMS",
                                                                "Celular": "5511965688547"
                                                         }
                                                      








Retorno

Parâmetro Tipo Descrição
status Boolean Status da resposta do servidor.
resultado String Resultado do envio do SMS, se foi enviado com sucesso ou se houve algum erro.

                                                      {
                                                             "status": true,
                                                             "resultado": "SMS enviado com sucesso"
                                                      }
                                                   

Renderização

A Intermeio disponibiliza um URL onde os boletos emitidos podem ser renderizados.

Query String da Requisição

Parâmetro Tipo Obrigatório Descrição
hashBoleto GUID Sim Identificador único do boleto.