Payment Inquiry - DashPay API Documentation

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": []
  }
}

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": []
  }
}

Query Parameters

apiKey

string

required

The API Key of your account.

data

object

required

Hide properties

Key

string

Refers to the invoice number or payment ID based on the key typeSamples: 3308076 or 100325710000064334.

KeyType

string

required

The key type should be either InvoiceId or PaymentId.

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

Hide properties

InvoiceId

integer

required

A unique integer value of the invoice.

InvoiceStatus

string

required

A string value indicates the invoice status.Expected values: Pending, Paid, or Canceled.

InvoiceReference

string

required

Invoice reference that is generated by DashPay system.

CustomerReference

string

required

The customer reference data associated with the invoice.

CreatedDate

string

required

The creation date of the invoice.

ExpiryDate

string

required

The expiry date for the invoice.

InvoiceValue

string

required

Invoice total value with the actual base account currency.

Comments

string

required

Comments that are associated with the invoice.

CustomerName

string

required

The customer name that was save along with the invoice.

CustomerMobile

string

required

Customer mobile number.

CustomerEmail

string

required

Customer email address.

UserDefinedField

string

required

The user defined filed that was stored during the invoice creation.

InvoiceDisplayValue

string

required

Invoice value that is displayed in case of different currency from the base one.

DueDeposit

number

required

The amount that will be deposited to the vendor account.

DepositStatus

string

required

The deposit status of the invoice, if it is Deposited or Not Deposited.

InvoiceItems

array

required

Invoice items as stored in the invoice creation.

Error Codes

Here’s a list of possible error codes of this endpoint.

Code	Description
1	Missing or invalid api key
2	`Key` is a required parameter.
3	`KeyType` is a required parameter.
4	`Key` is invalid.
5	Unknown error.
6	General error occurred, please try again.

executePayment Make Refund

​Query Parameters

​Response properties

​Error Codes

Query Parameters

Response properties

Error Codes