Retrieve Transactions

Lists transactions across one or more locations within a date range. Use it for reconciliation, reporting, and finding transaction IDs to inspect or refund.

Request Headers

HeaderRequiredDescription
AuthorizationYesBearer YOUR_ACCESS_TOKEN

Request Parameters

Query Parameters:

ParameterTypeRequiredDescription
global_on_idintegerNoOriginating channel identifier.
datetime_startstring (YYYY-MM-DD)ConditionalStart of the date range (required when date_filter=custom).
datetime_endstring (YYYY-MM-DD)ConditionalEnd of the date range (required when date_filter=custom).
date_filterstringNoDate filter mode, for example custom.
corporate_locationsstringNoComma-separated location IDs to include.
location_idintegerNoRestrict to a single location.
user_idintegerNoThe acting user.
pageintegerNoPage number.

cURL Example

curl --request GET \
  --url "https://sandbox-api.softpoint.io/interface/v1/transactions?global_on_id=19&datetime_start=2026-05-01&datetime_end=2026-05-07&corporate_locations=4004969&date_filter=custom" \
  --header "Authorization: Bearer YOUR_ACCESS_TOKEN"

Success Response

A paginator whose data array holds transaction summaries (abridged to one record).

{
  "current_page": 1,
  "data": [
    {
      "transaction_id": 69625960,
      "location_id": 4000479,
      "location_name": "Developer Sandbox",
      "payment_id": 68299586,
      "payment_status": "Approved",
      "tid": "19930817",
      "terminal_name": "A920 PRO",
      "base_amount": 1040,
      "tip_amount": 0,
      "total_amount": 1040,
      "card_type": "VISA",
      "last4": "0043",
      "auth_code": "000000",
      "transaction_type_name": "Sale",
      "status": "Approved",
      "created_datetime": "2025-09-11 17:09:13"
    }
  ]
}

Response Fields

FieldTypeDescription
current_pageintegerCurrent page number.
dataarrayTransaction summaries.
data[].transaction_idintegerTransaction identifier.
data[].payment_status / statusstringResult (for example, Approved).
data[].base_amount / tip_amount / total_amountintegerAmounts in minor units.
data[].card_type / last4stringCard brand and last four digits.
data[].auth_codestringAuthorization code.
data[].transaction_type_namestringType (for example, Sale, Refund).
data[].terminal_name / tidstringDevice that processed the transaction.
data[].created_datetimestringTransaction timestamp.

Error Responses

Unauthorized / Invalid Token

{
  "error": {
    "code": 10759,
    "message": "Operation timed out. Please try again.",
    "details": { "Exception": "Token could not be parsed from the request." }
  }
}

Status Codes

CodeDescription
200Transactions returned
401Token missing or invalid

Workflow Placement

A reporting read used after payments to reconcile activity and locate transaction IDs.

Notes

  • When date_filter=custom, supply both datetime_start and datetime_end.

  • Amounts are in minor units.

Common Mistakes

  • Using date_filter=custom without a start and end date.

  • Expecting a bare array; transactions are under data.

Query Params
integer
string
string
integer
string
Responses

Language
Credentials
Bearer
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
text/plain