Reporting API

Overview

The Sola Reporting API enables you to generate transaction reports based on specified parameters, such as date ranges. Reports can be created for single accounts or multiple accounts.

Credentials

Parameter	Description	Comment
xKey	Credential	Max Size: 250 Alphanumeric Characters

Universally Required Parameters

Parameter	Description	Comment
xVersion	Gateway API version	The current version is 5.0.0
xSoftwareName	The name of your software
xSoftwareVersion	Version number of your software	2.1
xCommand	Transaction type	Samples: report:all, report:approved

Other Parameters

Parameter	Description	Comment
xReturnDownloadURL	A boolean flag indicating if response should include xReportURL to use for downloading the results instead of xReportData.	If you are running reports that are returning more than 5MB of data we recommend that you use this parameter. The URL returned is valid for 5 minutes.

Endpoints

Base URL: https://x1.cardknox.com

Sola reporting API allows you to send the data in FormData and JSON formats. Add to the base URL any of the following formats to indicate which format you are sending it as:

FormData	/report	https://x1.cardknox.com/report
JSON	/reportjson	https://x1.cardknox.com/reportjson

Request Method

Method: POST The Cardknox gateway requires the POST method to be used for enhanced security. We do not support the GET method.

Pagination

1. Submit the first request.

2. If xRecordsReturned equals xReportingMaxTransactions, submit another report request and adjust the beginning date and time according to the last transaction returned.

Filter Options

Available filtering options include the following:

Required Parameters

Parameter	Description	Sample Value
xgetnewest	Returns the most recent transactions in the requested date range	True/False
xmaxrecords	Sets the maximum number of records to return on the report	Integer value between 1 – 1000* If the date range on the report is within 24 hours you can request up to 5000 transactions

For date-based reports, you can filter results using the following operators for any of the reporting fields:

Parameter	Operator	Description	Example
ai	In	Use for an exact match.	xBillCountry=aiCanada
a=	Like	Use for fields that include your search string, but sometimes also include other information.	xAmount=a=40
a!	Not Like	Use for fields that do not include your search string, but sometimes also include other information.	xCardLastFour=a!4444
an	Not In	Shows results that don’t have the value you enter.	xBillPhone=an212
as	Ends With	Use when you know what your value starts with.	xName=asJane
ae	Ends With	Use when you know what your value ends with.	xEmail=aeOrg

Customize report parameters

To customize the transaction parameters included in a generated report, you can utilize the "xFields" parameter and specify the desired field names. Refer to the available parameters listed here.

Parameter	Description	Sample Value
xFields	Specify parameters to be returned in the report.	xrefnum, xcommand, xname, xmaskedcardnumber, xtoken, xamount, xentereddate, xresponseresult

/GetReconReport

Gets a list of Invoices for a specific Cardknox MID with an option to get data for multiple MIDs. This includes all invoices charged to the merchant by Sola. GoPlus merchants only.

Method: POST

Authentication is required.

Request Body (JSON)

Parameter	Required	Type	Description
FromDate	yes	Date	The start date to pull invoices for
ToDate	yes	Date	The end date to pull invoices for. Can be max 6 months from FromDate if IsMultiMidReport is false, 31 days if true
IsMultiMidReport	no	Boolean	If true, data will be returned for all mids user has access to

Sample Request

{
    "FromDate": "2026-04-15",
    "ToDate": "2026-04-19",
    "IsMultiMidReport": false
}

Response Body (JSON)

Parameter	Type	Description	Valid Values
Result	char	The result of the API call. S represents success, E represents an error.	S, E
RefNum	string	A unique request ID.
Error	string	If the Result parameter contains a value of E, this parameter will contain any relevant error messages.
InvoiceList	array of json objects	The invoices for the requested billing date range	See fields below

Invoice Field	Type	Description	Valid Values
InvoiceId	string	The unique id of this invoice	numeric
InvoiceDescription	string	The description of the fees being charged on the invoice
SolaMID	string	The Sola MID the fee was billed to	numeric, valid Sola MID
ProcessorMID	string	The Processor MID of the account the fee was billed to	numeric, valid Fiserv or ACHQ MID
DBA	string	The account’s business name
BillingStatus	string	The current status of the invoice	Completed, Bounced, paid, paid-reconciled
BillingDate	date	The date the fees were billed
TransactionStartDate	datetime	Only returned on invoices where the description is “Processing Fees”. The start date of the transactions the fees were charged for
TransactionEndDate	datetime	Only returned on invoices where the description is “Processing Fees”. The end date of the transactions the fees were charged for
Processor	string	The processor of the account/SolaMID the invoice is for	Go Plus, ACHQ
ProcessingFees	decimal	The amount of the fees charged for transaction processing
OtherFees	decimal	The amount of fees charged for other services
TotalFees	decimal	The total amount of the fees charged
Batches	string	Only returned on invoices where the description is “Processing Fees” for accounts billed per batch. The batches the fees were charged for	comma-delimited list of batch numbers

Sample Response

