Convidar uma transportadora

Parâmetros, estrutura de dados e respostas do contrato versionado.

POST/convites/transportadoras

convidarTransportadoraBase de Homologação: https://api.fleetpay.site/v1

Descrições técnicas preservadas do contrato versionado. Exemplos de dados foram omitidos da cópia pública.

Convida uma transportadora para abrir conta na FleetPay.

Voce nao cadastra a transportadora — voce a apresenta. O cadastro e conduzido pela FleetPay junto ao representante legal: e ele quem informa os dados que so ele tem, faz a biometria e conclui a abertura da conta digital. Por isso o convite pede so dois campos.

O convite chega por WhatsApp no numero informado. A partir dai o acompanhamento e da FleetPay.

O telefone e o celular do representante legal, nao o telefone comercial da transportadora — e com essa pessoa que a FleetPay vai conversar para abrir a conta. Um numero errado significa um convite que nao chega a ninguem.

O documento pode ser CPF ou CNPJ. Transportadora pessoa fisica (o transportador autonomo) e caso comum e e aceita aqui.

Chamar de novo e seguro. Se a transportadora ja foi convidada — inclusive por outra empresa — a resposta e 200 com status: ja_convidada, e nenhum convite novo e enviado. So o primeiro convite dispara mensagem.

Este endpoint nao abre conta e nao habilita ninguem a receber pagamento. Ele inicia a conversa.

Autenticação

[
  {
    "oauth2": []
  },
  {
    "chaveApi": []
  }
]

A disponibilidade depende do ambiente, dos escopos habilitados e do provedor. Esta referência não executa chamadas nem recebe credenciais.

Parâmetros

Nenhum parâmetro declarado nesta operação.

Corpo da Requisição

Obrigatório

`application/json`

ConviteTransportadoraRequest ↗

documentostringObrigatório

CPF ou CNPJ da transportadora, somente digitos. CPF e aceito — transportador autonomo e pessoa fisica.

telefonestringObrigatório

Celular do REPRESENTANTE LEGAL, com DDD (10 ou 11 digitos). E por aqui que o convite chega, por WhatsApp. Aceita com ou sem o codigo do pais.

Respostas

200 Resposta HTTP

A transportadora ja havia sido convidada. Nenhum convite novo foi enviado. Nao e erro: e o resultado de chamar duas vezes.

`application/json`

RespostaConvite ↗

dataobjectObrigatório

Convite ↗

ambienteobjectObrigatório

Ambiente ↗

201 Resposta HTTP

Convite enviado

`application/json`

RespostaConvite ↗

dataobjectObrigatório

Convite ↗

ambienteobjectObrigatório

Ambiente ↗

400 Resposta HTTP

Requisição inválida

`application/json`

Erro ↗

errorobjectOpcional

401 Resposta HTTP

Não autenticado (autenticacao): credencial ausente, inválida ou expirada — inclusive chave de API usada no ambiente errado. A chave de homologação não vale em produção, nem a de produção em homologação; a mensagem do erro indica o ambiente esperado.

`application/json`

Erro ↗

errorobjectOpcional

403 Resposta HTTP

Escopo não habilitado para esta credencial

`application/json`

Erro ↗

errorobjectOpcional

429 Resposta HTTP

Limite de requisições excedido (limite_requisicoes). Aguarde o intervalo indicado no header Retry-After antes de repetir. Pode vir do provedor, repassado, ou do teto anti-abuso da própria FleetPay — contado por empresa autenticada e por grupo de rotas, com uma janela curta que pega a rajada e uma longa que pega o robô lento. Os tetos são folgados de propósito: integração real, inclusive lote grande processado de uma vez, não chega perto deles. Se a sua chegar, fale com a FleetPay.

`application/json`

Erro ↗

errorobjectOpcional

500 Resposta HTTP

Erro interno (erro_interno)

`application/json`

Erro ↗

errorobjectOpcional

Definição Completa da Operação

{
  "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": []
}