GET
/
getTransactions

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.

Response properties

success
boolean
required

A boolean value indicates the response status.

result
object
required
items
object
required
id
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:

  1. mada
  2. visa
  3. master
  4. amex
  5. ap-mada (ApplePay Mada)
  6. ap-visa (ApplePay Visa)
  7. ap-master (ApplePay Mastercard)
  8. 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.

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