Skip to content

setup.md

Latest commit

 

History

History
521 lines (376 loc) · 13.6 KB

setup.md

File metadata and controls

521 lines (376 loc) · 13.6 KB
Raw

UCS (Unified Connector Service) Setup Guide

This guide helps you set up and run UCS locally for testing payment integrations with various payment processors.

Overview

UCS is a stateless payments abstraction service built using gRPC that provides a unified contract for integrating with multiple payment processors. It supports the complete payment lifecycle: authorization, capture, refunds, status checks, and chargebacks.

Prerequisites

System Requirements

  • Rust (latest stable version)
  • Protocol Buffers compiler
  • PostgreSQL development libraries (will be removed in future)

Install Dependencies

macOS

# Install Rust
curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
source ~/.cargo/env

# Install dependencies via Homebrew
brew install protobuf postgresql

Ubuntu/Debian

# Install Rust
curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
source ~/.cargo/env

# Install dependencies
sudo apt-get update
sudo apt-get install build-essential protobuf-compiler pkg-config libssl-dev

Setup Instructions

1. Clone the Repository

git clone https://github.com/juspay/connector-service.git
cd connector-service

2. Build the Project

# Build the project
cargo build

3. Run the UCS Server

Start the gRPC server (uses config/development.toml by default):

cargo run

Optional: Custom Configuration

Edit config/development.toml to disable optional features:

[log.kafka]
enabled = false  # Disable logging/tracing to Kafka topic as subscriber for local testing

[events]
enabled = false  # Disable audit events to Kafka topic for local testing

Then run with your custom config:

cargo run

The server will start on http://localhost:8000 by default.

4. Install grpcurl (for testing)

macOS Installation

brew install grpcurl

Ubuntu Installation

Install grpcurl:

# Detect architecture and download appropriate version
ARCH=$(uname -m)
case $ARCH in
  x86_64) GRPC_ARCH="linux_x86_64" ;;
  aarch64) GRPC_ARCH="linux_arm64" ;;
  *) echo "Unsupported architecture: $ARCH"; exit 1 ;;
esac

# Download and install grpcurl
curl -L "https://github.com/fullstorydev/grpcurl/releases/download/v1.9.3/grpcurl_1.9.3_${GRPC_ARCH}.tar.gz" -o grpcurl.tar.gz
tar -xzf grpcurl.tar.gz
sudo mv grpcurl /usr/local/bin/
rm grpcurl.tar.gz

# Verify installation
grpcurl --version

5. Verify Setup

Check if the server is running:

gRPC Health Check

grpcurl -plaintext localhost:8000 grpc.health.v1.Health/Check

Expected response:

{
  "status": "SERVING"
}

This confirms the gRPC server is running and ready to accept requests.

Payment Testing

Test a payment authorization with automatic capture:

grpcurl -plaintext \
  -H "x-connector: braintree" \
  -H "x-auth: signature-key" \
  -H "x-api-key: your_public_key" \
  -H "x-key1: your_private_key" \
  -H "x-merchant-id: your_merchant_id" \
  -H "x-api-secret: your_api_secret" \
  -H "x-reference-id: test_ref_123" \
  -d '{
    "request_ref_id": {
      "id": "ref_000987654321"
    },
    "amount": 6540,
    "minor_amount": 6540,
    "currency": "USD",
    "capture_method": "AUTOMATIC",
    "auth_type": "NO_THREE_DS",
    "payment_method": {
      "card": {
        "credit": {
          "card_number": { "value": "4242424242424242"},
          "card_cvc": {"value": "123"},
          "card_exp_month": {"value": "10"},
          "card_exp_year": {"value": "2025" },
          "card_network":  "VISA" 
        }
      }
    },
    "address": {},
    "connector_customer_id": "customer123",
    "return_url": "https://google.com",
    "webhook_url": "https://google.com",
    "order_category": "pay",
    "enrolled_for_3ds": false,
    "request_incremental_authorization": false,
    "metadata": {
      "udf1": "value1",
      "new_customer": "true",
      "login_date": "2019-09-10T10:11:12Z",
      "description": "Test payment from setup guide",
      "merchant_account_id": "your_merchant_account"
    }
  }' \
  localhost:8000 ucs.v2.PaymentService/Authorize

Expected Success Response:

