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/cardpayments/monitor - Production API endpoint: https://api.paysafe.com/
For example: https://api.paysafe.com/cardpayments/monitor
API Endpoint Patterns
The API endpoints typically conform to the pattern of the example below:
https://api.test.paysafe.com/cardpayments/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. |
| cardpayments | Replace with the API you are using. The available values are:
|
| account_id | Replace with your unique merchant account number, which you receive when you create your test account, the email will include the information. Alternatively, you can log in to the merchant back-office to see a list of your accounts and associated account IDs. 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. |
| APIrequest | Replace with the type of API request, such as verifications, authorizations, or settlements. |
| v1* | This is the version of the API. * Currently all APIs, with the exception of 3D Secure 2, are on version 1. See the 3D Secure 2 API endpoint example for more details. |
Refer to the table below for further examples.
| API Request | Used To | Endpoint Pattern |
|---|---|---|
Authorizations | Authorize a payment on a card. The amount authorized is reserved on the customer's card so that it cannot be used, but not deducted from the customer's account. | POST/cardpayments/v1/accounts/account_id/auths |
| Verifications | Verify that a card is a valid card. An authorization for a zero amount (zero auth) is obtained. | POST/cardpayments/v1/accounts/account_id/verifications |
Void Authorization (Also known as Reverse Authorization) | Void (Reverse) an authorization on a card. Any reserved funds are released on the customer's account. | POST/cardpayments/v1/accounts/account_id/auths/id/voidauths |
| Settlements | Capture an amount that was previously authorized on a customer’s credit or debit card. You can capture all or part of an existing authorization. Funds will be settled to your account with the next Paysafe batch run. | POST/cardpayments/v1/accounts/account_id/auths/id/settlements |
| Cancel a Settlement | Cancels a pending settlement. Note that this must be done prior to Paysafe's batching, which is typically at the end of day. | PUT/cardpayments/v1/accounts/account_id/settlements/id |
Refunds | Refund back to a customer’s credit or debit card an amount that has previously been settled. Refunds can be for a full or partial amount of the original transaction. | POST/cardpayments/v1/accounts/account_id/settlements/id/refunds |
Original Credits | Issue credits to cardholders without requiring a previous authorization or settlement. Can be used for payouts to customers. | POST/cardpayments/v1/accounts/account_id/originalcredits |
Standalone Credits | Issue credits to cardholders without requiring a previous authorization or settlement. Can be used for payouts to customers. | POST/cardpayments/v1/accounts/account_id/standalonecredits |
- 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, for a void (authorization reversal) request, both account_id and id must be included.
- The examples point to the production system.
Legacy API Endpoints
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