Getting Started with Paygrid

Integrate your financial institution with the Paygrid clearing network in minutes

Quick Setup (5 minutes)
Follow these steps to start integrating
1

Get Your Invitation Code

Receive your unique invitation code from the Paygrid team

2

Register Your Institution

Complete onboarding at institution.paygrid.network

3

Create API Keys

Generate scoped API keys from your institution dashboard

4

Start Integrating

Use our TypeScript SDK or REST APIs to submit your first payment

Installation

npm install @paygrid/sdk

Authentication

Create an API Key
All API requests require authentication
  1. Sign in to your institution dashboard
  2. Navigate to Settings → API Keys
  3. Click "Create API Key"
  4. Select scopes: discovery:read, accord:write
  5. Copy and securely store your API key (shown only once)

Important: API keys are shown only once. Store them securely in your environment variables.

Your First Payment

Submit a Payment
Complete code example with TypeScript SDK
import { PaygridClient } from '@paygrid/sdk';

// Initialize client
const paygrid = new PaygridClient({
  apiKey: process.env.PAYGRID_API_KEY,
  baseUrl: 'https://api.dev.paygrid.network'
});

// 1. Discover a counterparty
const payee = await paygrid.discovery.lookup('institution-bravo');
console.log('Found:', payee.displayName);

// 2. Create and submit a payment
const payment = await paygrid.accord.createPayment({
  payeeId: 'institution-bravo',
  amount: '1000000', // 1 USDC (6 decimals)
  asset: 'eip155:8453/erc20:0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48',
  metadataHash: '0x...' // keccak256 of private data
});

console.log('Payment submitted:', payment.paymentId);
console.log('Status:', payment.status);

// 3. Wait for acknowledgement (webhook or polling)
// Payment will be automatically batched into next epoch

Key Concepts

Payment
A cryptographically signed payment instruction from one institution to another. Uses EIP-712 for secure, verifiable signatures.
Acknowledgement
The receiving institution's signed confirmation of the payment. Forms a bilateral settlement intent.
Epoch
A 30-minute window where payments are batched, netted, and settled atomically. Reduces gross settlement volume by up to 90%.
Net Position
Your final payment obligation after multilateral netting. Always significantly less than gross payment volume.