Retrieve a batch | Ntropy Docs

X-Api-Keystring

API Key authentication via header

idstringRequired

Successful Response

idstring

A unique identifier for the batch.

operationenum

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.

404

Not Found Error

422

Unprocessable Entity Error

$	curl -X "GET" \
>	"https://api.ntropy.com/v3/batches/203613d2-83c8-4130-8809-d14206eeec20" \
>	-H "Accept: application/json" \
>	-H "X-API-KEY: cd1H...Wmhl"

1	{
2	"id": "203613d2-83c8-4130-8809-d14206eeec20",
3	"operation": "POST /v3/transactions",
4	"status": "processing",
5	"created_at": "2024-01-01T00:00:00",
6	"updated_at": "2024-01-01T00:00:30",
7	"progress": 0,
8	"total": 4000
9	}

$	curl -X "GET" \
>	"https://api.ntropy.com/v3/batches/203613d2-83c8-4130-8809-d14206eeec20" \
>	-H "Accept: application/json" \
>	-H "X-API-KEY: cd1H...Wmhl"

1	{
2	"id": "203613d2-83c8-4130-8809-d14206eeec20",
3	"operation": "POST /v3/transactions",
4	"status": "processing",
5	"created_at": "2024-01-01T00:00:00",
6	"updated_at": "2024-01-01T00:00:30",
7	"progress": 0,
8	"total": 4000
9	}