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/customervault/monitor - Production API endpoint: https://api.paysafe.com/
For example: https://api.paysafe.com/customervault/monitor
API Endpoint Patterns
The API endpoints typically conform to the pattern of the example below:
https://api.test.paysafe.com/customervault/v1/profiles
Replace the following elements in the API endpoint example above with details as follows:
| Element | Usage |
|---|---|
test | Use test for a test transaction. Remove test for a live transaction. |
| customervault | Use for Customer Vault API requests. |
| v1 | This is the version of the API. Currently all APIs are on version 1. |
| profiles | Use profiles when working with customer profiles; substitute the paths from the table below for other uses. |
Refer to the table below for further examples.
| API | Used for | API Endpoint |
|---|---|---|
| Create a Profile | Creating a new customer profile. | POST/customervault/v1/profiles |
| Create an Address | Creating and linking a customer address to an existing profile. A profile can have multiple linked addresses. | POST/customervault/v1/profiles/id/addresses |
| Create a Card | Creating and linking a card to an existing profile. A profile can have multiple linked cards. | POST/customervault/v1/profiles/id/cards |
| Create a Bank Account | Creating and linking a bank account (in this case, an ACH bank account) to an existing profile. A profile can have multiple linked bank accounts. | POST/customervault/v1/profiles/id/achbankaccounts |
| Create a Mobile Device Single-use Token | Create a single-use token for use with mobile phone payments. Single-use tokens are valid for only 15 minutes and are not consumed by verification. | POST/customervault/v1/singleusetokens |
| Create an ApplePay Single-use Token | Create a single-use token for mobile phone payments with Apple Pay. Single-use tokens are valid for only 15 minutes and are not consumed by verification. | POST/customervault/v1/applepaysingleusetokens |
| Authorization with a Payment Token | Process the payment using a token linked to a profile and card. Note that this uses the Card Payments API. | POST/cardpayments/v1/accounts/account_id/auths |
- In the above examples replace id with the unique customer ID returned when setting up the customer profile.
- Some API endpoints include multiple parameters. For example, an address lookup request requires a profile_id and an address_id.
We recommend that customers using the following API endpoints migrate to the Paysafe API endpoints above:
- Test – https://api.test.netbanx.com
- Production – https://api.netbanx.com