Peeap API Documentation

Build powerful integrations with Peeap's platform services — shipping, payments, point-of-sale, events, and more.

Base URL: https://api.peeap.com/api/v1

Services

Shipping API

Create deliveries, get quotes, track shipments in real-time. Integrate Peeap Shipping into any platform.

DeliveriesTrackingZonesRatesWebhooks

Checkout API

Accept payments via card, mobile money, QR codes, and NFC. Redirect or embed checkout.

Card PaymentsMobile MoneyQRNFC

USSD API

Initiate USSD payment sessions, handle callbacks, and manage session lifecycle. Works across all major mobile networks.

InitiateCallbackSessionNetworks

Payments API

Initialize, authorize, capture, and refund payments. Full payment lifecycle management.

InitializeCaptureRefundIntentsSessions

Webhooks

Receive real-time event notifications for shipping, payments, and store orders.

Shipping EventsPayment EventsSignaturesRetries

POS Terminal

Products, categories, sales, inventory management for point-of-sale systems.

ProductsCategoriesSalesInventory

Invoices API

Create, manage, and send professional invoices to your customers.

CreateUpdateSendTrack

Events API

Manage events, sell tickets, and handle ticket scanning at the door.

EventsTicketsScanningCheck-in

Payment Links

Create shareable payment links for instant checkout without a website.

CreateShareTrackEmbed

Apps & Widgets

Embeddable checkout widgets, POS terminal app, and platform integrations.

EmbedWidgetTerminalIntegration

JavaScript SDK

Client-side SDK for secure tokenization and inline checkout experiences.

TokenizeCheckoutReactCustomize

AI Assistant

AI-powered wallet assistant and developer tools for automated workflows.

AIAutomationAssistantWallet

Quick Start

1

Get your API key

Log in to your Peeap dashboard and navigate to Developer → API Keys to generate a secret API key.

2

Make your first request

Test your API key against any endpoint. All requests use the Authorization header.

curl -X GET "https://api.peeap.com/api/v1/shipping/zones" \
  -H "Authorization: Bearer sk_live_your_api_key"
3

Build your integration

Explore the services above to find the APIs you need and start building.

Response Format

All v1 API responses follow a consistent JSON envelope:

// Success
{
  "success": true,
  "data": { ... },
  "mode": "live"
}

// Paginated
{
  "success": true,
  "data": [ ... ],
  "page": 1,
  "limit": 20,
  "total": 150
}

// Error
{
  "success": false,
  "error": {
    "code": "UNAUTHORIZED",
    "message": "Invalid or missing secret API key"
  }
}

Note: Public tracking endpoints on shipping.peeap.com use a different response format and do not require authentication.