- 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
- Business Portal
- Business Portal Acquiring
- Partner Portal
- Subscriptions
- 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 either the Test or Production (live) environment.
- Test API endpoint: https://api.test.paysafe.com/
For example: https://api.test.paysafe.com/threedsecure/v2/accounts/account_id - Production API endpoint: https://api.paysafe.com/
For example: https://api.paysafe.com/threedsecure/v2/accounts/account_id
API Endpoint Patterns
The API endpoints typically conform to the pattern of the example below:
https://api.test.paysafe.com/threedsecure/v2/accounts/account_id/authentications
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 transaction. |
| threedsecure | Replace with the API you are using. The available values are:
|
| v2 | This is the version of the API. |
| account_id | Replace with your unique merchant account number. Merchants can have multiple accounts, for example to process payments in different currencies. All accounts can be set up to use the same API key. |
Refer to the table below for further examples.
| API Request | Used To | Endpoint Pattern |
|---|---|---|
| Authentication | Authenticate a card with 3D Secure 2. | POST/threedsecure/v2/accounts/account_id/authentications |
| Get Authentication | Look up an authentication request. | GET/threedsecure/v2/accounts/account_id/authentications/authentication_id |
- In the above examples replace account_id with your unique merchant account number and replace id with the unique ID of the original transaction.
- Some API endpoints include multiple parameters. For example, to look up an authentication request, both account_id and authentication_id must be included.