Skip to main content
POST
Criar corrida

Authorizations

Authorization
string
header
required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

api-key
string
header
required

Obrigatório. Sua chave API.

Body

application/json
dados_cadastro
object
required
dados_passageiro
object
required
forma_pagamento
string
required

Forma de pagamento da corrida.

partida
object
required
id_externo

Identificador externo da integração.

desejado
object
empresa
object
categoria_id
integer
categoria_nome
string
info_antes_aceite
string
info_apos_aceite
string
estimativas
boolean
ignorar_condutores_proximos
boolean
chat_ativo
boolean
default:false

Envie true para habilitar o chat da corrida. Sem ele a corrida não tem chat: os endpoints de mensagem recusam, e o condutor não vê a caixa de texto no app. Com ele, as mensagens são enviadas por POST /mensagens/corridas/passageiro e lidas por GET /mensagens/corridas/passageiro/{solicitacao_id}, e os dois lados podem escrever desde o início da corrida.

extras
object
condutor
object
paradas
object[]

Lista de paradas da corrida. Limite máximo de 1000 itens.

Maximum array length: 1000
antecedencia
integer
retorno
boolean
codigo_cupom
string

Código do cupom de desconto a ser aplicado na corrida.

Response

200 - application/json

Corrida criada com sucesso. passageiro_id e condutor_id são os identificadores que os endpoints de mensagem exigem no corpo — guarde-os na criação em vez de consultar a corrida antes de cada envio. condutor_id só aparece quando a corrida já nasce com um condutor definido. chat_ativo só aparece quando você enviou o campo na criação, e diz se a corrida ficou de fato com chat. Quando vier false, chat_ativo_motivo diz por quê: PASSAGEIRO_POSSUI_APP, quando o passageiro da corrida já usa o aplicativo e a conversa acontece por ele, ou FALHA_AO_REGISTRAR, quando não conseguimos habilitar o chat. A corrida vale nos dois casos. Os campos valor_corrida, valor_desconto e valor_cupom só vêm presentes quando a bandeira usa cálculo pré-fixo ou pré-variável (valor pré-calculado).

The response is of type object.