API Documentation

REST reference · Interactive playground

All systems nominal

REST API v1.0

ShipCard API Reference

Three endpoints power the entire interceptive issuing architecture. Click any endpoint to expand — or hit “Try it” to run a live request against the sandbox.

Base URLhttps://api.shipcard.io/v1

AuthX-ShipCard-Key: Bearer <token>

Sandboxhttp://localhost:3000

Content-Typeapplication/json

POST

/api/issue-proxy

Issue a virtual proxy card

~85ms p50

WEBHOOK

/api/jit-funding-webhook

Real-time JIT authorization webhook

<100ms end-to-end

POST

/api/generate-legacy-batch

Generate legacy bank batch file

~200ms (scales with record count)

Error Codes

HTTP	Error Code	Description	Resolution
400	`INVALID_JSON`	Request body is not valid JSON	Check Content-Type and body encoding
401	`INVALID_SIGNATURE`	Webhook HMAC signature mismatch	Verify LITHIC_WEBHOOK_SECRET in environment
422	`VALIDATION_ERROR`	Missing or invalid request parameters	Check required fields and type constraints
422	`TENANT_QUOTA_EXCEEDED`	Monthly card issuance limit reached	Contact support to raise quota or upgrade tier
422	`SPEND_LIMIT_TOO_HIGH`	spendLimitCents exceeds $100,000 maximum	Reduce limit or request exception via enterprise tier
500	`SFTP_CONNECTION_TIMEOUT`	Sponsor bank SFTP endpoint unreachable	Batch will retry at next window; check SFTP config

TypeScript SDK — Coming Q2 2026

A fully-typed SDK with automatic retries, webhook validation helpers, and a shadow ledger client is in development. Use the REST API directly in the meantime — all endpoints are production-stable.

npm install @shipcard/sdk # coming soon