Atlar · Schema

BatchResult

Result of processing an individual payment request as part of a batch request.

CompanyFintechTreasuryPaymentsBankingCash ManagementFinancial OperationsERP Integration

Properties

Name Type Description
paymentId string ID of the payment (a credit transfer or direct debit resource). Present if the result represent the successful creation of a credit transfer or direct debit resource.
errors array
skipped boolean Indicates whether a given payment request was skipped when processed as part of a batch.
recordIndex integer 0-based index specifying which record in the batch input that this result is associated with. If the batch input was a CSV file the `recordIndex` will refer to rows (lines) in the file. If the batch i
externalId object External ID of the payment, if any.
View JSON Schema on GitHub

JSON Schema

atlar-batch-result-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/atlar/json-schema/atlar-batch-result-schema.json",
  "title": "BatchResult",
  "description": "Result of processing an individual payment request as part of\na batch request.\n",
  "x-generated": "2026-11-10",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/atlar-direct-debits-api-openapi.yml#/components/schemas/BatchResult",
  "type": "object",
  "properties": {
    "paymentId": {
      "description": "ID of the payment (a credit transfer or direct debit\nresource). Present if the result represent the successful\ncreation of a credit transfer or direct debit resource.\n",
      "type": "string",
      "$ref": "#/$defs/ResourceID"
    },
    "errors": {
      "type": "array",
      "items": {
        "$ref": "#/$defs/ErrorDetails",
        "minItems": 0
      },
      "x-omitempty": true
    },
    "skipped": {
      "description": "Indicates whether a given payment request was skipped when\nprocessed as part of a batch.\n",
      "type": "boolean"
    },
    "recordIndex": {
      "description": "0-based index specifying which record in the batch input that\nthis result is associated with. If the batch input was a\nCSV file the `recordIndex` will refer to rows (lines) in\nthe file. If the batch input was JSON it will refer to\nJSON array indicies.\n\nIf the error(s) are not directly related to a specific\nrecord/row/line the `recordIndex` will not be present.\n",
      "type": "integer"
    },
    "externalId": {
      "$ref": "#/$defs/ExternalID",
      "description": "External ID of the payment, if any."
    }
  },
  "$defs": {
    "ErrorDetails": {
      "type": "object",
      "description": "Error detail.",
      "properties": {
        "code": {
          "description": "An error code for this error. Not always present.",
          "type": "string"
        },
        "error": {
          "description": "A description of this specific error.",
          "type": "string"
        },
        "field": {
          "description": "The field which has an error. This only set if the error has to do with a specific field, such as for validation errors. Nested fields are concatenated with `.`, as well as indexed fields in lists.",
          "type": "string"
        }
      }
    },
    "ExternalID": {
      "type": "string",
      "pattern": "^[a-zA-Z0-9._\\-+=]{1,64}$",
      "description": "External ID is optional to use, but if used, the Atlar platform will persist it, index it, as well as require it to be unique across all resources. It is possible to retrieve a resource using the external ID using the prefix `external:`.",
      "x-omitempty": true
    },
    "ResourceID": {
      "type": "string",
      "description": "Unique resource identifier.",
      "minLength": 32,
      "maxLength": 64
    }
  }
}

Work with this as data

Every JSON Schema here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for schemas

4 MCP tools reach this
  • find_json_schemasBrowse and filter every JSON Schema in the catalog.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This JSON Schema
curl "https://apis.io/api/v1/json-schemas/atlar-batch-result"
All schemas
curl "https://apis.io/api/v1/json-schemas?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.