documentostringObligatorioCPF o CNPJ del transportista, solo dígitos. Se acepta CPF: el transportista autónomo es una persona física.
← InicioFleetPay / API
Invitar a un transportista
Parámetros, estructura de datos y respuestas del contrato versionado.
POST
/convites/transportadorasLas descripciones técnicas se traducen del contrato versionado. Se conservan los identificadores y el JSON originales; se omiten los ejemplos de datos.
Invita a una transportista a abrir una cuenta en FleetPay.
Usted no registra a la transportista: la presenta. FleetPay gestiona el registro directamente con el representante legal, quien aporta la información que solo él posee, realiza la verificación biométrica y completa la apertura de la cuenta digital. Por eso, la invitación solicita solo dos campos.
La invitación llega por WhatsApp al número indicado. A partir de ahí, FleetPay se encarga del seguimiento.
telefone es el celular del representante legal, no el teléfono comercial de la transportista: FleetPay conversará con esa persona para abrir la cuenta. Un número incorrecto impide que la invitación llegue a la persona indicada.
El documento puede ser CPF o CNPJ. El transportista persona física (autónomo) es un caso habitual y se acepta aquí.
Repetir la llamada es seguro. Si la transportista ya fue invitada, incluso por otra empresa, la respuesta es 200 con status: ja_convidada y no se envía una invitación nueva. Solo la primera invitación genera un mensaje.
Este endpoint no abre una cuenta ni habilita a nadie para recibir pagos. Inicia la conversación.
Autenticación
[
{
"oauth2": []
},
{
"chaveApi": []
}
]La disponibilidad depende del entorno, los permisos habilitados y el proveedor. Esta referencia no ejecuta solicitudes ni recibe credenciales.
Parámetros
No hay parámetros declarados para esta operación.
Cuerpo de la Solicitud
Obligatorio
application/json
telefonestringObligatorioMóvil del REPRESENTANTE LEGAL, con código de área (10 u 11 dígitos). La invitación llega a este número por WhatsApp. Se acepta con o sin código de país.
Respuestas
200 Respuesta HTTP
El transportista ya había sido invitado. No se envió una nueva invitación. No es un error: es el resultado de llamar dos veces.
201 Respuesta HTTP
Invitación enviada
401 Respuesta HTTP
Sin autenticación (autenticacao): credencial ausente, inválida o vencida, incluida una clave API utilizada en el entorno incorrecto. La clave de homologación no es válida en producción, ni la de producción en homologación; el mensaje de error indica el entorno esperado.
403 Respuesta HTTP
Ámbito no habilitado para esta credencial
429 Respuesta HTTP
Límite de solicitudes excedido (limite_requisicoes). Espera el intervalo indicado en el encabezado Retry-After antes de reintentar. Puede provenir del proveedor o del límite antiabuso de FleetPay, calculado por empresa autenticada y grupo de rutas, con una ventana corta para ráfagas y otra larga para tráfico automatizado lento. Los límites son amplios deliberadamente: las integraciones reales, incluidos lotes grandes procesados de una vez, deberían quedar muy por debajo. Si tu integración alcanza un límite, contacta con FleetPay.
Definición Completa de la Operación
{
"tags": [
"Convites"
],
"summary": "Convidar uma transportadora",
"operationId": "convidarTransportadora",
"description": "Convida uma transportadora para abrir conta na FleetPay.\n\n**Voce nao cadastra a transportadora — voce a apresenta.** O cadastro e conduzido pela\nFleetPay junto ao representante legal: e ele quem informa os dados que so ele tem, faz a\nbiometria e conclui a abertura da conta digital. Por isso o convite pede so dois campos.\n\nO convite chega por **WhatsApp** no numero informado. A partir dai o acompanhamento e da\nFleetPay.\n\n**O `telefone` e o celular do representante legal**, nao o telefone comercial da\ntransportadora — e com essa pessoa que a FleetPay vai conversar para abrir a conta. Um\nnumero errado significa um convite que nao chega a ninguem.\n\n**O documento pode ser CPF ou CNPJ.** Transportadora pessoa fisica (o transportador\nautonomo) e caso comum e e aceita aqui.\n\n**Chamar de novo e seguro.** Se a transportadora ja foi convidada — inclusive por outra\nempresa — a resposta e `200` com `status: ja_convidada`, e nenhum convite novo e enviado.\nSo o primeiro convite dispara mensagem.\n\n> Este endpoint **nao** abre conta e **nao** habilita ninguem a receber pagamento. Ele\n> inicia a conversa.\n",
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConviteTransportadoraRequest"
}
}
}
},
"responses": {
"200": {
"description": "A transportadora ja havia sido convidada. Nenhum convite novo foi enviado. Nao e erro: e o resultado de chamar duas vezes.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RespostaConvite"
}
}
}
},
"201": {
"description": "Convite enviado",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RespostaConvite"
}
}
}
},
"400": {
"$ref": "#/components/responses/Erro400"
},
"401": {
"$ref": "#/components/responses/Erro401"
},
"403": {
"$ref": "#/components/responses/Erro403"
},
"429": {
"$ref": "#/components/responses/Erro429"
},
"500": {
"$ref": "#/components/responses/Erro500"
}
},
"method": "POST",
"path": "/convites/transportadoras",
"parameters": []
}