Capitalização para o Cliente

Histórico de modificações da API

API direcionada ao cliente de produtos de Capitalização.

Cobranças do título

Cobranças do título do cliente

Experimente

Solicitar URL

Parâmetros de solicitação

string

Identificador do Cliente - CPF

integer

Identificador do título - Número do título

(opcional)
string

Atributos que deverão ser retornados

Cabeçalhos de solicitação

string

Código da Empresa

string
A chave de API atribuída a um indivíduo para acessar a API. Você pode encontrar a chave de API em sua conta.

Corpo da solicitação

Resposta 200

Success

{
                                "cobrancas": [{
                                    "parcela": 1,
                                    "dataVencimento": "2019-01-10",
                                    "status": {
                                        "sigla": "PG",
                                        "descricao": "Paga"
                                    },
                                    "formaCobranca": {
                                        "sigla": "BB",
                                        "descricao": "Boleto Bancário"
                                    },
                                    "dataPagamento": "2019-01-10",
                                    "valorPago": 1000,
                                    "valorAplicado": 900
                                }, {
                                    "parcela": 2,
                                    "dataVencimento": "2019-02-10",
                                    "status": {
                                        "sigla": "PG",
                                        "descricao": "Paga"
                                    },
                                    "formaCobranca": {
                                        "sigla": "BB",
                                        "descricao": "Boleto Bancário"
                                    },
                                    "dataPagamento": "2019-02-12",
                                    "valorPago": 1000,
                                    "valorAplicado": 900
                                }, {
                                    "parcela": 3,
                                    "dataVencimento": "2019-03-10",
                                    "status": {
                                        "sigla": "NG",
                                        "descricao": "Não Paga"
                                    },
                                    "formaCobranca": {
                                        "sigla": "BB",
                                        "descricao": "Boleto Bancário"
                                    },
                                    "dataPagamento": "",
                                    "valorPago": 0,
                                    "valorAplicado": 0
                                }]
                            }

Resposta 400

Bad Request

{
  "status": "string",
  "mensagem": "string"
}
{
  "type": "object",
  "properties": {
    "status": {
      "type": "string"
    },
    "mensagem": {
      "type": "string"
    }
  }
}

Resposta 401

Unauthorized

{
  "status": "string",
  "mensagem": "string"
}
{
  "type": "object",
  "properties": {
    "status": {
      "type": "string"
    },
    "mensagem": {
      "type": "string"
    }
  }
}

Resposta 403

Forbidden

{
  "status": "string",
  "mensagem": "string"
}
{
  "type": "object",
  "properties": {
    "status": {
      "type": "string"
    },
    "mensagem": {
      "type": "string"
    }
  }
}

Resposta 404

Not Found

{
  "status": "string",
  "mensagem": "string"
}
{
  "type": "object",
  "properties": {
    "status": {
      "type": "string"
    },
    "mensagem": {
      "type": "string"
    }
  }
}

Resposta 415

Unsupported Media Type

{
  "status": "string",
  "mensagem": "string"
}
{
  "type": "object",
  "properties": {
    "status": {
      "type": "string"
    },
    "mensagem": {
      "type": "string"
    }
  }
}

Resposta 422

Client Error

{
  "status": "string",
  "mensagem": "string"
}
{
  "type": "object",
  "properties": {
    "status": {
      "type": "string"
    },
    "mensagem": {
      "type": "string"
    }
  }
}

Resposta 500

Server Error

{
  "status": "string",
  "mensagem": "string"
}
{
  "type": "object",
  "properties": {
    "status": {
      "type": "string"
    },
    "mensagem": {
      "type": "string"
    }
  }
}

Exemplos de código

@ECHO OFF

curl -v -X GET "https://api-tst.icatuseguros.com.br/relacionamento-cliente/capitalizacao/v1/clientes/{idcliente}/titulos/{idtitulo}/cobrancas?_atributos={string}"
-H "CodigoEmpresa: "
-H "Ocp-Apim-Subscription-Key: {subscription key}"

--data-ascii "{body}" 
namespace CSHttpClientSample
{
    using System;
    using System.Net.Http.Headers;
    using System.Text;
    using System.Net.Http;
    using System.Web;

