Before You Start
This guide is for developers who want to integrate with the Paysafe Subscriptions API to schedule recurring payments for consumers, in conjunction with the following Paysafe APIs:
- Customer Vault API – Create and securely store payment tokens for the consumer's credit card and/or bank account information – the payment tokens will be used in a subscription's recurring payments.
- Card Payments API – Subscriptions that contain a payment token from a consumer's credit card will process the recurring payments through the Card Payments API, using the accountId (merchant account) specified in the subscription.
- Direct Debit API – Subscriptions that contain a payment token from a consumer's bank account will process the recurring payments through the Direct Debit API, using the accountId (merchant account) specified in the subscription.
- Before you start integrating, be sure to apply for the accounts you need to test your integration.
- Make sure you are integrated with Paysafe's Card Payments API or Direct Debit API, or both.
- Make sure you have registered your consumer in the Paysafe Customer Vault API, which is where you will get the paymentToken to use in the request to create a subscription.
- This guide assumes that you have developer-level knowledge of REST-based APIs, which you use to connect to the Paysafe platform.
Using the REST API
- Test API calls can be sent to the Paysafe platform using cURL. Alternatively, you can use a graphical browser-based REST client tool such as Postman or the Advanced Rest Client. An example is provided in the section on REST architecture.
- All API requests must be made over HTTPS. Calls made over plain HTTP will fail.
- API requests without authentication will fail.
- The Payment Card Industry (PCI) imposes strict regulations related to the handling and storage of customer payment method details by merchants and service providers, as part of the industry's Data Security Standards (DSS) for online payments. Merchants accepting online payments must conform to the PCI DSS. For more information, see PCI DSS Compliance.
- Use of the Direct Debit API requires you to collect sensitive customer information, such as the customer's bank account details, on your e-commerce website and send these to Paysafe with your API request. Your systems will need to be able to collect these details securely.