For the complete documentation index, see llms.txt. This page is also available as Markdown.

Recurring Payments

The Recurring Payments engine securely stores customer information, including e-mail address, billing address, first name, and last name.

The Recurring Payments Service allows you to:

  • Create customers and customer tokens for future payment process.

  • Schedule payment plans at various frequencies.

  • Automatically process payments according to the defined schedule.

Prerequisites

To process recurring payments, ensure you have following:

✅ An active Xplor Pay account.

Contact to Xplor Pay to create an active account.

✅ API access key issued to you by Xplor Pay.

Visit Let's Get Started - Xplor Pay to get API access key.

1

Create customer

To create a customer:

  1. Use the POST method.

  2. Send the customer request to the Customer endpoint with required fields.

The success response returns the customer key in the customer-key field.

2

Create customer token

To create a customer token:

  1. Use the POST method.

  2. Include the customer-key in the request header for authentication.

See the customer-key field in the successful response from the create customer endpoint.

  1. Send the request to the Customer Token URL with required fields.

The success response returns the customer payment token and card details.

3

Create payment plan

To create a payment plan:

  1. Use the POST method.

  2. Send the request to the Payment Plans endpoint URL with required fields.

The success response returns the plan-key for specified date range payment frequency that confirm the payment plan is created and activated for the customer.

See Recurring Payments Service for more information.

Last updated

Was this helpful?