API Endpoints

The API endpoint (URI or URL) must point to the Production (live) environment.

  • Production API endpoint: https://api.paysafe.com/
    For example: https://api.paysafe.com/reporting/v1/monitor/
  • Test API endpoint: https://api.test.paysafe.com/
    For example: https://api.test.paysafe.com/reporting/v1/monitor/

Resource Patterns

Analytics Reports

The following table describes the major request types supported by the Reporting API for Analytics Reports.

API Request Endpoint Pattern
Report Subscription Controller

Subscribe to a report on on-demand basis

POST/reporting/v1/report-request

Get the subscription details

GET/reporting/v1/report-request/{requestId}

You have to use the unique API key to retrieve or generate a report.

Authorization and Go Live

Upon completion of the integration, partners must notify the account manager in order to authorize or activate the API key to access reports. This is a one-time activity for authorizing the merchant to access Reports API.

Use Cases

Use Case # 1: Configure the columns in a report

You can configure specific columns to appear on the report with data.

Request

{
            "columns": [
                "PARTNER_NAME",
                "PARTNER_ID",
				"PRODUCT_NAME",
                "PRODUCT_ID"
        ],
        "interval": {
            "type": "PREVIOUS_WEEK"
        },
        "reportType": "onboarding_report",
        "timeZone": "EST",
        "webhook": {
            "url": "https://webhook.site/26c2d4c8-e036-4a54-9024-5497482f62e9"
        }
    }

Response

{
        "reportType": "onboarding_report",
        "timeZone": "EST",
        "columns": [
                "PARTNER_NAME",
                "PARTNER_ID",
				"PRODUCT_NAME",
                "PRODUCT_ID"
        ],
        "interval": {
            "startDate": "2021-11-22T05:00:00Z",
            "endDate": "2021-11-29T05:00:00Z"
        },
        "webhook": {
            "url": "https://webhook.site/26c2d4c8-e036-4a54-9024-5497482f62e9"
        },
        "id": "b7715045-633e-4218-a303-056f1ede5196",
        "status": "PENDING"
    }

Use Case # 2: Generate a report with minimum requirements

You can generate a specific report with minimum requirements such as interval, webhook url, timezone, and report type

Request

{
    "interval": {
        "type": "PREVIOUS_WEEK"
    },
    "reportType": "onboarding_report",
    "timeZone": "EST",
    "webhook": {
        "url": "https://webhook.site/26c2d4c8-e036-4a54-9024-5497482f62e9"
    }
}

Response

{
    "reportType": "onboarding_report",
    "timeZone": "EST",
    "interval": {
        "startDate": "2021-11-22T05:00:00Z",
        "endDate": "2021-11-29T05:00:00Z"
    },
    "webhook": {
        "url": "https://webhook.site/26c2d4c8-e036-4a54-9024-5497482f62e9"
    },
    "id": "6dfb96ab-e279-4f81-aae7-5c40b833d5e3",
    "status": "PENDING"
}

Use Case # 3: Generate a report with empty intervals

An error occurs when you try to generate a report with empty intervals

Request

{
    "columns": [
        "AuthDate",
        "DBA"
    ],
    "interval": {
 |   },
    "reportType": "onboarding_report",
    "timeZone": "EST",
    "webhook": {
        "url": "https://webhook.site/26c2d4c8-e036-4a54-9024-5497482f62e9"
    }
}

Response

{
    "error": {
        "code": "5068",
        "message": "Field error(s)",
        "details": [
            "Provide either interval.type or interval.startDate & interval.endDate"
        ]
    }
}

Did you find this page useful?