Get Transactions

GET

getTransactions

curl --request GET \
  --url https://dashu.sa/api/external/getTransactions

{
  "success": true,
  "result": {
    "items": [
      {
        "id": 1,
        "payment_method": "ap-mada",
        "amount": "313.00",
        "service_charge": "1.00",
        "time": "2021-01-21 13:12:59"
      }
    ],
    "page_num": 1,
    "total_pages": 1,
    "total_rows": 1
  }
}

Query Parameters

apiKey

string

required

The API Key of your account.

startDate

string

required

The starting date of the result.

Sample: 2021-05-27 15:31:39

endDate

string

required

The ending date of the result.

Sample: 2021-06-28 23:59:59

pageNum

integer

required

The current page number (used for pagination in your system)

itemsPerPage

integer

required

Specifies the total items that should be return for each request (each page). It should be a number between 1 and 50.

{
  "success": true,
  "result": {
    "items": [
      {
        "id": 1,
        "payment_method": "ap-mada",
        "amount": "313.00",
        "service_charge": "1.00",
        "time": "2021-01-21 13:12:59"
      }
    ],
    "page_num": 1,
    "total_pages": 1,
    "total_rows": 1
  }
}

Response properties

success

boolean

required

A boolean value indicates the response status.

result

object

required

Hide properties

items

object

required

Hide properties

integer

required

A unique integer value indicating the deposit request in DashPay system.

payment_method

string

required

The payment method used by the customer to complete the payment process.

This can be one of the following values:

mada
visa
master
amex
ap-mada (ApplePay Mada)
ap-visa (ApplePay Visa)
ap-master (ApplePay Mastercard)
ap-amex (ApplePay AmericanExpress)

amount

string

required

The total amount of the transaction.

service_charge

string

required

The fee amount of the transaction (DashPay fees).

time

string

required

Date of creating the transaction.

page_num

integer

required

The current page number.

total_pages

integer

required

Total pages available (according to the date range specified and the total items per page).

total_rows

integer

required

Total rows of the current page (total transactions returned in this request).

Error Codes

Here’s a list of possible error codes of this endpoint.

Code	Description
1	Missing or invalid api key
3	You cannot pass a number greater than 50 for the parameter `itemsPerPage`
4	Invalid `startDate“.
5	invalid `endDate“.

curl --request GET \
  --url https://dashu.sa/api/external/getTransactions

{
  "success": true,
  "result": {
    "items": [
      {
        "id": 1,
        "payment_method": "ap-mada",
        "amount": "313.00",
        "service_charge": "1.00",
        "time": "2021-01-21 13:12:59"
      }
    ],
    "page_num": 1,
    "total_pages": 1,
    "total_rows": 1
  }
}

GET

getTransactions

curl --request GET \
  --url https://dashu.sa/api/external/getTransactions

{
  "success": true,
  "result": {
    "items": [
      {
        "id": 1,
        "payment_method": "ap-mada",
        "amount": "313.00",
        "service_charge": "1.00",
        "time": "2021-01-21 13:12:59"
      }
    ],
    "page_num": 1,
    "total_pages": 1,
    "total_rows": 1
  }
}

Query Parameters

apiKey

string

required

The API Key of your account.

startDate

string

required

The starting date of the result.

Sample: 2021-05-27 15:31:39

endDate

string

required

The ending date of the result.

Sample: 2021-06-28 23:59:59

pageNum

integer

required

The current page number (used for pagination in your system)

itemsPerPage

integer

required

Specifies the total items that should be return for each request (each page). It should be a number between 1 and 50.

{
  "success": true,
  "result": {
    "items": [
      {
        "id": 1,
        "payment_method": "ap-mada",
        "amount": "313.00",
        "service_charge": "1.00",
        "time": "2021-01-21 13:12:59"
      }
    ],
    "page_num": 1,
    "total_pages": 1,
    "total_rows": 1
  }
}

Response properties

success

boolean

required

A boolean value indicates the response status.

result

object

required

Hide properties

items

object

required

Hide properties

integer

required

A unique integer value indicating the deposit request in DashPay system.

payment_method

string

required

The payment method used by the customer to complete the payment process.

This can be one of the following values:

mada
visa
master
amex
ap-mada (ApplePay Mada)
ap-visa (ApplePay Visa)
ap-master (ApplePay Mastercard)
ap-amex (ApplePay AmericanExpress)

amount

string

required

The total amount of the transaction.

service_charge

string

required

The fee amount of the transaction (DashPay fees).

time

string

required

Date of creating the transaction.

page_num

integer

required

The current page number.

total_pages

integer

required

Total pages available (according to the date range specified and the total items per page).

total_rows

integer

required

Total rows of the current page (total transactions returned in this request).

Error Codes

Here’s a list of possible error codes of this endpoint.

Code	Description
1	Missing or invalid api key
3	You cannot pass a number greater than 50 for the parameter `itemsPerPage`
4	Invalid `startDate“.
5	invalid `endDate“.

curl --request GET \
  --url https://dashu.sa/api/external/getTransactions

{
  "success": true,
  "result": {
    "items": [
      {
        "id": 1,
        "payment_method": "ap-mada",
        "amount": "313.00",
        "service_charge": "1.00",
        "time": "2021-01-21 13:12:59"
      }
    ],
    "page_num": 1,
    "total_pages": 1,
    "total_rows": 1
  }
}

Query Parameters

Response properties

Error Codes

Redirect Integration

Embedded Integration

General Endpoints

Get Transactions

Query Parameters

Response properties

Error Codes

​Query Parameters

​Response properties

​Error Codes

Redirect Integration

Embedded Integration

General Endpoints

​Query Parameters

​Response properties

​Error Codes

Query Parameters

Response properties

Error Codes

Query Parameters

Response properties

Error Codes