> ## Documentation Index
> Fetch the complete documentation index at: https://docs.paysight.io/llms.txt
> Use this file to discover all available pages before exploring further.

# NMI Network Tokens

> Complete guide for enabling and configuring NMI network tokens via Customer Token Vault

# Setting up NMI Network Tokens

Modern payment processing requires advanced security measures to protect sensitive cardholder data while maintaining high transaction success rates. This comprehensive walkthrough covers the complete implementation process for NMI's Customer Token Vault integration, ensuring your payment infrastructure meets the highest security standards.

<Info>
  **What are Network Tokens?**

  Network tokens are secure, non-sensitive representations of payment cards issued by card networks (Visa, Mastercard). They offer better security, higher authorization rates, and automatic card updates when cards are reissued.
</Info>

## Prerequisites

<Warning>
  **Before You Begin**

  Ensure you have:

  * Active NMI account with Paysight
  * Administrative access to your NMI gateway
  * Contact information for your NMI agent
  * Paysight account manager contact details
</Warning>

## Overview

The network token setup process involves three main steps:

<Steps>
  <Step title="Enable Customer Token Vault">
    Add Customer Token Vault to your NMI account and verify it's enabled
  </Step>

  <Step title="Configure API Response Variables">
    Add 'Network Token Used' to your API response variables
  </Step>

  <Step title="Enable Network Tokens">
    Contact your Paysight account manager to enable network tokens
  </Step>
</Steps>

## Step 1: Enable Customer Token Vault

### Request Customer Token Vault Access

