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 any remaining amount 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 the customer's first name

customerEmail

string, optional

250

Pass the customer's email

customerMobileNumber

string, optional

10

Pass the customer's mobile number

reference

string, optional

255

Pass order reference

notifyUrl

string, optional

255

Pass notification URL

requireApproval

boolean, optional

true/false

Pass true if the Refund request needs to be approved.

refundReason

string, optional

255

Pass the refund reason
Note: required only when requireApproval is true

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"
    }
}

Data flow diagram for refunds

Language
Click Try It! to start a request and see the response here!