Retrieve Transactions

GET All Transactions

The API uses the payments and transactions tables to construct its payload.

A SALE can only have status: Approved or Declined A REFUND can have status: Refunded or Declined

if transaction type = SALE and status = 1 then Approved
if transaction type = SALE and status = 2 then Declined
if transaction type = REFUND and status = 1 then Refunded
if transaction type = REFUND and status = 2 then Declined

Note: we are not going to show transactions.status = 0 (meaning Processing/Pending transactions)

Parameters

ParameterRequiredTypeDescription
datetime_endnodatetimeFormat, YYYY-MM-DD
datetime_startnodatetimeFormat, YYYY-MM-DD
statusnoenum(approved, refunded,declined)Filters the results by the status of the transactions
pagenointegerpage number to retrieve
corporate_idno*integer*Required if location_id is not present, should not be sent if location_id is present
location_idno*integer*Required if corporate_id is not present, should not be sent if corporate_id is present
Language
URL
Click Try It! to start a request and see the response here!