Skip to content

Initial Setup and Onboarding

Before your application can integrate with the Paynetworx gateway API a few prerequisite steps need to be made. These required steps are different depending on whether the environment you wish to use is the Paynetworx test environment or the Paynetworx production environment.

Initial Setup for the Test Environment

Complete the following ordered steps to enable application integration into the Paynetworx test environment:

  1. Confirm the Paynetworx gateway features will meet your application requirements.

  2. Access tokens for development using the Paynetworx test environment from the Paynetworx team.

Initial Setup for the Production Environment

Complete the following ordered steps to enable application integration into the Paynetworx production environment:

  1. Complete the merchant onboarding process with the Paynetworx team. Upon successful completion of this process the Paynetworx team will provide you with the authentication token (for use with HTTP Basic authentication requests).

Access Token Device Types

Access token configurations are based upon the merchant's device type and usage scenario. Environment specific access tokens are provided for both the Test Environment and the Production Environment.

Note

The Test Environment Token will only work in the Test Environment and the Production Token will only work in the Production Environment.

The Access token device type is used to find the transaction payload initiation type, the 'InitiatedBy' fields.

See Payload Processing Specifiers 'InitiatedBy' fields for initiation type information for use with a particular type of access token.

POS terminal

POS terminal is a hardware device operated by the merchant for transaction entry. The access token for this device supports card entry modes of manual entry, magnetic stripe swipe, insert card, tap card, and card-on-file. This device uses the InitiatedByPOS initiation type.

ECommerce device

ECommerce device is a device operated by the cardholder, for example, through a website on an at-home computer. The access token for this device supports card entry modes of manual and card-on-file. This device uses the InitiatedByEcommerce initiation type.

POS Virtual Terminal application

A POS Virtual Terminal application device, often a browser based terminal, is a device operated by the merchant for transaction entry. The access token for this device supports card entry modes of manual and card-on-file. This device uses the InitiatedByVirtualTerminal initiation type.