Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.ecrypt.com/llms.txt

Use this file to discover all available pages before exploring further.

The Reporting API lets you fetch transaction details directly from ECRYPT and display in your own environment.

​
Authentication

All Reporting API requests require a Reporting API key passed in the request header. This is a separate key from your standard private API key. 
X-Api-Key: {{reporting_api_key}}
Reporting API keys can be created in the ECRYPT Dashboard under Settings > Account Settings > Developer Tools > API/Security Keys.

​
Get a Transaction

Fetch the details of a single transaction by its ID. 
GET https://reportinguiapi.v2.ecrypt.com/api/transactions/{{transaction_id}}

​
Request

GET /api/transactions/230021901 HTTP/1.1
Host: reportinguiapi.v2.ecrypt.com
X-Api-Key: {{reporting_api_key}}

​
Response

{
  "transactionId": 230021901,
  "type": "SALE",
  "tender": "CREDITCARD",
  "paymentName": "A TEST",
  "paymentNetwork": "MC",
  "paymentAccount": "5***********1111",
  "paymentAccountExpiry": "1025",
  "amount": 29.95,
  "authorizationAmount": 29.95,
  "capturedAmount": 29.95,
  "gratuityAmount": 0.00,
  "surchargeAmount": 0.00,
  "settlementAmount": 29.95,
  "approvalCode": "123456",
  "avsCode": "N",
  "cvvCode": "M",
  "status": "SETTLED",
  "created": "2024-09-30T17:55:23"
}

​
Response Fields

FieldDescription
transactionIdUnique transaction identifier
typeTransaction type (e.g., SALE, REFUND, VOID)
tenderPayment method used (e.g., CREDITCARD, ACH)
paymentNameName on the payment method
paymentNetworkCard network (e.g., VI = Visa, MC = Mastercard)
paymentAccountMasked account or card number
paymentAccountExpiryCard expiration in MMYY format
paymentAccountRoutingBank routing number (ACH transactions)
amountTotal transaction amount
authorizationAmountAmount authorized
capturedAmountAmount captured
gratuityAmountTip amount
surchargeAmountSurcharge amount
settlementAmountAmount settled
voidedAmountAmount voided
referenceTransactionIdID of the original transaction, if applicable
approvalCodeIssuer approval code
avsCodeAVS response code
cvvCodeCVV response code
enhancedWhether Level 2/3 data was submitted
statusTransaction status (e.g., SETTLED, VOIDED)
createdTimestamp the transaction was created (UTC)