The Integrations Process

This guide describes the standard process for building and launching an integration with Paytronix.

The process is divided into five stages:

  1. Resource : Submitting the request
  2. Scope : Gather requirements and agree on scope of work
  3. Develop : Build and test the integration in a non-production environment.
  4. Certify : Verify that the integration meets the agreed technical and business requirements.
  5. Go-live : Deploy the certified integration to production

Process at a glance

Stage Objective Output
Resource Make sure the team has what it needs to start. Named team, access, documentation, environments, and contacts.
Scope Define the integration contract. Approved scope, requirements, assumptions.
Develop Implement the integration. Working code, configuration, tests, and technical documentation.
Certify Validate the implementation and address any issues. Certification evidence and approval to release.
Go-live Release and operate the integration. Production deployment and support handover.

1. Resource

Most integrations with the Paytronix REST API begin when a Paytronix customer identifies a business need, engages a developer or development team, and submits a formal request to kick off an Integrations project.

Activities

  • Define the business need and desired user flow. The Paytronix customer should first define the business problem or opportunity the integration is intended to address. This includes:
    • Identifying the platform that will integrate with Paytronix, such as a point-of-sale (POS) system, mobile application, guest-facing website, or eGift web page.
    • Defining the desired user flows, including important business rules and expected outcomes.
  • Engage a developer or development team if the integration will not be developed in-house.
  • Contact Paytronix through the Intercom agent or the assigned TSM to discuss the request in the context of the Paytronix platform and its capabilities.
  • If the request is considered feasible, submit a formal project request to the Paytronix Integrations team.
  • The Integrations team reviews new project requests each week to prioritise them and assign an owner.

Expected outputs

  • A developer/integrator who has agreed to undertake the development work
  • Requirements around the user journeys
  • A support ticket submission
  • A project management resource and an integrations resource assignment

2. Scope

Define the integration requirements so that the Paytronix Integrations team can accurately scope the API endpoints, integration flows, configuration, and test cases required.

Activities

  • Paytronix schedules an IDI (Integrations Deployment Interview), attended by:
    • The assigned Paytronix support resource
    • The assigned Paytronix Integrations specialist
    • The developer responsible for implementing the integration
    • The Paytronix customer providing the business and technical requirements
  • The IDI is used to:
    • Describe the business use case and the systems involved
    • Outline the current state and the desired future state
    • Detail the desired user journeys and integration flows
  • Resolve open questions and confirm assumptions
  • Review the remaining stages of the integrations process and confirm next steps

Expected outputs

  • A work order listing the API endpoints required for the integration, provided to the client for review and signature
  • API Terms of Service provided to the developer for review and signature

3. Develop

Once the work order and API Terms of Service have been signed, Paytronix Integrations sends a Welcome Email to all parties. Development against the Paytronix API may begin once the Welcome Email has been received and sandbox access is available.

Activities

  • Paytronix sends a Welcome Email containing:
    • API credentials for accessing a Paytronix sandbox environment
    • The endpoints listed in the signed work order
    • Relevant API documentation
    • A link to the Certification Submission Form
    • A test plan containing the test cases that Paytronix Integrations will use during certification
  • During development, raise any questions, assumptions, or requests for specific test setups or test accounts
    • Integrations with the smoothest certification process are usually those where developers ask targeted questions and verify assumptions early
  • Notify Paytronix Integrations of any changes to the agreed scope or any additional endpoints required
  • Keep all parties informed of expected timelines
  • Complete internal QA before submitting the integration for certification

Expected outputs

  • A developed and internally tested integration deployed in a sandbox or other development environment
  • A completed certification submission through the Certification Submission Form linked in the Welcome Email, including instructions for accessing the integration
    • For mobile applications, provide an .apk file, AppTester build, or TestFlight build
    • For websites and web applications, provide a development URL
    • For other platforms, such as POS systems and kiosks, provide instructions for accessing the integration through TeamViewer, remote desktop, or an equivalent tool
    • If persistent access is not available or practical, participate in a live certification session using screen sharing. Multiple sessions may be required depending on the complexity of the integration

4. Certify

Certification verifies that the integration meets the Paytronix customer’s business needs and Paytronix’s technical requirements.

Certification consists of testing the integration as an end user, verifying the user flows and functionality, and reviewing internal logs to confirm that the API calls and integration flows behave as expected.

Activities

  • Paytronix Integrations conducts a certification round
  • Paytronix documents issues, notes, and questions in the test plan and sends the updated plan to the developer
  • The developer addresses the items identified in the test plan and informs Paytronix Integrations when the integration is ready for the next round of certification testing
  • Once all required items have been addressed, Paytronix marks certification as passed and issues production credentials
  • Certification does not replace user acceptance testing (UAT). The Paytronix customer should conduct its own UAT after certification has passed

Expected outputs

  • Between certification rounds, an updated test plan documenting passed test cases and test cases requiring fixes, clarification, or follow-up
  • On completion, an email confirming that certification has passed and providing credentials for accessing the Paytronix production environment

5. Go-live

Deploy the certified integration to production and confirm that it is ready for use by the Paytronix customer

Activities

  • Confirm that certification has passed and that the integration is ready for production release
  • Complete production testing
  • Confirm that the Paytronix customer has completed user acceptance testing (UAT)
  • Coordinate the go-live date, responsibilities, communications, and production enablement

Expected outputs

  • Production deployment
  • Go-live communication to all relevant parties

Guidelines on Paytronix API Credentials

  • Treat Paytronix-issued API credentials as operationally owned and managed by the Integrator. Although Paytronix generates the credentials, the Integrator is responsible for securely storing, managing, and configuring them
  • Keep API credentials opaque to Paytronix customers. Do not expose credentials through merchant-facing configuration, client-side code, logs, or support materials
  • Paytronix integrations are enabled on a per-merchant basis. Manage and surface merchant-specific configuration separately from the shared API credentials
  • Most integrations use a single credential set for the entire integration, with merchant-specific URL schemes and merchant IDs used to route requests to the appropriate merchant
  • Some, particularly integrated white-label solutions, may use a separate credential set for each integration instance.
  • Contact Paytronix Integrations before implementing changes to the credential model, for requests to rotate keys, and with any questions regarding configuration levels