Skip to content
PQSafe PQSafe AgentPay

Installation

Requirements

  • Node.js ≥ 18.0.0 (for TypeScript/JavaScript)
  • Python ≥ 3.10 (for Python SDK)
  • A PQSafe account — sign up at pqsafe.xyz

Install

Terminal window
npm install @pqsafe/agent-pay

Configure your environment

Create a .env file at your project root:

# Required: your PQSafe issuer API key (from pqsafe.xyz/dashboard)
PQSAFE_ISSUER_KEY=pk_live_...


# Optional: default rail to use when not specified in envelope
PQSAFE_DEFAULT_RAIL=airwallex


# Optional: enable verbose payment logging
PQSAFE_LOG_LEVEL=info

Verify installation

import { getAgentPayConfig } from '@pqsafe/agent-pay'


console.log(getAgentPayConfig())
// { version: '0.x.x', defaultRail: 'airwallex', ... }

TypeScript setup

The SDK ships with full TypeScript types. No @types/ package needed.

Recommended tsconfig.json:

{
  "compilerOptions": {
    "target": "ES2022",
    "module": "ESNext",
    "moduleResolution": "Bundler",
    "strict": true,
    "lib": ["ES2022"]
  }
}

Next step

→ Quickstart — send your first payment in 5 minutes