Please select the type of integration you wish to review.
Section 1. Smart Screens Method
Section 2. Direct Method
Section 3. Remote Auth Method
Section 4. API Method
Section 5. Cold Fusion Method
Section 6. Remote Administration
Section 7. Remote Membership Administration
Section 1. Smart Screens Method
Billing and shipping information will be collected by us through our Secure Payment Screens.
 
A credit card authorization may be obtained by submitting a form post to the payment script shown below. The resulting web page will present a form for the collection of the billings and/or shipping information. The system will respond by calling a URL as defined by the values submitted.  

If the URL is a web page, the system will respond by redirecting the customer to this URL. If the URL is a script, the system will do a remote POST to the script, passing it all variables collected as well as all variables passed to it with the exception of the credit card number.  

Payment URL: https://{your-secure-payment-server-domain}/payment/{publisher-name}pay.cgi

Please use only those Variables marked with a "x" in the "SS" (Smart Screens) column in variable table below.
Section 2. Direct Method
Assumes merchant is hosted on a secure server and will be collecting payment information.
 
A credit card authorization may be obtained by submitting a post with the defined variables below to the following URL. The system will respond by calling a URL as defined by the values submitted. If the URL is a web page, the system will respond by redirecting the customer to this URL. If the URL is a script, the system will do a remote POST to the script, passing it all variables collected as well as all variables passed to it with the exception of the credit card number.  

Payment URL: https://{your-secure-payment-server-domain}/payment/{publisher-name}.cgi

Please use only those Variables marked with a "x" in the "DM" (Direct Method) column in variable table below.
Section 3. Remote Auth Method
Assumes merchant is hosted on a secure server and will be collecting payment information and performing necessary data validation.

A credit card authorization may be obtained by submitting a post with the defined variables below to the following URL. The system will respond with a URL encoded text string suitable for parsing. This method is also used by the various API/COM/CFX libraries available and can be used as a reference of the name/value pairs received and returned.

Payment URL: https://{your-secure-payment-server-domain}/payment/pnpremote.cgi  

Please refer to the 'Remote Client Specifications' document for Variable parameters and available modes for remote operation.
Section 4. API Method
Assumes merchant is hosted on a secure server and will be collecting payment information and performing necessary data validation.
 
A credit card authorization may be obtained by submitting a post with the defined variables below to the following URL.  The system will respond by calling a URL as defined by the values submitted.  If the URL is a web page, the system will respond by redirecting the customer to this URL.  If the URL is a script, the system will do a remote POST to the script, passing it all variables collected as well as all variables passed to it with the exception of the credit card number.

Payment URL: https://yourdomain.com/path_to_api/PNPapi  

The current API's available are: [Platform/Type & Name]
PERL - Requires additional perl modules available from CPAN. (PnPremote.pm)
Java Servlet - Requires Servlet Engine (pnp_api.jar)
NT – COM Object (pnpcom.dll)
 
Please refer to the 'Remote Client Specifications' document for Variable parameters and available modes for remote operation.
Section 5. Cold Fusion Method
Assumes merchant is hosted on a secure server and will be collecting payment information and performing necessary data validation.

Merchant will need to register the pnpcfx.dll with Cold Fusion and associate it with the CFX_PlugnPay tag.
 
A credit card authorization may be obtained by embedding the CFX Tag with the defined attributes listed below. The system will respond by returning a query containing all of the attributes submitted along with the additional values defined below.

Please refer to the 'Remote Client Specifications' document for Variable parameters and available modes for remote operation.
Section 6. Remote Administration
Assumes merchant is hosted on a secure server and will be collecting payment information and performing necessary data validation.

Several administration functions can also be controlled remotely using one of the API/COM/CFX libraries available or by calling the URL shown below. In addition to the username and password required, the IP address of the server making the transaction requests needs to be registered prior to commencing transactions.

Payment URL: https://{your-secure-payment-server-domain}/payment/pnpremote.cgi  

