Pular para o conteúdo
Português - Brasil
  • Não há sugestões porque o campo de pesquisa está em branco.

API PAY

Futuramente, esta versão da API será descontinuada. Por esse motivo, recomendamos que os integradores iniciem o planejamento da migração para a nossa API V2.

 Gostaríamos de reforçar uma atualização importante em nossa API de emissão de CIOT
que entrará em vigor em 10/06/2026.

Ação Obrigatória – Alteração na estrutura de Origem e Destino
A partir de 10/06/2026, o sistema deixará de aceitar os campos:
source_*
destination_*
Para emissões de CIOT Padrão (Lotação).
Passará a ser obrigatória a utilização da estrutura routes, permitindo informar um ou mais
trechos da operação.
Exemplo:
"routes": [
{
"origin": {
"street": "Rua Ida",
"number": "137",
"city": "Arujá",
"state": "SP",
"zip_code": "07400820",
"latitude": -23.3859808,
"longitude": -46.3321207
},
"destination": {
"street": "Rua Volta",
"number": "139",
"city": "Guarulhos",
"state": "SP",
"zip_code": "07176670",
"latitude": -23.410426,
"longitude": -46.376075
},
"distance_travelled": 7
}
]
Como preencher o array routes
Sempre que houver um novo ponto de coleta, parada ou entrega, deverá ser enviada uma
nova rota contendo:
● Origem;
● Destino;
● Distância percorrida entre os pontos (distance_travelled).
Importante:
● O campo distance_travelled não pode ser enviado com valor 0.
● Deve ser enviada a distância calculada da rota.
● Caso a distância ainda não esteja disponível, não há necessidade enviar o campo.
Sem esta adequação, a emissão de CIOTs Padrão (Lotação) passará a ser rejeitada a
partir de 10/06/2026.
Reforço das alterações implementadas para
atendimento à Nova Lei do Frete Mínimo
Além da alteração de endereços, seguem os principais ajustes já disponibilizados e que
devem ser observados nas integrações:
1. Quantidade de eixos (Obrigatório)
Todos os veículos informados devem possuir o campo:
"vehicle_axle_quantity"
Exemplo:
"vehicle": [
{
"vehicle_plate": "IRI2E25",
"vehicle_category": "2",
"vehicle_axle_quantity": 3
}
]
2. Indicadores Operacionais (Obrigatório para CIOT Padrão/Lotação)
Os indicadores abaixo devem ser enviados com valor true ou false:
"operational_indicators": {
"vehicle_composition": false,
"auto_performance": false,
"empty_return": false
}
Campos:
● vehicle_composition (Composição Veicular)
● auto_performance (Alto Desempenho)
● empty_return (Retorno Vazio)
3. Tipo de Carga (Obrigatório)
Deve ser informado o campo cargo_type_code, com valores válidos de 1 a 12.
Aplicável para operações:
● Padrão (Lotação)
● Fracionado
4. Latitude e Longitude
Embora não sejam obrigatórios, recomendamos fortemente o envio dos campos de latitude
e longitude nos endereços.
Essa informação reduz significativamente ocorrências de rejeição da ANTT relacionadas a
CEPs não cadastrados ou inconsistentes.
5. Tipo de Pagamento
Passou a ser obrigatório informar a condição de pagamento quando aplicável:
"payment_condition"
Valores:
● 0 = À vista
● 1 = A prazo
6. Pertence à Frota
Campo opcional e informativo:
"is_fleet": false/true
7. Novo Tipo Operacional – Fracionado
Foi disponibilizado o novo tipo de operação:
● 2 – Fracionado: "contractor_operation_type": "2"
Para auxiliar na implementação, disponibilizamos:
Payload completo para emissão de CIOT Padrão (Lotação);
{
"contractor_operation_type": "1", // 1 = padrão/lotação, 2 = fracionado, 3 = tac
"date_departure": "26/05/2026",
"date_finish": "26/05/2026",
"routes": [ // objeto rotas há possibilidade de informar mais uma combinação de origem e
destino, igual no fracionado
{
"origin": {
"street": "Rua Ida",
"number": "137",
"complement": "Casa",
"neighborhood": "Centro Residencial",
"city": "Arujá",
"state": "SP",
"country": "Brasil",
"zip_code": "07400820",
"latitude": -23.3859808,
"longitude": -46.3321207
},
"destination": {
"street": "Rua Volta",
"number": "139",
"complement": "Casa",
"neighborhood": "Centro Residencial",
"city": "Guarulhos",
"state": "SP",
"country": "Brasil",
"zip_code": "07176670",
"latitude": -23.410426,
"longitude": -46.376075
},
"distance_travelled": 7
}
],
"hired": [
{
"hired_type": "1",
"hired_name": "KAIQUE DEPOSITO INTEGRAÇÃO PAY FMS",
"hired_doc": [
{
"hired_doc_type": "2",
"hired_doc_number": "46407864000123"
},
{
"hired_doc_type": "5",
"hired_doc_number": "54998411"
}
],
"hired_account_agency": "0001",
"hired_account_agency_digit": "1",
"hired_account_number": "180213637",
"hired_account_bank": "301",
"hired_account_type": "1"
},
{
"hired_type": "3",
"hired_name": "MOTORISTA INTEGRAÇÃO PAY FMS",
"hired_doc": [
{
"hired_doc_type": "2",
"hired_doc_number": "39606753808",
"hired_phone_number": "11949039340"
}
]
}
],
"doc_freight": [
{
"doc_freight_type": "1",
"doc_freight_number": "123456789",
"doc_freight_cubing": "300.00",
"doc_freight_commodity_value": "90.00",
"doc_freight_weight": "300.00",
"doc_freight_nature": "2617",
"fiscal_person": [
{
"fiscal_type": "2",
"fiscal_doc_type": "1",
"fiscal_doc_number": "46.010.408/0001-45",
"fiscal_name": "MIYOSHI ODONTOLOGIA LTDA",
"fiscal_address_zip_code": "07400820",
"fiscal_address": "Rua das Laranjeiras"
}
]
}
],
"load_weight": "300.00",
"load_nature": "2105",
"tax": [
{
"tax_type": "IR",
"tax_value": "1.00"
}
],
"payment_method": "2",
"parcel": [
{
"parcel_effectiveness_type": "2",
"parcel_value": "650.55",
"parcel_subtype": "1",
"parcel_status_id": "2",
"parcel_number_client": "1"
}
],
"discharge": [
{
"discharge_reservation": "2",
"discharge_place": "2",
"discharge_discount_type": "2",
"discharge_load_type": "1",
"discharge_tolerance": "10"
}
],
"cargo_type_code": 1, // tipo da carga conforme tabela antt de 1 à 12 (padrão e
fracionado)
"payment_condition": 0, // condição de pagamento quando o tipo pagamento for Deposito
em Conta (0 = a vista, 1 = a prazo)
"is_fleet": false, // frota propria
"vehicle": [
{
"vehicle_plate": "IRI2E25",
"vehicle_category": "2",
"vehicle_axle_quantity": 3 // quantidade de eixos por veiculos
}
],
"operational_indicators": { // Indicadores operacionais (obrigatório no padrão/lotação)
"vehicle_composition": false,
"auto_performance": false,
"empty_return": false
}
}
Payload completo para emissão de CIOT Fracionado;
{
"date_departure": "26/05/2026",
"date_finish": "26/05/2026",
"hired": [
{
"hired_type": "1",
"hired_name": "KAIQUE DEPOSITO INTEGRAÇÃO PAY FMS",
"hired_doc": [
{
"hired_doc_type": "2",
"hired_doc_number": "46407864000123"
},
{
"hired_doc_type": "5",
"hired_doc_number": "54998411"
}
],
"hired_account_agency": "0001",
"hired_account_agency_digit": "1",
"hired_account_number": "180213637",
"hired_account_bank": "301",
"hired_account_type": "1"
},
{
"hired_type": "3",
"hired_name": "MOTORISTA INTEGRAÇÃO PAY FMS",
"hired_doc": [
{
"hired_doc_type": "2",
"hired_doc_number": "39606753808",
"hired_phone_number": "11949039340"
}
]
}
],
"doc_freight": [
{
"doc_freight_type": "1",
"doc_freight_number": "123456789",
"doc_freight_cubing": "300.00",
"doc_freight_commodity_value": "90.00",
"doc_freight_weight": "300.00",
"doc_freight_nature": "2617",
"fiscal_person": [
{
"fiscal_type": "2",
"fiscal_doc_type": "1",
"fiscal_doc_number": "46.010.408/0001-45",
"fiscal_name": "MIYOSHI ODONTOLOGIA LTDA",
"fiscal_address_zip_code": "07400820",
"fiscal_address": "Rua das Laranjeiras"
}
]
}
],
"load_weight": "300.00",
"load_nature": "2105",
"tax": [
{
"tax_type": "IR",
"tax_value": "1.00"
}
],
"payment_method": "2",
"parcel": [
{
"parcel_effectiveness_type": "2",
"parcel_value": "650.55",
"parcel_subtype": "1",
"parcel_status_id": "2",
"parcel_number_client": "1"
}
],
"discharge": [
{
"discharge_reservation": "2",
"discharge_place": "2",
"discharge_discount_type": "2",
"discharge_load_type": "1",
"discharge_tolerance": "10"
}
],
"contractor_operation_type": "2", // 1 = padrão/lotação, 2 = fracionado, 3 = tac
"routes": [ // rotas de destinos de ponto A/B, possibilitando informar mais de uma rota
(obrigatório no padrão e fracionado)
{
"origin": {
"city": "Arujá",
"state": "SP",
"zip_code": "07400820",
"latitude": -23.3859808, // latitude somente no tipo operação Fracionado
"longitude": -46.3321207 // longitude somente no tipo operação Padrão/Lotação
},
"destination": {
"city": "Guarulhos",
"state": "SP",
"zip_code": "07095005",
"latitude": -23.410426, // latitude somente no tipo operação Fracionado
"longitude": -46.376075 // longitude somente no tipo operação Padrão/Lotação
}
}
],
"cargo_type_code": 1, // tipo da carga conforme tabela antt de 1 à 12 (padrão e
fracionado)
"payment_condition": 0, // condição de pagamento quando o tipo pagamento for Deposito
em Conta (0 = a vista, 1 = a prazo)
"is_fleet": true, // frota propria
"contractors": [ // dados dos contratantes quando o tipo CIOT for fracionado
{
"document": "42226861823",
"name": "Mikaely"
},
{
"document": "45579368810",
"name": "Kaique"
}
],
"vehicle": [
{
"vehicle_plate": "IRI2E25",
"vehicle_category": "2",
"vehicle_axle_quantity": 3 // quantidade de eixos por veiculos
}
]
}
As adequações devem estar em produção no dia 10/06 para seguirmos com as emissões
normalmente.

Aproveitamos este comunicado para compartilhar que, futuramente, esta versão da API será
descontinuada.

Por esse motivo, recomendamos que os integradores iniciem o planejamento da migração
para a nossa API V2.

Documentação da API V2:
• https://ciot.api.homolog.truckpad.io/redoc
• https://ciot.api.homolog.truckpad.io/docs

Em caso de dúvidas ou necessidade de apoio durante a adequação, nosso time está à
disposição.


Atenciosamente,
Equipe TruckPa