Quick Start

This page helps you set up recurring payments to create customers, store customers information, generate customer tokens, and schedule automated recurring payments according to your specified schedule.

About Xplor Pay Recurring Payments

The Xplor Pay Recurring Payments Engine securely stores customer information, including email address, billing address, first name, and last name.

The Recurring Payments API provides:

• Create customers and customer tokens for payment processing.

• Schedule payment plans at various frequencies.

• Automatically process payments according to the defined schedule.

Prerequisites

To leverage Xplor Pay Recurring Payments, ensure the following prerequisites are met:

✅ Active Xplor Pay account.

✅ API access key issued to you by Xplor Pay.

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

1

Create a Customer to Set Up Recurring Payments

To create a customer:

1. Use the POST method.

2. Send the customer request to the /rest/v2/customers endpoint URL with required fields.

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

2

Create a Customer Payment Token

To create a payment token for the customer:

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 a Customer.

1. Send the request to the/rest/v2/customers/{customerKey}/tokens endpoint URL with required fields.

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

3

Create a Recurring Payment Plan

To create a payment plan:

1. Use the POST method.

2. Send the request to the /rest/v2/payment-plans endpoint URL with required fields.

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

For available fields and payload structure, see the Recurring Payments Service API.