    static class Program
    {
        static void Main()
        {
            MakeRequest();
            Console.WriteLine("Hit ENTER to exit...");
            Console.ReadLine();
        }
        
        static async void MakeRequest()
        {
            var client = new HttpClient();
            var queryString = HttpUtility.ParseQueryString(string.Empty);

            // Request headers
            client.DefaultRequestHeaders.Add("CodigoEmpresa", "");
            client.DefaultRequestHeaders.Add("Ocp-Apim-Subscription-Key", "{subscription key}");

            // Request parameters
            queryString["_atributos"] = "{string}";
            var uri = "https://api-tst.icatuseguros.com.br/relacionamento-cliente/capitalizacao/v1/clientes/{idcliente}/titulos/{idtitulo}/cobrancas?" + queryString;

            var response = await client.GetAsync(uri);
        }
    }
}	
// // This sample uses the Apache HTTP client from HTTP Components (http://hc.apache.org/httpcomponents-client-ga/)
import java.net.URI;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpGet;
import org.apache.http.client.utils.URIBuilder;
import org.apache.http.impl.client.HttpClients;
import org.apache.http.util.EntityUtils;

public class JavaSample 
{
    public static void main(String[] args) 
    {
        HttpClient httpclient = HttpClients.createDefault();

        try
        {
            URIBuilder builder = new URIBuilder("https://api-tst.icatuseguros.com.br/relacionamento-cliente/capitalizacao/v1/clientes/{idcliente}/titulos/{idtitulo}/cobrancas");

            builder.setParameter("_atributos", "{string}");

            URI uri = builder.build();
            HttpGet request = new HttpGet(uri);
            request.setHeader("CodigoEmpresa", "");
            request.setHeader("Ocp-Apim-Subscription-Key", "{subscription key}");


            // Request body
            StringEntity reqEntity = new StringEntity("{body}");
            request.setEntity(reqEntity);

            HttpResponse response = httpclient.execute(request);
            HttpEntity entity = response.getEntity();

            if (entity != null) 
            {
                System.out.println(EntityUtils.toString(entity));
            }
        }
        catch (Exception e)
        {
            System.out.println(e.getMessage());
        }
    }
}

<!DOCTYPE html>
<html>
<head>
    <title>JSSample</title>
    <script src="http://ajax.googleapis.com/ajax/libs/jquery/1.9.0/jquery.min.js"></script>
</head>
<body>

<script type="text/javascript">
    $(function() {
        var params = {
            // Request parameters
            "_atributos": "{string}",
        };
      
        $.ajax({
            url: "https://api-tst.icatuseguros.com.br/relacionamento-cliente/capitalizacao/v1/clientes/{idcliente}/titulos/{idtitulo}/cobrancas?" + $.param(params),
            beforeSend: function(xhrObj){
                // Request headers
                xhrObj.setRequestHeader("CodigoEmpresa","");
                xhrObj.setRequestHeader("Ocp-Apim-Subscription-Key","{subscription key}");
            },
            type: "GET",
            // Request body
            data: "{body}",
        })
        .done(function(data) {
            alert("success");
        })
        .fail(function() {
            alert("error");
        });
    });
</script>
</body>
</html>
#import <Foundation/Foundation.h>

int main(int argc, const char * argv[])
{
    NSAutoreleasePool * pool = [[NSAutoreleasePool alloc] init];
    
    NSString* path = @"https://api-tst.icatuseguros.com.br/relacionamento-cliente/capitalizacao/v1/clientes/{idcliente}/titulos/{idtitulo}/cobrancas";
    NSArray* array = @[
                         // Request parameters
                         @"entities=true",
                         @"_atributos={string}",
                      ];
    
    NSString* string = [array componentsJoinedByString:@"&"];
    path = [path stringByAppendingFormat:@"?%@", string];

    NSLog(@"%@", path);

    NSMutableURLRequest* _request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:path]];
    [_request setHTTPMethod:@"GET"];
    // Request headers
    [_request setValue:@"" forHTTPHeaderField:@"CodigoEmpresa"];
    [_request setValue:@"{subscription key}" forHTTPHeaderField:@"Ocp-Apim-Subscription-Key"];
    // Request body
    [_request setHTTPBody:[@"{body}" dataUsingEncoding:NSUTF8StringEncoding]];
    
    NSURLResponse *response = nil;
    NSError *error = nil;
    NSData* _connectionData = [NSURLConnection sendSynchronousRequest:_request returningResponse:&response error:&error];

    if (nil != error)
    {
        NSLog(@"Error: %@", error);
    }
    else
    {
        NSError* error = nil;
        NSMutableDictionary* json = nil;
        NSString* dataString = [[NSString alloc] initWithData:_connectionData encoding:NSUTF8StringEncoding];
        NSLog(@"%@", dataString);
        
        if (nil != _connectionData)
        {
            json = [NSJSONSerialization JSONObjectWithData:_connectionData options:NSJSONReadingMutableContainers error:&error];
        }
        
        if (error || !json)
        {
            NSLog(@"Could not parse loaded json with error:%@", error);
        }
        
        NSLog(@"%@", json);
        _connectionData = nil;
    }
    
    [pool drain];

    return 0;
}
<?php
// This sample uses the Apache HTTP client from HTTP Components (http://hc.apache.org/httpcomponents-client-ga/)
require_once 'HTTP/Request2.php';