{
	"refNum": "ra501002009",
	"result": "S",
	"error": "",
	"invoiceList": [
		{
			"invoiceId": "21015",
			"invoiceDescription": "Processing Fees",
			"solaMID": "999000017",
			"processorMID": "855956893512",
			"dba": "Test Go Plus",
			"billingStatus": "Complete",
			"billingDate": "2026-05-27",
			"transactionStartDate": "2026-05-01T21:32:46",
			"transactionEndDate": "2026-05-28T12:08:59",
			"processor": "Go Plus",
			"processingFees": 4.85,
			"otherFees": 0.00,
			"totalFees": 4.85,
			"batches": "37927929,5010404"
		},
        {
			"invoiceId": "279308.0",
			"invoiceDescription": "Processing Fees, Return Fee",
			"solaMID": "36977",
			"processorMID": "2001",
			"dba": "Test Retry, TID 10",
			"billingStatus": "Complete",
			"billingDate": "2026-05-29",
			"processor": "ACHQ",
			"processingFees": 3.0,
			"otherFees": 25.0,
			"totalFees": 28.0,
			"batches": "5005327"
		}
	]
}

Report Types

Available report types include the following:

Date-Based Reports

Report:Approved

xCommand: Report:Approved

The Report:Approved command returns the following transactions:

• CC:Sale

• CC:Capture

• CC:PostAuth

• CC:Save

• CC:Credit

• CC:Refund

The Report:Approved command does not return authorization-only transactions that have not been captured.

Required Parameters

Parameter	Description	Sample Value
xBeginDate	Transaction begin date in YYYY-MM-DD or YYYY-MM-DD HH:MM:SS format	2020-01-01 2019-08-15 09:00:00
xEndDate	Transaction end date in YYYY-MM-DD or YYYY-MM-DD HH:MM:SS format	2019-10-31 2020-06-30 12:00:00

Report:Declined

xCommand: Report:Declined

The Report:Declined command returns the following transactions:

• CC:Sale

• CC:AuthOnly

• CC:Capture

• CC:PostAuth

• CC:Save

• CC:Credit

• CC:Refund

Required Parameters

Parameter	Description	Sample Value
xBeginDate	Transaction begin date in YYYY-MM-DD or YYYY-MM-DD HH:MM:SS format	2020-01-01 2019-08-15 09:00:00
xEndDate	Transaction end date in YYYY-MM-DD or YYYY-MM-DD HH:MM:SS format	2019-10-31 2020-06-30 12:00:00

Report:Auth

xCommand: ReportAuth

The Report:Auth command returns the following transaction:

• CC:AuthOnly

The ReportAuth command only returns approved authorizations.

Required Parameters

Parameter	Description	Sample Value
xBeginDate	Transaction begin date in YYYY-MM-DD or YYYY-MM-DD HH:MM:SS format	2020-01-01 2019-08-15 09:00:00
xEndDate	Transaction end date in YYYY-MM-DD or YYYY-MM-DD HH:MM:SS format	2019-10-31 2020-06-30 12:00:00

Report:All

xCommand: Report:All

The Report:All command returns the following transactions:

• CC:Sale

• CC:AuthOnly

• CC:Capture

• CC:PostAuth

• CC:Save

• CC:Credit

• CC:Refund

Required Parameters

Parameter	Description	Sample Value
xBeginDate	Transaction begin date in YYYY-MM-DD or YYYY-MM-DD HH:MM:SS format	2020-01-01 2019-08-15 09:00:00
xEndDate	Transaction end date in YYYY-MM-DD or YYYY-MM-DD HH:MM:SS format	2019-10-31 2020-06-30 12:00:00

Note: You can run a report against all accounts by adding the search parameter xSecondaryKeys:[comma-delimited xKeys] and use all the xKeys for all accounts for the following date-based reports

Parameter	Description	Sample Value
xSecondaryKeys	Run a report for secondary accounts. For multiple account keys, you can include comma-separated values.	Bread_Butter_xxxdxxxecbxxxxaxxxdbexxx, Other_Account_xxxxfxxxexxfxxxfxbxxx, Yet_Another_Account_xxxbexaxxddxxbabbxexcxxxafxfexx

