Payment Inquiry
Using this endpoint you’ll have the ability to get the complete information about a specific invoice or payment using it’s identifier (e.g: InvoiceId)
Query Parameters
The API Key of your account.
Refers to the invoice number or payment ID based on the key type
Samples: 3308076 or 100325710000064334.
The key type should be either InvoiceId or PaymentId.
Set this property to true to send the request to the development
environment.
Response properties
The response status.
The description of the response status.
List of validation errors (if any).
A unique integer value of the invoice.
A string value indicates the invoice status.
Expected values: Pending, Paid, or Canceled.
Invoice reference that is generated by DashPay system.
The customer reference data associated with the invoice.
The creation date of the invoice.
The expiry date for the invoice.
Invoice total value with the actual base account currency.
Comments that are associated with the invoice.
The customer name that was save along with the invoice.
Customer mobile number.
Customer email address.
The user defined filed that was stored during the invoice creation.
Invoice value that is displayed in case of different currency from the base one.
The amount that will be deposited to the vendor account.
The deposit status of the invoice, if it is Deposited or Not Deposited.
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. |