Bem vindo

Bem vindo a documentação da API Intermeio. Em caso de dúvidas, contate-nos nos canais de atendimento:

E-mail: suporte@intermeio.com
Skype: suporte@intermeio.com

A versão 3 da api, traz vários novos recursos, como:

  • Boletos em lote
  • Cartão tokenizado
  • Personalização da comunicação digital
  • Frentes personalizáveis de cobrança

Nota: Esta documentação está sendo atualizada progressivamente da versão 2.1 para 3.0

Ambientes e requisições

Com a finalidade de garantir um melhor serviço a Intermeio disponibiliza a seus clientes um ambiente de desenvolvimento. Diferentemente das versões anteriores, o [EndPoint] de desenvolvimento tem o mesmo endereço do [EndPoint] de produção.

Agora o que indica se a transação está sendo gerada em desenvolvimento ou produção, é o parametro no header da requição [Env=dev]. Veja como assinar uma transação como desenvolvimento. Ex.:

Authorization: Intermeio Base64(AppKey:[SUAAPPKEY], Signature: [SUASIGNATURE], Env:dev )
Content-Type: application/Json
Importante: Caso o Env=dev não seja informado em uma transação, automaticamente essa transação é redirecionada para produção.

Validações dos ambientes

Desenvolvimento
Gerais
- A validação de ip do requisitante é desabilitada para facilitar o desenvolvimento; - Todas as requisições devem conter em seu header o content-type: application/Json; - Todas as transações são automaticamente excluídas após 48 horas a partir da data de sua criação; - Não é possível fazer requisições via ajax para api, por baixa segurança e a exposição de dados senssíveis no browse do cliente;
Boletos

- O valor máximo para boletos em desenvolvimento é de R$ 2,99;

Produção
Gerais
- A validação de ip do requisitante é habilitada; - Todas as requisições devem conter em seu header o content-type: application/Json; - Não é possível fazer requisições via ajax para api, por baixa segurança e a exposição de dados senssíveis no browse do cliente;
Hubs Intermeio

A Intermeio disponibiliza 2 hubs para requisições api, cuja finalidade é aumentar a disponibilidade e manutenção dos canais sem prejudicar a demanda.

Recomendamos que o integrante, integre uma lógica a seus sistemas, que quando uma requisição falhar (retornar algum erro não tratado), alterne a url de [EndPoint] e efetue a mesma requisição novamente.

https://api.intermeio.com
https://api.intermeio.com.br

Token

O token de autenticação é uma chave gerada na API Intermeio permitindo que uma transação seja realizada, e tem por objetivo garantir a segurança das transações realizadas, ele também é a identificação da transação entre a API e o requisitante. Uma vez que o token for criado ele tem um prazo de validade de (1 hora) e só poderá ser utilizado para uma única transação neste período.

Nota: O token é o identificador único da transação entre a o Requisitante e a Intermeio
Importante: O token deve ser armazedo pelo requisitante para consultas futuras e confirmaconfirmações de pagamento.

Url da chamada - POST

[EndPoint]/[Versao]/Token/Gerar

Header da requisição

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

