Skip to content

Disbursements Status

This endpoint is used to check the status of a disbursement request by its reference ID.

Endpoint

GET https://api.lipila.dev/api/v1/disbursements/check-status

Query Parameters

The following query parameter is accepted.

ParameterTypeDescriptionRequired
referenceIdstringUnique reference identifier of the disbursement transactionYes

Headers

The following header is accepted.

HeaderTypeDescriptionRequired
acceptapplication/jsonExpected response formatYes

Example Request

bash

curl -X 'GET' \
  'https://api.lipila.dev/api/v1/disbursements/check-status?referenceId=6e807106-3803-4908-8cd4-c79d0b107404' \
  -H 'accept: application/json' \
  -H 'x-api-key: your_secret_key'

Example Successful Response

Below is an example successful response.

HTTP Status CodeDescription
200Status check Successful
bash

{
  "referenceId": "046b3b664c35",
  "currency": "ZMW",
  "amount": 0.2,
  "accountNumber": "260xxxxxxxxxx",
  "status": "Successful",
  "paymentType": "ZamtelKwacha",
  "type": "Disbursement",
  "ipAddress": "::1",
  "identifier": "LPLTXNDZK-20250819104104-EF4D8905AAC1",
  "externalId": "MP251003.1252.C0324",
  "message": "Process service request successfully."
}

Error Codes

HTTP Status CodeError CodeDescription
400BAD REQUESTMissing or invalid request parameters
401UNAUTHORIZEDMissing or invalid API authentication
403FORBIDDENAccess denied to this resource
429TOO MANY REQUESTSRate limit exceeded, slow down requests

Released under the MIT License.