Recurring Payments Service

The Recurring Payments Service allows you to create and manage recurring payments. It lets you maintain customer profiles, manage payment tokens, configure and schedule recurring payment plans, and forecast upcoming payment runs based on your defined schedules.

Base URLs

Environment	URL
Sandbox	https://gateway-sb.clearent.net/rest/
Production	https://gateway.clearent.net/rest/

Headers

Content-Type: application/json
Accept: application/json
AccessKey: Secret access key issued by Xplor Pay

Available endpoints

• Customers

  • GET /rest/v2/customers

  • POST /rest/v2/customers

  • GET /rest/v2/customers/{customerKey}

  • PUT /rest/v2/customers/{customerKey}

  • DELETE /rest/v2/customers/{customerKey}

• Customer Tokens

  • GET /rest/v2/customers/{customerKey}/tokens

  • POST /rest/v2/customers/{customerKey}/tokens

  • PUT /rest/v2/customers/{customerKey}/tokens

• Payment Plans

  • GET /rest/v2/payment-plans

  • POST /rest/v2/payment-plans

  • GET /rest/v2/payment-plans/{paymentPlanKey}

  • PUT /rest/v2/payment-plans/{paymentPlanKey}

  • DELETE /rest/v2/payment-plans/{planKey}

  • GET /rest/v2/payment-plans/{paymentPlanKey}/expected-runs

• Payments

  • GET /rest/v2/payments

• Forecast

  • GET /rest/v2/plan-forecast

Path Parameters

Name	Data Type	Required?	Description
customerKey	String	Required	Unique identifier for the customer
paymentPlanKey	String	Required	Unique identifier for the payment plan
planKey	String	Required	Plan identifier used to specify which plan to delete