Authorization: Intermeio Base64(AppKey:[SUAAPPKEY], Signature: [SUASIGNATURE] )
Content-Type: application/Json
Parametro Tipo Obrigatório Descrição
AppKey String
Sim
Identificador do requisitante.
Signature String
Sim
Contra-chave do requisitante.
Environment String
Não
Caso o requisitante queira criar um token no ambiente de desenvolvimento ele deverá informar o parametro [Env] com o valor dev. Ex: Authorization Intermeio Base64(AppKey: [SUAAPPKEY, Signature: [SUASIGNATURE], Env:dev)
Caso tenha dúvidas de como e quando utilizar o ambiente de desenvolvimento clique aqui.

Retorno

PARAMETRO TIPO OBRIGATÓRIO DESCRIÇÃO
Requisição String
Sim
Status da resposta do servidor
Paginação String
Sim
Paginação da requisição
Resultado String
Sim
Resultado da requisção

                    
                                        using  System;
                                        using  System.Text;
                                        using  System.Net.Http;  
                                        using  System.Net.Http.Headers; 

                                        /*Exemplo POST API para gerar token
                    Nota: Os dados neste exemplo são apenas para ilustração, - 
                    deve-se substituir pelas credenciais válidas*/

                                        public class  ApiIntermeio   {
                                        public object GerarTokenApi()   {             
                                        var bytes = Encoding.UTF8.GetBytes(  
                                        "AppKey:d54fd5, Signature:sded8f8ef8e8ee8e8e8g4g4g46e6e98");  
                                        var base64 = Convert.ToBase64String(bytes);  
                                        using (var requisicao = new HttpClient() {  
                                        try   {  
                                requisicao.DefaultRequestHeaders.Accept.Clear();  
                                requisicao.DefaultRequestHeaders.Authorization  = new AuthenticationHeaderValue("Intermeio", base64);  
                                requisicao.DefaultRequestHeaders.Add("Accept", "application/json");  
                                var result = requisicao.PostAsJsonAsync([Endpoint]/Token/Gerar").Result;  
                                return result.Content.ReadAsAsync<object>().Result;  
                                                                              } 
    catch (Exception ex){  
                                return null;  
                                              }
    }  
                                                                                                                                                    }
                                                                                        }   
          
                    

Exemplo de retorno em JSON:


               
                
                 
                     {  
                                        "Token": "8709f8b5-67c2-44b8-a6a7-105a18444486",  
                                         "Codigo": 200,  
                                         "Titulo": "Transação de gerado com sucesso!",  
                                         "Descricao":   
                     }
                    

Versionamento

O versionamento funciona como um agrupador de ferramentas, garantindo a autenticidade dos métodos consumidos.

Quando a API é atualizada a versão anterior continua em funcionamento, permitindo que você escolha o momento adequado para mudar sua versão.

Você será notificado a cada nova versão disponível, e informado das alterações e novas ferramentas disponíveis, que poderão ou não requerer mudanças contratuais.

Para que uma nova versão possa ser utilizada, um novo processo de Homologação será solicitado

A versão deve ser informada na URL logo após o Endpoint do ambiente com nomenclatura V seguido pelo número da versão. Ex.:

[EndPoint]/[Versao]
Versão atual: V3

Fluxos

O token é a chave indispensável para transações, consultas e notificações de pagamentos. Seguem alguns fluxogramas para os processos:

Boleto unitário

O boleto unitário consiste em uma ferramenta para emissão de boletos de pagamento, sem parcelamento ou recorrência.

Url da chamada - POST

[EndPoint]/[Versao]/Boleto/Gerar

Header da requisição

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

Authorization: Intermeio Base64(Token:[TOKENGERADO])
Content-Type: application/Json

Objeto - Boleto Obrigatório
Parametro Tipo Obrigatório Descrição
Valor String
Sim
Identificador do requisitante.
DataVencimento String
Sim
Contra-chave do requisitante.
NumeroDocumento String
Sim
Identificador único do cliente em sistema próprio.
CONFIGURAÇÃO DE JUROS

Para configurar multa e juros na emissão do boleto, deve-se informar uma propriedade entre ([PercentualJuros] e [ValorJuros]) para Juros e/ou ([PercentualMulta] e [ValorMulta]) para Multa. Não é permitido informar porcentagem e valor para cada encargo.
PercentualJuros String
Não
Porcentagem de juros ao mes, aplicado ao valor do boleto.
Formato: "10,23". Máximo de: 40%
ValorJuros String
Não
Valor em R$ de juros ao dia, aplicado ao valor do boleto. Formato: "0023" = R$ 0,23. Os dois últimos números representam a casa decimal.
QntDiasJuros integer
Não
Quantidade de dias após o vencimento que se iniciará o cálculo dos juros.
PercentualMulta String
Não
Porcentagem de multa ao mes, aplicado ao valor do boleto.
Formato: "10,23". Máximo de: 40%
ValorMulta String
Não
Valor em R$ de multa após o vencimento do titulo, aplicado ao valor do boleto. Formato: "0023" = R$ 0,23. Os dois últimos números representam a casa decimal.
QntDiasMulta integer
Não
Quantidade de dias após o vencimento que se iniciará o cálculo da multa.
Objeto - Cliente Obrigatório
NomeRazao String
Sim
Nome do sacado.
CpfCnpj String
Sim
Cpf ou Cnpj do sacado.
Email String
Sim
E-mail válido do sacado.
Sexo String
Não
Sexo do sacado em caso de pessoa física.
DataDeNascimento String
Não
Data de nascimento do sacado no caso de pessoa física.
Celular String
Não
Número de celular do sacado.
ApelidoEndereco String
Sim
Apelido identificador para o endereço do sacado. Ex.: Casa
CEP String
Sim
Cep do endereço do sacado. É necessário informar um cep válido.
Logradouro String
Sim
Logradouro do sacado. Ex.: Av
Endereco String
Sim
Endereço do sacado.
Bairro String
Sim
Bairro do endereço sacado.
Numero String
Sim
Número do endereço do sacado.
Complemento String
Sim
Complemento do endereço do sacado.
Cidade String
Sim
Cidade do endereço do sacado.
Estado String
Sim
Estado do endereço do sacado. Ex.: SP
Parâmetros Split- Cliente OPCIONAL
NomeRazao String
Sim
Nome do sacado
CpfCnpj String
Sim
Documento do participante do split
Email String
Sim
Email do participante do split
Taxa String
Sim
Porcentagem que o cliente split deverá receber encima do valor da cobrança
Descricao String
Não
Porcentagem que o cliente split deverá receber encima do valor da cobrança
NotificarPorSms Booleano
Sim
Caso queira notificar por SMS ao participante do split sobre a quantia recebida. O SMS só será enviado caso a cobrança seja paga. As tarifas de envio serão cobradas do emissor da cobrança.
NotificarPorEmail Booleano
Sim
Caso queira notificar por e-mail ao participante do split sobre a quantia recebida. O e-mail só será enviado caso a cobrança seja paga. As tarifas de envio serão cobradas do emissor da cobrança.
Parâmetros Split- Telefones > CASO OPTE EM INFORMAR OS TELEFONES DO O PARTICIPANTE DO SPLIT
Apelido String
Sim
Apelido para o telefone informado, exemplo:(Comercial / Celular)
DDD String
Sim
DDD para o número informado
Numero String
Sim
Número do telefone
Parâmetros Split- Conta Bancária > CASO OPTE EM INFORMAR A CONTA BANCÁRIA DO PARTICIPANTE DO SPLIT
CodigoBanco String
Sim
Código do banco a que pertence a conta
Agencia String
Sim
Número da agência
DigAgencia String
Sim
Dígito da agência
Conta String
Sim
Número da conta
DigConta String
Sim
Dígito da conta
Parâmetros Split- Transferência Automática > CASO OPTE EM EFETUAR A TRANSFERÊNCIA AUTOMÁTICA PARA O PARTICIPANTE DO SPLIT
EfetuarTefAutomatica Booleano
Sim
True para habilitar a tef automática e false para desabilitar. Caso não informe esse objeto o default e FALSE
ACobrar Booleano
Sim
True para transferir a cobrança da tarifa para o participante do split e False para cobrar a tarifa do emissor.
Periodicidade Int
Sim
Indica a periodicidade tef's automáticas para o cliente participante do split. 1 - Todo 1º dia útil do mês; 2 - Todo 1º dia útil da semana; 3 - Diariamente;
ValorMinimo String
Sim
Indica valor mínimo para as tef's automáticas serem efetuadas ao participante do split
Objeto - Configuracoes Opcional
Objeto - Configuracoes > EmissaoDigital Opcional
Objeto - Configuracoes > EmissaoDigital > Sms Opcional
Celular String
Sim
Número para envio do SMS
Padrao String
Não
Formato do corpo do sms.
Msg String
Não
Mensagem personalizada pelo requisitante. Caso informe esse parametro, o parametro [Padrao] será substituido por este.
Tamanho: Máximo de 20 caracteres

Retorno

PARAMETRO TIPO OBRIGATÓRIO DESCRIÇÃO
Requisição String
Sim
Status da resposta do servidor
Paginação String
Sim
Paginação da requisição
Resultado String
Sim
Resultado da requisção

Renderização do boleto

HTML CLEAN

Para renderizar o boleto em HTML CLEAN utilize a url:

[EndPoint]/[hashBoleto]

ou

[EndPoint]/[hashSimplificado]
INTERFACE DE PAGAMENTO PERSONALIZADA

Para renderizar o boleto na INTERFACE PERSONALIZADA DE PAGAMENTO utilize a url:

[EndPoint]/Boleto/[hashBoleto]

ou

[EndPoint]/Boleto/[hashSimplificado]

NOTA: Para envio da url por e-mail e/ou sms, recomendamos o envio utilzando o [hashSimplificado] . Este hash é um redirecionador para o [hashBoleto] e tem como validade 60 dias após a emissão do boleto.


                                    /*Exemplo POST API para gerar boleto
                    Nota: Os dados neste exemplo são apenas para ilustração, - 
                    deve-se substituir pelas credenciais válidas*/

                                    // Lista de clientes do cliente split. 
                  var clientesSplit = new List<object>();
                                    // Lista de telefones do cliente split1. 
                  var telefonesClientesSplit1 = new List<object>();

                                    // Objeto telefone do cliente split1. 
                  telefonesClientesSplit1.Add(new { 
                        Apelido = "Comercial", 
                        DDD = 11, 
                        Numero = 58745623 
                    });
                                    // Objeto telefone do cliente split1. 
                  telefonesClientesSplit1.Add(new { 
                        Apelido = "Celular", 
                        DDD = 11, 
                        Numero = 986857374 
                    });
              
                                    // Objeto lista de clientes participantes do split. 
                                        Não é necessário informar o dono  

                  clientesSplit.Add(new {
                                    // Objeto cliente do split1. 
                          NomeRazao = "José Almeida",
                          CpfCnpj = "10139309000110",
                          Email = "jo@intermeio.com",
                          Taxa = 26,
                          Descricao = "Divisão de pagamentos",
                          NotificarPorSms = true,
                          NotificarPorEmail = true,
                          Telefones = telefonesClientesSplit1
                      });
              
                      clientesSplit.Add(new {
                                    // Objeto cliente do split2. 
                          NomeRazao = "Maria Souza",
                          CpfCnpj = "10139309000110",
                          Email = "ma@intermeio.com",
                          Taxa = 33,
                          Descricao = "Divisão de pagamentos",
                          NotificarPorSms = true,
                          NotificarPorEmail = true,
                          Telefones = ""
                      });
              
                                    // Objeto do POST. 
                  var objetoPost = new
                  {

                                    // Objeto boleto - OBRIGATÓRIO 
                      Boleto = new
                      {
                          Valor = "1000000",
                          DataVencimento = "06/06/2017",
                          NumeroDocumento = "102521402154",
                          PercentualJuros = "0",
                          ValorJuros = 0,
                          QntDiasJuros = 0,
                          PercentualMulta = "0",
                          ValorMulta = 0,
                          QntDiasMulta = 0
                      },

                                    // Objeto cliente(sacado) - OBRIGATÓRIO  
                      Cliente = new
                      {
                          NomeRazao = "José da Silva",
                          CpfCnpj = "45632444987",
                          Email = "jose@gmail.com",
                          Sexo = "M",
                          DataDeNascimento = "27/02/1987",
                          Celular = "11949544145",
                          ApelidoEndereco = "endereço 01",
                          CEP = "03633020",
                          Logradouro = "Rua",
                          Endereco = "Francisco Gonzales",
                          Numero = "94",
                          Bairro = "Tatuapé",
                          Complemento = "Casa",
                          Cidade = "São Paulo",
                          Estado = "SP'"
                      },

                                    // Objeto necessário caso queira configurar um split pagamentos  
                      Split = new
                      {
                                    // Lista de clientes do split. 
                          Clientes = clientesSplit,

                                    // Objeto conta bancária. 
                          ClienteContaBancaria = new
                          {
                              CodigoBanco = "001",
                              Agencia = "3652",
                              DigAgencia = "3",
                              Conta = "203654",
                              DigConta = "0"
                          },

                                    // Objeto de transferência automática. 
                          TransferenciaAutomatica = new
                          {
                              EfetuarTefAutomatica = true,
                              ACobrar = false,
                              ValorMinimo = "50000"
                          }
                      },

                                    // Objeto de configurações. 
                      Configuracoes = new
                      {
                                    // Objeto de emissão digital. 
                          EmissaoDigital = new
                          {
                              Celular = "11986857374",
                              Msg = "Presado cliente segue boleto referênte ao pagamento."
                          }
                      }
                  };

    

Exemplo de retorno em JSON:




							 
							     {  
                                        "Requisicao": "100 - Requisição efetuada com sucesso",  
                                         "Paginacao": null,  
                                         "Resultado": { 
                                         "HashBoleto":"78dbe999-0b7b-4e7b-aad3-5e52f081030b"
                                         "HashSimplificado":"d5f9wDWg"
                                         "LinhaDigitavel":" 2236 
								                . 54545 . 545454 . 9959895595959"}
								    }  
							     }
						        

Boleto em Lote

O boleto em lote, consiste em uma ferramenta para emissão de boletos de pagamento de forma massiva, sem parcelamento ou recorrência.

As regras para cada boleto contido no lote de boletos, são as mesmas do 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 é variante de acordo com a quantidade de boletos contidos no lote.

Após o processamento do lote, a Api comunicará via POST para uma url pré-configurada do cliente o resultado do processamento.

Url da chamada - POST

[EndPoint]/[Versao]/Boleto/Lote

Header da requisição

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

Authorization: Intermeio Base64(Token:[TOKENGERADO])
Content-Type: application/Json

Retorno

PARAMETRO TIPO OBRIGATÓRIO DESCRIÇÃO
Requisição String
Sim
Status da resposta do servidor
Paginação String
Sim
Paginação da requisição
Resultado String
Sim
Resultado da requisção

                                    using  System;
                                    using  System.Text;
                                    using  System.Net.Http;  
                                    using  System.Net.Http.Headers; 

                                    /*Exemplo POST API para gerar boleto
                    Nota: Os dados neste exemplo são apenas para ilustração, - 
                    deve-se substituir pelas credenciais válidas*/

                                    public class  ApiIntermeio   {
                                    public object GerarTokenApi()   {             
                                     var data = new {  
                                    // Objeto boleto - OBRIGATÓRIO 
                   Boletos[] = new { 
                   Boleto = new {  
                Valor = "1000000",  
                DataVencimento = "06/06/2017",  
                NumeroDocumento = "102521402154"
                  },  
                                    // Objeto cliente(sacado) - OBRIGATÓRIO  
                  Cliente = new {   
                    NomeRazao = "José da Silva",   
                    CpfCnpj = "45632444987",  
                    Email = "jose@gmail.com",  
                    Sexo = "M",  
                    DataDeNascimento = "27/02/1987",  
                    Celular = "11949544145",  
                    ApelidoEndereco = "endereço 01",  
                    CEP = "03633020",  
                    Logradouro = "Rua",  
                    Endereco = "Francisco Gonzales",  
                    Numero = "94",  
                    Bairro = "Tatuapé",  
                    Complemento = "Casa",  
                    Cidade = "São Paulo",  
                    Estado = "SP'" 
                  },  
  
                                    // Objeto necessário caso queira configurar um split pagamentos  
               Split = new {     
                         
                         
  
                                    // Objeto lista de clientes participantes do split. Não é necessário informar o dono  
                                    // da transação, pois ele recebe automaticamente a sobra das % do split informado  
                            Clientes[] = new  
                            // Cliente 1 do split  
                            {  
                            NomeRazao = "Split 4",    
                            CpfCnpj = "14437114116",    
                            Email = "teste1@intermeio.com",    
                            Telefone = "1125478962",    
                            ApelidoTelefone= "Celular principal",  
                            Celular = "1199999999",    
                            Taxa = 30,  
                            Descricao= "Descrição que aparacerá no dashboard do cliente participante do split",                               
                            NotificarPorSms = true,  
                            NotificarPorEmail = false,  
  
                                    // Objeto Lista de conta bancárias - Adiciona uma ou mais conta(s) bancária(s)  
                                    // ao cliente do split  
                    ClienteContaBancaria[] = new   
                                 {  
                                        CodigoBanco = "033",                               
                                        Agencia = "459",  
                                        DigAgencia = "5",  
                                        ContaCorrente = "7058069",  
                                        DigContaCorrente = "3" 
        
                                 }  
                              ]  
                                    // Informa que deverá ser feita a(s) tef(s) automáticas para os participantes  
                                    // do split  
                            TransferenciaAutomatica = new {   
                                    EfetuarTefAutomatica = true,  
                                                        ACobrar = false,  
                                                        Periodicidade = 1,  
                                                        ValorMinimo = 25000  
   
                                                   }  
        
                                         },  
                                    // fim do cliente 1  
                                    // Cliente 2                      
                           new {  
                            NomeRazao = "Split 27",    
                            CpfCnpj = "08378133524",    
                            Email = "999@intermeio.com",    
                            Telefone = null,    
                            Celular = null,    
                            Taxa = 30,  
                            Descricao = "teste 999",                               
                            NotificarPorSms = null,  
                            NotificarPorEmail = null,  
                  
                            }  
                                    // fim cliente 2  
      
             },  
  
                                    // Objetos opcionais  
                   Configuracoes = new  {   
                    EmissaoDigital = new  { 
                 
                       Celular = "11999999999",
                       Msg = "Prezado cliente, segue seu boleto para pagamento. [urlBoleto]",
                       //Padrao = "1"  
                  
                                          } 
                                        }     
            } 
        };   
                                    var bytes = Encoding.UTF8.GetBytes(  
                                    "AppKey:d54fd5, Signature:sded8f8ef8e8ee8e8e8g4g4g46e6e98");  
                                    var base64 = Convert.ToBase64String(bytes);  
                                    using (var requisicao = new HttpClient() {  
                                    try   {  
                                requisicao.DefaultRequestHeaders.Accept.Clear();  
                                requisicao.DefaultRequestHeaders.Authorization  = new AuthenticationHeaderValue("Intermeio", base64);  
                                requisicao.DefaultRequestHeaders.Add("Accept", "application/json");  
                                var result = requisicao.PostAsJsonAsync([Endpoint]/Boleto/Gerar", data).Result;  
                                return result.Content.ReadAsAsyncobject().Result;  
                                                                              } 
    catch (Exception ex){  
                                return null;  
                                              }
    }  
                                                                                                                                                    }                                                            }             
                    

Exemplo de retorno em JSON:




							 
							     {  
                                        "Requisicao": "200 - Requisição efetuada com sucesso!",  
                                         "Paginacao": null,  
                                         "Resultado": "Solicitação registrada. Aguarde o processamento e o retorno na url configurada!",  
							     }
						        

Confirmação de Pagamento

A confirmação do pagamento é realizada de forma automática, ou seja, a API se encarrega de realizar as confirmações para o requisitante.

Confirmação boleto

No caso de pagamentos com boleto, quando o pagamento é efetuado a confirmação pode levar de 1 a 2 dias uteis dependendo da instituição financeira escolhida, e é realizada atravéz de um post um link de retorno informado nas configurações da API através do Painel Merchant passando os seguintes parâmetros:

Parametro Tipo Descrição
DataLote DateTime Data de envio do lote
Login String Login para validação informado pelo requisitante nas configurações da API através do Painel Merchant.
Senha String Senha para validação informado pelo requisitante nas configurações da API através do Painel Merchant.
(Lista) de Recebiveis
Token String Token da transação
ValorTitulo Decimal Valor original da transação
ValorPago Decimal Valor pago da transação
DataVencimento DateTime Data do vencimento da transação
DataPagamento DateTime Data do pagamento da transação
DivergenciaDeValores String Indicador de diferenças entre o valor original e o valor pago. ("S" indica que há divergencia e "N" que não há)
CodTipoPagamento String Código informando a instituição do pagamento:
01 - Boleto Bradesco
DescTipoPagamento String Descrição do tipo de pagamento
NDocumento String Número de controle interno do cliente
lstDuplicidades[] String Lista de objetos receveis referentes a boletos pagos duplicados

Retorno de recebimento confirmação

Como resposta ao post a API espera um retorno de confirmação, neste caso o método deverá enviar um tipo (object) com os parâmetros

Parametro Tipo Descrição
Resultado Booleano "true" no caso de as informações terem sido recebidas e tratadas corretamente e "false" em caso de falha no recebimento ou tratamento das informações
Descricao String Descrição do erro ocorrido do lado requisitante

Exemplo de retorno em JSON:




							 
							     {  
                                        "Requisicao": "8709f8b5-67c2-44b8-a6a7-105a18444486",  
                                         "Paginacao": 200,  
                                         "Resultado": "Transação de gerado com sucesso!",  
							     }
						        

Consulta Transação

Esta ferramenta destina-se a consulta de transações unitárias. Recomendamos ao cliente integrante não utilizar deste método como o padrão para a atualização de status de pagamento em seu negócio. Opte sempre pelo método "Confirmação de Pagamento" como principal.

Url da chamada - POST

[EndPoint]/[Versao]/Transacoes/ConsultaTransacao

Header da requisição

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

Authorization: Intermeio Base64(Token:[TOKENGERADO])
Content-Type: application/Json

Parâmetros da chamada header

Parametro Tipo Obrigatório Descrição
Token de Transacao String
Sim
Token de transação recebido na autenticação

Retorno em caso de sucesso

As seguintes informações são retornadas em caso de sucesso:

PARAMETRO TIPO OBRIGATÓRIO DESCRIÇÃO
Requisição String
Sim
Status da resposta do servidor
Paginação String
Sim
Paginação da requisição
Resultado String
Sim
Resultado da requisção

DadosPagamento

PARAMETRO TIPO OBRIGATÓRIO DESCRIÇÃO
ValorCobranca String
Sim
Valor inicial da cobrança, sem juros e/ou multa
ValorPago String
Sim
Valor pago pelo sacado
DataCadastro String
Sim
Data do cadastro da cobrança
DataVencimento String
Sim
Data do vencimento da cobrança
DataPagamento String
Sim
Data em que a cobrança foi paga
TipoCobranca String
Sim
Tipo da cobrança: 1 para Boleto; 2 para TEF

                                    using  System;
                                    using  System.Text;
                                    using  System.Net.Http;  
                                    using  System.Net.Http.Headers; 

                                    /*Exemplo POST API para consultar uma transação
                    Nota: Os dados neste exemplo são apenas para ilustração, - 
                    deve-se substituir pelas credenciais válidas*/

                                    public class  ApiIntermeio   {
                                    public object ConsultaTokenApi()   {             
                                    var bytes = Encoding.UTF8.GetBytes(  
                                    "Token = 224efc32-a793-499a-b43f-2bf03a18cac0");  
                                    var base64 = Convert.ToBase64String(bytes);  
                                    using (var requisicao = new HttpClient() {  
                                    try   {  
                                requisicao.DefaultRequestHeaders.Accept.Clear();  
                                requisicao.DefaultRequestHeaders.Authorization  = new AuthenticationHeaderValue("Intermeio", base64);  
                                requisicao.DefaultRequestHeaders.Add("Accept", "application/json");  
                                var result = requisicao.PostAsJsonAsync([Endpoint]/Transacoes/ConsultaTransacao").Result;  
                                return result.Content.ReadAsAsync<object>().Result;  
                                                                              } 
    catch (Exception ex){  
                                return null;  
                                              }
    }  
                                                                                                                                                    }                                                            }   
                    

Exemplo de retorno em JSON:




							 
							     {  
                                        "Requisicao": "8709f8b5-67c2-44b8-a6a7-105a18444486",  
                                         "Paginacao": 200,  
                                         "Resultado": 
							     }