PAYKX Rail Verification API

Deterministic certainty layer for high-friction payment corridors. All responses in shadow/demo mode are simulated.

Use the demo key below to try the endpoints directly from this page.

Version 1.0.1 Shadow / Demo Mode Contact: taseenrayed@paykx.co.uk

POST /api/v1/verify Verify a payment corridor ⌄

Runs a deterministic risk assessment on the specified corridor using three weighted probes: availability (40%), latency (30%), error pattern (20%), trend (10%).
Score ≥ 0.70 → GO | 0.50–0.69 → DEGRADED | < 0.50 → NO-GO

Parameters

Name	In	Type	Description
mode	query	string	shadow (default) or live
Authorization*	header	string	Bearer paykx-demo-key-001

Request Body

Field	Type	Required	Description
corridor	string	YES	e.g. UK-NIGERIA, US-UK

Example Response

"decision": "SHADOW: GO",
"score": 0.74,
"volatility": 0.09,
"confidence": 0.74,
"probe_count": 4,
"probe_details": "{ availability, latency, error_pattern, trend }",
"operator_id": "DEMO-****",
"amount": 0.00,
"currency": "***",
"demo_mode": true,
"environment": "shadow-demo"

Responses

200Verification result returned successfully

400Invalid request body — corridor field missing or malformed

401Missing or invalid API key

Try it out

GET /api/health API Health Check ⌄

Returns the current health status of the PAYKX Rail API, including version and total verification count. No authentication required.

Example Response

"status": "healthy",
"version": "1.0.1",
"total_verifications": 43,
"message": "PAYKX Rail Verification API is running successfully",
"mode": "shadow",
"environment": "shadow-demo"

Responses

200API is healthy and running

Try it out