Skip to content
Last updated

Merchant Integration Overview

Nelnet Payment Services SDK

Secure, PCI-compliant payment processing through iframe-based tokenization


Integration Architecture

The NPS payment integration uses JWT authentication and secure iframe architecture SDK to ensure payment data never touches your servers.

🔐 Secure Payment Integration Flow

🖥️
Server-side
JWT Auth
Session Token
☁️
NPS API
Session Token
🌐
Client-side
📦
NPS SDK
💳
Secure Payment Form
Isolated iFrame

Integration Flow

StepActionDetails
1
Create Payment Session
Server-side → NPS API
• Make an authenticated request to create a payment session
• Include your JWT Bearer token in the Authorization header
• Receive a session token and session id that's safe for client-side use
2
Initialize Payment Form
Client-side
• Load the NPS JavaScript SDK on your checkout page
• Initialize the SDK with the session token and session id from Step 1
• The SDK will create a secure payment form in your designated container
3
Collect Payment Information
Customer Interaction
• Customers enter their payment details in the secure form
• All sensitive data is isolated from your application
• Real-time validation provides immediate feedback
4
Tokenize Payment Data
Secure Tokenization
• When the customer submits, their payment data is securely tokenized
• You receive a payment token that represents the payment information
• No sensitive payment data ever touches your servers
5
Use Token
Server-side
• Use the secure payment token as needed
• The token represents the payment information collected
• Process according to your business requirements

Key Benefits

Security First

  • PCI Compliance: Reduce your PCI scope by never handling raw payment data
  • Domain Isolation: Payment fields are completely isolated in a secure iframe
  • Token-based: Work only with secure tokens, never sensitive card data

Developer Friendly

  • Integration: Get started with just a few lines of code
  • Multiple Payment Methods: Support for cards, ACH, and apple pay
  • Customizable UI: Style the payment form to match your page

Integration Method

The NPS JavaScript SDK provides secure payment collection through an isolated iframe architecture.

const nps = new NPS({
    sessionToken: 'your_session_token/random_key'
    sessionId: 'session_id'
});

Quick Start Steps

1
Install SDK
<script src="https://cdn.nelnetpay.com/sdk/v1.0.0/nps.js"></script>
2
Create Session
// Server-side: Request session
const session = await createPaymentSession();
3
Initialize object and Payment Form
// Client-side
const nps = new NPS({
 sessionToken: 'your_session_token/random_key'
 sessionid: 'session_id'
});
//Mount secure payment form
nps.mount('#payment-container');
4
Process Payment
// Server-side: Use token to process payment
const result = await processPayment(token,);

Supported Payment Methods

Credit & Debit CardsACH Bank TransfersDigital Wallets
• Visa
• Mastercard
• American Express
• Discover
• Real-time card validation and formatting
• Routing and account number validation
• Apple Pay

Testing Your Integration

Testing Environments

Test your integration across different environments to ensure compatibility

Test Payment Form Styling

Verify your custom styling renders correctly:

nps.mount('#payment-container', {
    styling: {
    }
});

Test Different Payment Methods

Card Testing

// Test card 
nps.mount('#payment-container', {
    paymentMethod: 'card'
});

ACH Testing

// Test ACH 
nps.mount('#payment-container', {
    paymentMethod: 'ach'
});

Apple Pay Testing

// Test Apple Pay 
nps.mount('#payment-container', {
    paymentMethod: 'applepay'
});

Test Cards

BrandNumberCVVExpiry
Visa4242 4242 4242 4242Any 3 digitsAny future date
Mastercard5555 5555 5555 4444Any 3 digitsAny future date
Amex3782 822463 10005Any 4 digitsAny future date
Visa4000 0000 0000 0002Any 3 digitsAny future date
Visa4000 0000 0000 9995Any 3 digitsAny future date

Testing Checklist

Testing Checklist

Test in all test environments
Verify custom styling appears correctly
Validate form behavior across devices
Test all supported payment methods
Verify error handling and messages
Test tokenization with various card types
Validate real-time formatting for various features
Verify accessibility features

Next Steps

DocumentationDescription
SDK Integration Guide Detailed SDK setup and configuration

Support Resources

Need Help?

Technical Support
NPSTechSupport@nelnet.net