Skip to main content

Payouts

This is an object for you to make a payment. The request for a payment will first check if there is sufficient balance in your account and if successful, an order will be placed. The response will show that the request is in sync. A callback url is required so as to receive the final status of the order. You could also check the status of the transaction using the status object.

POST: /v1/bus/pay

Services​

  • mpesa
  • airtel
  • absa
  • equity
  • kcb
  • usdc
  • usdt

Request​

    curl -X POST \
     https://api.tupay.africa/v1/bus/pay/{service} \
     -H 'Content-Type: application/json' \
     -H 'Authorization: Bearer {token}' \
     -H 'Idempotency-Key: {key}' \
     -d '"{"account": "{account}", "amount": {amount}, "currency": {currency}}"'
Payment Request
{
    "account": "0733000000",
    "reference": "ref1234",
    "amount": 10,
    "currency": "KES",
    "name": "John",
    "phone": "254722000000",
    "number": "100100",
    "note": "Paying John"
}
  • account (String): The account e.g. phone number
  • amount (Double): The amount required
  • currency (String): The currency code
  • reference (String): Your unique id *optional
  • name (String): The customer first name *optional
  • phone (String): The customer phone *optional
  • number (String): The paybill or till number *optional
  • note (String): Add a note *optional

Response​

Payment Response
{
    "id": "ABCDEFG250101",
    "reference": "ref1234",
    "status": 0,
    "mesasge": "Pending"
}
  • id (String): The transaction id (Optional incase of failure)
  • reference (String): Your unique id
  • status (Integer): The status of the request
  • message (String): The response message