DEVELOPER REFERENCE

RegX³ API Shield Reference

The RegX³ API Shield provides deterministic, sub-50ms financial pre-flight verification for both traditional batch ACH (FedACH) and instant payment rails (FedNow).

All requests hit our ephemeral processing pipeline. Payloads are inspected in volatile memory and destroyed immediately after score generation without saving plain-text bank or account records.

Base URL: https://regx3.com

All API endpoints require HTTPS / TLS 1.3 encryption and JSON payload bodies.

Authentication & Security

Every call to the RegX³ API Shield requires an authorized Bearer token passed in the Authorization header. Unauthorized or malformed requests return an immediate 401 Unauthorized response.

Required Headers

Header	Type	Description
Authorization	string REQUIRED	Bearer token formatted as `Bearer YOUR_API_KEY`
Content-Type	string REQUIRED	Must be specified as `application/json`

# Authorized Request Headers
headers = {
 "Authorization": "Bearer YOUR_API_KEY",
 "Content-Type": "application/json"
}// Authorized Request Headers
const headers = {
 'Authorization': 'Bearer YOUR_API_KEY',
 'Content-Type': 'application/json'
};# cURL Header Flags
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json"

Rate Limits & SLA

Standard developer tier tokens are rate-limited to 100 requests per minute (RPM). Enterprise and institutional tiers support unthrottled sub-50ms execution.

If an account exceeds its configured rate limit, the API returns 429 Too Many Requests with a Retry-After header in seconds.

Rate Limit Response (429) 429 Too Many Requests

{
 "error": "rate_limit_exceeded",
 "message": "Standard tier rate limit reached (100 RPM).",
 "retry_after_seconds": 14
}

POST /v1/validate/routing

FedACH™ Routing Radar Validation

Validates 9-digit ABA routing transit numbers (RTNs). Verifies mathematical compliance using the Federal Reserve’s official 3-7-1 Mod 10 checksum algorithm, queries live FedACH directory records, and checks active FedNow participant status.

Request Parameters

Field	Type	Description
routing_number	string REQUIRED	9-digit ABA routing transit number
environment	string	Target scope: `production` or `sandbox`

Response Attributes

Field	Type	Description
status	string	`valid` or `invalid`
checksum_passed	boolean	3-7-1 Mod 10 algorithmic verification result
fednow_active	boolean	Confirmed participant on the FedNow instant rail
institution	string	Official legal servicing depository bank name
latency_ms	float	Total pre-flight evaluation latency in milliseconds

import requests

url = "https://regx3.com/v1/validate/routing"
headers = {
 "Authorization": "Bearer YOUR_API_KEY",
 "Content-Type": "application/json"
}
payload = {
 "routing_number": "111000025",
 "environment": "production"
}

response = requests.post(url, json=payload, headers=headers)
print(response.json())const url = 'https://regx3.com/v1/validate/routing';
const options = {
 method: 'POST',
 headers: {
 'Authorization': 'Bearer YOUR_API_KEY',
 'Content-Type': 'application/json'
 },
 body: JSON.stringify({
 routing_number: '111000025',
 environment: 'production'
 })
};

fetch(url, options)
 .then(res => res.json())
 .then(json => console.log(json));curl -X POST https://regx3.com/v1/validate/routing \
 -H "Authorization: Bearer YOUR_API_KEY" \
 -H "Content-Type: application/json" \
 -d '{"routing_number":"111000025","environment":"production"}'

Response Payload (200 OK) 12.4ms

{
 "status": "valid",
 "checksum_passed": true,
 "fednow_active": false,
 "institution": "Lone Star Regional Reserve Bank, N.A.",
 "latency_ms": 12.4
}

POST /v1/validate/iso20022

FedNow Instant Payment ISO 20022 Radar

Parses and screens ISO 20022 raw XML messages (pacs.008.001.08 customer credit transfers and pain.013.001.07 payment requests). Validates syntax integrity, namespace schemas, and participant availability in sub-50ms before funds settle irrevocably.

Request Parameters

Field	Type	Description
message_type	string REQUIRED	ISO 20022 identifier: `pacs.008.001.08` or `pain.013.001.07`
raw_xml	string REQUIRED	Full XML payload snippet to evaluate

Response Attributes

Field	Type	Description
status	string	`valid` or `rejected`
syntax_verified	boolean	Schema conformance against Federal Reserve XSD rules
fednow_participant	boolean	Creditor bank real-time routing availability confirmed
latency_ms	float	Total pre-flight evaluation latency in milliseconds