Please refer to the 'Remote Client Specifications' document for Variable parameters and available modes for remote operation.
Section 7. Remote Membership Administration Functions
Assumes merchant is hosted on a secure server and will be collecting payment information and performing necessary data validation.

Several Membership Management administration functions can also be controlled remotely using one of the API/COM/CFX libraries available or by calling the URL shown below.  In addition to the username and password required, the IP address of the server making the transaction requests needs to be registered prior to commencing transactions.

Payment URL: https://{your-secure-payment-server-domain}/payment/pnpremote.cgi  

Please refer to the 'Remote Client Specifications' document for Variable parameters and available modes for remote operation.

 

Variable Table
Please use only those Variables marked with a "x" in the column for the type of method you wish to use.

'SS' = For Smart Screen Services
'DM' = For Direct Method Services
 
Variable Required Notes SS DM
publisher-name Mandatory Username Issued by us to you at time of sign up. x x
publisher-email Mandatory Person@place.com Address where order confirmation is sent. This is also the return address for email sent to customer. x x
card-amount Mandatory No "$" – Total amount to be charged"
NOTE: may be omitted if the number and cost of each product ordered is submitted as explained in note 2 below. The system will then calculate the total amount due.		 x x
convert Optional when value is set to "underscores", it converts underscores to hyphens.  Used to support client software, which is not able to use hyphens within variable names. x x
from-email Optional Return address on email sent to customer rather than "publisher-email" if preferred. x x
cc-mail Optional 2nd Address where order confirmation is sent. x x
subject Optional Subject line of email sent to merchant. Defaults to "Purchase Confirmation" x x
message Optional Additional message to include in email sent to customer. x x
subject-email Optional Subject line of email sent to customer. Defaults to "Purchase Confirmation" x x
dontsndmail Optional If set to "yes": will prevent system from sending confirmation email to customer. x x
shipinfo Optional Causes payment screens to prompt for separate shipping address. x x
plan Optional / Mandatory PlanID of the selected subscription plan.  Required to support Membership Management features if applicable. x x
easycart Optional If set to 1 will display contents of order on payment page and in email to customer and merchant. x x
item# - see note 2 Optional Model # of item x x
cost# - see note 2 Optional Cost of item x x
quantity# - see note 2 Optional Quantity of item x x
description# - see note 2 Optional Description of item x x
taxrate Optional Sales tax rate.  
Multiple Rates to be delimited with a "pipe" i.e. '|'.  
Ex. <input type="hidden" name="tax-rate" value="0.0825|0.075">
This will set 2 tax rates.		 x  
taxstate Optional Sales tax states.  
Multiple States to be delimited with a "pipe" i.e. '|'.  
Value equal to 2 letter state abbreviation.  
Ex. <input type="hidden" name="tax-state" value="NY|CA">
This sets 2 tax states. New York and California.		 x  
shipping Optional Sets shipping charge for entire order.
Ex. <input type="hidden" name="shipping" value="1.00">		 x x
card-allowed Optional Controls which credit card types are presented to the customer as payment options.  
Valid values are:
Visa,Mastercard,Discover,Amex,Diners,JCB,MYAR
Ex. <input type="hidden" name="card-allowd" value="Visa,Mastercard">		 x  
currency_symbol Optional Used to set the symbol used for currency in payment forms.
This only sets the symbol for the pages it does not do any calculation of exchange rates and does not actually set the currency for the transaction.
Ex. euro € €  
<input type="hidden" name="currency_symbol" value="€">		 x x
app-level Optional AVS (Address Verification System)  
Please refer to the AVS Code Specification section for valid values.		 x x
order-id Optional Value generated by you.
This can be customers name or what ever you wish to use to track the payment with the order.		 x x
paymethod Optional Allowed Values: “onlinecheck” for ACH payments,  
“credit” or blank for credit card Purchases.		 x  
success-link - see note 1 Optional Fully qualified URL to call after a successful authorization of the credit card is received from the credit card processor.
If URL is a script, method will be via a POST. If the URL is a web page, method will be by a GET.  
Ex. http://www.yourdomain.com/thankyou.html 		x x
badcard-link - see note 1 Optional Fully qualified URL to call after a failed card response is received from the credit card processor.
If URL is a script, method will be via a POST.  
If the URL is a web page, method will be by a GET.
Ex. http://www.yourdomain.com/badcard.html 		x x
problem-link - see note 1 Optional Fully qualified URL to call after either no response or an error message is received from the credit card processor.  
If URL is a script, method will be via a POST. If the URL is a web page, method will be by a GET.  
Ex. http://www.yourdomain.com/problem.html 		x x
card-name Mandatory Name as it appear on Credit Card   x
card-company Optional Billing company name   x
card-address1 Mandatory Billing Street Address Line 1   x
card-address2 Optional Billing Street Address Line 2   x
card-city Mandatory Billing City Address   x
card-state Mandatory Billing State Address   x
card-prov Optional Billing International Province.  For international provinces outside of US & Canada, set the "card-state" field's value to "ZZ" & include the province name here.   x
card-zip Mandatory Billing Zip Address   x
card-country Mandatory Billing Country Address   x
card-number Mandatory Credit Card Number   x
card-exp Mandatory Credit Card Expiration Date, Format: MM/YY   x
card-cvv Optional/Fraud Credit Card CVV Number. Mandatory for fraud protection.   x
phone Optional Customer contact number   x
fax Optional Customer Fax number   x
email Optional person@place.com - Address where customer's order confirmation is sent.   x
ipaddress Optional IP Address of originating client. Used for some fraud screening options.   x
routingnum Optional / Mandatory ABA bank routing number. Required for electronic check payments.   x
accountnum Optional / Mandatory Bank account number. Required for electronic check payments.   x
checknum Optional / Mandatory Bank account check number. Optional for electronic check payments.   x
orderID Optional Must be a unique number. If not submitted one will be generated using a date/time string. This number will be required to perform any future activity for an order, including but not limited to, voids and returns.   x
shipname Optional Shipping name   x
address1 Optional Shipping address - Line 1   x
address2 Optional Shipping address - Line 2   x
city Optional Shipping city   x
state Optional Shipping state   x
province Optional Shipping International Province.  For international provinces outside of US & Canada, set the "state" field's value to "ZZ" & include the province name here.   x
zip Optional Shipping zip   x
country Optional Shipping country   x
shipcompany Optional Shipping company name   x
shipphone Optional Shipping phone number   x
comments Optional Used to add comments to confirmation email   x
tax Optional Sales tax charge   x
 
