Refund-Transaction

Refund Transaction

This api is used to refund transaction by providing a transaction number on request. Provided transaction number should be eligible to refund. If the refund is successful then reverse transaction’s details will be provided in response.

Conditions to refund any transaction/eligibility criteria

1. Transaction should be within 3 months
2. Transaction should be a success.

POST

https://api-sandbox.sadad.qa/api//transactions/refundTransaction

Permission: Merchant

Example usage:

curl -d "@data.json" -H "Content-Type: application/json" -H "Authorization: {ACCESS_TOKEN}" -X POST https://api-sandbox.sadad.qa/api/transactions/refundTransaction

Header

Field	Type	Description
Authorization	String	User's unique access-token

Header-Example:

{
    "Authorization": "BN79o6YNrY4IPP60UF4JmNEM6O8hX9HVUq0e0HWNyo2tt1jqCT9IWnXSBhfr7Mws"
}

Parameter

Field	Type	Description
transactionno	String	transaction number to fetch

Request-Example:

{
    "transactionnumber": "SD33XXXXXXXXXX8"
}

Field	Type	Description
entityid	Number	Associated entity id such as invoice/order etc
invoicenumber	String	Transaction number
isRefund	Boolean	Transaction is refunded or not
amount	Number	Transaction amount
servicecharge	Number	Service charge of transaction
website_ref_no	String	It’s a order_id of checkout page that received from merchant side
transaction_summary	String	Transaction summary text
refundcharge	Number	If refunded then refund charges
id	Number	Unique transaction data id
transactiondate	String	Date of transaction
transactionentityId	Number	Transaction entity type id such as invoice/order etc
transactionmodeId	Number	Transaction payment mode id such as via credit/debit or via sadad
transactionstatusId	Number	Transaction status id such as inprogress/success/failure
guestuserId	Number	Transaction has been done through non sadad user then received that user id as a guestuserId with detail
senderId	Object/Number	Transaction sender id with details
receiverId	Object/Number	Transaction receiver id with details
transactionentity	Object	Transaction entity id detail
transactionstatus	Object	Transaction status id detail
transactionmode	Object	Transaction mode id detail
guestuser	Object	Guest user id details

Success-Response:

{
    "entityid": 9230,
    "isRefund": false,
    "invoicenumber": "SD33XXXXXXXXXX8",
    "amount": 1,
    "servicecharge": 0.025,
    "website_ref_no": null,
    "transaction_summary": null,
    "refundcharge": 0,
    "id": 25291,
    "transactiondate": "2021-01-11",
    "transactionentityId": 1,
    "transactionmodeId": 1,
    "transactionstatusId": 3,
    "guestuserId": 147,
    "senderId": 0,
    "receiverId": {
        "SadadId": "1853219",
        "name": "User1",
        "cellnumber": "54XXXXX5",
        "id": 466
    },
    "transactionentity": {
        "name": "INVOICE",
        "id": 1
    },
    "transactionstatus": {
        "name": "SUCCESS",
        "id": 3
    },
    "transactionmode": {
        "name": "CREDIT CARD",
        "id": 1
    },
    "guestuser": {
        "cellnumber": "9XXXXXXXXXX3",
        "id": 147
    }
}

Error 4xx

Name	Description
401	Authorization Required
400	Invalid data
404	Data not found

Response (example):

{
    "error": {
        "statusCode": 404,
        "name": "Error",
        "message": "Transaction not found"
    }
}