Skip to main content
POST
/
paymentInquiry
Payment Inquiry
curl --request POST \
  --url https://dashu.sa/api/external/paymentInquiry \
  --header 'Content-Type: application/json' \
  --data '
{
  "apiKey": "<string>",
  "data": {},
  "test": true
}
'
{
  "IsSuccess": true,
  "Message": "",
  "ValidationErrors": null,
  "Data": {
    "InvoiceId": 2817877,
    "InvoiceStatus": "Paid",
    "InvoiceReference": "2023016636",
    "CustomerReference": null,
    "CreatedDate": "2023-10-04T14:40:56.723",
    "ExpiryDate": "February 1, 2024",
    "ExpiryTime": "14:40:56.723",
    "InvoiceValue": 200,
    "Comments": null,
    "CustomerName": "Anonymous",
    "CustomerMobile": "+965",
    "CustomerEmail": null,
    "UserDefinedField": null,
    "InvoiceDisplayValue": "200.000 KD",
    "DueDeposit": 104.894,
    "DepositStatus": "Not Deposited",
    "InvoiceItems": []
  }
}

Documentation Index

Fetch the complete documentation index at: https://paydocs.dashu.sa/llms.txt

Use this file to discover all available pages before exploring further.

​
Query Parameters

​
apiKey
string
required
The API Key of your account.
​
data
object
required
​
test
boolean
Set this property to true to send the request to the development environment.
{
  "IsSuccess": true,
  "Message": "",
  "ValidationErrors": null,
  "Data": {
    "InvoiceId": 2817877,
    "InvoiceStatus": "Paid",
    "InvoiceReference": "2023016636",
    "CustomerReference": null,
    "CreatedDate": "2023-10-04T14:40:56.723",
    "ExpiryDate": "February 1, 2024",
    "ExpiryTime": "14:40:56.723",
    "InvoiceValue": 200,
    "Comments": null,
    "CustomerName": "Anonymous",
    "CustomerMobile": "+965",
    "CustomerEmail": null,
    "UserDefinedField": null,
    "InvoiceDisplayValue": "200.000 KD",
    "DueDeposit": 104.894,
    "DepositStatus": "Not Deposited",
    "InvoiceItems": []
  }
}

​
Response properties

​
IsSuccess
boolean
required
The response status.
​
Message
string
required
The description of the response status.
​
ValidationErrors
array|null
required
List of validation errors (if any).
​
Data
object
required

​
Error Codes

Here’s a list of possible error codes of this endpoint.
CodeDescription
1Missing or invalid api key
2Key is a required parameter.
3KeyType is a required parameter.
4Key is invalid.
5Unknown error.
6General error occurred, please try again.