Notes:		  
  1. If the success/badcard/problem-link URL is a program/cgi/script, all value/name pairs passed to the Payment URL, along with those listed below, will be POSTed back to the URL upon completion of the authorization process. They will also be included at the bottom of the confirmation email sent to the merchant. The server that will doing the POST to your URL will be our payment server. The IP of the machine calling your script will therefore be fixed and can be used to authenticate the POST request. The IP is 209.51.176.200. Your script is required to generate a web page as part of its execution. This web page will be redirected to the customer’s browser.  

2. To include a list of the items purchased in the confirmation emails sent to both the customer and the merchant, four name/value pairs are required for EACH item purchased, in the following format. This information will also be stored in our database and can be accessed for report generation from the payment administrative interface.
 
Name Value
item# Model number of item# purchased.
cost# Cost of Item#
quantity# Quantity of item#s purchased
description# Description of item#
Repeat the above 4 name/value pairs for each item purchased incrementing the value of "#" for each additional item.
I.E. If 2 items were sold, then 8 name/value pairs would be submitted with the following names.
 
First Item Second Item
item1,cost1,desciption1,quantity1 item2,cost2,description2,quantity2

Response Fields

The response string will consist of all name value pairs submitted along with the name value pairs delineated below.
Variable Value
FinalStatus success/badcard/problem
avs-code See Table AVS-1 in Appendix A
auth-code Authorization Code
MErrMsg Response Message
orderid Unique order id used to identify transaction for any future activity including voids and returns.
user-agent Browser or identifier of posting system.
ipaddress IP address of posting system