Skip to content

CX Platform Developer Documentation

Welcome to the CX Platform developer documentation. The CX Platform by Global Payments enables businesses to manage customer interactions, payments, scheduling, and communications through a unified platform. Integrate directly via the REST API or use the Java SDK for a type-safe, streamlined development experience.

Choose Your Path

  • REST API

    Integrate from any language using standard HTTP requests. Access the full power of the CX Platform with direct control over every request.

    API Overview

  • Java SDK

    Build integrations faster with a type-safe Java client. The SDK handles authentication, serialization, and error mapping for you.

    SDK Quick Start

Platform Status & SDK Version

Java SDK (Maven Central)

The production API host for live traffic will be provided to you by your CX sales representative or CX Support. The latest version of the Java SDK is available on Maven Central (us.cxgp:cx-sdk-client).

Key Capabilities

The CX Platform provides a comprehensive set of APIs for managing the customer experience lifecycle:

Capability Description
Customers Create and manage customer profiles and contact information
Statements Generate and retrieve customer billing statements
Events Subscribe to and receive platform event notifications
Forms Build and manage dynamic forms for data collection
Channels Configure communication channels for customer outreach
Scheduling Manage appointments and recurring schedules
Payment Requests Send payment requests to customers
Quotes Create and manage service quotes

Getting Started

Follow these three steps to make your first API call:

1. Get Your API Key

Contact your CX sales representative or CX Support to obtain an API key. Keys exist at two levels — Implementation, or Location — depending on your access needs. For partner onboarding, the common flow is: receive an Implementation key, generate a Location key with POST /cx/v2/apikey, create the service location, then use the Location key for day-to-day operations. See Authentication & Environments for details.

2. Choose Your Integration Path

Decide whether to use the REST API (any language, direct HTTP) or the Java SDK (Java 8+, type-safe client). Not sure? Read the API vs SDK comparison.

3. Make Your First Call

Test connectivity by retrieving the service location associated with your Location API key:

New REST integrations should use the explicit /cx/v2/ path prefix. See API Versioning for details.

=== "REST API (cURL)"

    ```bash
    curl -X GET "https://cx2-main.pit.cxgp.us/cx/v2/serviceLocation" \
      -H "CX-API-KEY: YOUR_API_KEY"
    ```

=== "Java SDK"

    ```java
    import com.gp.cx.sdk.api.ServiceLocationApi;
    import com.gp.cx.sdk.client.CxSdkClient;
    import com.gp.cx.sdk.model.ServiceLocationDetails;

    CxSdkClient client = new CxSdkClient.Builder()
        .apiKey("YOUR_API_KEY")
        .baseUrl("https://cx2-main.pit.cxgp.us")
        .build();

    ServiceLocationApi serviceLocationApi = client.getServiceLocationApi();
    ServiceLocationDetails location = serviceLocationApi.getServiceLocation();
    ```

Interactive Explorer

Use the built-in Swagger UI to explore and test API endpoints directly in your browser — no code required.