post https://sandboxapi.upayments.com/api/v1/create-refund
Single refund from order id
KNET refunds are done within 4 hours of refund initiation
CC refunds are done within 2-3 business days.
Refunds can be deleted (cancelled) if they have been initiated and not "refunded".
Once refunded, the refund request cannot be cancelled
Refunds are possible only if there is sufficient 'Balance' in your UPayments account
If 'Balance' is insufficient in your UPay account, you can top up your balance to process the refunds successfully
The top-up amount will be used for refund purposes only, and the remaining amount, if any, will be returned to the account within the next Deposit cycle.
The refund will automatically reach your customer's account within 1 working day for K-NET transactions and up to 10 working days
| Input Parameter | Type | Length | Description |
|---|---|---|---|
| orderId | string,mandatory | 255 | Pass refund order ID which is received in Get Payment Status API. |
| totalPrice | float, mandatory | 10,2 | Enter refund amount |
| customerFirstName | string, optional | 255 | Pass customer first name |
| customerEmail | string, optional | 250 | Pass customer email |
| customerMobileNumber | string, optional | 10 | Pass customer mobile number |
| reference | string, optional | 255 | Pass order reference |
| notifyUrl | string, optional | 255 | Pass notification URL |
Request Model
{
"orderId": "mv1GZnrG2l20221010125525514466916867376022022026038648992c2755f2",
"totalPrice": 10,
"customerFirstName": "Jhon",
"customerEmail": "[email protected]",
"customerMobileNumber": "+96512345678",
"reference": "11223344",
"notifyUrl": "https://upayments.com/en"
}
Response Model
{
"status": true,
"message": "Refund invoice generated successfully",
"data": {
"orderId": "k4eJmnNR8pME3OdxVO6m202210101255255144669168674086486939107564899f80070d8HsUDgrRtCbzbuJFTdH9QyMLNkgaFcKMU",
"refundOrderId": "HsUDgrRtCbzbuJFTdH9QyMLNkgaFcKMU",
"refundArn": "202311074314067023726014116806"
}
}
{
"status": true,
"message": "success",
"data": {
"orderId": "x9qgyobGKN2022101012552551446691695107275189570586650948cbbbbb0",
"isMultivendorRefund": true,
"refundPayload": [
{
"refundRequestId": "cDg2RTY1Yjc5aw==",
"ibanNumber": "KW91KFHO0000000000051010173254",
"totalPaid": "50.000",
"refundedAmount": 0,
"remainingLimit": 50,
"amountToRefund": 0,
"merchantType": "vendor"
},
{
"refundRequestId": "bExqUVk2T1Y4Tg==",
"ibanNumber": "KW31NBOK0000000000002010177457",
"totalPaid": "50.000",
"refundedAmount": 0,
"remainingLimit": 50,
"amountToRefund": 0,
"merchantType": "vendor"
}
],
"multivendor_refund_end_point": "https://sandbox.upayments.com/api/v1/create-multivendor-refund"
}
}
Data flow diagram for refunds
