🚀 We have launched a new version of the API. Read more about it in the [changelog](./changelog#new-version-of-the-api-). 🚀
Legacy DocsSign in
DocumentationChangelog
DocumentationChangelog
  • Get Started
    • Introduction
    • Get your API keys
    • Support
    • Privacy policy
    • Status
  • Transaction Enrichment
    • Overview
    • Entities Identification
    • Categorization
    • Recurrence
  • Bank Statements
    • Overview
    • Fast verification
  • Core resources
    • Batches
    • Entities
    • Account Holders
    • Webhooks
    • Personalization
    • Reporting wrong results
  • API Reference
    • Authentication
    • Errors
    • Request IDs
    • Pagination
    • Rate limits
LogoLogo
Legacy DocsSign in

🚀 We have launched a new version of the API. Read more about it in the changelog. 🚀

API ReferenceBatches

POST
https://api.ntropy.com/v3/batches
POST
/v3/batches
1curl -X "POST" \
2    "https://api.ntropy.com/v3/batches" \
3    -H "Accept: application/json" \
4    -H "X-API-KEY: cd1H...Wmhl"  \
5    -H "Content-Type: application/json" \
6    -d '{
7        "operation": "POST /v3/transactions",
8        "data": [
9            {
10                "id": "xbx8YP14g565Xk",
11                "description": "SQ* STARBUCKS 10 Union Sq",
12                "date": "2024-03-30",
13                "amount": 10.0,
14                "entry_type": "outgoing",
15                "currency": "USD",
16                "account_holder_id": "35b927b6-6fda-40aa-93b8-95b47c2b2cad",
17                "location": {
18                    "country": "US"
19                }
20            }
21        ]
22    }'
23
Try it
1{
2  "id": "203613d2-83c8-4130-8809-d14206eeec20",
3  "operation": "POST /v3/transactions",
4  "status": "processing",
5  "created_at": "2024-01-01T00:00:00Z",
6  "updated_at": "2024-01-01T00:00:30Z",
7  "progress": 0,
8  "total": 4000
9}
Was this page helpful?
Previous

Retrieve a batch

Next
Built with
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).
Submit a batch of requests

Authentication

X-Api-Keystring
API Key authentication via header

Request

This endpoint expects an object.
operation"POST /v3/transactions"Required
An enumeration.
datalist of objectsRequired

Response

Successful Response
idstring
A unique identifier for the batch.
operation"POST /v3/transactions"
An enumeration.
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

Successful Response

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.