Getting Started

This guide walks through authenticating and making your first PayBridge API call.

Authentication

Every request is scoped to a consumer 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.

curl https://api.example.nfs-pay.com/health \
  -H "X-API-Key: your-api-key"

A healthy environment responds with 200 OK:

{ "status": "ok" }

Creating a payment

Payments require an idempotency_key so retries never double-charge a customer.

curl https://api.example.nfs-pay.com/payments \
  -H "X-API-Key: your-api-key" \
  -H "Content-Type: application/json" \
  -d '{
    "idempotency_key": "order-1001",
    "amount": 2500,
    "currency": "USD",
    "payment_token": "vgs-tokenized-card"
  }'

Amounts are in minor units (cents). The payment_token is produced client-side by the checkout widget, so raw card data never touches your servers.

Next steps

More guides — webhooks, the embeddable widget, and the full API reference — are published alongside this site.