Transaction - List Transactions

This API is used to get the list of transactions of merchant. Filters are required. Pagination filters are required(skip and limit). If using date range filter, start and end dates are required. Dates should be in proper format.

Filters

1. Pagination Filters:
   Skip determines starting number of page and limit determines ending number of page
   ?filter[skip]=0&filter[limit]=10
   
2. Date Range filter:
   ?filter[skip]=0&filter[limit]=10&filter[date_range][startDate]=2020-03-15&filter[date_range][endDate]=2020-03-20
   
3. Name Filter:
   To fetch data by sender/receiver’s name
   ?filter[skip]=0&filter[limit]=10&filter[name]=Test
   
4. Cell number Filter:
   To fetch data by sender/receiver’s cell number
   ?filter[skip]=0&filter[limit]=10&filter[cellnumber]=91XXXXXXXXXX
   
5. Transaction number Filter:
   To fetch transaction by transaction number
   Transaction should be of authenticated user’s transaction
   ?filter[skip]=0&filter[limit]=10&filter[transaction_number]=SD5XXXXXXXXXXXX
   
6. Transaction status Filter:
   To fetch data by transaction status
   ?filter[skip]=0&filter[limit]=2&filter[status]=3
   
7. Transactions by merchant reference number
   This is the order_id that merchant has sent in the web checkout request.
   ?filter[skip]=0&filter[limit]=10&filter[website_ref_no]=XXXXX

Transaction Status Description

1. Inprogress
2. Failed
3. Success
4. Refund
5. Pending
6. Onhold
7. Rejected

Transaction Mode Description

1. Credit Card
2. Debit Card
3. Sadad

Transaction Entity Description

1. Invoice
2. Product Invoice
3. Add Funds
4. Withdrawal
5. Transfer
6. Order
7. Website Payment
8. QR Transfer
9. SDK Payment
10. AJAX Payment
11. Product Subscription Detail
12. Calender Webcheckout

GET

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

Permission: Merchant

Example usage:

curl -H "Content-Type: application/json" -H "Authorization: {ACCESS_TOKEN}" -X GET https://api-sandbox.sadad.qa/api/transactions/listTransactions?filter[skip]=0&filter[limit]=10

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

Header-Example:

{
    "Authorization": "BN79o6YNrY4IPP60UF4JmNEM6O8hX9HVUq0e0HWNyo2tt1jqCT9IWnXSBhfr7Mws"
}

Success 200

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

Field	Description
401	Authorization Required
400	Invalid data

Response (example):

{
    "error": {
        "statusCode": 400,
        "name": "Error",
        "message": "Please provide valid filter"
    }
}