Submit a batch of requests

import requests
url = "https://api.ntropy.com/v3/batches"
payload = { "body": {
        "operation": "POST /v3/transactions",
        "data": [
            {
                "id": "txn_9f8b7c6d5e4a3b2c",
                "description": "Salary Payment March 2024",
                "date": "2024-03-31",
                "amount": 3500,
                "entry_type": "incoming",
                "currency": "EUR",
                "account_holder_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
            }
        ]
    } }
headers = {
    "X-Api-Key": "<apiKey>",
    "Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.json())

{
  "id": "203613d2-83c8-4130-8809-d14206eeec20",
  "operation": "POST /v3/transactions",
  "status": "processing",
  "created_at": "2024-04-01T08:00:00Z",
  "updated_at": "2024-04-01T08:00:30Z",
  "progress": 1,
  "total": 1
}

Creates a batch of requests and runs them asynchronously. Each element of data has to be compatible with the body expected by the operation. A batch representing the progress and the status of the process is returned as a result. You can retrieve the results using /v3/batches/:id/results once the batch has finished processing.

This endpoints supports up to 24960 requests.

Complete guide: Batches.

Creates a batch of requests and runs them asynchronously. Each element of `data` has to be compatible with the body expected by the `operation`. A batch representing the progress and the status of the process is returned as a result. You can retrieve the results using [/v3/batches/:id/results](./get-batch-results) once the batch has finished processing. This endpoints supports up to 24960 requests. Complete guide: [Batches](../../../batches).

Authentication

X-Api-Keystring

API Key authentication via header

Request

This endpoint expects an object.

operationenumRequired

An enumeration.

Allowed values:

datalist of objectsRequired

Response

Successful Response

idstring

A unique identifier for the batch.

operationenum

An enumeration.

Allowed values:

statusenum

The status of the batch. Results are not available for a batch with an error status.

Allowed values:

created_atdatetime

The timestamp of when the batch was created.

updated_atdatetime

The timestamp of when the batch was last updated.

progressinteger

The number of transactions processed so far.

totalinteger

The total number of transactions in the batch.

Errors

422

Unprocessable Entity Error