​
Overview

The /transaction/report endpoint allows you to retrieve a paginated list of past transactions. You can filter the results by date range and status. This endpoint is useful for generating reports, auditing payments, and tracking user activity.

​
How It Works

1

Obtain an Access Token

Before calling /transaction/report, secure an access token by making a POST request to /auth/token using your ClientId and ClientSecret.
2

Specify Filters (Optional)

You may include optional query parameters such as from, to, status, and cursor to narrow the results or page through them.
3

Call the Endpoint

Make a GET request to /transaction/report with your access token and any desired filters. The response will contain a list of transactions, along with pagination info.
4

Process Results

Each transaction includes metadata such as sender/recipient names, accounts, amounts, dates, refund/reimbursement status, and recipient address details.

​
Retrieving Transactions

The /transaction/report endpoint supports filtered and paginated retrieval of transaction data.

​
Endpoint

  • URL: https://api.synchpay.com/transaction/report
  • Method: GET
  • Authorization: Bearer <AccessToken>

​
Query Parameters

ParameterTypeDescriptionRequired
companyIdstringThe companyIdthat was previously created.Yes
fromdatetimeStart date for transactions to include. Example: 2025-01-01T00:00:00ZNo
todatetimeEnd date for transactions to include. Example: 2025-01-31T23:59:59ZNo
statusstringFilter by transaction status (e.g., Completed, Pending, Cancelled) see available statuses belowNo
cursorstringUse to paginate through results. If hasMore is true, pass nextCursor.No

​
Available Statuses

  • Created
  • Pending
  • Processed
  • Completed
  • Cancelled
  • Failed

​
Example Request

GET /transaction/report?from=2025-01-01T00:00:00Z&to=2025-01-31T23:59:59Z&status=Completed HTTP/1.1
Authorization: Bearer eyJhbGciOi...

​
Example Response

{
  "transactions": [
    {
      "externalTransferId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "status": "Completed",
      "amount": {
        "value": 5000,
        "currencyCode": {
          "value": "USD",
          "displayName": "US Dollar",
          "cultureName": "en-US"
        }
      },
      "date": "2025-04-15T13:07:10.488Z",
      "senderName": "Alice Smith",
      "recipientName": "Bob Johnson",
      "isRefunded": false,
      "isReimbursed": true,
      "appliedForReimbursement": true,
      "recipientAddress": {
        "streetNumberAndName": "123 Main St",
        "apartmentNumber": "4B",
        "city": "New York",
        "zipCode": "10001",
        "state": "NY",
        "country": "USA"
      }
    }
  ],
  "hasMore": true,
  "nextCursor": "eyJwYWdlIjogMn0="
}