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/

API Endpoint Patterns

The API endpoints typically conform to the pattern described in the example below:

https://api.paysafe.com/reporting/v1/{report-requests}/

Because the Test environment is completely isolated, any changes you perform on your Test accounts configuration may have to be repeated in your Production account. Your production account IDs will also differ from your test account IDs.

Resource Patterns

Subscriptions

The following table describes the major request types supported by the Reporting API for Subscriptions:

API Request Endpoint Pattern
Get all subscriptions on a report for a Merchant

GET/report-configs/{reportId}/subscriptions/subscriptions_id/

Subscribe to a Report

POST/report-configs/{reportId}/subscriptions

Get a List of Subscriptions

GET/report-configs/{reportId}/subscriptions/subscriptions_id/

Subscribe to a report

PUT/report-configs/subscriptions/subscriptions/subscriptionId/

Unsubscribe from a Report

DELETE/report-configs/{reportId}/subscriptions/subscription_id

Submit a Report Request

POST/report-requests/

Preferences

The following table describes the major request types supported by the Reporting API for Preferences:

API Request Endpoint Pattern
Get all preferences for a merchant

GET/report-configs/preference/subscriptions/prefernceId

Create preference for a report

POST/report-configs/preference

Get preference for a report

GET/report-configs/preference/subscriptions/prefernceId/

Update a preference for a report

PUT/report-configs/preference/subscriptions/prefernceId/

Delete a preference for a report

DELETE/report-configs/preference/subscriptions/prefernceId/

Did you find this page useful?