Make Refund
Using this endpoint you’ll have the ability to make a refund full/partial for a specific invoice or payment.
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.
Your Supplier Code (you’ll get it after joining DashPay)
Sample: 123.
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).
The key value you have passed for the Request Transaction.
A unique number indicates the Refund request in DashPay system.
The refund reference generated by DashPay for following up with the finance team.
The InvoiceId of the refunded amount.
The amount to be refunded.
The comments that you have passed in the request.
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 | Suppliers is not valid. |
| 6 | wrong supplier code. |
| 7 | An error meessage from the bank. |