Get Started sPay

Software Partner API Reference

Reference EPS Rev 2.0

This manual is intended to assist developers in integrating the Pathward Merchant Portal API with their own software. It provides essential information for interacting with the API, without being specific to any single development platform.

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.

Disclaimer

Pathward provides this documentation on an “AS IS” basis, with no warranties of any kind. Pathward does not guarantee that its website or API will function securely or without interruptions. Furthermore, Pathward makes no representations or warranties regarding the API’s performance or the results that may be achieved through its use.

Pathward will not be liable for any direct, indirect, special, incidental, or consequential damages, or for any loss of profits, arising from the use of this documentation, even if Pathward was informed of the possibility of such damages. This limitation of liability applies whether the damage is caused by the client’s system or by Pathward’s services themselves.

Testing & Production

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

sPay 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

sPay Sample Request Data

	
  {
    "account_type" : "spay",
    "portal_website" : "dev.pathwardportal.com",
    "username" : "test@pathwardportal.com",
    "password" : "qCx(%e~6{A5&MBFY",
    "dayPhone": "9860668923",
    "evenPhone": "9860668923",
    "IpSignup": "4.14.150.145",
    "USCitizen": "TRUE",
    "BOAttestation": "TRUE",
    "TermsAcceptanceIP": "4.14.150.145",
    "TermsAcceptanceTimeStamp": "12-30-2024",
    "TermsVersion": "1",
    "NotificationEmail": "merchantsupport@pathward.com",
    "country": "USA",
    "BusinessLegalName": "A Legal Business LLC",
    "DoingBusinessAs": "A Legal Business LLC",
    "EIN": "193458989",
    "MCCCode": "5999",
    "WebsiteURL": "www.businessweb.com",
    "BusinessDesc": "My eBusiness",
    "MonthlyBankCardVolume": "2000000",
    "AverageTicket": "15000",
    "HighestTicket": "80000",
    "BusinessAddress": "120 Test",
    "BusinessAddress2": "Apt 3",
    "BusinessCity": "Atlanta",
    "BusinessCountry": "USA",
    "BusinessState": "GA",
    "BusinessZip": "30346",
    "BusinessType": "D",
    "BusinessPhoneNumber": "9860668923",
    "EstimatedCardUsageData": {
        "CardPresent": "0",
        "CardNotPresentKeyed": "0",
        "CardNotPresentEcommerce": "100"
    },
    "AccountCountryCode": "USA",
    "accountName": "Account Name",
    "AccountNumber": "123456",
    "AccountOwnershipType": "Personal",
    "accountType": "C",
    "BankName": "First Union",
    "RoutingNumber": "083908420",
    "BeneficialOwnerData": {
      "OwnerCount": "2",
      "Owners": [
          {
            "FirstName": "Jane",
            "LastName": "Doe",
            "Title": "President",
            "Address": "First Union",
            "Percentage": "75",
            "SSN": "193458989",
            "Country": "USA",
            "State": "GA",
            "City": "Atlanta",
            "Zip": "30346",
            "Email": "janetest@test.com",
            "DateOfBirth": "05-15-1995"
          },
         {
            "FirstName": "Joe",
            "LastName": "Doe",
            "Title": "CEO",
            "Address": "First Union",
            "Percentage": "25",
            "SSN": "193458989",
            "Country": "USA",
            "State": "GA",
            "City": "Atlanta",
            "Zip": "30346",
            "Email": "nmnchf8whi@yahoo.com",
            "DateOfBirth": "02-15-1990"
          }
        ]
     }
  }

sPay Sample Response

	
  {
   "Ok":true,
   "msg":"Created account successfull",
   "company":
    {
      "acctnumber":"718646543",
      "businesslegalname":"A Legal Business LLC",
      "pfirstname":"Test",
      "plastname":"Account",
      "dayphone":"5555555555",
      "merchantprofileid":3237405,
      "sourceemail":"test@pathward.com",
      "username":"test@pathward.com",
      "password":"qCx(%e~6{A5&MBFY",
      "reset":1
   }
 }

Params	Demo Data	Max	Required	Notes
account_type	spay		Required	sPay: Simple Pay
portal_website	dev.pathwardportal.com		Required	URL will be updated to specific portal once live.
username	test@pathward.com	100	Required	Username used to login to RA Portal https://ra.pathwardportal.com
password	qCx(%e~6{A5&MBFY	30	Required	Password used to login to RA Portal
dayPhone	5555555555	10	Required	Must be 10 characters with no dashes
evenPhone	5555555555		Required	Must be 10 characters with no dashes
USCitizen	TRUE			Must be sent as True or False
BOAttestation	TRUE			Must be sent as True or False
BusinessLegalName	My Tax Service LLC		Required	The legal name of the business as registered.
DoingBusinessAs	My Tax Service LLC		Required	This field can be used to provide DBA information on an account.
EIN	34232323	9	Required	EIN should be entered without a dash
MCCCode	7276		Required	Merchant Category Code 7276 => Tax Preparation Services 8931 => Accounting, Auditing, and Bookkeeping Services
BusinessDesc	Tax Preparation		Required	The Business’ description
BusinessAddress	123 Main St		Required	Business Physical Address
BusinessAddress2
BusinessCity	Atlanta		Required	Business Physical Address City
BusinessCountry	USA		Required	Must be ISO standard 3 characters country code.
BusinessState	GA		Required	Must be one of the standard 2 characters abbreviations.
BusinessZip	99999	5	Required	Zip Code should be set 5 characters
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
BusinessPhoneNumber	5555555555	10	Required	Must be 10 characters with no dashes
AccountCountryCode	USA	3	Required	Must be ISO standard 3 characters country code.
accountName	Account Name	32	Required	Merchant/Individual Name.
AccountNumber	123456	25	Required	Financial institution account number.
AccountOwnershipType	Business	15	Required	Valid values are: Personal and Business
accountType	C		Required	Valid values are: C – Checking S – Savings
BankName	Bank of America		Required	Name of financial institution.
RoutingNumber	110000025	9	Required	Financial institution routing number. Must be a valid ACH routing number.
BeneficialOwnerData:			Required	Merchant Beneficiary Owner Information – Required for all merchants validating KYC based off of personal data. Only certain types of merchants are exempt from this requirement.
OwnerCount	2		Required	Number of Beneficiary Owners, should be maximum 5.
Owners:			Required
FirstName	John		Required	Owner First Name.
LastName	Doe		Required	Owner Last Name.
Title	Owner		Required	This field contains the Title.
Address	123 Main		Required	Street address where Owner resides. *Required if passing Merchant Beneficiary Owner Information.
Percentage	100		Required	Percentage for Owner. Percentage should be in between 0 and 100.
SSN	444334444	9	Required	Social Security Number of the Owner. Should be 9 digits.
Country	USA		Required	The three-character, alpha country code for where the Owner resides.
State	GA		Required	The region code that corresponds to the state where the Owner resides.
City	Atlanta		Required	The name of the city where the Owner resides.
Zip	99999		Required	The postal code where the Owner resides.
Email	test@pathward.com		Required	Owner Email ID.
DateOfBirth	05-15-1995		Required	Date of Birth of the Owner. Must be in ‘mm-dd-yyyy’ format.