NAV Navbar

Logo
Logo

Introduction

Payment Data Systems - Enrollment API Documentation

PDS Enrollment API is a robust web service with SOAP, WCF and REST/JSON endpoints.
You will be able to create sub-merchants as well as view their current status.

Last updated on, 4/16/2019 © Payment Data Systems.

Change Log

DateAuthorVersionChange Summary
11/9/2018 Tracy Rickman 1.0 Initial web release
1/28/2019 Rachel Carlini 1.1 Updated endpoints
3/25/2019 Rachel Carlini 1.2 Added webhook section
4/16/2019 Rachel Carlini 1.3 Added sandbox environment

Environment

PRODUCTION https://enroll.securepds.com

Production

https://enroll.securepds.com

SOAP/WFC WSDL

https://enroll.securepds.com/enroll.svc?wsdl

REST/JSON Endpoints and definitions:

https://enroll.securepds.com/enroll.svc/JSON/help

Sandbox

https://devenroll.securepds.com

SOAP/WFC WSDL

https://devenroll.securepds.com/enroll.svc?wsdl

REST/JSON Endpoints and definitions:

https://devenroll.securepds.com/enroll.svc/JSON/help

Required Parameters in all calls

Parameter NameDescription
merchantID Merchant ID assigned by Payment Data Systems
login API Username
passwordAPI Password

Parameter values for sandbox

parameter nametest value
merchantID 12706313
login API12706313
password2pscavkjwe

Enrollment

Create Sub-Merchant

POST https://enroll.securepds.com/enroll.svc/JSON/CreateMerchant

            
{
   "merchantID": "string",
   "login": "string",
   "password": "string",
   "emailAddress": "string",
   "dbaName": "string",
   "legalName": "string",
   "businessDesc": "string",
   "businessStartDate": "string",
   "mcc": "string",
   "naics": "string",
   "ownershipType": "string",
   "fedTaxID": "string",
   "addressLine1": "string",
   "addressLine2": "string",
   "city": "string",
   "state": "string",
   "postalCode": "string",
   "busPhoneNo": "string",
   "website": "string",
   "ccMonthlyVolume": "string",
   "ccAverageTicket": "string",
   "ccHighTicket": "string",
   "achMonthlyVolume": "string",
   "achAverageTicket": "string",
   "achHighTicket": "string",
   "swipedPercent": "string",
   "keyedPercent": "string",
   "eComPercent": "string",
   "principalFirstName": "string",
   "principalLastName": "string",
   "principalTitle": "string",
   "principalAddress1": "string",
   "principalAddress2": "string",
   "principalCity": "string",
   "principalState": "string",
   "principalPostalCode": "string",
   "principalPhoneNo": "string",
   "principalDOB": "string",
   "principalLast4SSN": "string",
   "ownershipPercent": "string",
   "accountHolderName": "string",
   "bankRouteNo": "string",
   "bankAccountNo": "string",
   "isPersonal": false,
   "webhook_url": "string"
}
                
            

The above command returns the following JSON structure:

            
{
   "message": "string",
   "status": "string",
 "validationErrors":
         [ 
           { 
      	     "errorDescription": "string",
      	     "fieldName": "string"
           }
      ],
   "guid": "string"
}
                
            

Enroll a merchant in Payment Data Systems

HTTP Request

POST https://enroll.securepds.com/enroll.svc/JSON/CreateMerchant

Parameters

