Opayo Reporting API
Error Codes
The table below lists all errorcode values that can be returned from the system, and the meaning of the code attached in the error node.
Note: Important: Please note that the wording of the error messages may change at a future date. Therefore, please ensure you reference the error codes themselves, not the error messages, when using these commands.
Error Code Table
Code | Error Message |
---|---|
0000 | Success |
0001 | The message received was not valid XML. |
0002 | Invalid command. XML root node should be vspaccess. |
0008 | The specified vendor and user combination is not valid, or the user may be locked out. |
0009 | Error (retrieving/updating or inserting) data. Please email support@opayo.io with this error. |
0010 | Cannot validate the signature value. |
0011 | You cannot execute the specified command without administrative privileges. |
0013 | The command passed in the command parameter was not recognised. |
0019 | Error parsing the request XML. Check the format of your request message. |
0021 | Cannot create the new user. Check that the user does not already exist. |
0038 | The start date you have supplied is after the end date. |
0039 | The end date is more than one month after the start date. You can only return reports at monthly intervals. |
0042 | You must supply one of the following nodes with this command, either vendortxcode OR vpstxid . |
0043 | Unable to find the transaction for the vendortxcode or vpstxid supplied. |
0044 | The user does not have permission to view this transaction. |
0045 | You cannot set the administrator password using the reporting API. Please contact support@opayo.io if you need this reset. |
0077 | A valid homepageurl value is required. |
0078 | A valid supportemailaddress value is required. |
0099 | Start Row and End Row range too large. The difference between the startrow and endrow value must be no greater than 50. |
0204 | templatetype element either not found, or present more than once. |
0205 | A valid templatetype value is required. |
0211 | startvalue value must be less than the endvalue value. |
0235 | More than 50,000 rows returned. Please refine the search. |
1115 | streamlinetnumber element is only required for a Streamline merchant number. |
2097 | The email address provided was not recognised by PayPal. |
2098 | The primary admin user cannot be locked. |
2099 | You cannot unlock your own user. |
2104 | A valid address value is required in the format 123.123.123.123. You may need to zero pad your IP address so that each number block contains three digits. |
2106 | A valid mask value is required in the format 123.123.123.123. You may need to zero pad your subnet mask so that each number block contains three digits. |
2128 | The command cannot be run for the vspvendorname provided. |
2142 | vendortxcode or vpstxid element either not found, or present more than once. |
2173 | The user must have access to the specified homepage . Either provide the user with access to the chosen homepage or select another homepage which the user has access to. |
2180 | You cannot delete your own user. |
2188 | mask is too restrictive. Only C class subnet masks are allowed for blocking. |
2193 | 3D Secure rule not added. Overlaps with an existing rule. |
2194 | AVSCV2 rule not added. Overlaps with an existing rule. |
2197 | The primary admin user cannot be deleted. |
2210 | No running server found. |
2212 | No successful transaction found within this duration. |
2213 | Exceeded the allowed amount of commands to execute. |
2214 | IP Address ##### not added. |
2216 | password can not be less than 8 characters. |
2217 | IP Address ##### not deleted. |
2219 | Card Range ##### not added. |
2220 | Card Range ##### not deleted. |
2221 | TerminalId ##### not added. |
2222 | endrow cannot be before startrow , please check. |
2223 | username and vendorname cannot be the same. Please provide different username value. |
2224 | There is no such username associated with your account. |
2225 | startdate cannot be after this month. |
2226 | expirydate cannot be before this month. |
2227 | You must provide the first 9 digits of the card number in the cardbegins field. |
2228 | Cannot complete request. One or more of the specified terminalids already exists for the merchant number/currency combination. |
2229 | A valid startvalue value is required, this must be value between 0 and 100000.00. |
2230 | A valid endvalue value is required, this must be value between 0 and 100000.00. |
2231 | txtype values must be either PAYMENT, REFUND, DEFERRED, REPEAT, REPEATDEFERRED, MANUAL, AUTHENTICATE or AUTHORISE. |
2232 | A valid authprocessor is required. This should be one of the following: Barclays Merchant Services, NatWest Streamline, Lloyds TSB Cardnet, HSBC, American Express, Diners Club, Bank Of Scotland, JCB, Bank Of Ireland, Omnipay, Alliance and Leicester, PayPal, Allied Irish Bank or ChasePaymentTech. |
2233 | Provided vendor name does not exist in the system. |
2234 | The following currency code(s) are either not valid or not supported: currency . Please supply ISO 4217 standard currency codes. |
2235 | A valid amount value is required ,this must be value between 0 and 999999999.99. |
2236 | Provided token id does not exist in the system. |
2237 | Specified merchantnumber already exists. |
2238 | Unable to find the transaction for the vpstxid supplied. |
2241 | reportingpassword can not be less than 8 characters. |
2242 | Unable to find the transaction for the t3mtxid supplied. |
2243 | endrow cannot be more than 50 if startrow is not provided. |
2244 | endrow cannot be equal to zero. |
2245 | Fraud screen detail does not exist for this transaction. |
2254 | The given vendorsurcharge cannot be found. |
2255 | This Surcharge already exists (paymentsystem and currency combination). |
2256 | The paymentsystem supplied is not available on any merchant accounts associated with this vendor account. |
2257 | The currency supplied is not available on any merchant accounts associated with this vendor account. |
2258 | Either the currency requested is not available for this payment system, or the supplied combination of currency and paymentsystem is not available for this vendor account. |
2260 | Surcharge not allowed on this payment system. |
2261 | Negative surcharge value is not allowed. |
2262 | Surcharge value for percentage cannot be greater than 100. |
2263 | The following language code(s) are either not valid or not supported: defaultlanguage . |
2264 | Incorrect Fixed value entered. Only zero or positive decimal values, to 2 decimal places. |
2265 | Incorrect Fixed value entered. Only zero or positive integer. |
2266 | Incorrect Percentage value entered. Only zero or positive decimal value, to 2 decimal places. |
2267 | PPro is not enabled for this vendor. |
3000 | ##### element present more than once. |
3001 | ##### element not found. |
3002 | A valid ##### value is required. |
3003 | A valid ##### value is required, this should be either ##### or #####. |
3004 | You must provide at least one ##### element within ##### node. |
3005 | XML does not match the protocol. ##### tag either not required for this command or XML structure is incorrect. |
3006 | ##### must be a numeric value. |
3007 | ##### must be a numeric value with up to 2 decimal places. |
3008 | ##### supplied is too long. |
3009 | ##### is an invalid date format. Please use format dd/MM/yyyy HH:mm |
3010 | Duplicate Key |
8888 | Unable to complete request. Please email support@opayo.io with this error. |
8890 | This service is temporarily unavailable due to maintenance. |
9074 | merchantnumber does not exist. |
9999 | Unable to complete request. Please email support@opayo.io with this error. |