- 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
- Account Management
- 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
- Split Payouts
- Balance Transfers
- Paysafe Payments API
- Reference Information
- 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/bankaccountvalidator/v1/monitor - Production API endpoint: https://api.paysafe.com/
For example: https://api.paysafe.com/bankaccountvalidator/v1/monitor
API Endpoint Patterns
The following example demonstrates the pattern of a typical API endpoint:
https://api.test.paysafe.com/bankaccountvalidator/v1/accounts/account_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. |
| account_id | Replace with your unique merchant account number, which you receive when you create your test account – the email will include the information. |
| APIrequest | Replace with the type of API request, such as verifications. |
| v1 | This is the version of the API. |
Resource Patterns
| API Request | Used To | Endpoint Pattern |
|---|---|---|
| Verifications | Initiate a bank account verification request with Paysafe. | POST/bankaccountvalidator/v1/accounts/account_id/verifications |
| Redirect | Redirect a customer so they can validate their bank account details. | GET/bankaccountvalidator/v1/redirect?sessionId={sessionId} |
| Get Verification | Look up a verification request using the ID returned in the response to the original Create a Verification request. | GET/bankaccountvalidator/v1/accounts/account_id/verifications/verification_id |