- REST APIs
- Welcome
- Card Payments
- 3D Secure 2
- Vault
- Getting Started
- Using the API
- Typical API Calls
- Verify That the Service Is Accessible
- Create a Profile for a Customer
- Add an Address to a Profile
- Add a Card to a Profile
- Add a Bank Account to a Profile
- Create an Apple Pay Single-Use Token
- Create a Google Pay Single-Use Token
- Create a Mobile Single-Use Token
- Create a Direct Debit Single-Use Token
- Process a Transaction Using a Payment Token
- API Reference
- Test and Go Live
- Direct Debit
- Apple Pay
- Google Pay
- Business Portal
- Business Portal Acquiring
- Partner Portal
- Business Portal US
- Business Portal Ecommerce
- Alternate Payments
- Platforms
- Overview
- Accounts API V1
- Getting Started
- Using the API
- Typical API Calls
- Verify That the Service Is Accessible
- Create a New Merchant
- Create a New Merchant Account
- Create a New User
- Add an Address
- Create a Business Owner
- Add a Business Owner Address
- Add a Business Owner Identity Document
- Add a Merchant Bank Account
- Accept Our Terms and Conditions
- Activate the New Merchant Account
- Validate the Bank Account
- Enable Webhooks to Receive Application Statuses
- Test and Go Live
- Accounts API V2
- Subaccounts
- Split Payouts
- Balance Transfers
- Paysafe Payments API
- Reference Information
- SDKs
- Mobile SDKs
- Additional Documentation
- Resources and Support
- Shopping Carts
- Classic APIs
- Glossary
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/
API Endpoint Patterns
The API endpoints typically conform to the pattern of the example below:
https://api.paysafe.com/reporting/v1/
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
The following table lists the major request types supported by the Reporting API.
| API Request | Endpoint Pattern |
|---|---|
| Subscribe to a Report | POST/report-configs/{reportId}/subscriptions |
| Get Subscriptions | GET /report-configs/{reportId}/subscriptions{subscriptionId} |
| Unsubscribe from a Report | DELETE /report-configs//{reportId}/subscriptions/{subscriptionId} |
| Submit a Report Request | POST /report-requests/ |
Subscribe to a Report
You use this API to subscribe to reports that you want to be delivered over HTTP endpoint (webhooks). A valid, reachable webhook endpoint should be configured and provided to Paysafe. When you subscribe to a report, a unique subscribe id is returned to you. You’ve to use this id if you chose to unsubscribe a report.
Get Subscriptions
You use this API to fetch a list of subscriptions for a report.
Unsubscribe from a report
You use this API to unsubscribe users from the subscribed reports.
Submit a Report Request
You use this API to submit a request to retrieve a report, for example, monthly charge back report. The report format will be in .CSV. Depending upon the data, the file you obtain in the response could contain a single or even multiple files. The report will contain several field and columns. For a report to be delivered, you must subscribe to it first.