API Error Messages

Authorization

"errorCode": "InvalidCredentials",
"message": "Invalid username or password. Please try again."

This error means you are not using the correct credentials when attempting to access your Merchant via the API.

"errorCode": "Unauthorized",
"message": "Unauthorized",
"details": ["Unauthorized"]

This error means you are not using the correct merchantId.

Make a Payment Endpoint

MerchantId Field

"errorCode": "ValidationError",
"message": "Validation error happened",
"details": [ "merchantId required"]

When using our make a payment API. Please include the merchantId in your code. This is a required field.

"errorCode": "ValidationError",
"message": "Validation error happened",
"details": ["Could not convert string to integer: '. Path 'merchantId', line 2, position 21.", "merchantId required"]

This error is caused by sending in special characters instead of an int or string in the merchantId field.

"errorCode": "ValidationError",
"message": "Validation error happened",
"details": [ "Unexpected character encountered while parsing value: ,. Path 'merchantId', line 2, position 19." "After parsing a value an unexpected character was encountered: ". Path 'merchantId', line 3, position 4."]

This error is caused by sending in a the merchantId variable with no value or null assigned to it.

"errorCode": "ValidationError",
"message": "Validation error happened",
"details": ["Could not convert string to integer: 5161589748. Path 'merchantId', line 2, position 30.", "merchantId required"]

This is caused by sending in a mechantId that is longer then 9 digit.

TenderType Field

"errorCode": "ValidationError",
"message": "Validation error happened",
"details": ["Must specify valid information for parsing in the string.", "tenderType required. Must be one: Card, Check, Cash, or ACH." ]

When using the TenderType field, the value needs to be Card, Check, Cash, or ACH.

"errorCode": "ValidationError",
"message": "Validation error happened",
"details": ["Missing conditionally required field 'bankAccount' which is required when tenderType = 'ACH'","Missing required field 'entryClass' which is required when tenderType = 'ACH'"]

When using ACH as the tendertype, you must include the bankaccount field.

"errorCode": "ValidationError",
"message": "Validation error happened",
"details": [ "Cannot insert the value NULL into column 'PaymentTypeId', table 'MXG.dbo.Transaction_Batch'; column does not allow nulls. INSERT fails.::batch::::MID=516158974::PTId=NULL\r\nAn invalid application lock resource was passed to xp_userlock.::NULL::OId=NULL" ]

This error is caused by sending in a number instead of string in the tenderType field

Amount Field

"errorCode": "ValidationError",
"message": "Validation error happened",
"details": ["Input string was not in a correct format."]

This error occurs when you send in a string instead of an int for the amount field.

cardAccount Object

"errorCode": "ValidationError",
"message": "Validation error happened",
"details": ["Missing Account Information"]

This error is caused by leaving the number field empty.

"errorCode": "ValidationError",
"message": "Validation error happened",
"details": ["Invalid card number, no spaces allowed StringErrorTest"]

This error is caused by sending in a string instead of an integer in the number field

"errorCode": "ValidationError",
"message": "Validation error happened",
"details": ["Year, Month, and Day parameters describe an un-representable DateTime."]

This error is caused by sending in an invalid Int for the epiryMonth/epiryYear field.

"errorCode": "ContactCustomerSupport",
"message": "An error has occurred. Please contact customer support.",
"details": ["Input string was not in a correct format."]

This error is caused by sending a string instead of an integer in the expiryMonth field

"errorCode": "ValidationError",
"message": "Validation error happened",
"details": ["Missing expiration month and / or year"]

This error occurs when you send in the expiryMonth field with no value.

"errorCode": "ValidationError",
"message": "Validation error happened",
"details": [ "Value was either too large or too small for an Int32." ]

This error occurs when the integer you send in with expiryYear/expiryMonth is too large to be int32.

"errorCode": "ValidationError",
"message": "Validation error happened",
"details": [ "Incorrect zipcode format" ]

This error occurs when you send in any value besides numbers. This can also happen from submitting none 5 digit numbers.

Create Customer Endpoint

MerchantId Field

"errorCode": "ValidationError",
"message": "Validation error happened",
"details": [
"merchantId required"
]

When using our make a payment API. Please include the merchantId in your code. This is a required field.8

"errorCode": "ValidationError",
"message": "Validation error happened",
"details": [ "Could not convert string to integer: '. Path 'merchantId', line 2, position 21.", "merchantId required"]

This error is caused by sending in special characters instead of an int or string in the merchantId field.

"errorCode": "ValidationError",
"message": "Validation error happened",
"details": ["Unexpected character encountered while parsing value: ,. Path 'merchantId', line 2, position 19.","After parsing a value an unexpected character was encountered: ". Path 'merchantId', line 3, position 4."]

This error is caused by sending in a the merchantId variable with no value or null assigned to it.

"errorCode": "ValidationError",
"message": "Validation error happened",
"details": ["Could not convert string to integer: 5161589748. Path 'merchantId', line 2, position 30.","merchantId required"]

This is caused by sending in a mechantId that is longer than 9 digit.

Address1 & Address2 Field

"errorCode": "ValidationError",
"message": "Validation error happened",
"details": [ "address1 has to be at least 5 characters long" ]

This error occurs when you send a value that has less then 5 characters.

State Field

"errorCode": "ValidationError",
"message": "Validation error happened",
"details": [ "state is required" ]

This error occurs when you don't send in the state field and the state field is empty.

Zip Field

"errorCode": "ValidationError",
"message": "Validation error happened",
"details": [ "Incorrect zipcode format" ]

This error occurs when you send in any value besides numbers. This can also happen from submitting none 5 digit numbers.

CustomerType Field

"errorCode": "ValidationError",
"message": "Validation error happened",
"details": [ "Must specify valid information for parsing in the string." ]

This error is caused by sending in the customerType field empty.

"errorCode": "ValidationError",
"message": "Validation error happened",
"details": [ "Requested value '@@' was not found."]

This error is caused by sending special characters in the customerType field