Configure Connection
Paycom guide
Request API access from Paycom, allow the NIM server’s public address, and securely configure the connection.
Before you begin
To use the Paycom API, your organization must obtain credentials and have its connection origin approved by Paycom.
Have the following ready:
- The public IP address or addresses that the NIM server will use to access the Paycom API.
- A contact who can request API access from the Paycom Automation Team.
- A secure location for the API credentials after they are issued.
Request Paycom API access
Contact the Paycom Automation Team and provide the public IP address or addresses that will access the API. Request the following credentials:
| Credential | Purpose |
|---|---|
| SID | Identifies your organization’s API connection. |
| Token | Authenticates requests from NIM to Paycom. |
Allow time for IP approval
The Paycom API connection will not work until Paycom has approved the supplied public IP address or addresses. If the NIM server’s egress IP changes, contact Paycom to update the approved list.
Configure Paycom in NIM
- In NIM, add or open the Paycom system.
- Enter the SID and token provided by Paycom in the corresponding connection settings.
- Save the system configuration.
Protect the token
Treat the API token as a password. Store it only in approved secret-management locations and do not include it in tickets, email, or documentation.
Validate the connection
- Run a connection test or a read operation from NIM.
- If the connection is rejected, first confirm the SID and token, then verify that the NIM server is using one of the public IP addresses approved by Paycom.
- Contact the Paycom Automation Team if the IP allowlist or credentials need to be updated.