{
  "transactionId": {
    "id": "dHJhbnNhY3Rpb25fOGs4ZXRjMzU"
  },
  "status": "CHARGED",
  "statusCode": 200,
  "rawConnectorResponse": {
    "value": "{\"data\":{\"chargeCreditCard\":{\"transaction\":{\"id\":\"dHJhbnNhY3Rpb25fOGs4ZXRjMzU\",\"legacyId\":\"8k8etc35\",\"amount\":{\"value\":\"65.40\",\"currencyCode\":\"USD\"},\"status\":\"SUBMITTED_FOR_SETTLEMENT\"}}}}"
  },
  "state": {
    "connectorCustomerId": "customer123"
  }
}

⚠️ Security Notes:

  • Replace all placeholder values (your_*) with your actual Braintree credentials
  • Use test/sandbox credentials only - never use production credentials for testing
  • The card number 4242424242424242 is a test card number

Supported Operations

UCS supports the following operations across multiple payment processors:

  1. Payment Authorization - Create and authorize payments
  2. Payment Capture - Capture authorized payments
  3. Payment Void - Cancel authorized payments
  4. Refunds - Full and partial refunds
  5. Payment Status - Retrieve payment status
  6. Setup Mandates - For recurring payments
  7. Repeat Payments - Process subsequent payments

Container Deployment

Docker / OrbStack Setup

Building the Image

docker build -f Dockerfile -t ucs:latest .

Running the Container

# Run with port mapping (gRPC on 8000, metrics on 8080)
docker run --rm -p 8000:8000 -p 8080:8080 ucs:latest

Configuration Options

Default: Uses development.toml configuration (Kafka/events disabled, test URLs)

Custom Environment: Override with environment variable:

# Use sandbox configuration (config/sandbox.toml)
docker run --rm -p 8000:8000 -p 8080:8080 \
  -e CS__COMMON__ENVIRONMENT=sandbox \
  ucs:latest

# Use production configuration (config/production.toml)
docker run --rm -p 8000:8000 -p 8080:8080 \
  -e CS__COMMON__ENVIRONMENT=production \
  ucs:latest

Testing Docker Container

# Health check
grpcurl -plaintext localhost:8000 grpc.health.v1.Health/Check


### Podman Setup

**Memory Requirements:** 12GB minimum for successful build.

