Partner API Documentation

Use your Client ID and Client Secret to authenticate requests.

Base URL

https://app.swiftlyrescue.com/api/v1

Authentication

All requests must include the following headers:

        X-CLIENT-ID: YOUR_CLIENT_ID
        X-CLIENT-SECRET: YOUR_CLIENT_SECRET
        Accept: application/json
    

Keep your credentials secure. Do not expose them publicly.

POST Book Delivery

/partner/deliveries

Request Body (JSON)

        {
        "external_reference": "ORD-1001",
        "lat_from": "6.5244",
        "long_from": "3.3792",
        "lat_to": "6.6018",
        "long_to": "3.3515",
        "sender_phone": "+2348012345678",
        "recipient_phone": "+2348098765432",
        "recipient_name": "John Doe",
        "package_type": "document",
        "delivery_type": "instant",
        "payment_type": "wallet"
        }
    

Success Response

        {
        "success": true,
        "message": "Delivery booked successfully",
        "data": {
        "confirm_code": "7824",
        "status": "pending",
        "pick_up_address": "1 Idowu Taylor St, Lagos",
        "drop_off_address": "Plot 9 Agidingbi, Lagos",
        "sender_phone": "+2348012345678",
        "recipient_phone": "+2348098765432",
        "recipient_name": "John Doe",
        "package_type": "document",
        "additional_info": null,
        "amount": 4100,
        "distance_km": 11.716
        }
        }
    

Important

The external_reference must be unique per delivery. Duplicate requests with the same external_reference will not create new deliveries.

GET Fetch Delivery

/partner/deliveries/{external_reference}

Example

GET /api/v1/partner/deliveries/ORD-1001

Response

        {
        "success": true,
        "data": {
        "confirm_code": "7824",
        "status": "pending",
        "pick_up_address": "...",
        "drop_off_address": "...",
        "amount": 4100,
        "distance_km": 11.716
        }
        }
    

Error Response Format

        {
        "success": false,
        "message": "Validation error message"
        }
    

POST Verify Delivery

/partner/deliveries/{external_reference}/verify

This endpoint confirms a previously booked delivery and deducts the delivery amount from the partner's balance.

Headers

        X-CLIENT-ID: YOUR_CLIENT_ID
        X-CLIENT-SECRET: YOUR_CLIENT_SECRET
        Accept: application/json
    

Example Request

POST /api/v1/partner/deliveries/ORD-1001/verify

Success Response

        {
        "success": true,
        "data": {
        "confirm_code": "7824",
        "status": "pending",
        "pick_up_address": "...",
        "drop_off_address": "...",
        "amount": 4100,
        "distance_km": 11.716
        }
        }
    

HTTP Status Codes

200 – Successful request
400 – Invalid request / Insufficient balance
401 – Invalid API credentials
404 – Delivery not found
422 – Validation error

Failure Response

        {
        "success": false
        }
    

If the delivery is no longer pending, verification will fail.

⚠ Verification will deduct the delivery amount from the partner's available balance.

cURL Example

        curl -X POST https://app.swiftlyrescue.com/api/v1/partner/deliveries \
        -H "X-CLIENT-ID: YOUR_CLIENT_ID" \
        -H "X-CLIENT-SECRET: YOUR_CLIENT_SECRET" \
        -H "Accept: application/json" \
        -H "Content-Type: application/json" \
        -d '{
        "external_reference": "ORD-1001",
        "lat_from": "6.5244",
        "long_from": "3.3792",
        "lat_to": "6.6018",
        "long_to": "3.3515",
        "sender_phone": "+2348012345678",
        "recipient_phone": "+2348098765432",
        "recipient_name": "John Doe",
        "package_type": "document",
        "delivery_type": "instant",
        "payment_type": "wallet"
        }'
    