1. **Contact your NMI agent** to enable Customer Token Vault on your account
2. **Provide access** to Customer Token Vault functionality
3. **Reference the official documentation**: [Customer Token Vault Setup Guide](https://support.nmi.com/hc/en-gb/articles/27127243040145-Customer-Token-Vault)

<Tip>
  **Getting Agent Support**

  When contacting your NMI agent, mention that you need Customer Token Vault enabled for network tokenization. This is a specific feature that requires agent activation.
</Tip>

### Verify Customer Token Vault is Enabled

Once enabled, you'll see the Customer Token Vault option in your NMI settings:

1. Navigate to **Settings > Options** in your NMI account
2. Look for **Customer Token Vault** in the Transaction Options section
3. Click on **Customer Token Vault** to access the configuration page

<Note>
  **Finding Customer Token Vault**

  The Customer Token Vault option appears in the Transaction Options column of your NMI gateway settings. It should be visible once enabled by your agent.
</Note>

### Verify Tokenization Status

On the Customer Token Vault page, verify the following:

<CardGroup cols={2}>
  <Card title="Visa Status" icon="credit-card">
    Check that Visa shows a green "Ready" status under Onboarding Status
  </Card>

  <Card title="Mastercard Status" icon="credit-card">
    Verify Mastercard displays a green "Ready" status under Onboarding Status
  </Card>
</CardGroup>

<Warning>
  **Important Tokenization Notes**

  * **Account Updater Impact**: When services like Account Updater update a card number, existing tokens linked to the old card are invalidated, which can sometimes lead to a double charge
  * **First Transaction Limitation**: Previously untokenized credit cards and debit cards may not be tokenized on their first transaction
</Warning>

## Step 2: Configure API Response Variables

### Navigate to API Configuration

1. Go to **Options > Settings > API Configuration** in your NMI account
2. Look for the **Customize API Response Variables** section

### Add Network Token Variable

<Steps>
  <Step title="Select Custom Format">
    Choose "Use custom format" instead of the system default
  </Step>

  <Step title="Find Network Token Field">
    Locate "Network Token Used" in the Available Fields list
  </Step>

  <Step title="Drag to Fields Returned">
    Drag "Network Token Used" from Available Fields to Fields Returned
  </Step>

  <Step title="Save Configuration">
    Save your API configuration changes
  </Step>
</Steps>

<Note>
  **API Response Variables**

  The following API response variables only apply to:

  * Payment API
  * Customer Vault
  * Browser Redirect name/value pair APIs

  For detailed configuration instructions, see: [Configuring Payment API Response Variables](https://support.nmi.com/hc/en-gb/articles/18478005170705-Configuring-the-Payment-API-Response-Variables)
</Note>

### Verify Configuration

After adding "Network Token Used" to your Fields Returned, you should see it listed alongside other response fields like:

* Response
* Response Text
* Authorization Code
* Transaction ID
* AVS Response
* CVV Response

## Step 3: Enable Network Tokens with Paysight

### Contact Your Account Manager

<Info>
  **Final Step**

  Speak to your Paysight account manager to enable Network Tokens on your account. This is the final step that activates network tokenization for your transactions.
</Info>

### What to Provide

When contacting your Paysight account manager, have ready:

<AccordionGroup>
  <Accordion title="NMI Account Information">
    * Your NMI account details
    * Confirmation that Customer Token Vault is enabled
    * Verification that Visa and Mastercard show "Ready" status
  </Accordion>

  <Accordion title="API Configuration Details">
    * Confirmation that "Network Token Used" is added to API response variables
    * Screenshots of your API configuration if requested
  </Accordion>

  <Accordion title="Business Requirements">
    * Expected transaction volumes
    * Primary use cases for network tokens
    * Any specific requirements or concerns
  </Accordion>
</AccordionGroup>

## Testing Network Tokens

### Verify Token Generation

<Steps>
  <Step title="Process Test Transaction">
    Submit a test transaction through your integration
  </Step>

  <Step title="Check API Response">
    Verify that "Network Token Used" appears in the response
  </Step>

  <Step title="Confirm Token Creation">
    Check that a network token is generated and stored
  </Step>
</Steps>

### Test Scenarios

<CardGroup cols={2}>
  <Card title="New Card Tokenization" icon="plus">
    Test with a new card to ensure tokenization occurs
  </Card>

  <Card title="Existing Token Usage" icon="refresh">
    Verify that existing tokens are used for repeat transactions
  </Card>

  <Card title="Token Update" icon="update">
    Test automatic token updates when cards are reissued
  </Card>

  <Card title="Error Handling" icon="alert-triangle">
    Verify proper error handling for tokenization failures
  </Card>
</CardGroup>

## Benefits of Network Tokens

<AccordionGroup>
  <Accordion title="Enhanced Security">
    * Tokens replace sensitive card data
    * Reduced PCI compliance scope
    * Better fraud protection
  </Accordion>

  <Accordion title="Improved Success Rates">
    * Higher authorization rates
    * Reduced false declines
    * Better international transaction success
  </Accordion>

  <Accordion title="Automatic Updates">
    * Cards automatically updated when reissued
    * Reduced customer service calls
    * Improved subscription continuity
  </Accordion>
</AccordionGroup>

## Troubleshooting

### Common Issues

<AccordionGroup>
  <Accordion title="Customer Token Vault Not Available">
    <Steps>
      <Step title="Contact NMI Agent">
        Reach out to your NMI agent to enable the feature
      </Step>

      <Step title="Verify Account Status">
        Ensure your account meets the requirements for Customer Token Vault
      </Step>

      <Step title="Check Permissions">
        Verify you have the necessary permissions to access the feature
      </Step>
    </Steps>
  </Accordion>

  <Accordion title="API Response Variable Not Working">
    <Steps>
      <Step title="Verify Configuration">
        Double-check that "Network Token Used" is in Fields Returned
      </Step>

      <Step title="Test API Calls">
        Make test API calls to verify the variable is returned
      </Step>

      <Step title="Contact Support">
        Reach out to NMI support if the variable still doesn't appear
      </Step>
    </Steps>
  </Accordion>

  <Accordion title="Network Tokens Not Generating">
    <Steps>
      <Step title="Check Paysight Configuration">
        Verify that your Paysight account manager has enabled network tokens
      </Step>

      <Step title="Review Card Types">
        Ensure you're testing with supported card types (Visa, Mastercard)
      </Step>

      <Step title="Check Integration">
        Verify your integration is properly configured for tokenization
      </Step>
    </Steps>
  </Accordion>
</AccordionGroup>

## Best Practices

<Tip>
  **Network Token Best Practices**

  * **Monitor Token Usage**: Regularly check that tokens are being generated and used
  * **Handle Token Updates**: Implement logic to handle token updates and replacements
  * **Test Thoroughly**: Test with various card types and scenarios
  * **Monitor Performance**: Track authorization rates and transaction success
  * **Keep Documentation**: Maintain records of your tokenization setup
</Tip>

## Support and Resources

### Documentation Links

<CardGroup cols={2}>
  <Card title="NMI Customer Token Vault" icon="external-link" href="https://support.nmi.com/hc/en-gb/articles/27127243040145-Customer-Token-Vault">
    Official NMI documentation for Customer Token Vault setup
  </Card>

  <Card title="API Response Variables" icon="external-link" href="https://support.nmi.com/hc/en-gb/articles/18478005170705-Configuring-the-Payment-API-Response-Variables">
    NMI guide for configuring API response variables
  </Card>
</CardGroup>

### Contact Information

<Info>
  **Need Help?**

  * **NMI Support**: Contact your NMI agent for Customer Token Vault issues
  * **Paysight Support**: Reach out to your Paysight account manager for network token activation
  * **Technical Issues**: Use the troubleshooting section above for common problems
</Info>

## Related Documentation

* [Paysight API Documentation](/api-reference/introduction)
* [Payment Processing Guide](/guides/transactions)
* [Security Best Practices](/guides/transactions)
* [Webhook Configuration](/webhooks)

***

<Note>
  **Last Updated**

  This guide was last updated on {current_date}. For the most current information, always refer to the latest version of this documentation.
</Note>