Query Disbursement

Through this API, a disbursement's status can be identified. After calling the Create Disbursement API, a creedo disbursement id is returned. Using this disbursement id, the Query Disbursement API can be called at anytime.

Query a disbursement transaction using the following endpoint:

Endpoint: GET https://apihit.net/api/disbursement/status/{creedo_disbursement_id}

Success Response Parameters

Property	Type	Description
gateway_status	String	"accepted"
creedo_disbursement_id	String	Creedo generated disbursement ID for this disbursement creation request. This disbursement ID can be used later to track down the disbursement and in other disbursement related APIs.
merchant_disbursement_id	String	The merchant invoice number is a unique identifier assigned to a disbursement by the merchant.
disbursement_amount	Integer	This parameter specifies the total disbursement amount specified in the create disbursement API call.
disbursement_currency	String	Currency of the mentioned amount.
disbursement_method	String	disbursement method of the mentioned order.
creation_time	String	The time when the disbursement was created. Format is "dd-mm-YYYY H:M:S p".
paid_at	String or Null	The time when the disbursement was made. The "paid_at" parameter will be provided only if the payment has been completed; otherwise, it will not be included. The format is "dd-mm-YYYY H:M:S p".
disbursement_status	String	Current status of this disbursement.

Error Response Parameters

Property	Type	Description
gateway_status	String	"rejected"
message	String	Error message here.

Success Response

A successful response will return a JSON object containing:

{
    "gateway_status": "accepted",
    "creedo_disbursement_id": "6AQ027SVVS",
    "merchant_disbursement_id": "1234",
    "disbursement_method": "EASYPAISA_P2C",
    "disbursement_currency": "PKR",
    "disbursement_amount": 550,
    "creation_time": "2024-09-03 06:53:24 PM",
    "disbursement_status": "on_queue"
  }

Error Response

In case of an error, the API will return a JSON object with error details:

{
    "gateway_status": "rejected",
    "message": "Unknown error occurred."
}