Optional Field: xBatch:[batch#]to get only the transactions of a specific batch.

Report:Deposit

xCommand: Report:Deposit

The Report:Deposit command will only return valid responses for accounts that have ongoing ACHQ activity. The Deposit ID given as a parameter must be an ACHQ deposit ID and the values shown in the response are only pertaining to ACHQ transaction activity.

The Report:Deposit command returns the following values:

• Deposit Id

• Deposit Date

• Total Amount

• Transactions

  • Refnum

  • Amount

Required Parameters

Parameter	Description	Sample Value
xDepositId*
xBeginDate*	Begin date in YYYY-MM-DD or YYYY-MM-DD HH:MM:SS format	2020-01-01 2019-08-15 09:00:00
xEnd Date*	End date in YYYY-MM-DD or YYYY-MM-DD HH:MM:SS format	2019-10-31 2020-06-30 12:00:00

*Either xDepositId or xBeginDate and xEndDate are required.

Transaction-Based Reports

Single transaction

• report:transaction

xCommand: Report:Transaction

Required Parameters

Parameter	Description	Sample Value
xRefnum	Reference number Multiple reference numbers are comma delimited. This value is required only if you do not enter an Invoice number.	r10000001 r10000001,r2000001,r3000001

EBT Balance Fields

For EBT and eWIC transactions, the report record includes the card balances as of the moment the transaction was approved:

Parameter	Description	Sample Value
xBalanceAtApprovalEBTFS	EBT food stamp (SNAP) balance on the card at the time of approval. Two decimal places.	50.44
xBalanceAtApprovalEBTCB	EBT cash benefit balance on the card at the time of approval. Two decimal places.	25.00
xBalanceAtApprovalEBTW	eWIC benefit balances at the time of approval, as a JSON list of per-category item balances.	[{"CategoryCode":"19","Balance":"3.00"}]

These fields are a point-in-time snapshot — not the card's current balance, which may have changed since the transaction. (The live transaction response returns the same values as xRemainingBalanceEBTFS/EBTCB/EBTW; the report uses distinct names to make the point-in-time meaning explicit.) Omitted for non-EBT transactions and for any balance the processor did not return. The same fields appear in records returned by report:transactions.

Multiple transactions

• report:transactions

xCommand: Report:Transactions

Reports queried without xBeginDate and xEndDate will only return transactions from the past 2 years.

Required Parameters

Parameter	Description	Sample Value
xRefnum	Reference number Multiple reference numbers are comma delimited. This value is required only if you do not enter an Invoice number.	r10000001 r10000001,r2000001,r3000001
xInvoice	Invoice number Multiple invoice numbers are comma delimited. This value is required only if you do not enter a Reference number.	1234 1234,5678,9012

Related Transactions

xCommand: Report:Related

Required Parameters

Parameter	Description	Sample Value
xRefnum	Reference number Multiple reference numbers are comma delimited. This value is required only if you do not enter an Invoice number.	r10000001 r10000001,r2000001,r3000001

Gift:Approved

xCommand: Report:GiftApproved

Required Parameters

xKey	Your Sola API key	Max Size: 250 Alphanumeric Characters
xCommand	Sola transaction type	Report:GiftApproved
xBeginDate	Beginning date of range	2020-01-01 2019-08-15 09:00:00
xEndDate	Ending date of range	2020-01-01 2019-08-15 09:00:00
xSoftwareName	Name of your software	[xsoftwarecredentials]
xSoftwareVersion	Version number of your software	The current version is 4.5.8
xFields	Optional. If not used, returns all fields

Response Fields

xResult	“A”
xStatus	“Approved”
xError	““
xRefNum	"10000016875"
xRecordsReturned	“20”
xReportData

Gift:Summary

xCommand: Report:GiftSummary

Required Parameters

xKey	Your Sola API key	[xkeycredentials]
xCommand	Sola transaction type	Report:GiftSummary
xBeginDate	Beginning date of range	2020-01-01 2019-08-15 09:00:00
xEndDate	Ending date of range	2020-01-01 2019-08-15 09:00:00
xSoftwareName	Name of your software	[xsoftwarecredentials]
xSoftwareVersion	Version number of your software	The current version is 4.5.8
xFields	Optional. If not used, returns all fields

Response Fields

xResult	“A”
xStatus	“Approved”
xError	““
xRefNum	"10000016875"
xRecordsReturned	“20”
xReportData

Liability

xCommand: Report:Liability

Required Parameters

xKey	Your Sola API key	[xkeycredentials]
xCommand	Sola transaction type	Report:Liability
xSoftwareName	Name of your software	[xsoftwarecredentials]
xSoftwareVersion	Version number of your software	The current version is 4.5.8

Response Fields

Parameter	Example
xResult	“A”
xStatus	“Approved”
xError	““
xRefNum	"10000016875"
xRecordsReturned	“20”
xReportData

Batch Report

Obtain batch summary by date

• report:batch

xCommand: Report:Batch

Required Parameters

Parameter	Description	Sample Value
xBeginDate	Begin date in YYYY-MM-DD or YYYY-MM-DD HH:MM:SS format	2020-01-01 2019-08-15 09:00:00
xEndDate	End date in YYYY-MM-DD or YYYY-MM-DD HH:MM:SS format	2019-10-31 2020-06-30 12:00:00

Send a Receipt for a Completed Transaction

You can use the Reporting API feature to send a receipt for a completed transaction.

Reporting URL

Use the following Sola URL: https://x1.cardknox.com/report

Required Variables:

Parameter	Description	Comments
xKey	Credential	Max Size: 250 Alphanumeric Characters
xVersion	Gateway API version	The current version is 4.5.8
xSoftwareName	The name of your software
xSoftwareVersion	Version number of your software
xCommand	Transaction type	Report:Transaction
xRefnum	Reference number
xEmail	Email address of receipt destination