Integration
      Back to home
      1. Help Center
      2. Payer Knowledge Base
      3. Integration

      PaymentWorks Integration Guides

      The PaymentWorks Integration Guides provide detailed instructions and best practices for setting up and managing integrations between your systems and the PaymentWorks platform. These resources are designed to help technical teams seamlessly configure and maintain integrations, ensuring a smooth and efficient data exchange process.

      Each guide focuses on a specific phase or component of the integration process, from environment setup to file management and authentication configurations. Use the links below to access the full documentation for each topic.

      Available Guides

      1. Part 1 - Setup and Configuration
        Learn how to prepare your environment for integration with PaymentWorks, including system prerequisites, initial configurations, and best practices for a seamless setup.

      2. Part 2 - Development
        This guide covers the technical development process, including APIs, data mapping, and customizing integrations to meet your organization’s specific needs.

      3. Part 3 - Testing
        Understand how to thoroughly test your integration to ensure data accuracy and system reliability. This guide includes test case recommendations and troubleshooting tips.

      4. Part 4 - Supplier and Invoice Files
        Detailed instructions for formatting and uploading supplier and invoice files to PaymentWorks. Learn how to align file structures with platform requirements for efficient processing.

      5. Part 5 - SSO Configuration
        Step-by-step guidance on configuring Single Sign-On (SSO) to streamline user authentication and enhance security using your organization’s Identity Provider (IdP).

      6. Part 6 - SFTP Setup
        A comprehensive guide to setting up Secure File Transfer Protocol (SFTP) for automated file uploads and downloads between your systems and PaymentWorks.

      Templates and Examples

      Getting Started

      These guides are designed to provide end-to-end support for integrating your systems with PaymentWorks. Begin with Part 1 - Environment Setup and Configuration to establish the foundation, or select the guide that aligns with your immediate integration goals.

      For additional resources, visit the PaymentWorks Knowledge Base or reach out to PaymentWorks Support for further assistance.