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/alternatepayments/v1/accounts/account_id/payments - Production API endpoint: https://api.paysafe.com/
For example: https://api.paysafe.com/alternatepayments/v1/accounts/account_id/payments
API Endpoint Patterns
The API endpoints typically conform to the pattern of the example below:
https://api.test.paysafe.com/alternatepayments/v1/accounts/account_id/payments
where account_id is the account number for a specific payment method/currency combination.
Because the Test environment is completely isolated, any changes you perform on your Test accounts configuration may have to be repeated in your Production account. Your production account IDs will also differ from your test account IDs.
You can enable only one alternate payments method per account associated with your merchant account. Each of these accounts must have an associated settlement currency. If you need to use the same alternate payments method with multiple settlement currencies (where available) then you will need a separate account configured for each currency/payment method combination.
Resource Patterns
The following table lists the major request types supported by the Alternate Payments API.
| API Request | Endpoint Pattern |
|---|---|
| Process a Payment | POST/accounts/account_id/payments |
| Void a Payment | POST/accounts/account_id/payments/payment_id/voidauths |
| Look Up a Payment Using a Payment ID | GET/accounts/account_id/payments/payment_id |
| List Payments Using a merchantRefNum | GET/accounts/account_id/payments/?merchantRefNum=merchantRefNum |
| Refund a Payment | POST/accounts/account_id/payments/payment_id/refunds |
| Process a Settlement | POST/accounts/account_id/payments/payment_id/settlements |
| Look Up a Settlement Using a Settlement ID | GET/accounts/account_id/settlements/settlement_id |
| List Settlements Using a merchantRefNum | GET/accounts/account_id/settlements/?merchantRefNum=merchantRefNum |
| Refund a Settlement | POST/accounts/account_id/settlements/settlement_id/refunds |
| List Returns | GET/accounts/account_id/settlements/settlement_id/returns |
| Look Up a Return Using a Return ID | GET/accounts/account_id/returns/return_id |
| List Return Reversals | GET/accounts/account_id/returns/return_id/returnreversals |
| Look Up a Return Reversal Using a Return Reversal ID | GET/accounts/account_id/returns/return_id/returnreversals/returnreversal_id |
| Look Up a Refund Using a Refund ID | GET/accounts/account_id/refunds/refund_id |
| Look up a Refund Using a merchantRefNum | GET/accounts/account_id/refunds/?merchantRefNum=merchantRefNum |
- In the above examples replace account_id with your unique merchant account number and replace, e.g., payment_id with the unique ID of the original transaction.
- Some API endpoints include multiple parameters. For example, to look up a Settlement, both account_id and settlement_id must be included.