v1

latestOpenAPI 3.1.02026-07-2665153355.3 KB

Get Transactions

Retrieves transaction data for a given time period.

get/reporting/financial-data/transactions

Query parameters

startDatestring date-time required

Example:2025-05-26T00:00:00Z

Start date of the query in UTC ISO 8601 format.

endDatestring date-time required

Example:2025-07-24T23:59:59Z

End date of the query in UTC ISO 8601 format.

limitinteger

Maximum number of transactions to return per page.

Min: 1 Max: 10,000

sortDirection'asc' | 'desc'

Sort order of the results based on the timestamp field.

Headers

x-publisher-tokenstring required

Publisher token.

Response

Successfully retrieved transactions.

totalCountinteger

Total number of transactions matching the query.

nextCursorstring

Cursor pointing to the next page of results.

nextPageQuerystring

Fully-formed query string for fetching the next page of results.

Example response

{
  "nextCursor": "eyJpZCI6IjY0YzkidQ==",
  "nextPageQuery": "?startDate=2025-05-26T00:00:00Z&endDate=2025-07-24T23:59:59Z&limit=100&sortDirection=asc&cursor=eyJpZCI6IjY0YzkidQ==",
  "results": [
    {
      "orderId": "ac_order_98f3pb4",
      "purchaseId": "pr-1234-5678-9012-34567",
      "publisherTransactionId": "ca-9832-custom",
      "timestamp": "2025-05-26T14:30:00.000Z",
      "customerDetails": {
        "id": "jane-doe",
        "email": "jan.doe@example.com"
      },
      "geolocation": {
        "countryCode2": "US",
        "region": "CA",
        "ipAddress": "192.168.1.10",
        "zipCode": "94107"
      },
      "offerDetails": {
        "offerId": "offer_7890",
        "offerName": "Gem Pack",
        "type": "Bundle",
        "products": [
          {
            "name": "Gems",
            "sku": "gems_100",
            "quantity": 100
          }
        ]
      },
      "transactionDetails": {
        "id": "64c9f6a12e1b4a3d9c7a5f1ef",
        "type": "paid",
        "amount": 999,
        "amountUsd": 999,
        "totalTaxAmount": 90,
        "totalTaxAmountUsd": 90,
        "currencyExchangeCostUsd": 15,
        "transactionFeeUsd": 35,
        "publisherNetAmountUsd": 859,
        "currencyCode": "USD",
        "currencySymbol": "$",
        "paymentMethod": "credit_card"
      }
    }
  ]
}