API reference

All endpoints below require an Authorization: Bearer <accessToken> header (see Authentication) and are relative to https://api.boyasa.com/api.

Nearby drivers

POST/matching/find-drivers

Find nearby available drivers/riders for a trip or delivery.

Request body

{
  "pickupLocation": { "lat": 6.5244, "lng": 3.3792 },
  "destinationLocation": { "lat": 6.4550, "lng": 3.3841 },
  "vehicleType": "BIKE",
  "orderType": "PACKAGE_DELIVERY",
  "countryId": "<country-id>",
  "customerId": "<customer-id>",
  "businessId": "<business-id>"
}

Package delivery orders

POST/packages/estimate

Get a fare estimate before creating an order.

POST/packages/create

Create a package delivery order. Requires the BUSINESS or CUSTOMER role.

Request body

{
  "orderType": "BUSINESS_TO_CUSTOMER",
  "businessId": "<business-id>",
  "packageSize": "SMALL",
  "description": "Documents",
  "fragile": false,
  "requiresSignature": true,
  "vehicleType": "BIKE",
  "pickupLat": 6.5244,
  "pickupLng": 3.3792,
  "pickupAddress": "12 Marina, Lagos Island",
  "pickupContactName": "Ada",
  "pickupContactPhone": "+2348012345678",
  "deliveryLat": 6.4550,
  "deliveryLng": 3.3841,
  "deliveryAddress": "5 Admiralty Way, Lekki",
  "deliveryContactName": "Chidi",
  "deliveryContactPhone": "+2348098765432",
  "paymentMethod": "WALLET"
}

GET/packages/my-orders

List your package orders. Supports standard filter query params.

GET/packages/:id

Get full details for a single order.

POST/packages/:id/cancel

Cancel a pending order.

Wallet

GET/wallet

Get the current user's wallet balance.

GET/wallet/transactions

Paginated wallet transaction history.

Payment links

Businesses use payment links to collect customer payment for orders that route back to the business wallet, instead of accepting payment directly.

POST/payment-links

Create a payment link. Businesses only.

Request body

{
  "amount": 5000,
  "description": "Order #1032",
  "currency": "NGN",
  "orderId": "<order-id>",
  "gatewayCode": "paystack"
}

GET/payment-links/:reference

Public endpoint — no auth required. Used by the page the customer pays from.

Looking for something not listed here (drivers, staff, commissions, reports)? The full set of endpoints is documented via Swagger at https://api.boyasa.com/api/docs once your deployment enables it.