{"_id":"5bedd214812951004a2ad959","category":{"_id":"5bedd214812951004a2ad94d","version":"5bedd214812951004a2ad9df","project":"57336fd5a6a9c40e00e13a0b","__v":0,"sync":{"url":"","isSync":false},"reference":false,"createdAt":"2015-10-15T16:21:09.840Z","from_sync":false,"order":10,"slug":"errors","title":"Errors"},"user":"560d5913af97231900938124","project":"57336fd5a6a9c40e00e13a0b","parentDoc":null,"version":{"_id":"5bedd214812951004a2ad9df","project":"57336fd5a6a9c40e00e13a0b","__v":0,"forked_from":"5bcf36ac4eaaa605217d94b8","createdAt":"2018-04-24T15:22:41.561Z","releaseDate":"2018-04-24T15:22:41.561Z","categories":["5bedd214812951004a2ad943","5bedd214812951004a2ad944","5bedd214812951004a2ad945","5bedd214812951004a2ad946","5bedd214812951004a2ad947","5bedd214812951004a2ad948","5bedd214812951004a2ad949","5bedd214812951004a2ad94a","5bedd214812951004a2ad94b","5bedd214812951004a2ad94c","5bedd214812951004a2ad94d","5bedd214812951004a2ad94e","5bedd214812951004a2ad94f","5bedd214812951004a2ad950","5bedd214812951004a2ad951"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":false,"codename":"3.28 Release","version_clean":"8976.0.0-JSON","version":"8976-JSON"},"githubsync":"","__v":0,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2016-01-04T20:31:51.124Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":7,"body":"The following errors can be returned in response to a Batch Transaction request.\n[block:callout]\n{\n  \"type\": \"info\",\n  \"title\": \"Format of batch transaction errors\",\n  \"body\": \"Some batch transaction errors are formatted differently from other error types. They include the `processing-info` element, which contains the `processing-status`, `processing-error-code`, `processing-error-name`, and `processing-error-description` elements. For details, see the sample error below.\"\n}\n[/block]\n\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Code\",\n    \"h-1\": \"Name\",\n    \"h-2\": \"Description\",\n    \"1-0\": \"2\",\n    \"2-0\": \"3\",\n    \"3-0\": \"4\",\n    \"1-2\": \"callback-url element is required\",\n    \"1-1\": \"MISSING_CALLBACK_URL\",\n    \"2-1\": \"MISSING_BATCH_ID\",\n    \"2-2\": \"batch-id element is required\",\n    \"3-2\": \"Batch ID already exists\",\n    \"3-1\": \"DUPLICATE_BATCH_ID\",\n    \"0-0\": \"0\",\n    \"4-1\": \"MISSING_MERCHANT_TRANSACTION_ID\",\n    \"0-1\": \"UNEXPECTED_ERROR\",\n    \"4-0\": \"6\",\n    \"9-0\": \"20011\",\n    \"9-1\": \"TRANSACTION_TYPE_NOT_ALLOWED\",\n    \"9-2\": \"Only AUTH_CAPTURE card transactions, ECP or recurring PayPal payments are allowed in Batch\",\n    \"4-2\": \"merchant-transaction-id element is required for card transactions\",\n    \"0-2\": \"An unexpected error has occurred.\",\n    \"6-2\": \"The API version passed in the request is invalid.\",\n    \"6-0\": \"10000\",\n    \"6-1\": \"INVALID_API_VERSION\",\n    \"8-2\": \"User input suspected as malicious.\",\n    \"8-0\": \"11001\",\n    \"8-1\": \"XSS_EXCEPTION\",\n    \"7-0\": \"10001\",\n    \"7-2\": \"The resource passed in the request has violated validation rules. Additional information about the specific issue is provided in the error description.\",\n    \"7-1\": \"VALIDATION_GENERAL_FAILURE\",\n    \"5-0\": \"101\",\n    \"5-1\": \"INVALID_BATCH_ID\",\n    \"5-2\": \"Invalid batchId\"\n  },\n  \"cols\": 3,\n  \"rows\": 10\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"<?xml version=\\\"1.0\\\" encoding=\\\"UTF-8\\\" standalone=\\\"yes\\\"?>\\n<batch-transaction xmlns=\\\"http://ws.plimus.com\\\">\\n  <batch-id>123</batch-id>\\n  <callback-url>http://localhost:8080/jsp/batch_callback.jsp</callback-url>\\n  <processing-info>\\n    <processing-status>fail</processing-status>\\n    <processing-errors>\\n      <processing-error>\\n        <processing-error-code>2</processing-error-code>\\n        <processing-error-name>MISSING_CALLBACK_URL</processing-error-name>\\n        <processing-error-description>callback-url element is required</processing-error-description>\\n      </processing-error>\\n    </processing-errors>\\n  </processing-info>\\n</batch-transaction>  \",\n      \"language\": \"xml\",\n      \"name\": \"Sample Batch Transaction Error\"\n    }\n  ]\n}\n[/block]","excerpt":"","slug":"batch-errors","type":"basic","title":"Batch Transaction Errors"}

Payment API (JSON)

Card/Wallet Transactions

PayPal Transactions

ACH/ECP Transactions

SEPA Direct Debit Transactions

Refunds

Vaulted Shoppers

Subscriptions

Marketplace

Wallets

Errors

JSON Objects

Test Data & Codes

Guides & Tools

Mobile SDK

Batch Transaction Errors

The following errors can be returned in response to a Batch Transaction request.

Format of batch transaction errors

Some batch transaction errors are formatted differently from other error types. They include the processing-info element, which contains the processing-status, processing-error-code, processing-error-name, and processing-error-description elements. For details, see the sample error below.

Code
Name
Description

0

UNEXPECTED_ERROR

An unexpected error has occurred.

2

MISSING_CALLBACK_URL

callback-url element is required

3

MISSING_BATCH_ID

batch-id element is required

4

DUPLICATE_BATCH_ID

Batch ID already exists

6

MISSING_MERCHANT_TRANSACTION_ID

merchant-transaction-id element is required for card transactions

101

INVALID_BATCH_ID

Invalid batchId

10000

INVALID_API_VERSION

The API version passed in the request is invalid.

10001

VALIDATION_GENERAL_FAILURE

The resource passed in the request has violated validation rules. Additional information about the specific issue is provided in the error description.

11001

XSS_EXCEPTION

User input suspected as malicious.

20011

TRANSACTION_TYPE_NOT_ALLOWED

Only AUTH_CAPTURE card transactions, ECP or recurring PayPal payments are allowed in Batch

Sample Batch Transaction Error
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<batch-transaction xmlns="http://ws.plimus.com">
  <batch-id>123</batch-id>
  <callback-url>http://localhost:8080/jsp/batch_callback.jsp</callback-url>
  <processing-info>
    <processing-status>fail</processing-status>
    <processing-errors>
      <processing-error>
        <processing-error-code>2</processing-error-code>
        <processing-error-name>MISSING_CALLBACK_URL</processing-error-name>
        <processing-error-description>callback-url element is required</processing-error-description>
      </processing-error>
    </processing-errors>
  </processing-info>
</batch-transaction>