Skip to main content
Version: v1

HCP Registration & API Authentication

Convenient Checkout API service is available through the HealthSafePay Cloud Platform (HCP), enabling secure RESTful access to CCG APIs for merchants, partners, and internal business users.

Steps to Register and Authenticate with HCP​

  1. Visit the HCP site

    • Review onboarding instructions for subscribing to the Convenient Checkout APIs within the Financial package (Commerce SubPackage).

  2. Register Your Application

    • Complete the application registration process in HCP.
    • Request access to CCG APIs with the required scopes.

  3. Configure API Access

    • After approval, your application will have access to all APIs in the Commerce sub-package.
    • Use the provided client credentials (client ID/secret) for authentication.

  4. Explore the HCP Console

    • Visit the HCP console to manage registered clients and resources.
    • Review API usage, keys, and access logs.

  5. Browse the API Catalog

    • Refer to the API Catalog for a list of available APIs and documentation.

Resource Groups​

  • STAGE: rg-common-checkout-nonprod
    for accessing/integrating non prod environments
  • PROD: rg-common-checkout-prod
    Use for live/production integrations.

Best Practices​

  • Always use secure storage for client credentials and API keys.
  • Rotate secrets regularly and follow your organization's security policies.
  • Review API Access Levels to ensure least-privilege access.
  • Monitor API usage and set up alerts for unusual activity.

Troubleshooting & Support​

  • If you encounter issues with registration or authentication, consult the HCP Team.
  • For further assistance, contact your HCP administrator or the support team.