API Endpoints
The API endpoint (URI or URL) must point to either the Test or the Production (live) environment.
- Test API endpoint: https://api.test.paysafe.com/
For example: https://api.test.paysafe.com/accountmanagement/v1/merchants - Production API endpoint: https://api.paysafe.com/
For example: https://api.paysafe.com/accountmanagement/v1/merchants
API Endpoint Patterns
The API endpoints typically conform to the pattern of the following example:
https://api.test.paysafe.com/accountmanagement/v1/merchants/merchant_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 transaction. |
| merchant_id | Replace with your unique merchant ID, which you received in the response when you first created a merchant to board on your platform. |
| APIrequest | Replace with the type of API request, such as merchants, merchant accounts, and business owners. |
| 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 |
|---|---|---|
Merchants | Create a merchant entity. Once the merchant is created, you can add more objects to it, such as a merchant account, a business owner of that account, addresses, and bank account information. | POST/accountmanagement/v1/merchants |
| Merchant Accounts | Add one or more merchant accounts to the merchant entity. | POST/accountmanagement/v1/merchants/merchant_id/accounts |
Users | Add a user to a merchant account. The user will be able to sign in to the Paysafe Merchant Back Office for that account. | POST/accountmanagement/v1/accounts/account_id/users |
Merchant Account Addresses | Add an address for the merchant account. | POST/accountmanagement/v1/accounts/account_id/addresses |
| Business Owners | Add a business owner for each merchant account you create. | POST/accountmanagement/v1/accounts/account_id/businessowners |
| Business Owner Current Addresses | Add an address for the business owner. In some cases, both a current and a previous address will be required. | POST/accountmanagement/v1/businessowners/businessowner_id/currentaddresses |
| Business Owner Previous Addresses | Add a previous address for the business owner, where required. | POST/accountmanagement/v1/businessowners/businessowner_id/previousaddresses |
Business Owner ID | Add an identification document to each business owner. The type of ID required will depend on the jurisdiction of the business owner. For example, if the business owner is Canadian, you can optionally add a Canadian Driving License as the ID. | POST/accountmanagement/v1/businessowners/businessowner_id/canadiandrivinglicenses |
Merchant Bank Account | Add a bank account to the merchant account you create. The type of bank account required will depend on the jurisdiction of the merchant account. For example, for a Canadian merchant account, you must add a Canadian (EFT) bank account. | POST/accountmanagement/v1/accounts/account_id/eftbankaccounts |
| Terms and Conditions | The merchant accepts Paysafe's Terms and Conditions, which is required before the merchant account can be activated. | POST/accountmanagement/v1/accounts/account_id/termsandconditions |
| Merchant Account Activation | Activate the merchant account so that the merchant can begin processing payments with Paysafe. | POST/accountmanagement/v1/accounts/account_id/activation |
| Microdeposit | In some jurisdictions, you can validate the details of an ACH or EFT bank account using a small deposit made by Paysafe into that bank account. | POST/accountmanagement/v1/bank_scheme/bank_account_id/microdeposits |
| Balance Transfers | Transfer balances between linked merchant accounts, both credits and debits. | POST/accountmanagement/v1/accounts/account_id/credits POST/accountmanagement/v1/accounts/account_id/debits |
In the above examples, replace variable instances like account_id, businessowner_id, and merchant_id with the unique ID returned by Paysafe in the responses to their respective creation requests.