Skip to main content

Request Payment

This api endpoint requests for a payment from a mobile money subscriber.

HTTP Request​

POST​
https://livepay.com/api/v1/deposit

Arguments​

Parameter Type Required Description
apikey string Required Account Public key. This is generated for you when you create a business account.
phone string Required Mobile money subscribers phone number from which to deduct payment. Should be internationally formatted. for-example 256701345678
amount decimal Required Amount to be deducted from mobile money subscriber’s account.
reference string Required A unique generated string to identify your request. A minimum of 8 and maximum of 36 characters is allowed.
description string Optional A description for the request.

Sample payment request​


curl "https://livepay.com/api/v1/deposit" \

   -X POST \
   -H "Content-Type: application/json" \
   -H "Authorization: Bearer <--Your API Secret Key-->" \
   -d '{
        "apikey": "Pubkey-7d9f2a-4c8e1b-6f0d3e-9a4b7c",
        "reference": "52750b30ffbc7de3b36",
        "phone": "256701345672",
        "amount": 500.00,
        "description": "Payment Request."
    }'

Sample response.​


{
    "status": "success",
    "message": "Request payment in progress.",
    "phone": "256701234567",
    "payment_method": "airtel",
    "transaction_id": "32QV4VRV70445G",
    "reference_id": "52750b30ffbc7de3b36"
}