Software Partner API Reference

Reference EPS Rev 2.0

API Response Codes

 

The Pathward API returns (status) for every request. Status represents the overall outcome of the transaction and is not specific to a particular method. Developers should map the following values:


Code

Value

Notes

00

Success

The API request was successful

**Also indicates approval when returned by transaction processing methods**

20

Invalid username

The value <userId /> is already in use in Pathward’s system

21

Invalid TransType

Requested <transType /> method is not permitted for account

22

Invalid Currency Code

Verify that the value for <currencyCode /> is a valid ISO 3 characters currency code

23

Invalid Account Type

Verify the value for <accountType /> element is valid

24

Invalid Source Email

Verify that the value for <sourceEmail /> is valid email format. Value <sourceEmail /> must be unique in Pathward system.

25

Invalid First Name

The value <firstName /> cannot exceed 20 characters

26

Invalid M Initial

The value <mInitial /> cannot exceed 2 characters

27

Invalid Last Name

The value <lastName /> cannot exceed 25 characters

28

Invalid Address

Verify the value <Addr /> in all address tags (addr 1, 2, 3) is valid. Addr 1 value cannot exceed 50 characters.
P.O. Boxes are not allowed. See API manuals for
acceptable character limits.

29

Invalid Apt Number

Verify the value <aptNum /> is valid. Value cannot exceed 100 characters.

30

Invalid city

The value in the city tag cannot exceed 30 characters

31

Invalid state

The value <state /> cannot exceed 3 characters. U.S. state abbreviation values should contain only 3
characters.

32

Invalid Zip

This indicates the zip code is missing (null), the format for the given country is invalid, or the zip code exceeds the allowable length for the given country.

33

Invalid Mail Address

Verify the value <mailAddr /> is valid. Value cannot exceed 100 characters.

34

Invalid Mail Apt

Verify the value <mailApt /> is valid. Value cannot exceed 100 characters

35

Invalid Mail City

The value <mailCity /> cannot exceed 30 characters

36

Invalid Mail State

The value <state /> cannot exceed 3 characters. Note: U.S. state abbreviation values should contain only 2 characters.

37

Invalid Mail Zip

Verify the value for <mailZip /> is valid

38

Invalid Day Phone

Verify the value <DayPhone /> is valid. For USA and CAN, value must be 10 characters with no dashes.

39

Invalid Evening Phone

Verify the value <evenPhone /> is valid. For USA and CAN, value must be 10 characters with no dashes

40

Invalid SSN

Verify that the value for <ssn /> is valid. Must be 9 numerical characters without dashes.

41

Invalid Date of Birth

Verify that value <dob /> is valid and follows ‘mm-dd-yyyy’ format

42

Invalid Receiving Email

Verify that the value for <recEmail /> is valid email format

43

Invalid Known Account

Value for <knownAccount /> should be “Yes” or “No”

44

Invalid amount

Verify the value <amount /> is being passed without decimals or other non-numerical characters

45

Invalid invNum

The value <invNum /> cannot exceed 50 characters

46

Invalid Routing Number

Verify that the value <RoutingNumber /> is valid. Cannot exceed 9 characters.

47

Invalid Account Number

Invalid Bank Account Number

48

Invalid ccNum

Verify that the value for <ccNum /> element is valid. Card numbers must pass Luhn check.

49

Invalid expDate

Verify that the value for <expDate /> element is valid and follows ‘mmdd’ format.

50

Invalid cvv2

Verify the value <CVV2 /> is valid. Value should be 3 or 4 characters in length.

51

Invalid transNum and/or
Unable to act perform actions on transNum due to funding

Verify that the value <transNum /> is a valid numerical value, OR the requested action cannot be performed on the transaction.

52

Invalid split Number

 

53

A Pathward account with this email address already exists

Less common than status 87 which is returned because the email address provided is already being used as the username for an existing Pathward account.

54

A Pathward account with this social security number already exists

(Deprecated.) Pathward now allows multiple accounts to exist with the same SSN.

55

The email address provided does not correspond to a Pathward account.

Some older (no longer supported) integrations allowed transactions to be processed onto a Pathward account specified via email. (Deprecated)

57

Cannot settle transaction because it already expired

 

58

Credit card declined

The value of the responseCode element will provide info on the decline reason

59

Invalid Credential or IP address not allowed

Verify that the IP address that you are using has been whitelisted by Pathward. Verify that <certStr /> value is valid

60

Credit card authorization timed out; retry at a later time

Try again later

61

Amount exceeds single transaction limit

Value <amount /> exceeds the amount allowed for a single transaction. Contact your relationship manager if you need this increased

62

Amount exceeds monthly volume limit

The Pathward account has processed the maximum amount allowed in a single month. Contact your relationship manager if you need this limit increased.

