Get Disbursement Status

To get disbursement status from the disbursement facility, send the request headers and body parameters via GET.

GET/disburse/status?transactionReference={{transactionReference}}

Header Parameters

Parameter	Required?	Type	Description
Content-Type	Optional	string	Default content type of the API.
Authorization	Required	string	Unique identifier of the integrator.

Query Parameters

Parameter	Required?	Type	Description
transactionReference	Required	string	Reference of the disbursement transaction.

Request Samples

cURL

curl 
-X GET "https://test-api-dbm.tlpe.io/disburse/status?transactionReference=210613135438LDN4101" \
-H "Content-Type: application/json" \
-H "Authorization: {integratorToken}" \

Responses

200 Successful Response

Get Disbursement Details Response Parameters!

401 Erroneous Response

Get Disbursement Details Response Parameters!

Response Samples

200401

{
  "timestamp": "2021-06-14 02:33:14 +0000",
  "status": 200,
  "message": "OK",
  "path": "/disburse/status",
  "data": {
    "transactionReference": "210613135438LDN4101",
    "statusCode": "OK.00.00",
    "statusDescription": "Disbursement completed",
    "items": [
      {
        "reference": "12345678",
        "amount": "1",
        "transactionFee": "1.00",
        "status": "200",
        "statusDescription": "SUCCESS"
      }
    ]
  }
}

{
  "timestamp": "2021-06-14 03:31:03 +0000",
  "status": 401,
  "error": "Unauthorized",
  "path": "/disburse/status"
}