Appearance
Overview
PayBridge is a payment onboarding and checkout platform. It sits between your application and the payment processors (Clearent/XplorPay and Aptexx), giving you a single integration for two capabilities:
- Onboarding — register a merchant and submit their business details to the processor for underwriting, so they end up with a live payment account.
- Payments — create a hosted checkout session, take the customer's card or bank payment, and settle it through the merchant's processor.
Card payments run through a PayBridge-hosted checkout page, so card data is captured there rather than on your servers, keeping your integration out of PCI scope.
Environments
| Environment | Base URL |
|---|---|
| Sandbox | https://sandbox.api.nfs-pay.com |
| Production | https://api.nfs-pay.com |
Full field-level details are in the API Reference, available in every environment. Interactive Swagger ({base_url}/docs) and ReDoc ({base_url}/redoc) are also served in sandbox and other non-production environments (disabled in production).
Authentication
Every request is scoped to a partner app via an API key sent in the X-API-Key header. Your integration contact provides the key and the base URL for each environment.
X-API-Key: your_api_key_hereState-changing requests (POST, PUT, PATCH, DELETE) also require:
X-Requested-With: PayBridgeA quick health check confirms your key and base URL:
bash
curl https://sandbox.api.nfs-pay.com/health \
-H "X-API-Key: your_api_key_here"json
{ "status": "ok" }Amounts
All amounts in the API are in minor units (cents). 75000 = $750.00.
Where to next
- Onboarding — onboard a merchant.
- Payments — accept a payment.