63

Insufficient funds in account

There are not enough funds

64

Over credit card use limit

 

65

Miscellaneous error

General error; report the issue to Pathward

66

 Pathward account requires Additional Review

Partner should display a descriptive message guiding a new user to provide a picture of photo ID and proof of personal physical address. See notes below.

67

Unauthorized service requested

The acting entity or account is not configured to perform the requested action.

68

Account not affiliated

The action requested requires that the account share the same affiliation as the requesting credential

69

Duplicate invoice number (The same card was charged for the same amount with the same invoice number (including blank invoices) in a 1-minute period.

Duplicate <invNum /> element value. (The same card was charged for the same amount with the same invoice number (including blank invoices) in a defined

70

Duplicate external ID

<ExternalId /> values must be unique per affiliation

71

Account previously set up, but problem affiliating it with partner

 

74

Account or Trans Error

Many possible reasons, including MID not found for account.

75

Money already pulled

The funds have already been pulled

77

Empty results

 

78

Invalid Authentication

Authentication credentials are not valid

79

Generic account status error

Contact Pathward Customer Service

80

Invalid Password

Password is not valid

81

Account Expired

The Pathward account has expired. Contact your relationship manager

82

Invalid User ID

The value <userId /> is not a valid Pathward userId

84

Invalid Begin Date

Verify the value <beginDate />. Must follow format ‘mm-dd-yyyy’. BeginDate cannot be greater than End Date.

85

Invalid End Date

Verify the value <endDate />. Must follow format ‘mm- dd-yyyy’. End Date cannot be greater than Begin Date.

86

Invalid External ID

 

87

Duplicate User ID

Developer should display descriptive response that the email is already in use. See notes below.

90

Transaction already refunded

The transaction has already been refunded and cannot be refunded again

95

Invalid Country Code

The value in <country /> is not valid. Value should be ISO 3166 standard 3 character country codes.

96

Invalid PIN

 

97

Account created in documentary status

The account must be validated to be activated

98

Account created in documentary status, and must be paid for

The account must be validated and paid for to be activated

99

Account created successfully, but must be paid for.

The account must be paid for to be activated

100

Transaction Already Refunded

The transaction has already been refunded and cannot be refunded again

101

Refund Exceeds Original Transaction

The refund amount is greater than the original transaction amount.

102

Invalid Payer Name

The value <payerName /> is not valid.

103

Transaction does not meet date criteria

 

104

Transaction could not be refunded due to current transaction state.

 

105

Direct deposit account not specified

 

110

Required field is missing

Returned for edit Pathward account. See Response element for field name.
Returned if account edit was attempted on an
account not belonging to the affiliation.

111

Invalid EIN

Verify the <EIN /> element value is valid. See IRS.GOV for valid values.

112

Invalid business legal name (DBA)

<BusinessLegalName /> is required for business account type signups.

113

One of the business legal address fields is invalid

 

114

Business city is invalid

The value <BusinessCity /> cannot exceed 30 characters

115

Business state is invalid

The value <BusinessState /> cannot exceed 3 characters. For a U.S. state, follow standard 2 character abbreviation.

116

Business zip is invalid

Verify that the value <BusinessZip /> is valid. Cannot exceed 9 characters.

117

Business country is invalid

The value <BusinessCountry /> cannot exceed 3 characters. Should follow standard 3 character country code format.

118

Mailing address invalid

 

119

Business address is invalid

 

120

Incomplete business address

 

126

Currency code not allowed for this transaction

Value <currencyCode /> must be an allowed currency for the merchant account

127

Currency code not permitted for this account

Value <currencyCode /> must be an allowed currency for the merchant account

128

Requires Additional Validation

 

131

Capture amount exceeds allowed amount

Capture <amount /> value cannot be more than the initial authorization amount

132

Account setup does not allow capture for amount greater than authorization

Capture <amount /> value cannot be more than the initial authorization amount

133

Threat Metrix risk denied (no responseCode is returned)

 

134

Threat Metrix Invalid SessionId

 

135

Threat Metrix Invalid Account configuration

Contact Pathward Risk Department

136

External Payment Method Not Provided

 

137

External Payment Provider not provided

 

138

External Payment Identifier not provided

 

139

External Payment Provider not valid

 

140

External Payment Method Provided

 

141

Inactive or blocked MCC Code

Unable to use passed value <MCCCode /> due to the
MCC Code being blocked or inactive with the card brands

142

Invalid MCC Code Non-numeric or not in Pathward® database

Verify that the value <MCCCode /> is valid. Value cannot exceed 4 characters. Value must be numerical.

143

   Gross settle: invalid credit card information

Verify the value <GrossSettleCreditCardNumber /> is valid. Cannot exceed 16 characters and must pass Luhn check.

144

Gross settle: invalid billing information

 

145

Gross settle: no billing information was included with the payment info

 

146

Gross settle: error setting up billing information

 

147

Gross settle: Tier does not support gross settlement

The tier provided as <tier /> element has not been configured to support gross settlement

148

ExternalPaymentMethodIdentifier Invalid

Verify that the value <externalPaymentMethodIdentifier /> is valid. Must be a valid Visa Checkout payment identifier.

149

Invalid DoingBusinessAs

Verify <DoingBusinessAs /> element value is valid.

150

Invalid Service Setting

One or more request tags contain invalid data.

151

Amex Enhanced Account Not Configured

 

152

Bad Request

The request has extra tags which are not required.

153

Invalid Payment Type

The payment type is not valid.

154

Invalid Significant Owner Percentage

The Significant Owner Percentage value provided is invalid. Check the </SignificantOwnerPercentage> tag.

155

Invalid Significant Owner Date of Birth

The Significant Owner Date of Birth provided is invalid. Check the </SignificantOwnerDateofBirth> tag.

156

Invalid Significant Owner SSN

The Significant Owner Social Security Number provided is invalid. Check the </SignificantOwnerSSN> tag.

157

Invalid Notification Email

The Notification Email provided is invalid. Check the </NotificationEmail> tag.

158

Invalid Beneficial Owner Data

Beneficiary Owner Data provided in Signup Request is invalid, all Owner details provided are mandatory and should be valid.

159

Invalid Beneficial Owner Count

Beneficiary Owner Count provided in Signup Request is invalid. Owner count provided should be less than 6 and should not be greater than the list of Owners data provided in request.

160

Invalid card holder billing name

The cardholder billing last name doesn't match what is saved for the Pathward account

161

Invalid card for fast fund

The card provided for fast fund is invalid.

162

Transaction declined

The transaction is declined by visa direct.

163

Invalid card type

The card type is invalid.

166

Service unavailable

The Visa direct Rest service is unavailable.

167

Account not registered

The visa direct account is not registered.

168

Invalid Document Name

The uploading document name is not valid.

169

Invalid Document Type

The uploading document type is not valid.

170

Invalid Document

The uploading document is not valid.

171

Invalid Transaction Reference Number

The transaction reference number is not valid.

172

Invalid card holder name

The card holder name is invalid.

173

Invalid Referrer URL

URL passed for single-sign-on not properly formatted

174

Invalid IP Address

IP address passed for single-sign-on not properly formatted.

175

Invalid subnet mask

Subnet mask passed for single-sign-on not properly formatted.

182

Invalid Card Present Type Id

Invalid card present type id

183

Invalid Cardholder Identity Id

Invalid cardholder identity id

184

Invalid Cardholder Address

Invalid cardholder address

185

Missing Required Signup Data

One of the fields specifically required for your program is missing from your signup request.

190

Daily Transaction Limit Exceeded

Daily transaction limit has been exceeded

191

Invalid Comment

Value of Comment1 and/or Comment2 fields (if any), should be between 1-120 char, alphanumeric with period, comma, hyphen allowed

192

Invalid Account Credit Limit

Invalid account credit limit

203

Invalid Time Zone Data

The Time Zone data required for a Portico account is missing or incorrectly formatted.

204

Invalid Device Request Format

Indicates that the sign up request with device(s) is in invalid format.

206

Invalid Quantity

Indicates that the quantity of devices ordered is not valid.

231

InvalidAttemptNumber

The transaction number is invalid

232

Invalid Terms Acceptance IP

The terms acceptance IP address was invalid or incorrect

233

Invalid Terms Version

The submitted terms version is invalid or incorrect

242

Invalid Address Id

The address id exceeds the allowable length. This API response only applies if you are doing an Address Lookup (Equifax).

243

Invalid business Phone Number

The business phone number exceeds the allowable length or is null (blank).

249

Invalid Fee Type

The fee type indicated is not valid for this account or is not present in the system.

251

Invalid Token

Token expired or not a valid token or max attempts for token validation exceeded.

253

Invalid Token Requestor ID

Invalid Token Requestor ID

254

Both card and Token should not be present

Both card and token info should not be present.

260

Required Legal Address xField is Missing

Required legal address fields are missing /null: Legal Address, City, Zip, and Country. (Missing / Null Post Town will return code 241.)

261

Invalid External Transaction ID

Invalid External Transaction ID, or Max length exceeded or null value.

262

Missing or Invalid Bank Name

The Bank name is missing from the request and also cannot be found using the provided routing number

272

EIN Does Not Apply

Returned if the EIN field is used in Trans Type 01, or 42 for a country where the Employee Identification Number does not apply, or is replaced with a Business Registration Number, or some other specific identifier.