Recurring Payments Service
The Recurring Payments Service allows you to create and manage scheduled payments using stored customer payment tokens.
The Recurring Payments Engine stores customer information such as e-mail address, billing address, first name, last name, and more. The Recurring payments services API lets you create customers and tokens to process one-time payments. You can also schedule a payment plan at various frequencies to automatically process payments according to the specified schedule.
See Authentication when you call the Recurring Payments Service API endpoints to process recurring payments for your customers.
The sections below describe how to manage scheduled payments and customers.
Payment Plans
The Payment Plans API allows you to configure and manage recurring payment schedules for customers. A payment plan defines the payment amount, frequency, and associated customer with payment method.
Customer Token
The Customer Token API allows you to securely store and manage payment methods associated with a customer.
The customer token represents the secure payment method used in recurring payment plan instead of showing raw payment data.
Use this API to:
Add a payment token for a customer
Retrieve customer tokens
Update customer tokens
Customers
The Customers API allows you to create and manage customer profiles used for recurring payments.
Use this API to:
Create a customer
Retrieve customer details
Update customer details
Delete a customer
Search customers
Forecast
The Forecast API allows you to view upcoming scheduled payments based on configured payment plans.
Payments
The Payments API allows you to retrieve payment processed records under recurring payment plans.
Last updated
Was this helpful?