Get Started iPay

Software Partner API Reference

Reference EPS Rev 2.0

Most of the methods in the API require the merchant authentication credentials. Send your merchant key and API key with the query to authenticate your request:

While Pathward offers resources to support developers in building solutions for the software, it remains the developer’s responsibility to create their own solution on the chosen platform and ensure proper utilization of Pathward’s services.

• Merchant Key - A string of digits assigned to each merchant when its payment processing account was created. It is a permanent assignment. The merchant key parameter name is 'merchantkey'.
• API Key - A string which is assigned to your merchant setup when you activate the Intellipay Web API service. The API key parameter name is 'apikey' Keep your API key private and never share it with anyone. Protect it just as you would a password.

Together, the merchantkey and apikey work as a username/password pair which the system uses to authenticate calls made to it and link to the merchant’s account.

To use the web API, you must first set up a merchant account . You will receive a merchant key and an API key that you will use to authenticate your calls to the API.

Testing & Production

API URL: https://eps.pathwardportal.com/api/singup

iPay Sign Up

Create An Account

This method will create a Merchant Account which is a link between a client’s Pathward credentials and an established processor merchant account.

HTTP URL: https://eps.pathwardportal.com/api/signup

HTTP Verb: PUT

iPay Sample Request Data

	
  {
    "account_type" : "ipay",
    "portal_website" : "dev.pathwardportal.com",
    "businesslegalname": "A Legal Business LLC",
    "doingbusinessas": "A Legal Business LLC",
    "address": "120 Test",
    "address2": "Mailing Address (If different from business)",
    "city": "Atlanta",
    "BusinessCountry": "USA",
    "us_state": "GA",
    "zipcode": "30346",
    "firstname": "D",
    "lastname": "Freddy",
    "phone": "9860668923",
    "businesstype": "D",
    "email": "dev@gmail.com",
    "ein": "193458989",
    "years": "Years in Business",
    "producttype": "S",
    "priorprocess": "C",
    "terminated": "C",
    "terminationreason": "T",
    "owners": [
      {
        "ownfirstname": "Jane",
        "ownlastname": "Doe",
        "owntitle": "President",
        "ownaddress": "First Union",
        "ownpercent": "75",
        "ownssn": "193458989",
        "ownstate": "GA",
        "owncity": "Atlanta",
        "ownzip": "30346",
        "ownemail": "janetest@test.com",
        "owndob": "05-15-1995"
      },
      {
        "ownfirstname": "Joe",
        "ownlastname": "Doe",
        "owntitle": "CEO",
        "ownaddress": "First Union",
        "ownpercent": "25",
        "ownssn": "193458989",
        "ownstate": "GA",
        "owncity": "Atlanta",
        "ownzip": "30346",
        "ownemail": "joetest@yahoo.com",
        "owndob": "02-15-1990"
      }
    ]
  }

iPay Sample Response

Params	Demo Data	Max	Required	Notes
account_type	ipay		Required	iPay: Traditional Merchant
portal_website	dev.pathwardportal.com		Required	URL will be updated to specific portal once live.
businesslegalname	A Legal Business LLC		Required	The legal name of the business as registered.
doingbusinessas	A Legal Business		Required	This field can be used to provide DBA information on an account.
address	120 Test	10	Required	Business Physical Address
address2				If different from business
city	Atlanta		Required
us_state	GA	2		Must be one of the standard 2 characters abbreviations.
zipcode	99999	5	Required	Zip Code should be set 5 characters
firstname	Jane		Required
lastname	Doe		Required
phone	9860668923	10	Required	Must be 10 characters with no dashes
businesstype	D		Required	D => C - Corp. (Non-publicly traded) Limited Company E => C - Corp. (Publicly traded) F => 501c3 Non-Profit Organization G => Municipality or Government Organization M => LLC (Non-publicly traded) N => LLC (Publicly traded) Q => General Partnership R => Publicly Traded Partnership Limited Liability Partnership S => Sole Proprietorship Sole Trader X => American Express Reserved Indicator P => Limited Partnership
email	dev@gmail.com		Required	Owner Email ID
ein	193458989	9	Required	EIN should be entered without a dash
years			Required	Years in Business
producttype	Tax Services		Required	Type of Product(s) / Service(s) Taking Payments for:
priorprocess	Yes		Required	Have you processed credit cards before? Set as Yes or No
terminated	No		Required	Have you ever been terminated from a processor before? Set as Yes or No
terminationreason		string		Reason for Termination
ownfirstname	Jane		Required	Name of Owner
ownlastname	Doe		Required	Owner Last Name
owntitle	President		Required	Title Owners Hold
ownpercent	50		Required	Percentage for Owner. Percentage should be in between 0 and 100.
ownssn	193458989	9	Required	Social Security Number of the Owner. Should be 9 digits
owndob	05-15-1995		Required	Date of Birth of the Owner. Must be in ‘mm-dd-yyyy’ format.
ownaddress	123 Main St		Required	Street address where Owner resides. *Required if passing Merchant Beneficiary Owner Information.
owncity	Atlanta		Required	The name of the city where the Owner resides.
ownstate	GA	2		Must be one of the standard 2 characters abbreviations.
ownzip	30346		Required	The postal code where the Owner resides.
ownemail	janetest@test.com		Required	Owner Email ID.
ownfirstname	John		Required	Owner First Name.
ownlastname	Doe		Required	Owner Last Name.
owntitle	Owner		Required	This field contains the Title.
ownpercent	50		Required	Percentage for Owner. Percentage should be in between 0 and 100.
ownssn	193458989	9	Required	Social Security Number of the Owner. Should be 9 digits
owndob	02-15-1990	9	Required	Date of Birth of the Owner. Must be in ‘mm-dd-yyyy’ format.
ownaddress	123 Parkway Dr		Required	Street address where Owner resides. *Required if passing Merchant Beneficiary Owner Information.
owncity	Atlanta		Required	The name of the city where the Owner resides.
ownstate	GA	2	Required	Must be one of the standard 2 characters abbreviations.
ownzip	99999		Required	The postal code where the Owner resides.
ownemail	janetest@test.com		Required	Owner Email ID.

iPay Sign Up | iPay Process Payment