Using Paycux with On-prem Customers

Introduction

Using Paycux with On-prem Customers is part of the Paycux platform. This page explains what it does, when to reach for it, and the smallest working setup you can ship.

Everything below applies to both environments. Build and test in staging, then promote the same configuration to production without changing your code — only the API key and client ID differ.

Using a static API key for each customer’s deployment

Every API request is authenticated with a bearer token in the Authorization header. Keys are scoped to a single environment and are shown once at creation — store them in a secret manager, not in source control.

1curl -X GET 'https://api.paycux.com/v1/organizations' \
2  -H 'Authorization: Bearer $PAYCUX_API_KEY'

Allowing Paycux Traffic Through Firewalls

Allowing Paycux Traffic Through Firewalls is handled by Using Paycux with On-prem Customers rather than by your application code. Paycux exposes it through the same API surface as the rest of the platform, so the client you already configured needs no additional setup.

Configuration lives in the dashboard and is versioned per environment. Change it in staging, confirm the behaviour, then apply the same change to production.

Strategy 1: Configure Firewall Rules or ACLs

Strategy 1: Configure Firewall Rules or ACLs is handled by Using Paycux with On-prem Customers rather than by your application code. Paycux exposes it through the same API surface as the rest of the platform, so the client you already configured needs no additional setup.

Configuration lives in the dashboard and is versioned per environment. Change it in staging, confirm the behaviour, then apply the same change to production.

Strategy 2: Use ngrok for Network Traffic Management

Strategy 2: Use ngrok for Network Traffic Management is handled by Using Paycux with On-prem Customers rather than by your application code. Paycux exposes it through the same API surface as the rest of the platform, so the client you already configured needs no additional setup.

Configuration lives in the dashboard and is versioned per environment. Change it in staging, confirm the behaviour, then apply the same change to production.

Air-Gapped Environments

Air-Gapped Environments is handled by Using Paycux with On-prem Customers rather than by your application code. Paycux exposes it through the same API surface as the rest of the platform, so the client you already configured needs no additional setup.

Configuration lives in the dashboard and is versioned per environment. Change it in staging, confirm the behaviour, then apply the same change to production.