```bash
# Configure memory (one-time setup)
podman machine set --memory 12288

# Use same commands as Docker
podman build -f Dockerfile -t ucs:latest .
podman run --rm -p 8000:8000 -p 8080:8080 ucs:latest

Configuration Files Available:

  • development.toml (default) - Local testing
  • sandbox.toml - Test URLs
  • production.toml - Production URLs

Troubleshooting

Common Issues

1. Connection Refused

Error: connection refused when connecting to UCS

Solution: Ensure the gRPC server is running on the correct port (8000 by default)

2. gRPC Status 404

Error: grpc-status header missing, mapped from HTTP status code 404

Solution:

  • Verify the server URL format: http://localhost:8000 (not https)
  • Ensure you're connecting to the gRPC port (8000), not the metrics port (8080)

3. Build Errors

Error: Compilation or build failures

Solution:

# Clean and rebuild
cargo clean
cargo build

# Update dependencies
cargo update

4. Missing Dependencies

Error: protoc not found or linking errors

Solution: Ensure all system dependencies are installed according to the Prerequisites section

Logs and Debugging

Enable detailed logging by setting the log level in your configuration:

[log.console]
enabled = true
level = "DEBUG"
log_format = "default"

Running Connector Integration Tests

UCS includes a full connector integration test suite driven by test-prism. The suite covers payment flows (authorize, capture, void, refund, etc.) across all supported connectors and optionally includes Google Pay / Apple Pay scenarios.

One-time setup

Run the setup script once before running any connector tests:

make setup-connector-tests

This will:

  1. Install Node.js dependencies for the browser automation engine
  2. Download Playwright browser binaries (Chromium + WebKit)
  3. Install grpcurl if not already present
  4. Deploy Google Pay token-generator pages to Netlify (optional — see below)
  5. Verify your credentials file is present
  6. Install the test-prism launcher to your PATH

Google Pay / Apple Pay setup (optional)

Google Pay tests require a static HTML page hosted on HTTPS (Google's pay.js refuses to load from localhost). The setup script handles this automatically — no manual steps needed.

When the setup script reaches the Netlify step it will:

  1. Print a one-time authorization URL in the terminal
  2. You open that URL in your browser and click "Authorize" — one click, no forms if you are already logged in to netlify.com
  3. The script detects authorization automatically and continues
  4. A Netlify site is created, the pages are deployed, and the URL is saved to .env.connector-tests — all future runs skip this step entirely
[setup] Netlify login required for Google Pay test setup.

  Open this URL in your browser to authorize (one click):

    https://app.netlify.com/authorize?response_type=ticket&ticket=xxxx

  Waiting for authorization...........
[setup] Netlify authorization successful.
[setup] Netlify site created: ucs-gpay-myhostname-1234567890
[setup] Netlify deploy successful: https://ucs-gpay-xxx.netlify.app/gpay/gpay-token-gen.html

If you already have NETLIFY_AUTH_TOKEN set, the browser step is skipped entirely and the deploy runs fully headlessly — useful for CI/CD.

To skip Google Pay tests entirely (no Netlify account needed):

SKIP_NETLIFY_DEPLOY=1 make setup-connector-tests

For full details on the Google Pay flow, see browser-automation-engine/gpay/README.md.

Running tests

# Run all connector tests
test-prism

# Run tests for a specific connector
test-prism --connector stripe

# Run a specific scenario
test-prism --connector stripe --suite authorize --scenario no3ds_auto_capture_credit_card

# Interactive wizard
test-prism --interactive

Running Payment Flow Tests

UCS includes comprehensive integration tests for payment processors with centralized credential management.

Test Credential Configuration

UCS tests require actual payment processor credentials to run successfully. At runtime, tests load credentials from creds.json in the repo root. A starter template is kept at .github/test/template_creds.json.

Setting Up Your Credentials

  1. Copy the template into the runtime location:

    cp .github/test/template_creds.json creds.json

  2. Replace placeholder values with real credentials:

    Edit creds.json and replace the test_* placeholder values with your actual sandbox/test credentials from each payment processor.

    Example for Authorize.Net:

    {
  "authorizedotnet": { //connector name
    "connector_account_details": {
      "auth_type": "BodyKey", // or HeaderKey, SignatureKey, etc.
      "api_key": "your_actual_api_login_id",
      "key1": "your_actual_transaction_key"
    },
   "metadata": {
     "additional_field": "value_if_needed"
   }
  }
}

Supported Authentication Types

  • TemporaryAuth: Temporary authentication
  • HeaderKey: Simple API key in headers
  • BodyKey: API key + transaction key in body
  • SignatureKey: API key + secret + additional key
  • MultiAuthKey: Multiple authentication keys (api_key, key1, api_secret, key2)
  • CurrencyAuthKey: Complex currency-based authentication
  • CertificateAuth: Certificate and private key authentication
  • NoKey: No authentication required

Running Tests

  1. Install nextest

  2. Run all tests for a connector

    cargo nextest run --test authorizedotnet_payment_flows_test

  3. Run a specific test within the test file.

    cargo nextest run --test authorizedotnet_payment_flows_test test_payment_authorization_auto_capture

Note: Tests in the beta_tests/ directories are work in progress and may not be fully functional. These tests are under development and should not be used for production validation.

Development Commands (Optional)

UCS includes a Makefile with convenient development commands:

# Format code (requires nightly Rust)
make fmt

# Run checks
make check

# Run linting
make clippy

# Run tests
make test

# Run all checks
make all

Integration

gRPC Client SDKs

UCS provides client SDKs for multiple programming languages in the sdk/ directory:

  • Node.js: sdk/node-grpc-client/
  • Python: sdk/python-grpc-client/
  • Rust: sdk/rust-grpc-client/

Each SDK includes README files with specific integration instructions.

Example Implementations

The examples/ directory contains sample implementations:

  • CLI: examples/example-cli/ - Command-line interface
  • JavaScript: examples/example-js/ - Node.js example
  • Python: examples/example-py/ - Python example
  • Rust: examples/example-rs/ - Rust example

Notes

PostgreSQL Dependency

Currently, PostgreSQL development libraries are required for compilation due to transitive dependencies from the hyperswitch_masking crate. Since UCS is a stateless service that doesn't use a database, this dependency will likely be removed in future versions.

Platform Differences

Requirements may vary by platform depending on available system libraries. The dependencies listed above represent the verified minimal requirements for successful compilation and execution.