POST
/
makeRefund

​
Query Parameters

​
apiKey
string
required

The API Key of your account.

​
data
object
required
​
Key
string

Refers to the invoice number or payment ID based on the key type

Samples: 3308076 or 100325710000064334.

​
KeyType
string
required

The key type should be either InvoiceId or PaymentId.

​
Suppliers
array
required
​
SupplierCode
integer
required

Your Supplier Code (you’ll get it after joining DashPay)

Sample: 123.

​
test
boolean

Set this property to true to send the request to the development environment.

​
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
​
Key
string
required

The key value you have passed for the Request Transaction.

​
RefundId
integer
required

A unique number indicates the Refund request in DashPay system.

​
RefundReference
string
required

The refund reference generated by DashPay for following up with the finance team.

​
RefundInvoiceId
string
required

The InvoiceId of the refunded amount.

​
Amount
string
required

The amount to be refunded.

​
Comment
string
required

The comments that you have passed in the request.

​
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.
5Suppliers is not valid.
6wrong supplier code.
7An error meessage from the bank.
Payment InquiryGet Deposits