v1

latestOpenAPI 3.1.0Apache 2.02026-07-2498321298.8 KB

Direct Debits

Get direct debit batch

Retrieve a specific direct debit batch.

get/payments/v2beta/direct-debit-batches/{id}

Path parameters

idstring required

Atlar resource ID or External ID. Prefix External IDs with external:.

Response

A direct debit batch.

idstring required

Unique resource identifier.

organizationIdstring required

Unique resource identifier for an Organization.

treatment'INDIVIDUAL_PAYMENTS' | 'BATCH' required

Deprecated: You can approve or reject on batch and individual level regardless of the treatment type.

status'CREATED' | 'PROCESSING_STARTED' | 'COMPLETED' required

The status of this batch. The status only refers to the processing of the input, not the processing or success of the resources themselves.

COMPLETED is the only end-state. Failure is indicated by a non-empty list of errors.

externalIdstring

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:.

creatorUserIdstring

Unique resource identifier.

metadataMetadata nullable

Metadata is a string-string key-value container that can be used to store information known at the time of resource creation. This can be retrieved later on, for instance when a payment or expected transaction is reconciled with the booked transaction on the bank statement.

Metadata can have at most 20 entries. Keys may have a maximum length of 64 chars and values a maximum length of 512 chars.

By default, this field is optional. It is possible to make it required in the Atlar Dashboard by visiting the Metadata keys page. Requirement rules can be specified per API resource. Both the Dashboard and the API will then enforce these rules and give validation errors when the required fields are not set.

etagstring required

ETag based on the resource version. This can be passed along in If-Match HTTP header when updating a resource to perform a conditional update.

versioninteger required

Resource version. Starts at value 1 when the resource is created and increases by one for each successive update.

createdstring date-time required

Time at which the resource was created.

updatedstring date-time required

Time at which the resource was last updated.

Example response

{
  "id": "2ed9a3ee-60aa-4f9f-a858-2eed4eefbbc8",
  "organizationId": "0160f6ab-5741-49e1-af46-9138927e547e",
  "treatment": "INDIVIDUAL_PAYMENTS",
  "input": {
    "sums": [
      {
        "currency": "EUR",
        "stringValue": "15.02",
        "value": 1502
      }
    ],
    "content": {
      "size": 4711,
      "checksum": "sha256:08343d976a896e8563b4915c84878207199b5fa139d3edde1bd77d99339bd18c",
      "filename": "batch-2022-05-07.csv"
    }
  },
  "inputContent": {
    "size": 4711,
    "checksum": "sha256:08343d976a896e8563b4915c84878207199b5fa139d3edde1bd77d99339bd18c",
    "filename": "batch-2022-05-07.csv"
  },
  "inputDetails": {
    "sums": [
      {
        "currency": "EUR",
        "stringValue": "15.02",
        "value": 1502
      }
    ]
  },
  "results": {
    "sums": [
      {
        "currency": "EUR",
        "stringValue": "15.02",
        "value": 1502
      }
    ]
  },
  "resultDetails": {
    "sums": [
      {
        "currency": "EUR",
        "stringValue": "15.02",
        "value": 1502
      }
    ]
  },
  "status": "COMPLETED",
  "errors": [
    {
      "code": "invalid_value",
      "error": "Must be one of [direct_debits mandates payments]",
      "field": "filter.0.resource"
    }
  ],
  "approvalSteps": [
    {
      "id": "735c7b8c-ef29-456a-8caf-113be117d131",
      "status": "APPROVED",
      "approver": {
        "id": "2ed9a3ee-60aa-4f9f-a858-2eed4eefbbc8",
        "username": "john.smith@example.com",
        "name": "John Smith",
        "roleId": "2a1e16eb-2f83-4597-99e2-cffbc4311df2"
      }
    }
  ],
  "externalId": "walVNuin6X5Mvte4xhg1ibTAVSACfN4Q9hl",
  "creatorUserId": "2ed9a3ee-60aa-4f9f-a858-2eed4eefbbc8",
  "metadata": {
    "my_metadata_key": "2a9a79b9-601c-449b-aa05-432f41dbbc4a"
  },
  "etag": "version:3",
  "version": 1,
  "created": "2022-05-04T18:31:12.889104898Z",
  "updated": "2022-05-04T18:47:32.213842599Z"
}