$request = new Http_Request2('https://api-tst.icatuseguros.com.br/relacionamento-cliente/capitalizacao/v1/clientes/{idcliente}/titulos/{idtitulo}/cobrancas');
$url = $request->getUrl();

$headers = array(
    // Request headers
    'CodigoEmpresa' => '',
    'Ocp-Apim-Subscription-Key' => '{subscription key}',
);

$request->setHeader($headers);

$parameters = array(
    // Request parameters
    '_atributos' => '{string}',
);

$url->setQueryVariables($parameters);

$request->setMethod(HTTP_Request2::METHOD_GET);

// Request body
$request->setBody("{body}");

try
{
    $response = $request->send();
    echo $response->getBody();
}
catch (HttpException $ex)
{
    echo $ex;
}

?>
########### Python 2.7 #############
import httplib, urllib, base64

headers = {
    # Request headers
    'CodigoEmpresa': '',
    'Ocp-Apim-Subscription-Key': '{subscription key}',
}

params = urllib.urlencode({
    # Request parameters
    '_atributos': '{string}',
})

try:
    conn = httplib.HTTPSConnection('api-tst.icatuseguros.com.br')
    conn.request("GET", "/relacionamento-cliente/capitalizacao/v1/clientes/{idcliente}/titulos/{idtitulo}/cobrancas?%s" % params, "{body}", headers)
    response = conn.getresponse()
    data = response.read()
    print(data)
    conn.close()
except Exception as e:
    print("[Errno {0}] {1}".format(e.errno, e.strerror))

####################################

########### Python 3.2 #############
import http.client, urllib.request, urllib.parse, urllib.error, base64

headers = {
    # Request headers
    'CodigoEmpresa': '',
    'Ocp-Apim-Subscription-Key': '{subscription key}',
}

params = urllib.parse.urlencode({
    # Request parameters
    '_atributos': '{string}',
})

try:
    conn = http.client.HTTPSConnection('api-tst.icatuseguros.com.br')
    conn.request("GET", "/relacionamento-cliente/capitalizacao/v1/clientes/{idcliente}/titulos/{idtitulo}/cobrancas?%s" % params, "{body}", headers)
    response = conn.getresponse()
    data = response.read()
    print(data)
    conn.close()
except Exception as e:
    print("[Errno {0}] {1}".format(e.errno, e.strerror))

####################################
require 'net/http'

uri = URI('https://api-tst.icatuseguros.com.br/relacionamento-cliente/capitalizacao/v1/clientes/{idcliente}/titulos/{idtitulo}/cobrancas')

query = URI.encode_www_form({
    # Request parameters
    '_atributos' => '{string}'
})
if query.length > 0
  if uri.query && uri.query.length > 0
    uri.query += '&' + query
  else
    uri.query = query
  end
end

request = Net::HTTP::Get.new(uri.request_uri)
# Request headers
request['CodigoEmpresa'] = ''
# Request headers
request['Ocp-Apim-Subscription-Key'] = '{subscription key}'
# Request body
request.body = "{body}"

response = Net::HTTP.start(uri.host, uri.port, :use_ssl => uri.scheme == 'https') do |http|
    http.request(request)
end

puts response.body