import requests

url = "https://regx3.com/v1/validate/iso20022"
headers = {
 "Authorization": "Bearer YOUR_API_KEY",
 "Content-Type": "application/json"
}
payload = {
 "message_type": "pacs.008.001.08",
 "raw_xml": "<Document xmlns=\\"urn:iso:std:iso:20022:tech:xsd:pacs.008.001.08\\">...</Document>"
}

response = requests.post(url, json=payload, headers=headers)
print(response.json())const url = 'https://regx3.com/v1/validate/iso20022';
const options = {
 method: 'POST',
 headers: {
 'Authorization': 'Bearer YOUR_API_KEY',
 'Content-Type': 'application/json'
 },
 body: JSON.stringify({
 message_type: 'pacs.008.001.08',
 raw_xml: '<Document xmlns="urn:iso:std:iso:20022:tech:xsd:pacs.008.001.08">...</Document>'
 })
};

fetch(url, options)
 .then(res => res.json())
 .then(json => console.log(json));curl -X POST https://regx3.com/v1/validate/iso20022 \
 -H "Authorization: Bearer YOUR_API_KEY" \
 -H "Content-Type: application/json" \
 -d '{"message_type":"pacs.008.001.08","raw_xml":"<Document...>"}'

Response Payload (200 OK) 38.1ms

{
 "status": "valid",
 "syntax_verified": true,
 "message_type": "pacs.008.001.08",
 "routing_number": "111000025",
 "fednow_participant": true,
 "latency_ms": 38.1
}

GATEWAY INTEGRATION // PAYPAL & BRAINTREE

Braintree Pre-Flight Shield Architecture

Intercept fraudulent ACH entries, synthetic bank accounts, and checkout velocity bursts before tokenization or submission to the PayPal / Braintree gateway.

By placing RegX³ directly in front of gateway.transaction.sale(), merchants eliminate manual "Pending Review" queue bottlenecks and stop unauthorized return fees (R05, R07, R10) before transactions hit payment rails.

The 3-Step Execution Pipeline

Step	Action	Outcome
1. Pre-Flight	RegX³ API Shield	Sub-50ms velocity inspection and 3-7-1 Mod 10 checksum verification.
2. Gatekeeper	Verdict Enforcement	If `BLOCK`, transaction terminates locally. Zero gateway fees incurred.
3. Settlement	Braintree SDK	If `ALLOW`, safe payload submits to `gateway.transaction.sale()`.

# RegX³ + Braintree Gateway Pipeline
import braintree
import requests

# 1. RegX³ Sub-50ms Pre-Flight Gatekeeper
shield_res = requests.post(
 "https://regx3.com/v1/validate/routing",
 headers={"Authorization": "Bearer YOUR_API_KEY"},
 json={"routing_number": customer_rtn},
 timeout=0.045 # 45ms fail-open timeout
).json()

if shield_res.get("status") == "valid":
 # 2. Proceed to Braintree Transaction Sale
 result = gateway.transaction.sale({
 "amount": "149.00",
 "payment_method_nonce": nonce_from_client,
 "options": {"submit_for_settlement": True}
 })
else:
 raise ValueError("Pre-flight verification failed: invalid routing")// RegX³ + Braintree Node.js Pipeline
const braintree = require('braintree');

// 1. RegX³ Sub-50ms Pre-Flight Check
const shieldCheck = await fetch('https://regx3.com/v1/validate/routing', {
 method: 'POST',
 headers: {
 'Authorization': 'Bearer YOUR_API_KEY',
 'Content-Type': 'application/json'
 },
 body: JSON.stringify({ routing_number: customerRtn })
}).then(r => r.json());

if (shieldCheck.status === 'valid') {
 // 2. Execute Braintree Sale
 const result = await gateway.transaction.sale({
 amount: '149.00',
 paymentMethodNonce: nonce,
 options: { submitForSettlement: true }
 });
}# CLI Pre-Flight Verification before Gateway Submission
curl -X POST https://regx3.com/v1/validate/routing -H "Authorization: Bearer YOUR_API_KEY" -H "Content-Type: application/json" -d '{"routing_number":"111000025"}'

Braintree Gateway Settlement Result Zero Return Risk

{
 "pre_flight_shield": "PASSED",
 "braintree_status": "submitted_for_settlement",
 "transaction_id": "bt_tx_89432174",
 "fail_open_engaged": false
}