TripCreateRequest
A Ghana mobile number (0241234567 or +233241234567). The recipient
gets texts with the tracking link and at key moments. Check sms
in the response: queued, or off if texts aren't active.
Your business name in the texts. Letters, digits, spaces and ' & - only.
Possible values: <= 30 characters
What the courier should collect on delivery. Leave out if nothing is due.
Possible values: >= 0
GHSYour own ID for the courier. Needed for cash balances.
Possible values: <= 64 characters
Your reference, e.g. an order number. Unique per account when set.
Possible values: <= 128 characters
destination objectrequired
One end of a route — supply exactly one of hex, plus_code, gps_code, point, or profile_slug.
A GhanaPostGPS digital address, with or without dashes. It is
looked up in the GhanaPostGPS registry and the route uses the
centre of its cell. An unknown or malformed code returns
400 VALIDATION_ERROR.
GA-183-8164A full Plus Code (Open Location Code), case-insensitive. The route
uses the centre of its cell (about 14 m across for a 10-digit
code). Short codes are rejected as ambiguous; expand them first
with GET /v2/pluscode/{code}?ref=lat,lng.
6CQXJR37+F6Physical location selector, mutually exclusive with hex/point/profile_slug. Private locations require a profile grant.
Canonical gate ID; requires profile_slug or location_id and excludes entrance_type.
Reject if the approved revision changed.
Possible values: >= 1
Address-profile handle; access is checked before resolving coordinates/entrances
Optional explicit entrance for profile_slug. Otherwise defaults to truck/main gate selection, then profile point.
Possible values: [main, truck_gate, loading_dock, visitor, staff, pedestrian, compound]
AfriHex code at resolution 7
AF-GH-7-0GXTJJB0ZZZZZpoint object
Raw coordinate
-0.18675.604Device compass bearing in degrees (0 = north). On dual-carriageway roads it disambiguates which carriageway the endpoint snaps to, so routes don't begin with a phantom U-turn. Omit when unknown.
Possible values: >= 0 and <= 359
270Shown on the recipient's tracking page.
Possible values: <= 200 characters
Possible values: [motor_scooter, driving, bicycle, foot, truck]
motor_scootertrip.approaching fires when the ETA reaches this many seconds.
Possible values: >= 60 and <= 3600
300Within this distance of the destination the courier has arrived.
Possible values: >= 20 and <= 1000
100Promised arrival; trip.delayed fires if the ETA runs more than 5 minutes past it.
Possible values: >= 1 and <= 72
24Your own data (up to 4 KB). Returned to you and in webhooks; never on the tracking page.
{
"recipient_phone": "string",
"sender_name": "string",
"amount_to_collect": 0,
"currency": "GHS",
"rider_ref": "string",
"external_id": "string",
"destination": {
"gps_code": "GA-183-8164",
"plus_code": "6CQXJR37+F6",
"location_id": "string",
"entrance_id": "string",
"entrance_revision": 0,
"profile_slug": "string",
"entrance_type": "main",
"hex": "AF-GH-7-0GXTJJB0ZZZZZ",
"point": {
"lng": -0.1867,
"lat": 5.604
},
"heading": 270
},
"destination_label": "string",
"mode": "motor_scooter",
"approaching_threshold_s": 300,
"arrival_radius_m": 100,
"scheduled_arrival_at": "2024-07-29T15:51:28.071Z",
"expires_in_hours": 24,
"metadata": {}
}