Skip to main content
POST
/
api
/
Transactions
List Transactions
curl --request POST \
  --url https://reporting.ecrypt.com/api/Transactions \
  --header 'Content-Type: application/json' \
  --header 'X-Api-Key: <api-key>' \
  --data '
{
  "startDate": "2025-01-01",
  "endDate": "2025-02-01",
  "sortColumn": "Id",
  "page": 1,
  "pageSize": 20,
  "sortOrder": "DESC"
}
'
{
  "transactions": {
    "items": [
      {
        "transactionId": 123,
        "type": "<string>",
        "tender": "<string>",
        "paymentName": "<string>",
        "paymentNetwork": "<string>",
        "paymentAccount": "<string>",
        "paymentAccountExpiry": "<string>",
        "payamentAccountRouting": "<string>",
        "amount": 123,
        "authorizationAmount": 123,
        "capturedAmount": 123,
        "gratuityAmount": 123,
        "surchargeAmount": 123,
        "settlementAmount": 123,
        "voidedAmount": 123,
        "referenceTransactionId": 123,
        "approvalCode": "<string>",
        "avsCode": "<string>",
        "cvvCode": "<string>",
        "enhanced": true,
        "status": "<string>",
        "created": "2023-11-07T05:31:56Z",
        "events": [
          {
            "type": "<string>",
            "code": "<string>",
            "text": "<string>",
            "created": "2023-11-07T05:31:56Z"
          }
        ],
        "order": {
          "discount": 123,
          "surcharge": 123,
          "shipping": 123,
          "tip": 123,
          "tax": 123,
          "total": 123,
          "billingAddress": {
            "name": "<string>",
            "line1": "<string>",
            "line2": "<string>",
            "city": "<string>",
            "state": "<string>",
            "postalCode": "<string>",
            "country": "<string>"
          },
          "shippingAddress": {
            "name": "<string>",
            "line1": "<string>",
            "line2": "<string>",
            "city": "<string>",
            "state": "<string>",
            "postalCode": "<string>",
            "country": "<string>"
          },
          "lines": [
            {
              "orderId": 123,
              "productCode": "<string>",
              "description": "<string>",
              "commodityCode": "<string>",
              "unitOfMeasure": "<string>",
              "unitCost": 123,
              "quantity": 123,
              "discount": 123,
              "taxableAmount": 123,
              "alternateTaxId": "<string>",
              "tax": 123,
              "total": 123
            }
          ],
          "metadata": [
            {
              "key": "<string>",
              "value": "<string>"
            }
          ]
        }
      }
    ],
    "page": 123,
    "pageSize": 123,
    "totalCount": 123
  }
}

Authorizations

X-Api-Key
string
header
required

Enter your API key

Body

application/json
startDate
string<date-time>
default:2025-01-01
required

Start date, all date times are in UTC.

Format:

  • yyyy-MM-dd
  • yyyy-MM-ddTHH:mm
  • yyyy-MM-ddTHH:mm:ss
  • yyyy-MM-ddTHH:mm:ss.fff
endDate
string<date-time>
default:2025-02-01
required

End date, all date times are in UTC.

Format:

  • yyyy-MM-dd
  • yyyy-MM-ddTHH:mm
  • yyyy-MM-ddTHH:mm:ss
  • yyyy-MM-ddTHH:mm:ss.fff
sortColumn
string | null
default:Id

Sort column, the column being used for sorting. The default is TransactionId.

Valid Options:

  • Id
  • Type
  • Tender
  • Amount
  • AuthorizedAmount
  • CapturedAmount
  • GratuityAmount
  • SurchargeAmount
  • SettlementAmount
  • AvsCode
  • CvvCode
  • Created
Maximum string length: 100
Pattern: ^[A-Za-z0-9]*$
page
integer<int32> | null
default:1

Page, the of results being requested.

Required range: 1 <= x <= 2147483647
pageSize
integer<int32> | null
default:20

Page size, the number of items being requested for the page.

Required range: 1 <= x <= 1000
sortOrder
string | null
default:DESC

Sort order, the sort columns desired sort direction. The default is DESC.

Examples:

  • ASC
  • DESC
Maximum string length: 20
Pattern: ^[A-Za-z]*$

Response

object | null

OK

transactions
object