- REST APIs
- Welcome
- Cards
- 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
- 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
- Reports API
- Getting Started
- Report Types
- Report Types
- API Endpoints
- API Endpoints
- Onboarding
- Onboarding Pending
- Onboarding Holds
- Payments On Hold
- Daily Processing CC
- Daily Processing DD
- Monthly Processing CC
- Monthly Processing DD
- Daily Detailed Transaction Activity DD
- DD Returns
- Notification of Change
- Splitpay Returned DD Returns
- 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 either the Test or Production (live) environment.
- Test API endpoint: https://api.test.paysafe.com/
For example: https://api.test.paysafe.com/customeridentification/monitor - Production API endpoint: https://api.paysafe.com/
For example: https://api.paysafe.com/customeridentification/monitor
API Endpoint Patterns
The API endpoints typically conform to the pattern of the example below:
https://api.test.paysafe.com/customeridentification/v1/identityprofiles/identity_check_id/APIrequest
Replace the elements in the API endpoint example above as follows:
| Element | Usage |
|---|---|
| test | Use test for a Test transaction. Remove the word test for a live (i.e., Production) transaction. |
| identity_check_id | In this case, replace identity_check_id with the unique ID returned in the response to the original Customer Identity Check request. |
| APIrequest | Replace with the type of API request, such as rerunfailedchecks. |
| v1 | This is the version of the API. Currently all APIs are on version 1. |
Refer to the table below for further examples.
| API Request | Used To | Endpoint Pattern |
|---|---|---|
| Customer Identity Checks | Run a Customer Identity check on a customer. | POST/customeridentification/v1/identityprofiles/ |
| Rerun a Customer Identity Check | Rerun a Customer Identity check on a customer in the case where the original Customer Identity check resulted in an error. | POST/customeridentification/v1/identityprofiles/identity_check_id/rerunfailedchecks |
- In the above examples replace identity_check_id with the unique ID returned in the response to the original Customer Identity Check request.
- The examples point to the Production system.