Recurring Payments — Overview
Introduction
Recurring Payments is an essential feature of the Payments API that allows you to implement recurring payments through the card vault. This feature securely stores consumers’ card data and is fundamental to implement subscriptions, automatic payments, and improve the user experience by avoiding the need to enter card data on every transaction.
Benefits of recurring payments
- Security: Card data is stored securely and encrypted
- Convenience: Enables recurring payments without re-entering data
- Compliance: Meets payment industry security standards
- Flexibility: Supports different card brands
Available operations
| Operation | Description | Endpoint |
|---|---|---|
| Store card | Stores card data in the vault for recurring payments | POST /v1/vaults/cards |
| Authentication | Generate an access token for the Recurrence API | POST /authorize/clientcredentials |
| Plans | Create and manage recurrence plans | POST /v1/recurrences/plans |
| Subscriptions | Create and manage subscriptions | POST /v1/recurrences/subscriptions |
| Billings | Query and cancel recurring payments | GET /v1/recurrence/billing |
Usage flow
- Authentication: Obtain an access token via the authentication API
- Tokenization: Tokenize the card number first
- Storage: Store the tokenized data in the vault
- Plan creation: Create a recurrence plan with the desired settings
- Subscription creation: Associate the vault with the plan to create a subscription
- Recurring payments: The system automatically processes payments according to the plan
Security
- All data is encrypted at rest
- Access is restricted via API authentication
- PCI DSS compliance
- Full audit of all operations
For more details on each operation, navigate through the sections available in this documentation.