- 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
- Alternate Payments
- Reports API
- ISV Reports
- 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
- Subaccounts
- Applications API
- Split Payouts
- Balance Transfers
- Paysafe Payments API
- Paysafe Checkout
- Paysafe JS
- Payments API
- Bad Bin API
- Reference Information
- SDKs
- Mobile SDKs
- Additional Documentation
- Resources and Support
- Shopping Carts
- Classic APIs
- Glossary
Using your API Key
API keys are used to authorize access to some API resources on the Paysafe platform.
Your API Key
Your API key should be included in most API requests to the Paysafe payment platform.
There are two API keys available
- Server-to-Server API key – This is the default API Key used by most calls. This API key is used for calls from your merchant server to Paysafe's servers.
- Single-Use Token API key – This key is used by client devices (mobile phones or from a user's browser) for a limited number of API calls.
Each API key has two forms:
- Standard form that is composed of two items: a user name and password.
- Base64 encoded form created by concatenating the user name and password separated by a colon (username:password) and encoding the result using Base64 encoding. See the authentication section for more details.
Different REST API testing tools may use different key forms. Similarly, different SDKs may need one or other of the forms.
Where to Find Your API Key
- Sign in to the Merchant Back Office and select Settings > API Key.
Your API key consists of your User name and Password - To generate a Base64-encoded version of your API key, select the View Base 64 Encoded link.
The Base64-encoded version is displayed in a pop-up window. - To copy the encoded key, click Copy.
Locating Your API Key in the Merchant Back Office
How to Include Your API Key in the API Console Window
The API Reference section provides a Console window that enables you to test API calls from a web browser.
To test using your own account credentials, paste your encoded API key over the string YOUR-BASE-64-ENCODED API key in the Authorization Header of the API Console.
Using Your API Key in the API Console