Withdrawals API

Process withdrawal requests to transfer funds from your LakiPay account to customer accounts through supported payment providers.

Overview

The Withdrawal API allows you to transfer funds from your merchant account to customer accounts. Withdrawals are processed through the same payment providers used for deposits.

Endpoint

POST /api/v2/payment/withdrawal

Authentication

X-API-Key header required

API Endpoint

Request Parameters

Parameter	Type	Required	Description
amount	decimal	Required	Withdrawal amount (e.g., 100.00)
currency	string	Required	Currency code (ETB or USD)
phone_number	string	Required	Recipient phone in E.164 format
medium	string	Required	Payment provider (MPESA, TELEBIRR, etc.)
reference	string	Required	Unique reference ID
callback_uri	string	Optional	Webhook URL for status updates

Example Request

curl -X POST https://api.lakipay.co/api/v2/payment/withdrawal \
  -H "Content-Type: application/json" \
  -H "X-API-Key: your-api-key-here" \
  -d '{
    "amount": 500.00,
    "currency": "ETB",
    "phone_number": "+251911234567",
    "medium": "MPESA",
    "reference": "WITHDRAW-12345",
    "callback_uri": "https://yourwebsite.com/webhook"
  }'

Success Response

{
  "status": "SUCCESS",
  "message": "Withdrawal initiated successfully",
  "data": {
    "transaction_id": "TXN-987654321",
    "reference": "WITHDRAW-12345",
    "amount": 500.00,
    "currency": "ETB",
    "status": "PENDING",
    "medium": "MPESA",
    "created_at": "2024-01-15T10:30:00Z"
  }
}

Supported Providers

Withdrawal Permissions

Withdrawal functionality requires special permissions. Contact support to enable withdrawals for your account. Some providers may have additional requirements or restrictions.

MPESA

Available for withdrawals

TELEBIRR

Available for withdrawals

CBE

Available for withdrawals

ETHSWITCH

Available for withdrawals

LAKIPAY

Available for withdrawals

Limits & Permissions

Minimum withdrawal amount varies by provider
Daily withdrawal limits apply based on your account tier
Withdrawals may take 1-3 business days to process
Account balance must be sufficient for withdrawal amount + fees