Reporting API

Overview

The Cardknox Reporting API enables you to retrieve data from transactions and create reports for all report types.


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 4.5.8
xSoftwareName The name of your software
xSoftwareVersion Version number of your software 2.1
xCommand Transaction type Samples: report:all, report:approved


 

Reporting URL

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


Endpoints

URL: https://x1.cardknox.com/report
Alternate URL: https://b1.cardknox.com/report

We also support JSON via the following URL:
JSON: https://x1.cardknox.com/reportjson

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.

Avaliable Report Types

Available report types include the following:

Date Based Reports

  • report:approved
  • report:declined
  • report:authonly
  • report:all

Transaction Based Reports

  • report:transaction
  • report:transactions

Date Based Reports

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

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

xCommand:

Report:Auth

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

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

Transaction Reports

Transaction Report (single transaction)

xCommand:

Report:Transaction

Required Parameters

Parameter Description Sample Value
xRefnum Reference number r10000001

Transaction Report (multiple transactions)

xCommand:

Report:Transactions

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

Note: You can use the xFields parameter to include additional non-default fields in all the above report methods.

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

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 Cardknox 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