Cancel Scheduled Disburse

Cancel endpoint is used to cancel existing scheduled disbursement.

DELETE/schedule/cancel?merchantReference={merchantReference}

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
merchantReference	Required	string	Unique Identifier for a transaction.

Request Sample

Scheduled Disburse

    curl 
    -X POST "https://test-api-dbm.tlpe.io/disburse/schedule/cancel?merchantReference={{merchantReference}}" \
    -H "Content-Type: application/json" \
    -H "Authorization: {integratorToken}" \

Response Samples

201401

  {
      "timestamp": "2025-08-28T06:32:44.748",
      "status": 200,
      "message": "OK",
      "path": "/disburse/schedule/cancel",
      "data": "Schedule with Merchant Reference: {{merchantReference}} was successfully cancelled"
  }

{
  "timestamp": "2021-06-13 07:11:19 +0000",
  "status": 401,
  "error": "Unauthorized",
  "path": "/disburse/schedule/cancel"
}

Responses

201 Successful Response

Parameter	Type	Description
timestamp	string	Request timestamp.
status	string	HTTP status code.
message	string	HTTP status code message/description.
path	string	Endpoint path used for the request.
data	object	Contains request related response.

400 Erroneous Response

Disburse Money Erroneous Response Parameters!