Create ride order

Creates a ride for a metro user. - Rider details are sent in this request. There is no separate user registration API. - `webhookURL` is required. Fery saves it on the ride and uses the same URL for status and location updates. - `pickupOtp` is optional. If omitted, Fery generates a 4-digit OTP and returns it.

Authentication

x-api-keystring
API key provided by Fery for DMRC integration.

Request

This endpoint expects an object.
userobjectRequired
pickupLocationobjectRequired
dropLocationobjectRequired
paymentModestringRequired
Payment mode, e.g. prepaid or postpaid
webhookURLstringRequiredformat: "uri"
HTTPS URL for status and location webhooks. Saved on the ride.
serviceTypeenumOptionalDefaults to scooty
pickupOtpstringOptionalformat: "^[0-9]{4}$"

Optional 4-digit OTP. Generated by Fery if omitted.

couponCodestring or nullOptional
metadatamap from strings to anyOptional
Your reference data. Echoed on webhooks when present.

Response

User already has an active ride
statusCodeintegerOptional
successbooleanOptional
messagestringOptional
dataobjectOptional

Errors

400
Bad Request Error
401
Unauthorized Error
500
Internal Server Error