v1

latestOpenAPI 3.1.0Apache 2.02026-07-2498321298.8 KB

Direct Debits

List direct debit batches

Returns a list of direct debit batches.

get/payments/v2beta/direct-debit-batches

Query parameters

limitinteger

Limit the number of items in resulting query response.

tokenstring

If a query response contains a non-empty nextToken, use that value as token query parameter to continue pagination.

Response

A list of direct debit batches.

nextTokenstring required

Pagination token for next page. The value will be a non-empty string if there are more resources to be fetched. The value will be an empty string if there are no more resources to be fetched.

tokenstring required

The pagination token that was used for this request. The value will be an empty string if no token query parameter was provided with the request.

limitinteger required

The page limit that was used for this request.

Example response

{
  "items": [
    {
      "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"
    }
  ],
  "nextToken": "eyIxIjogIlRoaXMgaXMgYSBkdW1teSBwYWdpbmF0aW9uIHRva2VuLiJ9",
  "token": "eyIwIjogIlRoaXMgaXMgYSBkdW1teSBwYWdpbmF0aW9uIHRva2VuLiJ9",
  "limit": 100
}