NameTypeRequiredLengthDescription
merchantID string Required 50 Your Merchant ID
login string Required 50 Username for the Enrollment Site
password string Required 100 Password for the Enrollment Site
emailAddress string Required 50 Business Address
dbaName string Required 50 Doing Business As Name
legalName string Required 50 Legal Business Name / Legal Name if Sole Prop
businessDesc string Optional 50 Business Description
businessStartDate string Optional N/A Date of Business Start
mcc string Optional 10 Merchant Category Code
naics string Optional 10 NAICS Code
ownershipType string Optional 50 Ownership Types: "Partnership", "C-Corp Private", "S-Corp Private", "Sole Prop", "Partnership Private", "LLC Private", "Not For Profit", "C-Corp Public", "S-Corp Public", "Government Agency", "LLC Public"
fedTaxID string Optional 11 Federal Tax ID / SSN if Sole Prop
addressLine1 string Optional 50 Business Address Line 1
addressLine2 string Optional 50 Business Address Line 2
city string Optional 38 Business City
state string Optional 2 Business State
postalCode string Optional 5 Business Postal Code
busPhoneNo string Optional 12 Business Phone Number
website string Optional 50 Business Website
ccMonthlyVolume string Optional 0 - 1,000,000 CC Monthly Volume
ccAverageTicket string Optional 0 - 1,000,000 CC Average Ticket
ccHighTicket string Optional 0 - 1,000,000 CC High Ticket
achMonthlyVolume string Optional 0 - 1,000,000 ACH Monthly Volume
achAverageTicket string Optional 0 - 1,000,000 ACH Average Ticket
achHighTicket string Optional 0 - 1,000,000 ACH High Ticket
swipedPercent string Optional 0 - 100, whole numbers only Percentage of Business Done via Card Swiped
keyedPercent string Optional 0 - 100, whole numbers only Percentage of Business Done via Keyed Card (Card Not Present)
eComPercent string Optional 0 - 100, whole numbers only Percentage of Business Done via eCommerce
principalFirstName string Optional 50 Principal First Name
principalLastName string Optional 50 Principal Last Name
principalTitle string Optional 50 Principal Title
principalAddress1 string Optional 50 Principal Address Line 1
principalAddress2 string Optional 50 Principal Address Line 2
principalCity string Optional 38 Principal City
principalState string Optional 2 Principal State
principalPostalCode string Optional 5 Principal Postal Code
principalPhoneNo string Optional 12 Principal Phone Number
principalDOB string Optional N/A Principal DOB
principalLast4SSN string Optional 4 Principal Last 4 SSN
ownershipPercent string Optional 0 - 100, whole numbers only Ownership Percentage
accountHolderName string Optional 50 Name on Account
bankRouteNo string Optional 9 Settlement Account Routing Number
bankAccountNo string Optional 4 - 17 Settlement Account Number
isPersonal boolean Optional N/A Settlement Account Type
webhook_url string Optional 100 Webhook URL

Response

NameTypeDescription
message string Response Message
status string Indicates success or failure
validationErrors object Displays list of errors, if any
   -errorDescription string Description of the error
   -fieldName string Name of erroneous field
guid string New merchant identifier

Sub-Merchant Status

POST https://enroll.securepds.com/enroll.svc/json/GetMerchantStatus

            
{
   "merchantID": "string",
   "login": "string",
   "password": "string",   
   "guid": "string"   
}
                
            

The above command returns the following JSON structure:

            
{
   "message": "string",
   "status": "string",
   "validationErrors":
         [ 
           { 
      	     "errorDescription": "string",
      	     "fieldName": "string"
           }
      ],
   "merchantList":
      [ 
           { 
      	     "dbaName": "string",
      	     "guid": "string",
      	     "legalName": "string",
      	     "login": "string",
      	     "merchantID": "string",
      	     "merchantStatus": "string",
      	     "password": "string"
           }
      ]
}
                
            

Check the status of a merchant. Send in guid to retrieve single merchant. Omit guid to retrieve information for all submerchants.

HTTP Request

POST https://enroll.securepds.com/enroll.svc/json/GetMerchantStatus

Parameters

NameTypeRequiredLengthDescription
merchantID string Required 50 Your Merchant ID
login string Required 50 Username for the Enrollment Site
password string Required 100 Password for the Enrollment Site
guid string Optional 50 Sub-Merchant Partner ID

Response

NameTypeDescription
message string Partner ID for the newly created sub-merchant.
status string Partner Key for the newly created sub-merchant.
validationErrors list Doing Business As Name
   -errorDescription object Displays list of errors, if any
   -fieldName string New merchant identifier
merchantList list Array of Merchants
   -dbaName string Merchant DBA Name
   -guid string Merchant GUID Identifier
   -legalName string Merchant Legal Name
   -login string Merchant Username
   -merchantID string Merchant's ID
   -merchantStatus string Merchant Current Status
   -password string Merchant Password

References

PDS Response Codes

PDS will return 6000 series response codes for errors that occur within our Enrollment system.

CodeDescription
6000 Security Violation
6004 Unable to Load Merchant Details
6089 Merchant Data Did Not Pass Validation
6090 Error Applying Inherited Data to Submerchant
6091 Invalid MCC Code
6092 Invalid NAICS Code
6093 Error Inserting Merchant into Database
6094 Error Updating Merchant Status

Webhooks

If you provided a webhook url during enrollment, any time the merchant status changes, a payload containing update information will be sent to the specified address. Details of the payload are described below:

Information will be POSTed to the webhook URL in the following JSON structure:

            
{ 
	 "dbaName": "string",
	 "guid": "string",
	 "legalName": "string",
	 "login": "string",
     "merchantID": "string",	
	 "merchantStatus": "string", 
	 "password": "string"
}
                
            
NameTypeDescription
   dbaName string Merchant DBA Name
   guid string Merchant GUID Identifier
   legalName string Merchant Legal Name
   login string Merchant Username
   merchantID string Merchant's ID
   merchantStatus string Merchant Current Status
   password string Merchant Password

Payments API

Please click here for access to our Payments API.