Reports

Generate Source Transactions Report

post

Sample request to get transactions report filters by PaymentDate after (operation 7 = After) January 1st 2026 (2026-01-01) sorted by PaymentDate column desc, returning page index 1 and page size 1000 records.

Please see Filters and Operation parameters defined here for requests: https://developers.frontstream.com/welcome-to-our-payment-api/api-references/retrieve-transactions-report#body-parameter-definitions

 POST /api/sourceTransactionsReport
	{
	"Filters": [
		{
  		"Name": "PaymentDate",
  		"Operation": 7,
  		"Values": [
   		 "2026-01-01"
  		]
		}
	],
	"SortColumns": [
		{
  		"Name": "PaymentDate",
  		"Descending": true,
  		"Order": 0
		}
	],
	"PageSize": 1000,
	"PageIndex": 1
	}

Header parameters

AccessTokenstringRequired

access token

Body

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

PageSizeinteger · int32Optional

How many records to return per page.

PageIndexinteger · int32Optional

Which page of results to return. Starts at 1 (0 will also return the first page)

Responses

200

Success

application/json

400

Failure

application/json

post

/api/sourceTransactionsReport

HTTPcURLJavaScriptPython

POST /api/sourceTransactionsReport HTTP/1.1
AccessToken: text
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 148

{
  "Filters": [
    {
      "Name": "text",
      "Operation": 1,
      "Values": [
        "text"
      ]
    }
  ],
  "SortColumns": [
    {
      "Name": "text",
      "Descending": true,
      "Order": 1
    }
  ],
  "PageSize": 1,
  "PageIndex": 1
}

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

{
  "CurrentPage": 1,
  "PageSize": 1,
  "Results": [
    {
      "PaymentGuid": "123e4567-e89b-12d3-a456-426614174000",
      "PaymentDate": "2026-01-27T17:52:17.133Z",
      "PaymentExternalId": "text",
      "OriginalExternalID": "text",
      "RecurringProfileGuid": "123e4567-e89b-12d3-a456-426614174000",
      "NextBillDate": "2026-01-27T17:52:17.133Z",
      "ProcessStatus": 1,
      "ProcessStatusValue": 1,
      "PaymentResult": 1,
      "PaymentResultValue": 1,
      "Amount": 1,
      "DistributionType": 1,
      "DistributionTypeValue": 1,
      "DistributionStatus": "text",
      "DistributionId": 1,
      "SourceGuid": "123e4567-e89b-12d3-a456-426614174000",
      "SourceName": "text",
      "CharityId": "text",
      "OrganizationName": "text",
      "Ein": "text",
      "ExternalConstituentId": "text",
      "FirstName": "text",
      "LastName": "text",
      "Email": "text",
      "CardHolderName": "text",
      "CCLastDigits": "text",
      "CCType": 1,
      "ExternalEventId": "text",
      "ExternalEventGuid": "123e4567-e89b-12d3-a456-426614174000",
      "ExternalEventName": "text",
      "TaxableBenefit": 1,
      "TranId": "text",
      "VoidRequestDate": "2026-01-27T17:52:17.133Z",
      "VoidReason": "text",
      "RefundRequestDate": "2026-01-27T17:52:17.133Z",
      "RefundReason": "text",
      "PaymentId": 1,
      "ProcessorId": 1,
      "ProcessorGuid": "123e4567-e89b-12d3-a456-426614174000",
      "PaymentMethodTypeId": 1,
      "Surcharge": 1,
      "IsSurchargeEligible": true,
      "CheckLastDigits": "text",
      "CheckNumber": "text",
      "CheckTypeId": 1,
      "CheckAccountTypeId": 1,
      "EpfSessionId": "123e4567-e89b-12d3-a456-426614174000",
      "TransactionLines": [
        {
          "PaymentGuid": "123e4567-e89b-12d3-a456-426614174000",
          "PaymentLineId": 1,
          "PaymentId": 1,
          "CreatedDate": "2026-01-27T17:52:17.133Z",
          "ModifiedDate": "2026-01-27T17:52:17.133Z",
          "IsDeleted": true,
          "Amount": 1,
          "CardFeeAmount": 1,
          "CommissionAmount": 1,
          "PayFee": true,
          "TransactionSourceGroupId": 1,
          "CardFeeRate": 1,
          "TotalCommissionRate": 1,
          "TotalCommissionAmount": 1,
          "PartnerCommissionRate": 1,
          "PartnerCommissionAmount": 1,
          "FsCommissionRate": 1,
          "FsCommissionAmount": 1,
          "TotalFees": 1,
          "PerTransFee": 1,
          "ExternalLineId": "text",
          "Tip": 1,
          "CommissionRateOverride": 1,
          "Tax": 1
        }
      ]
    }
  ],
  "TotalPages": 1,
  "TotalRows": 1
}

Export Source Transactions Report in specified format "csv" or "excel"

post

Header parameters

AccessTokenstringRequired

access token

Body

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

PageSizeinteger · int32Optional

How many records to return per page.

PageIndexinteger · int32Optional

Which page of results to return. Starts at 1 (0 will also return the first page)

Formatstring · nullableOptional

Determines which file type the report will be exported to. Valid values: "csv" or "excel"

Responses

200

Success

No content

400

Failure

application/json

post

/api/exportSourceTransactionsReport

HTTPcURLJavaScriptPython

POST /api/exportSourceTransactionsReport HTTP/1.1
AccessToken: text
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 164

{
  "Filters": [
    {
      "Name": "text",
      "Operation": 1,
      "Values": [
        "text"
      ]
    }
  ],
  "SortColumns": [
    {
      "Name": "text",
      "Descending": true,
      "Order": 1
    }
  ],
  "PageSize": 1,
  "PageIndex": 1,
  "Format": "text"
}

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

No content